lsst::afw::image::FilterProperty Class Reference

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
FilterProperty &	operator= (FilterProperty const &)=default
FilterProperty &	operator= (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.

            : _name(name), _lambdaEff(lambdaEff), _lambdaMin(lambdaMin), _lambdaMax(lambdaMax) {
        _insert(force);
    }

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

name	name of filter
prop	values describing the Filter
force	Allow this name to replace a previous one

Definition at line 52 of file Filter.cc.

        : _name(name), _lambdaEff(NAN), _lambdaMin(NAN), _lambdaMax(NAN) {
    if (prop.exists("lambdaEff")) {
        _lambdaEff = prop.getAsDouble("lambdaEff");
    }
    if (prop.exists("lambdaMin")) {
        _lambdaMin = prop.getAsDouble("lambdaMin");
    }
    if (prop.exists("lambdaMax")) {
        _lambdaMax = prop.getAsDouble("lambdaMax");
    }
    _insert(force);
}

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.

{ return _lambdaEff; }

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.

{ return _lambdaMax; }

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.

{ return _lambdaMin; }

getName()

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

inlinenoexcept

Return a filter's name.

Definition at line 76 of file Filter.h.

{ return _name; }

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.

{ return std::hash<double>()(_lambdaEff); };

lookup()

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

static

Lookup the properties of a filter "name".

Parameters

name	name of desired filter

Definition at line 101 of file Filter.cc.

                                                                  {
    if (!_propertyMap) {
        _initRegistry();
    }

    PropertyMap::iterator keyVal = _propertyMap->find(name);

    if (keyVal == _propertyMap->end()) {
        throw LSST_EXCEPT(pexEx::NotFoundError, "Unable to find filter " + name);
    }

    return keyVal->second;
}

operator!=()

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

inlinenoexcept

Return true iff rhs != this.

Parameters

rhs	Object to compare with this

Definition at line 98 of file Filter.h.

                                     {
        return !(*this == rhs);
    }

operator=() [1/2]

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

default

operator=() [2/2]

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

defaultnoexcept

operator==()

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

noexcept

Return true iff two FilterProperties are identical.

Parameters

rhs	Object to compare with this

Definition at line 87 of file Filter.cc.

                                                                        {
    return (_lambdaEff == rhs._lambdaEff);
}

reset()

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

inlinestatic

Clear all definitions.

Definition at line 107 of file Filter.h.

{ _initRegistry(); }

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/include/lsst/afw/image/Filter.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/19.0.0-4-ga671dab3b+1/src/image/Filter.cc