lsst.meas.base  14.0-10-g2b7913f+1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.base.wrappers.WrappedSingleFramePlugin Class Reference
Inheritance diagram for lsst.meas.base.wrappers.WrappedSingleFramePlugin:
lsst.meas.base.sfm.SingleFramePlugin lsst.meas.base.baseMeasurement.BaseMeasurementPlugin lsst.meas.base.pluginsBase.BasePlugin

Public Member Functions

def __init__ (self, config, name, schema, metadata, logName=None)
 
def measure (self, measRecord, exposure)
 
def measureN (self, measCat, exposure)
 
def fail (self, measRecord, error=None)
 
def getExecutionOrder (cls)
 
def getLogName (self)
 

Static Public Member Functions

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

Public Attributes

 cpp
 
 config
 
 name
 
 logName
 

Static Public Attributes

 registry = PluginRegistry(SingleFramePluginConfig)
 
 ConfigClass = 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
 

Detailed Description

Definition at line 14 of file wrappers.py.

Constructor & Destructor Documentation

◆ __init__()

def lsst.meas.base.wrappers.WrappedSingleFramePlugin.__init__ (   self,
  config,
  name,
  schema,
  metadata,
  logName = None 
)

Definition at line 16 of file wrappers.py.

Member Function Documentation

◆ fail()

def lsst.meas.base.wrappers.WrappedSingleFramePlugin.fail (   self,
  measRecord,
  error = None 
)

Definition at line 29 of file wrappers.py.

◆ getExecutionOrder()

def lsst.meas.base.pluginsBase.BasePlugin.getExecutionOrder (   cls)
inherited
Sets the relative order of plugins (smaller numbers run first).

In general, the following class constants should be used (other values
are also allowed, but should be avoided unless they are needed):
CENTROID_ORDER      centroids and other algorithms that require only a Footprint
            and its Peaks as input
SHAPE_ORDER         shape measurements and other algorithms that require getCentroid() to return
            a good centroid (in addition to a Footprint and its Peaks).
FLUX_ORDER          flux algorithms that require both getShape() and getCentroid(),
            in addition to a Footprint and its Peaks
DEFAULT_CATALOGCALCULATION plugins that only operate on the catalog

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

This approach was chosen instead of a full graph-based analysis of dependencies
because algorithm dependencies are usually both quite simple and entirely substitutable:
an algorithm that requires a centroid can typically make use of any centroid algorithms
outputs.  That makes it relatively easy to figure out the correct value to use for any
particular algorithm.

Definition at line 57 of file pluginsBase.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.

◆ measure()

def lsst.meas.base.wrappers.WrappedSingleFramePlugin.measure (   self,
  measRecord,
  exposure 
)

Definition at line 23 of file wrappers.py.

◆ measureN()

def lsst.meas.base.wrappers.WrappedSingleFramePlugin.measureN (   self,
  measCat,
  exposure 
)

Definition at line 26 of file wrappers.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.sfm.SingleFramePlugin.ConfigClass = SingleFramePluginConfig
staticinherited

Definition at line 62 of file sfm.py.

◆ cpp

lsst.meas.base.wrappers.WrappedSingleFramePlugin.cpp

Definition at line 19 of file wrappers.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.

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

◆ registry

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

Definition at line 61 of file sfm.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: