LSSTApplications  16.0-10-g9d3e444,16.0-11-g09ed895+3,16.0-11-g12e47bd+5,16.0-12-g5c924a4+12,16.0-12-g71e5ef5+1,16.0-15-g7af1f30,16.0-15-gdd5ca33+2,16.0-16-gf0259e2+1,16.0-17-g5cf0468+5,16.0-18-ga4d4bcb+7,16.0-18-gcf94535+4,16.0-18-geff7d6b+1,16.0-19-g9d290d5+4,16.0-2-g0febb12+22,16.0-2-g9d5294e+73,16.0-2-ga8830df+7,16.0-20-gec02d88,16.0-22-gf55172b7,16.0-28-g0a7b887,16.0-28-gfc9ea6c+11,16.0-29-ge8801f9+5,16.0-3-ge00e371+40,16.0-4-g18f3627+17,16.0-4-g5f3a788+21,16.0-4-ga3eb747+11,16.0-4-gabf74b7+35,16.0-4-gb13d127+7,16.0-5-g27fb78a+13,16.0-5-g6a53317+40,16.0-5-gb3f8a4b+93,16.0-53-ga4affb86,16.0-6-g9321be7+5,16.0-6-gcbc7b31+49,16.0-6-gf49912c+35,16.0-75-gbf7a9a820,16.0-8-g21fd5fe+36,16.0-8-g3a9f023+24,16.0-8-gc11f1cf+2,16.0-9-gf3bc169+3,16.0-9-gf5c1f43+12,master-gc237143d49+1,w.2019.03
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.transformMeasurement.ForcedSrcTransformTask Class Reference

Transform forced_src measuremenents to calibrated form. More...

Inheritance diagram for lsst.pipe.tasks.transformMeasurement.ForcedSrcTransformTask:
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 runDataRef (self, dataRef)
 Transform the source catalog referred to by dataRef. More...
 

Public Attributes

 butler
 

Static Public Attributes

string sourceType = 'forced_src'
 
string calexpType = 'calexp'
 
 RunnerClass = pipeBase.ButlerInitializedTaskRunner
 
 ConfigClass = RunTransformConfig
 

Detailed Description

Transform forced_src measuremenents to calibrated form.

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

Definition at line 297 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 209 of file transformMeasurement.py.

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

◆ measurementConfig()

def lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.measurementConfig (   self)
inherited

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.

Definition at line 229 of file transformMeasurement.py.

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

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

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

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

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

Definition at line 247 of file transformMeasurement.py.

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

Member Data Documentation

◆ butler

lsst.pipe.tasks.transformMeasurement.RunTransformTaskBase.butler
inherited

Definition at line 241 of file transformMeasurement.py.

◆ calexpType

string lsst.pipe.tasks.transformMeasurement.ForcedSrcTransformTask.calexpType = 'calexp'
static

Definition at line 308 of file transformMeasurement.py.

◆ ConfigClass

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

Definition at line 194 of file transformMeasurement.py.

◆ RunnerClass

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

Definition at line 193 of file transformMeasurement.py.

◆ sourceType

string lsst.pipe.tasks.transformMeasurement.ForcedSrcTransformTask.sourceType = 'forced_src'
static

Definition at line 307 of file transformMeasurement.py.


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