LSSTApplications  16.0-10-g9d3e444,16.0-11-g09ed895+3,16.0-11-g12e47bd+4,16.0-11-g9bb73b2+10,16.0-12-g5c924a4+10,16.0-15-g7af1f30,16.0-15-gdd5ca33+2,16.0-16-gf0259e2+1,16.0-17-g31abd91+11,16.0-17-g5cf0468+3,16.0-18-g51a54b3+3,16.0-18-ga4d4bcb+5,16.0-18-gcf94535+2,16.0-19-g9d290d5+2,16.0-2-g0febb12+22,16.0-2-g9d5294e+73,16.0-2-ga8830df+7,16.0-21-g3d035912+2,16.0-26-g8e79609,16.0-28-gfc9ea6c+9,16.0-29-ge8801f9+4,16.0-3-ge00e371+38,16.0-4-g18f3627+17,16.0-4-g5f3a788+21,16.0-4-ga3eb747+11,16.0-4-gabf74b7+33,16.0-4-gb13d127+7,16.0-5-g27fb78a+11,16.0-5-g6a53317+38,16.0-5-gb3f8a4b+91,16.0-51-gbbe9c988+3,16.0-6-g9321be7+5,16.0-6-gcbc7b31+47,16.0-6-gf49912c+33,16.0-7-gd2eeba5+56,16.0-75-gbf7a9a820,16.0-8-g21fd5fe+34,16.0-8-g3a9f023+24,16.0-9-gf3bc169+2,16.0-9-gf5c1f43+12,master-gd73dc1d098+5,w.2019.02
LSSTDataManagementBasePackage
Public Member Functions | Static Public Attributes | List of all members
lsst.pipe.tasks.processCcd.ProcessCcdTask Class Reference

Assemble raw data, fit the PSF, detect and measure, and fit WCS and zero-point. More...

Inheritance diagram for lsst.pipe.tasks.processCcd.ProcessCcdTask:

Public Member Functions

def __init__ (self, butler=None, psfRefObjLoader=None, astromRefObjLoader=None, photoRefObjLoader=None, kwargs)
 
def runDataRef (self, sensorRef)
 

Static Public Attributes

 ConfigClass = ProcessCcdConfig
 
 RunnerClass = pipeBase.ButlerInitializedTaskRunner
 

Detailed Description

Assemble raw data, fit the PSF, detect and measure, and fit WCS and zero-point.

Contents

Description

Perform the following operations:

Task initialisation

Parameters
[in]butlerThe butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]psfRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for image characterization. An example of when this would be used is when a CatalogStarSelector is used. May be None if the desired loader can be constructed from the butler argument or all steps requiring a catalog are disabled.
[in]astromRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]photoRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in,out]kwargsother keyword arguments for lsst.pipe.base.CmdLineTask

Invoking the Task

This task is primarily designed to be run from the command line.

The main method is runDataRef, which takes a single butler data reference for the raw input data.

Configuration parameters

See ProcessCcdConfig

Debug variables

ProcessCcdTask has no debug output, but its subtasks do.

A complete example of using ProcessCcdTask

The following commands will process all raw data in obs_test's data repository. Note: be sure to specify an --output that does not already exist:

setup obs_test
setup pipe_tasks
processCcd.py $OBS_TEST_DIR/data/input --output processCcdOut --id

The data is read from the small repository in the obs_test package and written ./processCcdOut (or whatever output you specified). Specifying --id with no values processes all data. Add the option --help to see more options.

Definition at line 79 of file processCcd.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.processCcd.ProcessCcdTask.__init__ (   self,
  butler = None,
  psfRefObjLoader = None,
  astromRefObjLoader = None,
  photoRefObjLoader = None,
  kwargs 
)
Parameters
[in]butlerThe butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]psfRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for image characterization. An example of when this would be used is when a CatalogStarSelector is used. May be None if the desired loader can be constructed from the butler argument or all steps requiring a catalog are disabled.
[in]astromRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for astrometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in]photoRefObjLoaderAn instance of LoadReferenceObjectsTasks that supplies an external reference catalog for photometric calibration. May be None if the desired loader can be constructed from the butler argument or all steps requiring a reference catalog are disabled.
[in,out]kwargsother keyword arguments for lsst.pipe.base.CmdLineTask

Definition at line 138 of file processCcd.py.

138  **kwargs):
139  """!
140  @param[in] butler The butler is passed to the refObjLoader constructor in case it is
141  needed. Ignored if the refObjLoader argument provides a loader directly.
142  @param[in] psfRefObjLoader An instance of LoadReferenceObjectsTasks that supplies an
143  external reference catalog for image characterization. An example of when this would
144  be used is when a CatalogStarSelector is used. May be None if the desired loader can
145  be constructed from the butler argument or all steps requiring a catalog are disabled.
146  @param[in] astromRefObjLoader An instance of LoadReferenceObjectsTasks that supplies an
147  external reference catalog for astrometric calibration. May be None if the desired
148  loader can be constructed from the butler argument or all steps requiring a reference
149  catalog are disabled.
150  @param[in] photoRefObjLoader An instance of LoadReferenceObjectsTasks that supplies an
151  external reference catalog for photometric calibration. May be None if the desired
152  loader can be constructed from the butler argument or all steps requiring a reference
153  catalog are disabled.
154  @param[in,out] kwargs other keyword arguments for lsst.pipe.base.CmdLineTask
155  """
156  pipeBase.CmdLineTask.__init__(self, **kwargs)
157  self.makeSubtask("isr")
158  self.makeSubtask("charImage", butler=butler, refObjLoader=psfRefObjLoader)
159  self.makeSubtask("calibrate", butler=butler, icSourceSchema=self.charImage.schema,
160  astromRefObjLoader=astromRefObjLoader, photoRefObjLoader=photoRefObjLoader)
161 

Member Function Documentation

◆ runDataRef()

def lsst.pipe.tasks.processCcd.ProcessCcdTask.runDataRef (   self,
  sensorRef 
)
Process one CCD

The sequence of operations is:
- remove instrument signature
- characterize image to estimate PSF and background
- calibrate astrometry and photometry

@param sensorRef: butler data reference for raw data

@return pipe_base Struct containing these fields:
- charRes: object returned by image characterization task; an lsst.pipe.base.Struct
    that will include "background" and "sourceCat" fields
- calibRes: object returned by calibration task: an lsst.pipe.base.Struct
    that will include "background" and "sourceCat" fields
- exposure: final exposure (an lsst.afw.image.ExposureF)
- background: final background model (an lsst.afw.math.BackgroundList)

Definition at line 163 of file processCcd.py.

163  def runDataRef(self, sensorRef):
164  """Process one CCD
165 
166  The sequence of operations is:
167  - remove instrument signature
168  - characterize image to estimate PSF and background
169  - calibrate astrometry and photometry
170 
171  @param sensorRef: butler data reference for raw data
172 
173  @return pipe_base Struct containing these fields:
174  - charRes: object returned by image characterization task; an lsst.pipe.base.Struct
175  that will include "background" and "sourceCat" fields
176  - calibRes: object returned by calibration task: an lsst.pipe.base.Struct
177  that will include "background" and "sourceCat" fields
178  - exposure: final exposure (an lsst.afw.image.ExposureF)
179  - background: final background model (an lsst.afw.math.BackgroundList)
180  """
181  self.log.info("Processing %s" % (sensorRef.dataId))
182 
183  exposure = self.isr.runDataRef(sensorRef).exposure
184 
185  charRes = self.charImage.runDataRef(
186  dataRef=sensorRef,
187  exposure=exposure,
188  doUnpersist=False,
189  )
190  exposure = charRes.exposure
191 
192  if self.config.doCalibrate:
193  calibRes = self.calibrate.runDataRef(
194  dataRef=sensorRef,
195  exposure=charRes.exposure,
196  background=charRes.background,
197  doUnpersist=False,
198  icSourceCat=charRes.sourceCat,
199  )
200 
201  return pipeBase.Struct(
202  charRes=charRes,
203  calibRes=calibRes if self.config.doCalibrate else None,
204  exposure=exposure,
205  background=calibRes.background if self.config.doCalibrate else charRes.background,
206  )
207 

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.processCcd.ProcessCcdTask.ConfigClass = ProcessCcdConfig
static

Definition at line 133 of file processCcd.py.

◆ RunnerClass

lsst.pipe.tasks.processCcd.ProcessCcdTask.RunnerClass = pipeBase.ButlerInitializedTaskRunner
static

Definition at line 134 of file processCcd.py.


The documentation for this class was generated from the following file: