LSSTApplications  17.0+11,17.0+35,17.0+60,17.0+61,17.0+63,17.0+7,17.0-1-g377950a+35,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+30,17.0.1-1-g55520dc+55,17.0.1-1-g5f4ed7e+59,17.0.1-1-g6dd7d69+22,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+63,17.0.1-1-gfc65f5f+56,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+9,17.0.1-12-g112a4bc+3,17.0.1-17-gab9750a3+5,17.0.1-17-gdae4c4a+16,17.0.1-19-g3a24bb2+2,17.0.1-2-g26618f5+35,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-21-g52a398f+5,17.0.1-26-gd98a1d13,17.0.1-3-g7e86b59+45,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+46,17.0.1-31-gb0791f330,17.0.1-4-g59d126d+10,17.0.1-5-g3877d06+2,17.0.1-7-g35889ee+7,17.0.1-7-gc7c8782+20,17.0.1-7-gcb7da53+5,17.0.1-9-gc4bbfb2+10,w.2019.24
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. 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 80 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. 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 139 of file processCcd.py.

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

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 164 of file processCcd.py.

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

Member Data Documentation

◆ ConfigClass

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

Definition at line 134 of file processCcd.py.

◆ RunnerClass

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

Definition at line 135 of file processCcd.py.


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