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 = TransformConfig

Detailed Description

Transform a SourceCatalog containing raw measurements to calibrated form.

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

Task invocation

Transform raw source measurements to calibrated quantities.

    @param[in] inputCat  SourceCatalog of sources to transform.
    @param[in] wcs       The world coordinate system under which transformations will take place.
    @param[in] photoCalib     The calibration under which transformations will take place.

    @return A BaseCatalog containing the transformed measurements.

Definition at line 55 of file transformMeasurement.py.

Constructor & Destructor Documentation

◆ init()

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

Initialize TransformTask.

    @param[in] measConfig      Configuration for the measurement task which
                               produced the measurments being transformed.
    @param[in] inputSchema     The schema of the input catalog.
    @param[in] outputDataset   The butler dataset type of the output catalog.
    @param[in] *args           Passed through to pipeBase.Task.__init__()
    @param[in] *kwargs         Passed through to pipeBase.Task.__init__()

Definition at line 98 of file transformMeasurement.py.

    def __init__(self, measConfig, inputSchema, outputDataset, *args, **kwargs):
        """!Initialize TransformTask.
 
        @param[in] measConfig      Configuration for the measurement task which
                                   produced the measurments being transformed.
        @param[in] inputSchema     The schema of the input catalog.
        @param[in] outputDataset   The butler dataset type of the output catalog.
        @param[in] *args           Passed through to pipeBase.Task.__init__()
        @param[in] *kwargs         Passed through to pipeBase.Task.__init__()
        """
        pipeBase.Task.__init__(self, *args, **kwargs)
 
        # This task can be used to generate multiple different output dataset types. We
        # need to be able to specify the output type together with its schema.
        self.outputDataset = outputDataset
 
        # Define a mapper and add the basic fields to be copied.
        self.mapper = afwTable.SchemaMapper(inputSchema)
        for field in self.config.copyFields:
            self.mapper.addMapping(inputSchema.find(field).key)
 
        # Build a list of all transforms that will be applied to the input. We
        # will iterate over this in run().
        self.transforms = []
        for name in measConfig.plugins.names:
            config = measConfig.plugins.get(name)
            transformClass = measConfig.plugins.registry.get(name).PluginClass.getTransformClass()
            self.transforms.append(transformClass(config, name, self.mapper))
 

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 127 of file transformMeasurement.py.

    def getSchemaCatalogs(self):
        """!Return a dict containing an empty catalog representative of this task's output."""
        transformedSrc = afwTable.BaseCatalog(self.mapper.getOutputSchema())
        return {self.outputDataset: transformedSrc}
 

◆ run()

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

Transform raw source measurements to calibrated quantities.

    @param[in] inputCat  SourceCatalog of sources to transform.
    @param[in] wcs       The world coordinate system under which transformations will take place.
    @param[in] photoCalib     The calibration under which transformations will take place.

    @return A BaseCatalog containing the transformed measurements.

Definition at line 133 of file transformMeasurement.py.

    def run(self, inputCat, wcs, photoCalib):
        """!Transform raw source measurements to calibrated quantities.
 
        @param[in] inputCat  SourceCatalog of sources to transform.
        @param[in] wcs       The world coordinate system under which transformations will take place.
        @param[in] photoCalib     The calibration under which transformations will take place.
 
        @return A BaseCatalog containing the transformed measurements.
        """
        outputCat = afwTable.BaseCatalog(self.mapper.getOutputSchema())
        outputCat.extend(inputCat, mapper=self.mapper)
 
        # Transforms may use a ColumnView on the input and output catalogs,
        # which requires that the data be contiguous in memory.
        inputCat = makeContiguous(inputCat)
        outputCat = makeContiguous(outputCat)
 
        for transform in self.transforms:
            transform(inputCat, outputCat, wcs, photoCalib)
        return outputCat
 
 

Member Data Documentation

◆ ConfigClass

lsst.pipe.tasks.transformMeasurement.TransformTask.ConfigClass = TransformConfig

static

Definition at line 95 of file transformMeasurement.py.

◆ mapper

lsst.pipe.tasks.transformMeasurement.TransformTask.mapper

Definition at line 115 of file transformMeasurement.py.

◆ outputDataset

lsst.pipe.tasks.transformMeasurement.TransformTask.outputDataset

Definition at line 112 of file transformMeasurement.py.

◆ transforms

lsst.pipe.tasks.transformMeasurement.TransformTask.transforms

Definition at line 121 of file transformMeasurement.py.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-4.0.5/Linux64/pipe_tasks/g8b9e2231ea+b61c7debcc/python/lsst/pipe/tasks/transformMeasurement.py

Public Member Functions

Public Attributes

Static Public Attributes