lsst.obs.base.filters.FilterDefinitionCollection Class Reference

Inheritance diagram for lsst.obs.base.filters.FilterDefinitionCollection:

Public Member Functions
def	__init__ (self, *filters)
def	__getitem__ (self, key)
def	__len__ (self)
def	__str__ (self)
def	defineFilters (self)
def	reset (cls)
def	findAll (self, name)

Public Attributes
	physical_to_band

Static Public Attributes
dictionary	physical_to_band = {}

Detailed Description

An order-preserving collection of multiple `FilterDefinition`.

Parameters
----------
filters : `~collections.abc.Sequence`
    The filters in this collection.

Definition at line 37 of file filters.py.

Constructor & Destructor Documentation

__init__()

def lsst.obs.base.filters.FilterDefinitionCollection.__init__	(		self,
		*	filters
	)

Definition at line 59 of file filters.py.

    def __init__(self, *filters):
        self._filters = list(filters)
        self.physical_to_band = {filter.physical_filter: filter.band for filter in self._filters}
 

Member Function Documentation

__getitem__()

def lsst.obs.base.filters.FilterDefinitionCollection.__getitem__	(		self,
			key
	)

Definition at line 63 of file filters.py.

    def __getitem__(self, key):
        return self._filters[key]
 

__len__()

def lsst.obs.base.filters.FilterDefinitionCollection.__len__

(

self

)

Definition at line 66 of file filters.py.

    def __len__(self):
        return len(self._filters)
 

__str__()

def lsst.obs.base.filters.FilterDefinitionCollection.__str__

(

self

)

Definition at line 69 of file filters.py.

    def __str__(self):
        return "FilterDefinitions(" + ', '.join(str(f) for f in self._filters) + ')'
 

defineFilters()

def lsst.obs.base.filters.FilterDefinitionCollection.defineFilters

(

self

)

Define all the filters to `lsst.afw.image.Filter`.

`~lsst.afw.image.Filter` objects are singletons, so we protect against
filters being defined multiple times.

Raises
------
RuntimeError
    Raised if any other `FilterDefinitionCollection` has already called
    ``defineFilters``.

Definition at line 72 of file filters.py.

    def defineFilters(self):
        """Define all the filters to `lsst.afw.image.Filter`.
 
        `~lsst.afw.image.Filter` objects are singletons, so we protect against
        filters being defined multiple times.
 
        Raises
        ------
        RuntimeError
            Raised if any other `FilterDefinitionCollection` has already called
            ``defineFilters``.
        """
        if self._defined is None:
            with warnings.catch_warnings():
                # surpress Filter warnings; we already know this is deprecated
                warnings.simplefilter('ignore', category=FutureWarning)
                self.reset()
                for filter in self._filters:
                    filter.defineFilter()
            FilterDefinitionCollection._defined = self
        elif self._defined is self:
            # noop: we've already defined these filters, so do nothing
            pass
        else:
            msg = f"afw Filters were already defined on: {self._defined}"
            raise RuntimeError(msg)
 

findAll()

def lsst.obs.base.filters.FilterDefinitionCollection.findAll	(		self,
			name
	)

Return the FilterDefinitions that match a particular name.

This method makes no attempt to prioritize, e.g., band names over
physical filter names; any definition that makes *any* reference
to the name is returned.

Parameters
----------
name : `str`
    The name to search for. May be any band, physical, or alias name.

Returns
-------
matches : `set` [`FilterDefinition`]
    All FilterDefinitions containing ``name`` as one of their
    filter names.

Definition at line 110 of file filters.py.

    def findAll(self, name):
        """Return the FilterDefinitions that match a particular name.
 
        This method makes no attempt to prioritize, e.g., band names over
        physical filter names; any definition that makes *any* reference
        to the name is returned.
 
        Parameters
        ----------
        name : `str`
            The name to search for. May be any band, physical, or alias name.
 
        Returns
        -------
        matches : `set` [`FilterDefinition`]
            All FilterDefinitions containing ``name`` as one of their
            filter names.
        """
        matches = set()
        for filter in self._filters:
            if name == filter.physical_filter or name == filter.band or name == filter.afw_name \
                    or name in filter.alias:
                matches.add(filter)
        return matches
 
 
@dataclasses.dataclass(frozen=True)

reset()

def lsst.obs.base.filters.FilterDefinitionCollection.reset

(

cls

)

Reset the afw Filter definitions and clear the `defined` singleton.
Use this in unittests that define different filters.

Definition at line 100 of file filters.py.

    def reset(cls):
        """Reset the afw Filter definitions and clear the `defined` singleton.
        Use this in unittests that define different filters.
        """
        with warnings.catch_warnings():
            # surpress Filter warnings; we already know this is deprecated
            warnings.simplefilter('ignore', category=FutureWarning)
            lsst.afw.image.utils.resetFilters()
        cls._defined = None
 

Member Data Documentation

physical_to_band [1/2]

dictionary lsst.obs.base.filters.FilterDefinitionCollection.physical_to_band = {}

static

Definition at line 52 of file filters.py.

physical_to_band [2/2]

lsst.obs.base.filters.FilterDefinitionCollection.physical_to_band

Definition at line 61 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