LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | Static Public Attributes | Static Private Attributes | List of all members
lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase Class Reference

Command line interface for TransformTask. 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
 The Butler dataset type for the schema of the input source catalog. More...
 
def outputDataset
 The Butler dataset type for the schema of the output catalog. More...
 
def measurementConfig
 The configuration of the measurement operation used to generate the input catalog. More...
 
def __init__
 
def run
 Transform the source catalog referred to by dataRef. More...
 

Public Attributes

 butler
 

Static Public Attributes

 RunnerClass = pipeBase.ButlerInitializedTaskRunner
 
 ConfigClass = RunTransformConfig
 
 sourceType = None
 
 calexpType = None
 

Static Private Attributes

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

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.

Parameters
[in]dataRefData reference for source catalog & calibrated exposure.
Returns
A BaseCatalog containing the transformed measurements.

Definition at line 165 of file transformMeasurement.py.

Constructor & Destructor Documentation

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

Definition at line 239 of file transformMeasurement.py.

240  def __init__(self, *args, **kwargs):
241  pipeBase.CmdLineTask.__init__(self, *args, config=kwargs['config'], log=kwargs['log'])
242  self.butler = kwargs['butler']
243  self.makeSubtask('transform', measConfig=self.measurementConfig,
244  inputSchema=self.butler.get(self.inputSchemaType).schema,
245  outputDataset=self.outputDataset)
def measurementConfig
The configuration of the measurement operation used to generate the input catalog.
def inputSchemaType
The Butler dataset type for the schema of the input source catalog.
def outputDataset
The Butler dataset type for the schema of the output catalog.

Member Function Documentation

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

210  def inputSchemaType(self):
211  """!
212  The Butler dataset type for the schema of the input source catalog.
213 
214  By default, we append `_schema` to the input source type. Subclasses may customize
215  if required.
216  """
217  return self.sourceType + "_schema"
def inputSchemaType
The Butler dataset type for the schema of the input source catalog.
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 calibration.measurement) if required.

Definition at line 229 of file transformMeasurement.py.

230  def measurementConfig(self):
231  """!
232  The configuration of the measurement operation used to generate the input catalog.
233 
234  By default we look for `measurement` under the root configuration of the
235  generating task. Subclasses may customize this (e.g. to `calibration.measurement`)
236  if required.
237  """
238  return self.butler.get(self.config.inputConfigType).measurement.value
def measurementConfig
The configuration of the measurement operation used to generate the input catalog.
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 219 of file transformMeasurement.py.

220  def outputDataset(self):
221  """!
222  The Butler dataset type for the schema of the output catalog.
223 
224  By default, we prepend `transformed_` to the input source type. Subclasses may
225  customize if required.
226  """
227  return 'transformed_' + self.sourceType
def outputDataset
The Butler dataset type for the schema of the output catalog.
def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.run (   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.

Parameters
[in]dataRefData reference for source catalog & calibrated exposure.
Returns
A BaseCatalog containing the transformed measurements.

Definition at line 247 of file transformMeasurement.py.

248  def run(self, dataRef):
249  """!Transform the source catalog referred to by dataRef.
250 
251  The result is both returned and written as dataset type "transformed_" + the input
252  source dataset type to the provided dataRef.
253 
254  @param[in] dataRef Data reference for source catalog & calibrated exposure.
255 
256  @returns A BaseCatalog containing the transformed measurements.
257  """
258  inputCat = dataRef.get(self.sourceType)
259  wcs = dataRef.get(self.calexpType).getWcs()
260  calib = dataRef.get(self.calexpType).getCalib()
261  outputCat = self.transform.run(inputCat, wcs, calib)
262  dataRef.put(outputCat, self.outputDataset)
263  return outputCat
264 
def run
Transform the source catalog referred to by dataRef.
def outputDataset
The Butler dataset type for the schema of the output catalog.

Member Data Documentation

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase._DefaultName = None
staticprivate

Definition at line 200 of file transformMeasurement.py.

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.butler

Definition at line 241 of file transformMeasurement.py.

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

Definition at line 206 of file transformMeasurement.py.

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

Definition at line 194 of file transformMeasurement.py.

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

Definition at line 193 of file transformMeasurement.py.

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

Definition at line 203 of file transformMeasurement.py.


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