lsst.pipe.tasks.transformMeasurement.SrcTransformTask Class Reference

More...

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

Public Member Functions
def	measurementConfig (self)
	The configuration of the measurement operation used to generate the input catalog. More...
def	inputSchemaType (self)
	The Butler dataset type for the schema of the input source catalog. More...
def	outputDataset (self)
	The Butler dataset type for the schema of the output catalog. More...
def	runDataRef (self, dataRef)
	Transform the source catalog referred to by dataRef. More...

Public Attributes
	butler

Static Public Attributes
string	sourceType = 'src'
string	calexpType = 'calexp'
	RunnerClass = pipeBase.ButlerInitializedTaskRunner
	ConfigClass = RunTransformConfig

Detailed Description

Transform src measuremenents to calibrated form.

This is a specialization of RunTransformTaskBase which operates on src measurements. Refer to the parent documentation for details.

Definition at line 274 of file transformMeasurement.py.

Member Function Documentation

inputSchemaType()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.inputSchemaType (   self )

inherited

The Butler dataset type for the schema of the input source catalog.

By default, we append _schema to the input source type. Subclasses may customize if required.

Definition at line 211 of file transformMeasurement.py.

    def inputSchemaType(self):
        """!
        The Butler dataset type for the schema of the input source catalog.
 
        By default, we append `_schema` to the input source type. Subclasses may customize
        if required.
        """
        return self.sourceType + "_schema"
 

measurementConfig()

def lsst.pipe.tasks.transformMeasurement.SrcTransformTask.measurementConfig

(

self

)

The configuration of the measurement operation used to generate the input catalog.

By default we look for measurement under the root configuration of the generating task. Subclasses may customize this (e.g. to calibrate.measurement) if required.

Reimplemented from lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.

Definition at line 288 of file transformMeasurement.py.

    def measurementConfig(self):
        return self.butler.get(self.config.inputConfigType).calibrate.measurement.value
 
 

outputDataset()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.outputDataset (   self )

inherited

The Butler dataset type for the schema of the output catalog.

By default, we prepend transformed_ to the input source type. Subclasses may customize if required.

Definition at line 221 of file transformMeasurement.py.

    def outputDataset(self):
        """!
        The Butler dataset type for the schema of the output catalog.
 
        By default, we prepend `transformed_` to the input source type. Subclasses may
        customize if required.
        """
        return 'transformed_' + self.sourceType
 

runDataRef()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.runDataRef (   self,   dataRef  )

inherited

Transform the source catalog referred to by dataRef.

    The result is both returned and written as dataset type "transformed_" + the input
    source dataset type to the provided dataRef.

    @param[in] dataRef  Data reference for source catalog & calibrated exposure.

    @returns A BaseCatalog containing the transformed measurements.

Definition at line 249 of file transformMeasurement.py.

    def runDataRef(self, dataRef):
        """!Transform the source catalog referred to by dataRef.
 
        The result is both returned and written as dataset type "transformed_" + the input
        source dataset type to the provided dataRef.
 
        @param[in] dataRef  Data reference for source catalog & calibrated exposure.
 
        @returns A BaseCatalog containing the transformed measurements.
        """
        inputCat = dataRef.get(self.sourceType)
        wcs = dataRef.get(self.calexpType).getWcs()
        photoCalib = dataRef.get(self.calexpType).getPhotoCalib()
        outputCat = self.transform.run(inputCat, wcs, photoCalib)
        dataRef.put(outputCat, self.outputDataset)
        return outputCat
 
 

Member Data Documentation

butler

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.butler

inherited

Definition at line 243 of file transformMeasurement.py.

calexpType

string lsst.pipe.tasks.transformMeasurement.SrcTransformTask.calexpType = 'calexp'

static

Definition at line 285 of file transformMeasurement.py.

ConfigClass

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.ConfigClass = RunTransformConfig

staticinherited

Definition at line 196 of file transformMeasurement.py.

RunnerClass

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.RunnerClass = pipeBase.ButlerInitializedTaskRunner

staticinherited

Definition at line 195 of file transformMeasurement.py.

sourceType

string lsst.pipe.tasks.transformMeasurement.SrcTransformTask.sourceType = 'src'

static

Definition at line 284 of file transformMeasurement.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/pipe_tasks/21.0.0-172-gfb10e10a+18fedfabac/python/lsst/pipe/tasks/transformMeasurement.py