lsst.afw  19.0.0-22-gd98cb7f78
Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::image::FilterProperty Class Referencefinal

Describe the properties of a Filter (e.g. More...

#include <Filter.h>

Public Member Functions

 FilterProperty (std::string const &name, double lambdaEff, double lambdaMin=NAN, double lambdaMax=NAN, bool force=false)
 
 FilterProperty (std::string const &name, lsst::daf::base::PropertySet const &prop=lsst::daf::base::PropertySet(), bool force=false)
 
 FilterProperty (FilterProperty const &)=default
 
 FilterProperty (FilterProperty &&) noexcept=default
 
FilterPropertyoperator= (FilterProperty const &)=default
 
FilterPropertyoperator= (FilterProperty &&) noexcept=default
 
 ~FilterProperty () noexcept=default
 
std::string const & getName () const noexcept
 Return a filter's name. More...
 
double getLambdaEff () const noexcept
 Return the filter's effective wavelength (nm) More...
 
double getLambdaMin () const noexcept
 Return the filter's minimum wavelength (nm) where the transmission is above 1% of the maximum. More...
 
double getLambdaMax () const noexcept
 Return the filter's maximum wavelength (nm) where the transmission is above 1% of the maximum. More...
 
bool operator== (FilterProperty const &rhs) const noexcept
 Return true iff two FilterProperties are identical. More...
 
bool operator!= (FilterProperty const &rhs) const noexcept
 Return true iff rhs != this. More...
 
std::size_t hash_value () const noexcept
 Return a hash of this object. More...
 

Static Public Member Functions

static void reset ()
 Clear all definitions. More...
 
static FilterProperty const & lookup (std::string const &name)
 Lookup the properties of a filter "name". More...
 

Detailed Description

Describe the properties of a Filter (e.g.

effective wavelength)

Definition at line 51 of file Filter.h.

Constructor & Destructor Documentation

◆ FilterProperty() [1/4]

lsst::afw::image::FilterProperty::FilterProperty ( std::string const &  name,
double  lambdaEff,
double  lambdaMin = NAN,
double  lambdaMax = NAN,
bool  force = false 
)
inlineexplicit

Definition at line 53 of file Filter.h.

◆ FilterProperty() [2/4]

lsst::afw::image::FilterProperty::FilterProperty ( std::string const &  name,
lsst::daf::base::PropertySet const &  prop = lsst::daf::base::PropertySet(),
bool  force = false 
)
explicit
Parameters
namename of filter
propvalues describing the Filter
forceAllow this name to replace a previous one

Definition at line 52 of file Filter.cc.

◆ FilterProperty() [3/4]

lsst::afw::image::FilterProperty::FilterProperty ( FilterProperty const &  )
default

◆ FilterProperty() [4/4]

lsst::afw::image::FilterProperty::FilterProperty ( FilterProperty &&  )
defaultnoexcept

◆ ~FilterProperty()

lsst::afw::image::FilterProperty::~FilterProperty ( )
defaultnoexcept

Member Function Documentation

◆ getLambdaEff()

double lsst::afw::image::FilterProperty::getLambdaEff ( ) const
inlinenoexcept

Return the filter's effective wavelength (nm)

Definition at line 80 of file Filter.h.

◆ getLambdaMax()

double lsst::afw::image::FilterProperty::getLambdaMax ( ) const
inlinenoexcept

Return the filter's maximum wavelength (nm) where the transmission is above 1% of the maximum.

Definition at line 88 of file Filter.h.

◆ getLambdaMin()

double lsst::afw::image::FilterProperty::getLambdaMin ( ) const
inlinenoexcept

Return the filter's minimum wavelength (nm) where the transmission is above 1% of the maximum.

Definition at line 84 of file Filter.h.

◆ getName()

std::string const& lsst::afw::image::FilterProperty::getName ( ) const
inlinenoexcept

Return a filter's name.

Definition at line 76 of file Filter.h.

◆ hash_value()

std::size_t lsst::afw::image::FilterProperty::hash_value ( ) const
noexcept

Return a hash of this object.

Definition at line 91 of file Filter.cc.

◆ lookup()

FilterProperty const & lsst::afw::image::FilterProperty::lookup ( std::string const &  name)
static

Lookup the properties of a filter "name".

Parameters
namename of desired filter

Definition at line 101 of file Filter.cc.

◆ operator!=()

bool lsst::afw::image::FilterProperty::operator!= ( FilterProperty const &  rhs) const
inlinenoexcept

Return true iff rhs != this.

Parameters
rhsObject to compare with this

Definition at line 98 of file Filter.h.

◆ operator=() [1/2]

FilterProperty& lsst::afw::image::FilterProperty::operator= ( FilterProperty &&  )
defaultnoexcept

◆ operator=() [2/2]

FilterProperty& lsst::afw::image::FilterProperty::operator= ( FilterProperty const &  )
default

◆ operator==()

bool lsst::afw::image::FilterProperty::operator== ( FilterProperty const &  rhs) const
noexcept

Return true iff two FilterProperties are identical.

Parameters
rhsObject to compare with this

Definition at line 87 of file Filter.cc.

◆ reset()

static void lsst::afw::image::FilterProperty::reset ( )
inlinestatic

Clear all definitions.

Definition at line 107 of file Filter.h.


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