lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask Class Reference

Inheritance diagram for lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask:

Public Member Functions
	__init__ (self, refSchema, lsst.daf.base.PropertyList algMetadata=None, **kwds)
None	run (self, lsst.afw.table.SourceCatalog refCat, lsst.afw.table.SourceCatalog measCat, lsst.afw.image.Exposure exposure, lsst.afw.geom.SkyWcs refWcs, int|None beginOrder=None, int|None endOrder=None)
	initializePlugins (self, **kwds)
	addInvalidPsfFlag (self, schema)
	callMeasure (self, measRecord, *args, **kwds)
	doMeasurement (self, plugin, measRecord, *args, **kwds)

Public Attributes
	mapper = lsst.afw.table.SchemaMapper(refSchema)
	schema = self.mapper.getOutputSchema()
	keyInvalidPsf = schema.find(invalidPsfName).key

Static Public Attributes
	ConfigClass = SimpleBaseMeasurementConfig
	plugins = None
	algMetadata = None

Protected Member Functions
	_attachPsfShapeFootprints (self, sources, exposure, scaling=3)

Static Protected Attributes
str	_DefaultName = "measurement"

Detailed Description

Measure sources on an image using a simple forced measurement algorithm.

This differes from ForcedMeasurmentTask in that it uses a PSF-based
footprint for every source so it does not need to transform footprints.

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

Definition at line 75 of file simple_forced_measurement.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask.__init__	(		self,
			refSchema,
		lsst.daf.base.PropertyList	algMetadata = None,
		**	kwds )

Definition at line 92 of file simple_forced_measurement.py.

Member Function Documentation

_attachPsfShapeFootprints()

lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask._attachPsfShapeFootprints ( self, sources, exposure, scaling = 3 )

protected

Attach Footprints to blank sources prior to measurement, by
creating elliptical Footprints from the PSF moments.

Parameters
----------
sources : `lsst.afw.table.SourceCatalog`
    Blank catalog (with all rows and columns, but values other than
    ``coord_ra``, ``coord_dec`` unpopulated).
    to which footprints should be attached.
exposure : `lsst.afw.image.Exposure`
    Image object from which peak values and the PSF are obtained.
scaling : `int`, optional
    Scaling factor to apply to the PSF second-moments ellipse in order
    to determine the footprint boundary.

Definition at line 154 of file simple_forced_measurement.py.

addInvalidPsfFlag()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.addInvalidPsfFlag ( self, schema )

inherited

Definition at line 326 of file baseMeasurement.py.

callMeasure()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.callMeasure ( self, measRecord, * args, ** kwds )

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 337 of file baseMeasurement.py.

doMeasurement()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.doMeasurement ( self, plugin, measRecord, * args, ** kwds )

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 381 of file baseMeasurement.py.

initializePlugins()

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.initializePlugins ( self, ** kwds )

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.

Reimplemented in lsst.meas.base.baseMeasurement.BaseMeasurementTask.

Definition at line 282 of file baseMeasurement.py.

run()

None lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask.run	(		self,
		lsst.afw.table.SourceCatalog	refCat,
		lsst.afw.table.SourceCatalog	measCat,
		lsst.afw.image.Exposure	exposure,
		lsst.afw.geom.SkyWcs	refWcs,
		int | None	beginOrder = None,
		int | None	endOrder = None )

Perform forced measurement.

Parameters
----------
refCat : `lsst.afw.table.SourceCatalog`
    Catalog with locations and ids of sources to measure.
measCat : `lsst.afw.table.SourceCatalog`
    Catalog that measurements are made on.
exposure : `lsst.afw.image.exposureF`
    Image to be measured. Must have at least a `lsst.afw.geom.SkyWcs`
    attached.
refWcs : `lsst.afw.geom.SkyWcs`
    Defines the X,Y coordinate system of ``refCat``.
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.
idFactory : `lsst.afw.table.IdFactory`, optional
    Factory for creating IDs for sources.

Definition at line 106 of file simple_forced_measurement.py.

Member Data Documentation

_DefaultName

str lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask._DefaultName = "measurement"

staticprotectedinherited

Definition at line 259 of file baseMeasurement.py.

algMetadata

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.algMetadata = None

staticinherited

Definition at line 268 of file baseMeasurement.py.

ConfigClass

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.ConfigClass = SimpleBaseMeasurementConfig

staticinherited

Definition at line 258 of file baseMeasurement.py.

keyInvalidPsf

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.keyInvalidPsf = schema.find(invalidPsfName).key

inherited

Definition at line 329 of file baseMeasurement.py.

mapper

lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask.mapper = lsst.afw.table.SchemaMapper(refSchema)

Definition at line 94 of file simple_forced_measurement.py.

plugins

lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.plugins = None

staticinherited

Definition at line 261 of file baseMeasurement.py.

schema

lsst.meas.base.simple_forced_measurement.SimpleForcedMeasurementTask.schema = self.mapper.getOutputSchema()

Definition at line 103 of file simple_forced_measurement.py.

---

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

• python/lsst/meas/base/simple_forced_measurement.py