lsst.pipe.tasks  20.0.0-8-g7eef53f7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.transformMeasurement.TransformTask Class Reference

Transform a SourceCatalog containing raw measurements to calibrated form. More...

Inheritance diagram for lsst.pipe.tasks.transformMeasurement.TransformTask:

Public Member Functions

def __init__ (self, measConfig, inputSchema, outputDataset, *args, **kwargs)
 Initialize TransformTask. More...
 
def getSchemaCatalogs (self)
 Return a dict containing an empty catalog representative of this task's output. More...
 
def run (self, inputCat, wcs, photoCalib)
 Transform raw source measurements to calibrated quantities. More...
 

Public Attributes

 outputDataset
 
 mapper
 
 transforms
 

Static Public Attributes

 ConfigClass
 

Detailed Description

Transform a SourceCatalog containing raw measurements to calibrated form.

Contents

Description

Given a set of measurement algorithms with their associated configuration, the table of source measurements they have produced, and information about an associated WCS and calibration, transform the raw measurement output to a calibrated form.

Transformations are defined on a per-measurement-plugin basis. In addition, a configurable set of fields may be simply copied from the input to the output catalog.

This task operates on an input SourceCatalog and returns a BaseCatalog containing the transformed results. It requires that the caller supply information on the configuration of the measurement task which produced the input data as well as the world coordinate system and calibration under which the transformation will take place. It provides no functionality for reading or writing data from a Butler: rather, per-dataset-type command line tasks are provided to obtain the appropriate information from a Butler (or elsewhere) and then delegate to this task.

Task initialization

Initialize TransformTask.

Parameters
[in]measConfigConfiguration for the measurement task which produced the measurments being transformed.
[in]inputSchemaThe schema of the input catalog.
[in]outputDatasetThe butler dataset type of the output catalog.
[in]*argsPassed through to pipeBase.Task.__init__()
[in]*kwargsPassed through to pipeBase.Task.__init__()

Task invocation

Transform raw source measurements to calibrated quantities.

Parameters
[in]inputCatSourceCatalog of sources to transform.
[in]wcsThe world coordinate system under which transformations will take place.
[in]photoCalibThe calibration under which transformations will take place.
Returns
A BaseCatalog containing the transformed measurements.

Definition at line 54 of file transformMeasurement.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.pipe.tasks.transformMeasurement.TransformTask.__init__ (   self,
  measConfig,
  inputSchema,
  outputDataset,
args,
**  kwargs 
)

Initialize TransformTask.

Parameters
[in]measConfigConfiguration for the measurement task which produced the measurments being transformed.
[in]inputSchemaThe schema of the input catalog.
[in]outputDatasetThe butler dataset type of the output catalog.
[in]*argsPassed through to pipeBase.Task.__init__()
[in]*kwargsPassed through to pipeBase.Task.__init__()

Definition at line 97 of file transformMeasurement.py.

Member Function Documentation

◆ getSchemaCatalogs()

def lsst.pipe.tasks.transformMeasurement.TransformTask.getSchemaCatalogs (   self)

Return a dict containing an empty catalog representative of this task's output.

Definition at line 126 of file transformMeasurement.py.

◆ run()

def lsst.pipe.tasks.transformMeasurement.TransformTask.run (   self,
  inputCat,
  wcs,
  photoCalib 
)

Transform raw source measurements to calibrated quantities.

Parameters
[in]inputCatSourceCatalog of sources to transform.
[in]wcsThe world coordinate system under which transformations will take place.
[in]photoCalibThe calibration under which transformations will take place.
Returns
A BaseCatalog containing the transformed measurements.

Definition at line 131 of file transformMeasurement.py.

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.transformMeasurement.TransformTask.ConfigClass
static

Definition at line 94 of file transformMeasurement.py.

◆ mapper

lsst.pipe.tasks.transformMeasurement.TransformTask.mapper

Definition at line 114 of file transformMeasurement.py.

◆ outputDataset

lsst.pipe.tasks.transformMeasurement.TransformTask.outputDataset

Definition at line 111 of file transformMeasurement.py.

◆ transforms

lsst.pipe.tasks.transformMeasurement.TransformTask.transforms

Definition at line 120 of file transformMeasurement.py.


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