lsst.obs.base.filters.FilterDefinition Class Reference

Public Member Functions
def	__post_init__ (self)
def	__str__ (self)
def	defineFilter (self)
def	makeFilterLabel (self)

Static Public Attributes
	str
	float
	set

Detailed Description

The definition of an instrument's filter bandpass.

This class is used to interface between the `~lsst.afw.image.Filter` class
and the Gen2 `~lsst.daf.persistence.CameraMapper` and Gen3
`~lsst.obs.base.Instruments` and ``physical_filter``/``band``
`~lsst.daf.butler.Dimension`.

This class is likely temporary, until we have a better versioned filter
definition system that includes complete transmission information.

Definition at line 137 of file filters.py.

Member Function Documentation

__post_init__()

def lsst.obs.base.filters.FilterDefinition.__post_init__

(

self

)

Definition at line 200 of file filters.py.

    def __post_init__(self):
        # force alias to be immutable, so that hashing works
        if not isinstance(self.alias, frozenset):
            object.__setattr__(self, 'alias', frozenset(self.alias))
 

__str__()

def lsst.obs.base.filters.FilterDefinition.__str__

(

self

)

Definition at line 205 of file filters.py.

    def __str__(self):
        txt = f"FilterDefinition(physical_filter='{self.physical_filter}', lambdaEff='{self.lambdaEff}'"
        if self.band is not None:
            txt += f", band='{self.band}'"
        if self.afw_name is not None:
            txt += f", afw_name='{self.afw_name}'"
        if not np.isnan(self.lambdaMin):
            txt += f", lambdaMin='{self.lambdaMin}'"
        if not np.isnan(self.lambdaMax):
            txt += f", lambdaMax='{self.lambdaMax}'"
        if len(self.alias) != 0:
            txt += f", alias='{self.alias}'"
        return txt + ")"
 

defineFilter()

def lsst.obs.base.filters.FilterDefinition.defineFilter

(

self

)

Declare the filters via afw.image.Filter.

Definition at line 219 of file filters.py.

    def defineFilter(self):
        """Declare the filters via afw.image.Filter.
        """
        aliases = set(self.alias)
        name = self.physical_filter
        if self.band is not None:
            name = self.band
            aliases.add(self.physical_filter)
        if self.afw_name is not None:
            name = self.afw_name
            aliases.add(self.physical_filter)
        # Only add `physical_filter/band` as an alias if afw_name is defined.ee
        if self.afw_name is not None:
            if self.band is not None:
                aliases.add(self.band)
        with warnings.catch_warnings():
            # surpress Filter warnings; we already know this is deprecated
            warnings.simplefilter('ignore', category=FutureWarning)
            lsst.afw.image.utils.defineFilter(name,
                                              lambdaEff=self.lambdaEff,
                                              lambdaMin=self.lambdaMin,
                                              lambdaMax=self.lambdaMax,
                                              alias=sorted(aliases))
 

makeFilterLabel()

def lsst.obs.base.filters.FilterDefinition.makeFilterLabel

(

self

)

Create a complete FilterLabel for this filter.

Definition at line 243 of file filters.py.

    def makeFilterLabel(self):
        """Create a complete FilterLabel for this filter.
        """
        return lsst.afw.image.FilterLabel(band=self.band, physical=self.physical_filter)

Member Data Documentation

float

lsst.obs.base.filters.FilterDefinition.float

static

Definition at line 190 of file filters.py.

set

lsst.obs.base.filters.FilterDefinition.set

static

Definition at line 195 of file filters.py.

str

lsst.obs.base.filters.FilterDefinition.str

static

Definition at line 164 of file filters.py.

---

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

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/obs_base/21.0.0-27-gbbd0d29+ae871e0f33/python/lsst/obs/base/filters.py