Inheritance diagram for lsst.meas.base.sfm.SingleFrameMeasurementTask:

Public Member Functions
	__init__ (self, schema, algMetadata=None, **kwds)

	run (self, measCat, exposure, noiseImage=None, exposureId=None, beginOrder=None, endOrder=None, footprints=None)

	runPlugins (self, noiseReplacer, measCat, exposure, beginOrder=None, endOrder=None)

	measure (self, measCat, exposure)

	initializePlugins (self, **kwds)

	callMeasureN (self, measCat, args, *kwds)

	doMeasurementN (self, plugin, measCat, args, *kwds)

	addInvalidPsfFlag (self, schema)

	callMeasure (self, measRecord, args, *kwds)

	doMeasurement (self, plugin, measRecord, args, *kwds)

Static Public Member Functions
	getFootprintsFromCatalog (catalog)

Public Attributes
	schema = schema

bool	doBlendedness = True

	blendPlugin = self.plugins['base_Blendedness']

	undeblendedPlugins = PluginMap()

	keyInvalidPsf = schema.find(invalidPsfName).key

Static Public Attributes
str	NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER"

str	NOISE_SOURCE = "NOISE_SOURCE"

str	NOISE_OFFSET = "NOISE_OFFSET"

str	NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID"

	ConfigClass = SimpleBaseMeasurementConfig

	plugins = None

	algMetadata = None

Static Protected Attributes
str	_DefaultName = "measurement"

Detailed Description

A subtask for measuring the properties of sources on a single exposure.

Parameters
----------
schema : `lsst.afw.table.Schema`
    Schema of the output resultant catalog. Will be updated to provide
    fields to accept the outputs of plugins which will be executed by this
    task.
algMetadata : `lsst.daf.base.PropertyList`, optional
    Used to record metadaa about algorithm execution. An empty
    `lsst.daf.base.PropertyList` will be created if `None`.
**kwds
    Keyword arguments forwarded to `BaseMeasurementTask`.

Definition at line 161 of file sfm.py.

Constructor & Destructor Documentation

◆ init()

lsst.meas.base.sfm.SingleFrameMeasurementTask.__init__	(		self,
			schema,
			algMetadata = None,
		**	kwds )

Definition at line 195 of file sfm.py.

Member Function Documentation

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

◆ callMeasureN()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.callMeasureN	(		self,
			measCat,
		*	args,
		**	kwds )

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

◆ doMeasurementN()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.doMeasurementN	(		self,
			plugin,
			measCat,
		*	args,
		**	kwds )

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

◆ getFootprintsFromCatalog()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.getFootprintsFromCatalog ( catalog )

staticinherited

Get a set of footprints from a catalog, keyed by id.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog`
    Catalog with `lsst.afw.detection.Footprint`s attached.

Returns
-------
footprints : `dict` [`int`: (`int`, `lsst.afw.detection.Footprint`)]
    Dictionary of footprint, keyed by id number, with a tuple of
    the parent id and footprint.

Definition at line 566 of file baseMeasurement.py.

◆ initializePlugins()

lsst.meas.base.baseMeasurement.BaseMeasurementTask.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 from lsst.meas.base.baseMeasurement.SimpleBaseMeasurementTask.

Definition at line 456 of file baseMeasurement.py.

◆ measure()

lsst.meas.base.sfm.SingleFrameMeasurementTask.measure	(	self,
		measCat,
		exposure )

Backwards-compatibility alias for `run`.

Definition at line 362 of file sfm.py.

◆ run()

lsst.meas.base.sfm.SingleFrameMeasurementTask.run	(	self,
		measCat,
		exposure,
		noiseImage = None,
		exposureId = None,
		beginOrder = None,
		endOrder = None,
		footprints = None )

Run single frame measurement over an exposure and source catalog.

    Parameters
    ----------
    measCat : `lsst.afw.table.SourceCatalog`
        Catalog to be filled with the results of measurement. Must contain
        all the `lsst.afw.table.SourceRecord`\ s to be measured (with
        `lsst.afw.detection.Footprint`\ s attached), and have a schema
        that is a superset of ``self.schema``.
    exposure : `lsst.afw.image.ExposureF`
        Image containing the pixel data to be measured together with
        associated PSF, WCS, etc.
    noiseImage : `lsst.afw.image.ImageF`, optional
        Can be used to specify the a predictable noise replacement field
        for testing purposes.
    exposureId : `int`, optional
        Unique exposure identifier used to calculate the random number
        generator seed during noise replacement.
    beginOrder : `float`, optional
        Start execution order (inclusive): measurements with
        ``executionOrder < beginOrder`` are not executed. `None` for no
        limit.
    endOrder : `float`, optional
        Final execution order (exclusive): measurements with
        ``executionOrder >= endOrder`` are not executed. `None` for no
        limit.
    footprints : `dict` {`int`: `lsst.afw.detection.Footprint`}, optional
        List of footprints to use for noise replacement. If this is not
        supplied then the footprints from the measCat are used.

Definition at line 210 of file sfm.py.

◆ runPlugins()

lsst.meas.base.sfm.SingleFrameMeasurementTask.runPlugins	(	self,
		noiseReplacer,
		measCat,
		exposure,
		beginOrder = None,
		endOrder = None )

Call the configured measument plugins on an image.

Parameters
----------
noiseReplacer : `NoiseReplacer`
    Used to fill sources not being measured with noise.
measCat : `lsst.afw.table.SourceCatalog`
    Catalog to be filled with the results of measurement. Must contain
    all the `lsst.afw.table.SourceRecord`\ s to be measured (with
    `lsst.afw.detection.Footprint`\ s attached), and have a schema
    that is a superset of ``self.schema``.
exposure : `lsst.afw.image.ExposureF`
    Image containing the pixel data to be measured together with
    associated PSF, WCS, etc.
beginOrder : `float`, optional
    Start execution order (inclusive): measurements with
    ``executionOrder < beginOrder`` are not executed. `None` for no
    limit.
endOrder : `float`, optional
    Final execution order (exclusive): measurements with
    ``executionOrder >= endOrder`` are not executed. `None` for no
    limit.

Definition at line 275 of file sfm.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.

◆ blendPlugin

lsst.meas.base.sfm.SingleFrameMeasurementTask.blendPlugin = self.plugins['base_Blendedness']

Definition at line 205 of file sfm.py.

◆ ConfigClass

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

staticinherited

Definition at line 258 of file baseMeasurement.py.

◆ doBlendedness

bool lsst.meas.base.sfm.SingleFrameMeasurementTask.doBlendedness = True

Definition at line 204 of file sfm.py.

◆ keyInvalidPsf

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

inherited

Definition at line 329 of file baseMeasurement.py.

◆ NOISE_EXPOSURE_ID

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID"

static

Definition at line 191 of file sfm.py.

◆ NOISE_OFFSET

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_OFFSET = "NOISE_OFFSET"

static

Definition at line 187 of file sfm.py.

◆ NOISE_SEED_MULTIPLIER

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER"

static

Definition at line 179 of file sfm.py.

◆ NOISE_SOURCE

lsst.meas.base.sfm.SingleFrameMeasurementTask.NOISE_SOURCE = "NOISE_SOURCE"

static

Definition at line 183 of file sfm.py.

◆ plugins

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

staticinherited

Definition at line 261 of file baseMeasurement.py.

◆ schema

lsst.meas.base.sfm.SingleFrameMeasurementTask.schema = schema

Definition at line 197 of file sfm.py.

◆ undeblendedPlugins

lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins = PluginMap()

inherited

Definition at line 454 of file baseMeasurement.py.

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

python/lsst/meas/base/sfm.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ addInvalidPsfFlag()

◆ callMeasure()

◆ callMeasureN()

◆ doMeasurement()

◆ doMeasurementN()

◆ getFootprintsFromCatalog()

◆ initializePlugins()

◆ measure()

◆ run()

◆ runPlugins()

Member Data Documentation

◆ _DefaultName

◆ algMetadata

◆ blendPlugin

◆ ConfigClass

◆ doBlendedness

◆ keyInvalidPsf

◆ NOISE_EXPOSURE_ID

◆ NOISE_OFFSET

◆ NOISE_SEED_MULTIPLIER

◆ NOISE_SOURCE

◆ plugins

◆ schema

◆ undeblendedPlugins

◆ init()