lsst.pipe.tasks g0f82ab2f21+0b48447375
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase Class Reference

More...

Inheritance diagram for lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase:
lsst.pipe.tasks.transformMeasurement.CoaddSrcTransformTask lsst.pipe.tasks.transformMeasurement.ForcedSrcTransformTask lsst.pipe.tasks.transformMeasurement.SrcTransformTask

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

Provides a command-line task which can be used to run 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.

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.

◆ 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.

◆ 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.

◆ 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.

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

◆ 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

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