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.

Description

Perform the following operations:

Call isr to unpersist raw data and assemble it into a post-ISR exposure
Call charImage subtract background, fit a PSF model, repair cosmic rays, detect and measure bright sources, and measure aperture correction
Call calibrate to perform deep detection, deblending and single-frame measurement, refine the WCS and fit the photometric zero-point

Task initialisation

Parameters

[in]	butler	The butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]	psfRefObjLoader	An 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]	astromRefObjLoader	An 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]	photoRefObjLoader	An 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]	kwargs	other 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]	butler	The butler is passed to the refObjLoader constructor in case it is needed. Ignored if the refObjLoader argument provides a loader directly.
[in]	psfRefObjLoader	An 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]	astromRefObjLoader	An 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]	photoRefObjLoader	An 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]	kwargs	other keyword arguments for lsst.pipe.base.CmdLineTask

Definition at line 138 of file processCcd.py.

                  **kwargs):
         """!
         @param[in] butler  The butler is passed to the refObjLoader constructor in case it is
             needed.  Ignored if the refObjLoader argument provides a loader directly.
         @param[in] psfRefObjLoader  An 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.
         @param[in] astromRefObjLoader  An 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.
         @param[in] photoRefObjLoader  An 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.
         @param[in,out] kwargs  other keyword arguments for lsst.pipe.base.CmdLineTask
         """
         pipeBase.CmdLineTask.__init__(self, **kwargs)
         self.makeSubtask("isr")
         self.makeSubtask("charImage", butler=butler, refObjLoader=psfRefObjLoader)
         self.makeSubtask("calibrate", butler=butler, icSourceSchema=self.charImage.schema,
                          astromRefObjLoader=astromRefObjLoader, photoRefObjLoader=photoRefObjLoader)
 

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.

     def 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)
         """
         self.log.info("Processing %s" % (sensorRef.dataId))
 
         exposure = self.isr.runDataRef(sensorRef).exposure
 
         charRes = self.charImage.runDataRef(
             dataRef=sensorRef,
             exposure=exposure,
             doUnpersist=False,
         )
         exposure = charRes.exposure
 
         if self.config.doCalibrate:
             calibRes = self.calibrate.runDataRef(
                 dataRef=sensorRef,
                 exposure=charRes.exposure,
                 background=charRes.background,
                 doUnpersist=False,
                 icSourceCat=charRes.sourceCat,
             )
 
         return pipeBase.Struct(
             charRes=charRes,
             calibRes=calibRes if self.config.doCalibrate else None,
             exposure=exposure,
             background=calibRes.background if self.config.doCalibrate else charRes.background,
         )
 

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