lsst.meas.base gd5020cc1fb+2c4b13e112
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.classification.CatalogCalculationClassificationPlugin Class Reference
Inheritance diagram for lsst.meas.base.classification.CatalogCalculationClassificationPlugin:
lsst.meas.base.catalogCalculation.CatalogCalculationPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

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

Public Attributes

 keyProbability
 
 keyFlag
 

Static Public Attributes

 ConfigClass = CatalogCalculationClassificationConfig
 

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__()

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

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

Definition at line 72 of file classification.py.

Member Function Documentation

◆ calculate()

def 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()

def 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()

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

Member Data Documentation

◆ ConfigClass

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.ConfigClass = CatalogCalculationClassificationConfig
static

Definition at line 66 of file classification.py.

◆ keyFlag

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyFlag

Definition at line 76 of file classification.py.

◆ keyProbability

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyProbability

Definition at line 74 of file classification.py.


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