lsst.meas.base
20.0.0+14
|
Public Member Functions | |
def | __init__ (self, refSchema, algMetadata=None, **kwds) |
def | run (self, measCat, exposure, refCat, refWcs, exposureId=None, beginOrder=None, endOrder=None) |
def | generateMeasCat (self, exposure, refCat, refWcs, idFactory=None) |
def | attachTransformedFootprints (self, sources, refCat, exposure, refWcs) |
def | getPluginLogName (self, pluginName) |
def | initializePlugins (self, **kwds) |
def | callMeasure (self, measRecord, *args, **kwds) |
def | doMeasurement (self, plugin, measRecord, *args, **kwds) |
def | callMeasureN (self, measCat, *args, **kwds) |
def | doMeasurementN (self, plugin, measCat, *args, **kwds) |
Public Attributes | |
mapper | |
schema | |
undeblendedPlugins | |
Static Public Attributes | |
ConfigClass = ForcedMeasurementConfig | |
plugins = None | |
algMetadata = None | |
Measure sources on an image, constrained by a reference catalog. A subtask for measuring the properties of sources on a single image, using an existing "reference" catalog to constrain some aspects of the measurement. Parameters ---------- refSchema : `lsst.afw.table.Schema` Schema of the reference catalog. Must match the catalog later passed to 'ForcedMeasurementTask.generateMeasCat` and/or `ForcedMeasurementTask.run`. algMetadata : `lsst.daf.base.PropertyList` or `None` Will be updated in place to to record information about each algorithm. An empty `~lsst.daf.base.PropertyList` will be created if `None`. **kwds Keyword arguments are passed to the supertask constructor. Notes ----- Note that while `SingleFrameMeasurementTask` is passed an initial `~lsst.afw.table.Schema` that is appended to in order to create the output `~lsst.afw.table.Schema`, `ForcedMeasurementTask` is initialized with the `~lsst.afw.table.Schema` of the reference catalog, from which a new `~lsst.afw.table.Schema` for the output catalog is created. Fields to be copied directly from the reference `~lsst.afw.table.Schema` are added before ``Plugin`` fields are added.
Definition at line 216 of file forcedMeasurement.py.
def lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.__init__ | ( | self, | |
refSchema, | |||
algMetadata = None , |
|||
** | kwds | ||
) |
Definition at line 249 of file forcedMeasurement.py.
def lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.attachTransformedFootprints | ( | self, | |
sources, | |||
refCat, | |||
exposure, | |||
refWcs | |||
) |
Attach Footprints to blank sources prior to measurement. Notes ----- `~lsst.afw.detection.Footprint`\s for forced photometry must be in the pixel coordinate system of the image being measured, while the actual detections may start out in a different coordinate system. This default implementation transforms the Footprints from the reference catalog from the WCS to the exposure's WCS, which downgrades ``HeavyFootprint``\s into regular `~lsst.afw.detection.Footprint`\s, destroying deblend information. Note that `ForcedPhotImageTask` delegates to this method in its own `~ForcedPhotImageTask.attachFootprints` method. This method can be overridden by its subclasses to define how their `~lsst.afw.detection.Footprint`\s should be generated. See the documentation for `run` for information about the relationships between `run`, `generateMeasCat`, and `attachTransformedFootprints`.
Definition at line 425 of file forcedMeasurement.py.
|
inherited |
Call ``measure`` on all plugins and consistently handle exceptions. Parameters ---------- measRecord : `lsst.afw.table.SourceRecord` The record corresponding to the object being measured. Will be updated in-place with the results of measurement. *args Positional arguments forwarded to ``plugin.measure`` **kwds Keyword arguments. Two are handled locally: beginOrder : `int` Beginning execution order (inclusive). Measurements with ``executionOrder`` < ``beginOrder`` are not executed. `None` for no limit. endOrder : `int` Ending execution order (exclusive). Measurements with ``executionOrder`` >= ``endOrder`` are not executed. `None` for no limit. Others are forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``measRecord`` be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 289 of file baseMeasurement.py.
|
inherited |
Call ``measureN`` on all plugins and consistently handle exceptions. Parameters ---------- measCat : `lsst.afw.table.SourceCatalog` Catalog containing only the records for the source family to be measured, and where outputs should be written. *args Positional arguments forwarded to ``plugin.measure()`` **kwds Keyword arguments. Two are handled locally: beginOrder: Beginning execution order (inclusive): Measurements with ``executionOrder`` < ``beginOrder`` are not executed. `None` for no limit. endOrder: Ending execution order (exclusive): measurements with ``executionOrder`` >= ``endOrder`` are not executed. `None` for no ``limit``. Others are are forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``measRecord`` be the first argument. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 375 of file baseMeasurement.py.
|
inherited |
Call ``measure`` on the specified plugin. Exceptions are handled in a consistent way. Parameters ---------- plugin : subclass of `BasePlugin` Plugin that will be executed. measRecord : `lsst.afw.table.SourceRecord` The record corresponding to the object being measured. Will be updated in-place with the results of measurement. *args Positional arguments forwarded to ``plugin.measure()``. **kwds Keyword arguments forwarded to ``plugin.measure()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that ``plugin`` and ``measRecord`` be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 333 of file baseMeasurement.py.
|
inherited |
Call ``measureN`` on the specified plugin. Exceptions are handled in a consistent way. Parameters ---------- plugin : subclass of `BasePlugin` Plugin that will be executed. measCat : `lsst.afw.table.SourceCatalog` Catalog containing only the records for the source family to be measured, and where outputs should be written. *args Positional arguments forwarded to ``plugin.measureN()``. **kwds Keyword arguments forwarded to ``plugin.measureN()``. Notes ----- This method can be used with plugins that have different signatures; the only requirement is that the ``plugin`` and ``measCat`` be the first two arguments. Subsequent positional arguments and keyword arguments are forwarded directly to the plugin. This method should be considered "protected": it is intended for use by derived classes, not users.
Definition at line 418 of file baseMeasurement.py.
def lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.generateMeasCat | ( | self, | |
exposure, | |||
refCat, | |||
refWcs, | |||
idFactory = None |
|||
) |
Initialize an output catalog from the reference catalog. Parameters ---------- exposure : `lsst.afw.image.exposureF` Image to be measured. refCat : iterable of `lsst.afw.table.SourceRecord` Catalog of reference sources. refWcs : `lsst.afw.geom.SkyWcs` Defines the X,Y coordinate system of ``refCat``. idFactory : `lsst.afw.table.IdFactory`, optional Factory for creating IDs for sources. Returns ------- meascat : `lsst.afw.table.SourceCatalog` Source catalog ready for measurement. Notes ----- This generates a new blank `~lsst.afw.table.SourceRecord` for each record in ``refCat``. Note that this method does not attach any `~lsst.afw.detection.Footprint`\ s. Doing so is up to the caller (who may call `attachedTransformedFootprints` or define their own method - see `run` for more information).
Definition at line 386 of file forcedMeasurement.py.
|
inherited |
Definition at line 239 of file baseMeasurement.py.
|
inherited |
Initialize plugins (and slots) according to configuration. Parameters ---------- **kwds Keyword arguments forwarded directly to plugin constructors. Notes ----- Derived class constructors should call this method to fill the `plugins` attribute and add corresponding output fields and slot aliases to the output schema. In addition to the attributes added by `BaseMeasurementTask.__init__`, a ``schema``` attribute holding the output schema must be present before this method is called. Keyword arguments are forwarded directly to plugin constructors, allowing derived classes to use plugins with different signatures.
Definition at line 242 of file baseMeasurement.py.
def lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.run | ( | self, | |
measCat, | |||
exposure, | |||
refCat, | |||
refWcs, | |||
exposureId = None , |
|||
beginOrder = None , |
|||
endOrder = None |
|||
) |
Perform forced measurement. Parameters ---------- exposure : `lsst.afw.image.exposureF` Image to be measured. Must have at least a `lsst.afw.geom.SkyWcs` attached. measCat : `lsst.afw.table.SourceCatalog` Source catalog for measurement results; must be initialized with empty records already corresponding to those in ``refCat`` (via e.g. `generateMeasCat`). refCat : `lsst.afw.table.SourceCatalog` A sequence of `lsst.afw.table.SourceRecord` objects that provide reference information for the measurement. These will be passed to each plugin in addition to the output `~lsst.afw.table.SourceRecord`. refWcs : `lsst.afw.geom.SkyWcs` Defines the X,Y coordinate system of ``refCat``. exposureId : `int`, optional Optional unique exposureId used to calculate random number generator seed in the NoiseReplacer. beginOrder : `int`, optional Beginning execution order (inclusive). Algorithms with ``executionOrder`` < ``beginOrder`` are not executed. `None` for no limit. endOrder : `int`, optional Ending execution order (exclusive). Algorithms with ``executionOrder`` >= ``endOrder`` are not executed. `None` for no limit. Notes ----- Fills the initial empty `~lsst.afw.table.SourceCatalog` with forced measurement results. Two steps must occur before `run` can be called: - `generateMeasCat` must be called to create the output ``measCat`` argument. - `~lsst.afw.detection.Footprint`\ s appropriate for the forced sources must be attached to the ``measCat`` records. The `attachTransformedFootprints` method can be used to do this, but this degrades "heavy" (i.e., including pixel values) `~lsst.afw.detection.Footprint`\s to regular `~lsst.afw.detection.Footprint`\s, leading to non-deblended measurement, so most callers should provide `~lsst.afw.detection.Footprint`\s some other way. Typically, calling code will have access to information that will allow them to provide heavy footprints - for instance, `ForcedPhotCoaddTask` uses the heavy footprints from deblending run in the same band just before non-forced is run measurement in that band.
Definition at line 262 of file forcedMeasurement.py.
|
staticinherited |
Definition at line 224 of file baseMeasurement.py.
|
static |
Definition at line 247 of file forcedMeasurement.py.
lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.mapper |
Definition at line 251 of file forcedMeasurement.py.
|
staticinherited |
Definition at line 217 of file baseMeasurement.py.
lsst.meas.base.forcedMeasurement.ForcedMeasurementTask.schema |
Definition at line 259 of file forcedMeasurement.py.
|
inherited |
Definition at line 234 of file baseMeasurement.py.