lsst.meas.base  14.0-17-g4f4ea82+4
Public Member Functions | Static 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)
 
def calculate (self, cat, kwargs)
 Process either a single catalog enter or the whole catalog and produce output defined by the plugin. More...
 
def getLogName (self)
 

Static Public Member Functions

def getTransformClass ()
 Get the measurement transformation appropriate to this plugin. More...
 

Public Attributes

 keyProbability
 
 keyFlag
 
 config
 
 name
 
 logName
 

Static Public Attributes

 ConfigClass = CatalogCalculationClassificationConfig
 
 registry = PluginRegistry(CatalogCalculationPluginConfig)
 
string 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
 

Detailed Description

A binary measure of the extendedness of a source, based a simple cut on the ratio of the
PSF flux to the model flux.

Because the fluxes on which this algorithm is based on are slot measurements, they can be provided
by different algorithms, and the "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 48 of file classification.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 66 of file classification.py.

Member Function Documentation

◆ calculate() [1/2]

def lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.calculate (   self,
  cat,
  kwargs 
)
inherited

Process either a single catalog enter or the whole catalog and produce output defined by the plugin.

Parameters
[in,out]catEither a lsst source catalog or a catalog entery depending on the plug type specified in the classes configuration. Results may be added to new columns, or existing entries altered.
[in]kwargsAny additional kwargs that may be passed through the CatalogCalculationPlugin.

Definition at line 62 of file catalogCalculation.py.

◆ calculate() [2/2]

def lsst.meas.base.classification.CatalogCalculationClassificationPlugin.calculate (   self,
  measRecord 
)

Definition at line 72 of file classification.py.

◆ fail()

def lsst.meas.base.classification.CatalogCalculationClassificationPlugin.fail (   self,
  measRecord,
  error = None 
)

Definition at line 97 of file classification.py.

◆ getExecutionOrder()

def lsst.meas.base.classification.CatalogCalculationClassificationPlugin.getExecutionOrder (   cls)

Definition at line 63 of file classification.py.

◆ getLogName()

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

Definition at line 92 of file pluginsBase.py.

◆ getTransformClass()

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

Get the measurement transformation appropriate to this plugin.

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

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

Definition at line 117 of file pluginsBase.py.

Member Data Documentation

◆ APCORR_ORDER

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

Definition at line 53 of file pluginsBase.py.

◆ CENTROID_ORDER

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

Definition at line 50 of file pluginsBase.py.

◆ config

lsst.meas.base.pluginsBase.BasePlugin.config
inherited

Definition at line 88 of file pluginsBase.py.

◆ ConfigClass

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

Definition at line 60 of file classification.py.

◆ DEFAULT_CATALOGCALCULATION

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

Definition at line 54 of file pluginsBase.py.

◆ FLUX_ORDER

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

Definition at line 52 of file pluginsBase.py.

◆ keyFlag

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyFlag

Definition at line 70 of file classification.py.

◆ keyProbability

lsst.meas.base.classification.CatalogCalculationClassificationPlugin.keyProbability

Definition at line 68 of file classification.py.

◆ logName

lsst.meas.base.pluginsBase.BasePlugin.logName
inherited

Definition at line 90 of file pluginsBase.py.

◆ name

lsst.meas.base.pluginsBase.BasePlugin.name
inherited

Definition at line 89 of file pluginsBase.py.

◆ plugType

string lsst.meas.base.catalogCalculation.CatalogCalculationPlugin.plugType = 'single'
staticinherited

Definition at line 38 of file catalogCalculation.py.

◆ registry

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

Definition at line 31 of file catalogCalculation.py.

◆ SHAPE_ORDER

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

Definition at line 51 of file pluginsBase.py.


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