lsst.meas.base  13.0-26-g0f127ff+5
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.forcedMeasurement.ForcedPlugin Class Reference
Inheritance diagram for lsst.meas.base.forcedMeasurement.ForcedPlugin:
lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin lsst.meas.base.plugins.ForcedPeakCentroidPlugin lsst.meas.base.plugins.ForcedTransformedCentroidPlugin lsst.meas.base.plugins.ForcedTransformedShapePlugin lsst.meas.base.wrappers.WrappedForcedPlugin

Public Member Functions

def __init__ (self, config, name, schemaMapper, metadata, logName=None)
 
def measure (self, measRecord, exposure, refRecord, refWcs)
 
def measureN (self, measCat, exposure, refCat, refWcs)
 
- Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getExecutionOrder (cls)
 
def __init__ (self, config, name, logName=None)
 Initialize the plugin object. More...
 
def getLogName (self)
 
def fail (self, measRecord, error=None)
 Record a failure of the measure or measureN() method. More...
 

Static Public Attributes

 registry = PluginRegistry(ForcedPluginConfig)
 
 ConfigClass = ForcedPluginConfig
 
- Static Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
float CENTROID_ORDER = 0.0
 
float SHAPE_ORDER = 1.0
 
float FLUX_ORDER = 2.0
 
float APCORR_ORDER = 3.0
 
float DEFAULT_CATALOGCALCULATION = 4.0
 

Additional Inherited Members

- Static Public Member Functions inherited from lsst.meas.base.pluginsBase.BasePlugin
def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 
- Public Attributes inherited from lsst.meas.base.pluginsBase.BasePlugin
 config
 
 name
 
 logName
 

Detailed Description

Definition at line 68 of file forcedMeasurement.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.__init__ (   self,
  config,
  name,
  schemaMapper,
  metadata,
  logName = None 
)
Initialize the measurement object.

@param[in]  config       An instance of this class's ConfigClass.
@param[in]  name         The string the plugin was registered with.
@param[in,out]  schemaMapper  A SchemaMapper that maps reference catalog fields to output
                      catalog fields.  Output fields should be added to the
                      output schema.  While most plugins will not need to map
                      fields from the reference schema, if they do so, those fields
                      will be transferred before any plugins are run.
@param[in]  metadata     Plugin metadata that will be attached to the output catalog

Definition at line 75 of file forcedMeasurement.py.

Member Function Documentation

◆ measure()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measure (   self,
  measRecord,
  exposure,
  refRecord,
  refWcs 
)
Measure the properties of a source on a single image, given data from a
reference record.

@param[in] exposure       lsst.afw.image.ExposureF, containing the pixel data to
                  be measured and the associated Psf, Wcs, etc.  All
                  other sources in the image will have been replaced by
                  noise according to deblender outputs.
@param[in,out] measRecord lsst.afw.table.SourceRecord to be filled with outputs,
                  and from which previously-measured quantities can be
                  retreived.
@param[in] refRecord      lsst.afw.table.SimpleRecord that contains additional
                  parameters to define the fit, as measured elsewhere.
@param[in] refWcs         The coordinate system for the reference catalog values.
                  An afw.geom.Angle may be passed, indicating that a
                  local tangent Wcs should be created for each object
                  using afw.image.makeLocalWcs and the given angle as
                  a pixel scale.

In the normal mode of operation, the source centroid will be set to the
WCS-transformed position of the reference object, so plugins that only
require a reference position should not have to access the reference object
at all.

Definition at line 89 of file forcedMeasurement.py.

◆ measureN()

def lsst.meas.base.forcedMeasurement.ForcedPlugin.measureN (   self,
  measCat,
  exposure,
  refCat,
  refWcs 
)
Measure the properties of a group of blended sources on a single image,
given data from a reference record.

@param[in] exposure      lsst.afw.image.ExposureF, containing the pixel data to
                 be measured and the associated Psf, Wcs, etc.  Sources
                 not in the blended hierarchy to be measured will have
                 been replaced with noise using deblender outputs.
@param[in,out] measCat   lsst.afw.table.SourceCatalog to be filled with outputs,
                 and from which previously-measured quantities can be
                 retrieved, containing only the sources that should be
                 measured together in this call.
@param[in] refCat        lsst.afw.table.SimpleCatalog that contains additional
                 parameters to define the fit, as measured elsewhere.
                 Ordered such that zip(sources, references) may be used.
@param[in] refWcs        The coordinate system for the reference catalog values.
                 An afw.geom.Angle may be passed, indicating that a
                 local tangent Wcs should be created for each object
                 using afw.image.makeLocalWcs and the given Angle as
                 a pixel scale.

In the normal mode of operation, the source centroids will be set to the
WCS-transformed position of the reference object, so plugins that only
require a reference position should not have to access the reference object
at all.

Definition at line 115 of file forcedMeasurement.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.forcedMeasurement.ForcedPlugin.ConfigClass = ForcedPluginConfig
static

Definition at line 73 of file forcedMeasurement.py.

◆ registry

lsst.meas.base.forcedMeasurement.ForcedPlugin.registry = PluginRegistry(ForcedPluginConfig)
static

Definition at line 71 of file forcedMeasurement.py.


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