LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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.

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

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.

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

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

231  def measurementConfig(self):
232  """!
233  The configuration of the measurement operation used to generate the input catalog.
234 
235  By default we look for `measurement` under the root configuration of the
236  generating task. Subclasses may customize this (e.g. to `calibrate.measurement`)
237  if required.
238  """
239  return self.butler.get(self.config.inputConfigType).measurement.value
240 

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

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

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

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

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

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

Definition at line 205 of file transformMeasurement.py.


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