lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase Class Reference

More...

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

Public Member Functions
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	measurementConfig (self)
	The configuration of the measurement operation used to generate the input catalog. More...
def	__init__ (self, *args, **kwargs)
def	runDataRef (self, dataRef)
	Transform the source catalog referred to by dataRef. More...

Public Attributes
	butler

Static Public Attributes
	RunnerClass = pipeBase.ButlerInitializedTaskRunner
	ConfigClass = RunTransformConfig
	sourceType = None
	calexpType = None

Detailed Description

Command line interface for TransformTask.

Contents

• Description
• Task invocation

Description

Provides a command-line task which can be used to run TransformTask.

• Loads a plugin registry based on configuration;
• Loads configuration for the measurement task which was applied from a repository;
• Loads the SourceCatalog input schema from a repository;
• For each input dataRef, reads the SourceCatalog, WCS and calibration from the repository and executes TransformTask.

This is not a fully-fledged command line task: it requires specialization to a particular source type by defining the variables indicated below.

Task invocation

Definition at line 167 of file transformMeasurement.py.

Constructor & Destructor Documentation

__init__()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.__init__	(		self,
		*	args,
		**	kwargs
	)

Definition at line 241 of file transformMeasurement.py.

    def __init__(self, *args, **kwargs):
        pipeBase.CmdLineTask.__init__(self, *args, config=kwargs['config'], log=kwargs['log'])
        self.butler = kwargs['butler']
        self.makeSubtask('transform', measConfig=self.measurementConfig,
                         inputSchema=self.butler.get(self.inputSchemaType).schema,
                         outputDataset=self.outputDataset)
 

Member Function Documentation

inputSchemaType()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.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.

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.RunTransformTaskBase.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 in lsst.pipe.tasks.transformMeasurement.SrcTransformTask.

Definition at line 231 of file transformMeasurement.py.

    def 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.
        """
        return self.butler.get(self.config.inputConfigType).measurement.value
 

outputDataset()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.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.

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
	)

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

Definition at line 243 of file transformMeasurement.py.

calexpType

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.calexpType = None

static

Reimplemented in lsst.pipe.tasks.transformMeasurement.CoaddSrcTransformTask.

Definition at line 208 of file transformMeasurement.py.

ConfigClass

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

static

Definition at line 196 of file transformMeasurement.py.

RunnerClass

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

static

Definition at line 195 of file transformMeasurement.py.

sourceType

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.sourceType = None

static

Reimplemented in lsst.pipe.tasks.transformMeasurement.CoaddSrcTransformTask.

Definition at line 205 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