lsst.meas.base g876c692160+1d7ac31cb0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin Class Reference
Inheritance diagram for lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin:
lsst.meas.base.sfm.SingleFramePlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

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

Public Attributes

 key
 
 flag
 

Static Public Attributes

 ConfigClass = SingleFrameMomentsClassifierConfig
 

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 : `MomentsClassifierConfig`
    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 655 of file plugins.py.

Constructor & Destructor Documentation

◆ __init__()

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

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

Definition at line 687 of file plugins.py.

Member Function Documentation

◆ fail()

None lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.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 716 of file plugins.py.

◆ getExecutionOrder()

lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.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 684 of file plugins.py.

◆ measure()

None lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.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 695 of file plugins.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.ConfigClass = SingleFrameMomentsClassifierConfig
static

Definition at line 681 of file plugins.py.

◆ flag

lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.flag

Definition at line 693 of file plugins.py.

◆ key

lsst.meas.base.plugins.SingleFrameMomentsClassifierPlugin.key

Definition at line 689 of file plugins.py.


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