lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin Class Reference

Inheritance diagram for lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin:

Public Member Functions
	getExecutionOrder (cls)
	__init__ (self, config, name, schema, metadata)
None	measure (self, measRecord, exposure)
None	fail (self, measRecord, error=None)
	getLogName (self)

Static Public Member Functions
	getTransformClass ()

Public Attributes
	key
	flag = schema.addField(name + "_flag", type="Flag", doc="Moments-based classification failed")
	config = config
	name = name
	logName = logName

Static Public Attributes
int	FAILURE_BAD_SHAPE = 1
	registry = PluginRegistry(SingleFramePluginConfig)
float	CENTROID_ORDER = 0.0
float	SHAPE_ORDER = 1.0
float	FLUX_ORDER = 2.0
float	APCORR_ORDER = 3.0
float	DEFAULT_CATALOGCALCULATION = 4.0
	ConfigClass = BasePluginConfig

Detailed Description

Classify objects by comparing their moments-based trace radius to PSF's.

The plugin computes chi^2 as ((T_obj - T_psf)/T_psf^exponent)^2, where
T_obj is the sum of Ixx and Iyy moments of the object, and T_psf is the
sum of Ixx and Iyy moments of the PSF. The exponent is configurable.
The measure of being a galaxy is then 1 - exp(-0.5*chi^2).

Parameters
----------
config : `SingleFrameClassificationSizeExtendednessConfig`
    Plugin configuration.
name : `str`
    Plugin name.
schema : `~lsst.afw.table.Schema`
    The schema for the measurement output catalog. New fields will be
    added to hold measurements produced by this plugin.
metadata : `~lsst.daf.base.PropertySet`
    Plugin metadata that will be attached to the output catalog.

Notes
-----
The ``measure`` method of the plugin requires a value for the ``exposure``
argument to maintain consistent API, but it is not used in the measurement.

Definition at line 681 of file plugins.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata )

Definition at line 717 of file plugins.py.

Member Function Documentation

fail()

None lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.fail	(		self,
			measRecord,
			error = None )

Record a failure of the `measure` or `measureN` method.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Table record describing the source being measured.
error : `MeasurementError`, optional
    Only provided if the measurement failed due to a
    `MeasurementError` being raised; otherwise, will be `None`.

Notes
-----
When the plugin raises an exception, framework will call
`BasePlugin.fail` to allow the plugin to set its failure flag
field(s).  When `BasePlugin.measureN` raises an exception,
`BasePlugin.fail` will be called repeatedly with all the records that
were being measured.

If the exception is an `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.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 749 of file plugins.py.

getExecutionOrder()

lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.getExecutionOrder

(

cls

)

Get the relative execution order of this plugin.

Must be reimplemented as a class method by concrete derived classes.

Reimplemented from lsst.meas.base.pluginsBase.BasePlugin.

Definition at line 714 of file plugins.py.

getLogName()

lsst.meas.base.pluginsBase.BasePlugin.getLogName ( self )

inherited

Definition at line 134 of file pluginsBase.py.

getTransformClass()

lsst.meas.base.pluginsBase.BasePlugin.getTransformClass ( )

staticinherited

Get the measurement transformation appropriate to this plugin.

This returns a subclass of `transforms.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.

Notes
-----
By default, we copy everything from the input to the output without
transformation.

Reimplemented in lsst.meas.base.plugins.ForcedPeakCentroidPlugin, and lsst.meas.base.plugins.SingleFramePeakCentroidPlugin.

Definition at line 169 of file pluginsBase.py.

measure()

None lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.measure	(		self,
			measRecord,
			exposure )

Measure the properties of a source on a single image.

The image may be from a single epoch, or it may be a coadd.

Parameters
----------
measRecord : `lsst.afw.table.SourceRecord`
    Record describing the object being measured. Previously-measured
    quantities may be retrieved from here, and it will be updated
    in-place tih the outputs of this plugin.
exposure : `lsst.afw.image.ExposureF`
    The pixel data to be measured, together with the associated PSF,
    WCS, etc. All other sources in the image should have been replaced
    by noise according to deblender outputs.

Reimplemented from lsst.meas.base.sfm.SingleFramePlugin.

Definition at line 725 of file plugins.py.

Member Data Documentation

APCORR_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.APCORR_ORDER = 3.0

staticinherited

Definition at line 98 of file pluginsBase.py.

CENTROID_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.CENTROID_ORDER = 0.0

staticinherited

Definition at line 72 of file pluginsBase.py.

config

lsst.meas.base.pluginsBase.BasePlugin.config = config

inherited

Definition at line 130 of file pluginsBase.py.

ConfigClass

lsst.meas.base.pluginsBase.BasePlugin.ConfigClass = BasePluginConfig

staticinherited

Definition at line 116 of file pluginsBase.py.

DEFAULT_CATALOGCALCULATION

float lsst.meas.base.pluginsBase.BasePlugin.DEFAULT_CATALOGCALCULATION = 4.0

staticinherited

Definition at line 108 of file pluginsBase.py.

FAILURE_BAD_SHAPE

lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.FAILURE_BAD_SHAPE = 1

static

Definition at line 709 of file plugins.py.

flag

lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.flag = schema.addField(name + "_flag", type="Flag", doc="Moments-based classification failed")

Definition at line 723 of file plugins.py.

FLUX_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.FLUX_ORDER = 2.0

staticinherited

Definition at line 89 of file pluginsBase.py.

key

lsst.meas.base.plugins.SingleFrameClassificationSizeExtendednessPlugin.key

Initial value:

=  schema.addField(name + "_value",
                                   type="D",
                                   doc="Measure of being a galaxy based on trace of second order moments",
                                   )

Definition at line 719 of file plugins.py.

logName

lsst.meas.base.pluginsBase.BasePlugin.logName = logName

inherited

Definition at line 132 of file pluginsBase.py.

name

lsst.meas.base.pluginsBase.BasePlugin.name = name

inherited

Definition at line 131 of file pluginsBase.py.

registry

lsst.meas.base.sfm.SingleFramePlugin.registry = PluginRegistry(SingleFramePluginConfig)

staticinherited

Definition at line 76 of file sfm.py.

SHAPE_ORDER

float lsst.meas.base.pluginsBase.BasePlugin.SHAPE_ORDER = 1.0

staticinherited

Definition at line 80 of file pluginsBase.py.

---

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

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