|
def | __init__ (self, config, name, schemaMapper, metadata, logName=None) |
|
def | measure (self, measRecord, exposure, refRecord, refWcs) |
|
def | measureN (self, measCat, exposure, refCat, refWcs) |
|
def | getExecutionOrder (cls) |
|
def | getLogName (self) |
|
def | fail (self, measRecord, error=None) |
| Record a failure of the measure or measureN() method. More...
|
|
Definition at line 67 of file forcedMeasurement.py.
◆ __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 74 of file forcedMeasurement.py.
◆ fail()
def lsst.meas.base.pluginsBase.BasePlugin.fail |
( |
|
self, |
|
|
|
measRecord, |
|
|
|
error = None |
|
) |
| |
|
inherited |
Record a failure of the measure or measureN() method.
When the plugin raises an exception, framework will call fail() to allow the plugin to set its failure flag field(s). When measureN() raises an exception, fail() will be called repeatedly with all the records that were being measured.
If the exception is a MeasurementError, it will be passed as the error argument; in all other cases the error argument will be None, and the failure will be logged by the measurement framework as a warning.
Definition at line 93 of file pluginsBase.py.
◆ getExecutionOrder()
def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder |
( |
|
cls | ) |
|
|
inherited |
Sets the relative order of plugins (smaller numbers run first).
In general, the following class constants should be used (other values
are also allowed, but should be avoided unless they are needed):
CENTROID_ORDER centroids and other algorithms that require only a Footprint
and its Peaks as input
SHAPE_ORDER shape measurements and other algorithms that require getCentroid() to return
a good centroid (in addition to a Footprint and its Peaks).
FLUX_ORDER flux algorithms that require both getShape() and getCentroid(),
in addition to a Footprint and its Peaks
DEFAULT_CATALOGCALCULATION plugins that only operate on the catalog
Must be reimplemented as a class method by concrete derived classes.
This approach was chosen instead of a full graph-based analysis of dependencies
because algorithm dependencies are usually both quite simple and entirely substitutable:
an algorithm that requires a centroid can typically make use of any centroid algorithms
outputs. That makes it relatively easy to figure out the correct value to use for any
particular algorithm.
Definition at line 55 of file pluginsBase.py.
◆ getLogName()
def lsst.meas.base.pluginsBase.BasePlugin.getLogName |
( |
|
self | ) |
|
|
inherited |
◆ getTransformClass()
def lsst.meas.base.pluginsBase.BasePlugin.getTransformClass |
( |
| ) |
|
|
staticinherited |
Get the measurement transformation appropriate to this plugin.
This returns a subclass of MeasurementTransform, which may be instantiated with details of the algorithm configuration and then called with information about calibration and WCS to convert from raw measurement quantities to calibrated units. Calibrated data is then provided in a separate output table.
By default, we copy everything from the input to the output without transformation.
Definition at line 115 of file pluginsBase.py.
◆ 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 lsst.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 88 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 lsst.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 114 of file forcedMeasurement.py.
◆ APCORR_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0 |
|
staticinherited |
◆ CENTROID_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0 |
|
staticinherited |
◆ config
lsst.meas.base.pluginsBase.BasePlugin.config |
|
inherited |
◆ ConfigClass
◆ DEFAULT_CATALOGCALCULATION
float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0 |
|
staticinherited |
◆ FLUX_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0 |
|
staticinherited |
◆ logName
lsst.meas.base.pluginsBase.BasePlugin.logName |
|
inherited |
◆ name
lsst.meas.base.pluginsBase.BasePlugin.name |
|
inherited |
◆ registry
◆ SHAPE_ORDER
float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0 |
|
staticinherited |
The documentation for this class was generated from the following file: