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

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

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

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

def	measure (self, measCat, exposure)

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
	schema

	doBlendedness

	blendPlugin

	undeblendedPlugins

Static Public Attributes
	ConfigClass = SingleFrameMeasurementConfig

string	NOISE_SEED_MULTIPLIER = "NOISE_SEED_MULTIPLIER"

string	NOISE_SOURCE = "NOISE_SOURCE"

string	NOISE_OFFSET = "NOISE_OFFSET"

string	NOISE_EXPOSURE_ID = "NOISE_EXPOSURE_ID"

	plugins = None

	algMetadata = None

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 159 of file sfm.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 193 of file sfm.py.

Member Function Documentation

◆ callMeasure()

def lsst.meas.base.baseMeasurement.BaseMeasurementTask.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 289 of file baseMeasurement.py.

◆ callMeasureN()

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

◆ doMeasurement()

def lsst.meas.base.baseMeasurement.BaseMeasurementTask.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 333 of file baseMeasurement.py.

◆ doMeasurementN()

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

◆ getPluginLogName()

def lsst.meas.base.baseMeasurement.BaseMeasurementTask.getPluginLogName	(	self,
		pluginName
	)

inherited

Definition at line 239 of file baseMeasurement.py.

◆ initializePlugins()

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

Definition at line 242 of file baseMeasurement.py.

◆ measure()

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

Backwards-compatibility alias for `run`.

Definition at line 337 of file sfm.py.

◆ run()

def lsst.meas.base.sfm.SingleFrameMeasurementTask.run	(	self,
		measCat,
		exposure,
		noiseImage = `None`,
		exposureId = `None`,
		beginOrder = `None`,
		endOrder = `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.

Definition at line 207 of file sfm.py.

◆ runPlugins()

def 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 260 of file sfm.py.

Member Data Documentation

◆ algMetadata

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

staticinherited

Definition at line 224 of file baseMeasurement.py.

◆ blendPlugin

lsst.meas.base.sfm.SingleFrameMeasurementTask.blendPlugin

Definition at line 202 of file sfm.py.

◆ ConfigClass

lsst.meas.base.sfm.SingleFrameMeasurementTask.ConfigClass = SingleFrameMeasurementConfig

static

Definition at line 175 of file sfm.py.

◆ doBlendedness

lsst.meas.base.sfm.SingleFrameMeasurementTask.doBlendedness

Definition at line 201 of file sfm.py.

◆ NOISE_EXPOSURE_ID

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

static

Definition at line 189 of file sfm.py.

◆ NOISE_OFFSET

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

static

Definition at line 185 of file sfm.py.

◆ NOISE_SEED_MULTIPLIER

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

static

Definition at line 177 of file sfm.py.

◆ NOISE_SOURCE

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

static

Definition at line 181 of file sfm.py.

◆ plugins

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

staticinherited

Definition at line 217 of file baseMeasurement.py.

◆ schema

lsst.meas.base.sfm.SingleFrameMeasurementTask.schema

Definition at line 195 of file sfm.py.

◆ undeblendedPlugins

lsst.meas.base.baseMeasurement.BaseMeasurementTask.undeblendedPlugins

inherited

Definition at line 234 of file baseMeasurement.py.

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

python/lsst/meas/base/sfm.py

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ callMeasure()

◆ callMeasureN()

◆ doMeasurement()

◆ doMeasurementN()

◆ getPluginLogName()

◆ initializePlugins()

◆ measure()

◆ run()

◆ runPlugins()

Member Data Documentation

◆ algMetadata

◆ blendPlugin

◆ ConfigClass

◆ doBlendedness

◆ NOISE_EXPOSURE_ID

◆ NOISE_OFFSET

◆ NOISE_SEED_MULTIPLIER

◆ NOISE_SOURCE

◆ plugins

◆ schema

◆ undeblendedPlugins

◆ init()