lsst.pipe.tasks  21.0.0-115-g99380953+42c4f6a8e4
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.

@anchor ProcessCcdTask_

@section pipe_tasks_processCcd_Contents  Contents

 - @ref pipe_tasks_processCcd_Purpose
 - @ref pipe_tasks_processCcd_Initialize
 - @ref pipe_tasks_processCcd_IO
 - @ref pipe_tasks_processCcd_Config
 - @ref pipe_tasks_processCcd_Debug
 - @ref pipe_tasks_processCcd_Example

@section pipe_tasks_processCcd_Purpose  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

@section pipe_tasks_processCcd_Initialize  Task initialisation

@copydoc \_\_init\_\_

@section pipe_tasks_processCcd_IO  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.

@section pipe_tasks_processCcd_Config  Configuration parameters

See @ref ProcessCcdConfig

@section pipe_tasks_processCcd_Debug  Debug variables

ProcessCcdTask has no debug output, but its subtasks do.

@section pipe_tasks_processCcd_Example   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 77 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 135 of file processCcd.py.

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

Member Data Documentation

◆ ConfigClass

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

Definition at line 131 of file processCcd.py.

◆ RunnerClass

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

Definition at line 132 of file processCcd.py.


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