lsst.meas.base.classification.CatalogCalculationClassificationPlugin Class Reference

Inheritance diagram for lsst.meas.base.classification.CatalogCalculationClassificationPlugin:

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

Static Public Member Functions
	getTransformClass ()

Public Attributes
	keyProbability
	keyFlag = schema.addField(name + "_flag", type="Flag", doc="Set to 1 for any fatal failure.")
	config = config
	name = name
	logName = logName

Static Public Attributes
	registry = PluginRegistry(CatalogCalculationPluginConfig)
str	plugType = 'single'
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

Plugin which calculates a binary measure of source extendedness.

Extendedness is based on a simple cut of the ratio of the PSF flux to the
model flux.

Notes
-----
Because the fluxes on which this algorithm is based on are slot
measurements, they can be provided by different algorithms, and the
`~CatalogCalculationClassificationConfig.fluxRatio` threshold used by this
algorithm should generally be set differently for different algorithms.
To do this, plot the difference between the PSF magnitude and the model
magnitude vs. the PSF magnitude, and look for where the cloud of galaxies
begins.

Definition at line 49 of file classification.py.

Constructor & Destructor Documentation

__init__()

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.__init__	(		self,
			config,
			name,
			schema,
			metadata )

Definition at line 72 of file classification.py.

Member Function Documentation

calculate()

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.calculate	(		self,
			cat )

Perform the calculation specified by this plugin.

This method can either be used to operate on a single catalog record
or a whole catalog, populating it with the output defined by this
plugin.

Note that results may be added to catalog records as new columns, or
may result in changes to existing values.

Parameters
----------
cat : `lsst.afw.table.SourceCatalog` or `lsst.afw.table.SourceRecord`
    May either be a `~lsst.afw.table.SourceCatalog` or a single
    `~lsst.afw.table.SourceRecord`, depending on the plugin type. Will
    be updated in place to contain the results of plugin execution.
**kwargs
    Any additional keyword arguments that may be passed to the plugin.

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 78 of file classification.py.

fail()

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.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 103 of file classification.py.

getExecutionOrder()

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.getExecutionOrder

(

cls

)

Used to set the relative order of plugin execution.

    The values returned by `getExecutionOrder` are compared across all
    plugins, and smaller numbers run first.

    Notes
    -----
    `CatalogCalculationPlugin`\s must run with
    `BasePlugin.DEFAULT_CATALOGCALCULATION` or higher.

    All plugins must implement this method with an appropriate run level

Reimplemented from lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.

Definition at line 69 of file classification.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.

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.

FLUX_ORDER

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

staticinherited

Definition at line 89 of file pluginsBase.py.

keyFlag

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyFlag = schema.addField(name + "_flag", type="Flag", doc="Set to 1 for any fatal failure.")

Definition at line 76 of file classification.py.

keyProbability

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyProbability

Initial value:

=  schema.addField(name + "_value", type="D",
                                              doc="Set to 1 for extended sources, 0 for point sources.")

Definition at line 74 of file classification.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.

plugType

str lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single'

staticinherited

Definition at line 69 of file catalogCalculation.py.

registry

lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.registry = PluginRegistry(CatalogCalculationPluginConfig)

staticinherited

Definition at line 65 of file catalogCalculation.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/classification.py