lsst.fgcmcal.sedterms.Sedterm Class Reference

Inheritance diagram for lsst.fgcmcal.sedterms.Sedterm:

Public Member Functions
	validate (self)

Static Public Attributes
	primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")
	secondaryTerm
	extrapolated = Field(dtype=bool, default=False, doc="Extrapolate to compute SED slope")
	constant = Field(dtype=float, default=1.0, doc="Adjustment constant for SED slope")
	primaryBand
	secondaryBand
	tertiaryBand

Detailed Description

SED term for a single band.

The SED slope (in flux units) in the middle of a band is computed either
as an "interpolated" or "extrapolated" computation.  See Burke et al. 2018
Appendix A (https://ui.adsabs.harvard.edu/abs/2018AJ....155...41B).

For interpolation, with a secondary term::

   F'_nu ~ constant * (primaryTerm + secondaryTerm) / 2.0

For interpolation, without a secondary term::

   F'_nu ~ constant * primaryTerm

For extrapolation::

   F'_nu ~ primaryTerm + constant * (((lambda_primaryBand - lambda_secondaryBand) /
                                     (lambda_primaryBand - lambda_tertiaryBand)) *
                                     (primaryTerm - secondaryTerm))

where primaryTerm and secondaryTerm are names from a `SedboundarytermDict`, and
primaryBand, secondaryBand, and tertiaryBand are band names.

To construct a Sedterm, use keyword arguments::

    Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
            extrapolated=False, constant=1.0)

or::

    Sedterm(primaryTerm=primaryTermName, secondaryTerm=secondaryTermName,
            extrapolated=True, constant=1.0, primaryBand=primaryBandName,
            secondaryBand=secondaryBandName, tertiaryBand=tertiaryBandName)

This is a subclass of Config.  This follows the form of
`lsst.pipe.tasks.Colorterm`.

Definition at line 71 of file sedterms.py.

Member Function Documentation

validate()

lsst.fgcmcal.sedterms.Sedterm.validate

(

self

)

Validate the Config, raising an exception if invalid.

Raises
------
lsst.pex.config.FieldValidationError
    Raised if verification fails.

Notes
-----
The base class implementation performs type checks on all fields by
calling their `~lsst.pex.config.Field.validate` methods.

Complex single-field validation can be defined by deriving new Field
types. For convenience, some derived `lsst.pex.config.Field`-types
(`~lsst.pex.config.ConfigField` and
`~lsst.pex.config.ConfigChoiceField`) are defined in
``lsst.pex.config`` that handle recursing into subconfigs.

Inter-field relationships should only be checked in derived
`~lsst.pex.config.Config` classes after calling this method, and base
validation is complete.

Reimplemented from lsst.pex.config.config.Config.

Definition at line 121 of file sedterms.py.

    def validate(self):
        Config.validate(self)
        if self.extrapolated:
            if self.primaryBand is None or \
                    self.secondaryBand is None or \
                    self.tertiaryBand is None:
                raise RuntimeError("extrapolated requires primaryBand, secondaryBand, and "
                                   "tertiaryBand are provided.")
 
 

Member Data Documentation

constant

lsst.fgcmcal.sedterms.Sedterm.constant = Field(dtype=float, default=1.0, doc="Adjustment constant for SED slope")

static

Definition at line 113 of file sedterms.py.

extrapolated

lsst.fgcmcal.sedterms.Sedterm.extrapolated = Field(dtype=bool, default=False, doc="Extrapolate to compute SED slope")

static

Definition at line 112 of file sedterms.py.

primaryBand

lsst.fgcmcal.sedterms.Sedterm.primaryBand

static

Initial value:

=  Field(dtype=str, default=None, optional=True,
                        doc="Primary band name for extrapolation")

Definition at line 114 of file sedterms.py.

primaryTerm

lsst.fgcmcal.sedterms.Sedterm.primaryTerm = Field(dtype=str, doc="Name of primary Sedboundaryterm")

static

Definition at line 109 of file sedterms.py.

secondaryBand

lsst.fgcmcal.sedterms.Sedterm.secondaryBand

static

Initial value:

=  Field(dtype=str, default=None, optional=True,
                          doc="Secondary band name for extrapolation")

Definition at line 116 of file sedterms.py.

secondaryTerm

lsst.fgcmcal.sedterms.Sedterm.secondaryTerm

static

Initial value:

=  Field(dtype=str, default=None, optional=True,
                          doc="Name of secondary Sedboundaryterm")

Definition at line 110 of file sedterms.py.

tertiaryBand

lsst.fgcmcal.sedterms.Sedterm.tertiaryBand

static

Initial value:

=  Field(dtype=str, default=None, optional=True,
                         doc="Tertiary band name for extrapolation")

Definition at line 118 of file sedterms.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/fgcmcal/g487adcacf7+5fae3daba8/python/lsst/fgcmcal/sedterms.py