lsst.meas.base.baseMeasurement.SourceSlotConfig Class Reference

Inheritance diagram for lsst.meas.base.baseMeasurement.SourceSlotConfig:

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.

    def 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.
        """
        aliases = schema.getAliasMap()
        if self.centroid is not None:
            aliases.set("slot_Centroid", self.centroid)
        if self.shape is not None:
            aliases.set("slot_Shape", self.shape)
        if self.psfShape is not None:
            aliases.set("slot_PsfShape", self.psfShape)
        if self.apFlux is not None:
            aliases.set("slot_ApFlux", self.apFlux)
        if self.modelFlux is not None:
            aliases.set("slot_ModelFlux", self.modelFlux)
        if self.psfFlux is not None:
            aliases.set("slot_PsfFlux", self.psfFlux)
        if self.gaussianFlux is not None:
            aliases.set("slot_GaussianFlux", self.gaussianFlux)
        if self.calibFlux is not None:
            aliases.set("slot_CalibFlux", self.calibFlux)
 
 

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/meas_base/g212a7c68fe+04a9158687/python/lsst/meas/base/baseMeasurement.py