LSST Applications g0265f82a02+c6dfa2ddaf,g1162b98a3f+b2075782a9,g2079a07aa2+1b2e822518,g2bbee38e9b+c6dfa2ddaf,g337abbeb29+c6dfa2ddaf,g3ddfee87b4+a60788ef87,g50ff169b8f+2eb0e556e8,g52b1c1532d+90ebb246c7,g555ede804d+a60788ef87,g591dd9f2cf+ba8caea58f,g5ec818987f+864ee9cddb,g858d7b2824+9ee1ab4172,g876c692160+a40945ebb7,g8a8a8dda67+90ebb246c7,g8cdfe0ae6a+4fd9e222a8,g99cad8db69+5e309b7bc6,g9ddcbc5298+a1346535a5,ga1e77700b3+df8f93165b,ga8c6da7877+aa12a14d27,gae46bcf261+c6dfa2ddaf,gb0e22166c9+8634eb87fb,gb3f2274832+d0da15e3be,gba4ed39666+1ac82b564f,gbb8dafda3b+5dfd9c994b,gbeb006f7da+97157f9740,gc28159a63d+c6dfa2ddaf,gc86a011abf+9ee1ab4172,gcf0d15dbbd+a60788ef87,gdaeeff99f8+1cafcb7cd4,gdc0c513512+9ee1ab4172,ge79ae78c31+c6dfa2ddaf,geb67518f79+ba1859f325,geb961e4c1e+f9439d1e6f,gee10cc3b42+90ebb246c7,gf1cff7945b+9ee1ab4172,w.2024.12
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
lsst.meas.base.baseMeasurement.SourceSlotConfig Class Reference
Inheritance diagram for lsst.meas.base.baseMeasurement.SourceSlotConfig:
lsst.pex.config.config.Config lsst.pex.config.config.ConfigMeta

Public Member Functions

 setupSchema (self, schema)
 

Static Public Attributes

 Field = lsst.pex.config.Field
 
 centroid
 
 shape
 
 psfShape
 
 apFlux
 
 modelFlux
 
 psfFlux
 
 gaussianFlux
 
 calibFlux
 

Detailed Description

Assign named plugins to measurement slots.

Slot configuration which assigns a particular named plugin to each of a set
of slots.  Each slot allows a type of measurement to be fetched from the
`lsst.afw.table.SourceTable` without knowing which algorithm was used to
produced the data.

Notes
-----
The default algorithm for each slot must be registered, even if the default
is not used.

Definition at line 75 of file baseMeasurement.py.

Member Function Documentation

◆ setupSchema()

lsst.meas.base.baseMeasurement.SourceSlotConfig.setupSchema ( self,
schema )
Set up a slots in a schema following configuration directives.

Parameters
----------
schema : `lsst.afw.table.Schema`
    The schema in which slots will be set up.

Notes
-----
This is defined in this configuration class to support use in unit
tests without needing to construct an `lsst.pipe.base.Task` object.

Definition at line 107 of file baseMeasurement.py.

107 def setupSchema(self, schema):
108 """Set up a slots in a schema following configuration directives.
109
110 Parameters
111 ----------
112 schema : `lsst.afw.table.Schema`
113 The schema in which slots will be set up.
114
115 Notes
116 -----
117 This is defined in this configuration class to support use in unit
118 tests without needing to construct an `lsst.pipe.base.Task` object.
119 """
120 aliases = schema.getAliasMap()
121 if self.centroid is not None:
122 aliases.set("slot_Centroid", self.centroid)
123 if self.shape is not None:
124 aliases.set("slot_Shape", self.shape)
125 if self.psfShape is not None:
126 aliases.set("slot_PsfShape", self.psfShape)
127 if self.apFlux is not None:
128 aliases.set("slot_ApFlux", self.apFlux)
129 if self.modelFlux is not None:
130 aliases.set("slot_ModelFlux", self.modelFlux)
131 if self.psfFlux is not None:
132 aliases.set("slot_PsfFlux", self.psfFlux)
133 if self.gaussianFlux is not None:
134 aliases.set("slot_GaussianFlux", self.gaussianFlux)
135 if self.calibFlux is not None:
136 aliases.set("slot_CalibFlux", self.calibFlux)
137
138

Member Data Documentation

◆ apFlux

lsst.meas.base.baseMeasurement.SourceSlotConfig.apFlux
static
Initial value:
= Field(dtype=str, default="base_CircularApertureFlux_12_0", optional=True,
doc="the name of the algorithm used to set the source aperture instFlux slot")

Definition at line 96 of file baseMeasurement.py.

◆ calibFlux

lsst.meas.base.baseMeasurement.SourceSlotConfig.calibFlux
static
Initial value:
= Field(dtype=str, default="base_CircularApertureFlux_12_0", optional=True,
doc="the name of the instFlux measurement algorithm used for calibration")

Definition at line 104 of file baseMeasurement.py.

◆ centroid

lsst.meas.base.baseMeasurement.SourceSlotConfig.centroid
static
Initial value:
= Field(dtype=str, default="base_SdssCentroid", optional=True,
doc="the name of the centroiding algorithm used to set source x,y")

Definition at line 90 of file baseMeasurement.py.

◆ Field

lsst.meas.base.baseMeasurement.SourceSlotConfig.Field = lsst.pex.config.Field
static

Definition at line 89 of file baseMeasurement.py.

◆ gaussianFlux

lsst.meas.base.baseMeasurement.SourceSlotConfig.gaussianFlux
static
Initial value:
= Field(dtype=str, default="base_GaussianFlux", optional=True,
doc="the name of the algorithm used to set the source Gaussian instFlux slot")

Definition at line 102 of file baseMeasurement.py.

◆ modelFlux

lsst.meas.base.baseMeasurement.SourceSlotConfig.modelFlux
static
Initial value:
= Field(dtype=str, default="base_GaussianFlux", optional=True,
doc="the name of the algorithm used to set the source model instFlux slot")

Definition at line 98 of file baseMeasurement.py.

◆ psfFlux

lsst.meas.base.baseMeasurement.SourceSlotConfig.psfFlux
static
Initial value:
= Field(dtype=str, default="base_PsfFlux", optional=True,
doc="the name of the algorithm used to set the source psf instFlux slot")

Definition at line 100 of file baseMeasurement.py.

◆ psfShape

lsst.meas.base.baseMeasurement.SourceSlotConfig.psfShape
static
Initial value:
= Field(dtype=str, default="base_SdssShape_psf", optional=True,
doc="the name of the algorithm used to set PSF moments parameters")

Definition at line 94 of file baseMeasurement.py.

◆ shape

lsst.meas.base.baseMeasurement.SourceSlotConfig.shape
static
Initial value:
= Field(dtype=str, default="base_SdssShape", optional=True,
doc="the name of the algorithm used to set source moments parameters")

Definition at line 92 of file baseMeasurement.py.


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