lsst.obs.base  21.0.0-18-gaffd721+9e5b25d042
Public Member Functions | List of all members
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)
 

Detailed Description

An order-preserving collection of multiple `FilterDefinition`.

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

Definition at line 36 of file filters.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 51 of file filters.py.

Member Function Documentation

◆ __getitem__()

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

Definition at line 54 of file filters.py.

◆ __len__()

def lsst.obs.base.filters.FilterDefinitionCollection.__len__ (   self)

Definition at line 57 of file filters.py.

◆ __str__()

def lsst.obs.base.filters.FilterDefinitionCollection.__str__ (   self)

Definition at line 60 of file filters.py.

◆ 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 63 of file filters.py.

◆ 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 95 of file filters.py.

◆ 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 88 of file filters.py.


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