FilterDefinition¶
- class lsst.obs.base.FilterDefinition(physical_filter: str, band: str | None = None, doc: str | None = None, afw_name: str | None = None, alias: Set[str] = frozenset({}))¶
Bases:
object
The definition of an instrument’s filter bandpass.
This class is used to declare
physical_filter
andband
information for an instrument.This class is likely temporary, until we have a better versioned filter definition system that includes complete transmission information.
Attributes Summary
If not None, the name of the
Filter
object.Alternate names for this filter.
The generic name of a filter not associated with a particular instrument (e.g.
A short description of this filter, possibly with a link to more information.
Methods Summary
Create a complete FilterLabel for this filter.
Attributes Documentation
- afw_name: str | None = None¶
If not None, the name of the
Filter
object.This is distinct from physical_filter and band to maintain backwards compatibility in some obs packages. For example, for HSC there are two distinct
r
andi
filters, namedr/r2
andi/i2
.
- alias: Set[str] = frozenset({})¶
Alternate names for this filter. These are added to the
Filter
alias list.
- band: str | None = None¶
The generic name of a filter not associated with a particular instrument (e.g.
r
for the SDSS Gunn r-band, which could be on SDSS, LSST, or HSC).Not all filters have an abstract filter: engineering or test filters may not have a generically-termed filter name.
If specified and if
afw_name
is None, this is used as theFilter
name
field, otherwise it is added to the list ofFilter
aliases.
- doc: str | None = None¶
A short description of this filter, possibly with a link to more information.
Methods Documentation
- makeFilterLabel() FilterLabel ¶
Create a complete FilterLabel for this filter.