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

#include <Filter.h>

Public Member Functions
	FilterProperty (std::string const &name, double lambdaEff, bool force=false)
	FilterProperty (std::string const &name, lsst::daf::base::PropertySet const &prop=lsst::daf::base::PropertySet(), bool force=false)
	FilterProperty (std::string const &name, lsst::pex::policy::Policy const &pol, bool force=false)
std::string const &	getName () const
double	getLambdaEff () const
bool	operator== (FilterProperty const &rhs) const
bool	operator!= (FilterProperty const &rhs) const

Static Public Member Functions
static void	reset ()
static FilterProperty const &	lookup (std::string const &name)

Public Attributes
boost::shared_ptr< FilterProperty >	Ptr
boost::shared_ptr < FilterProperty const >	ConstPtr

Private Types
typedef std::tr1::unordered_map < std::string const, FilterProperty >	PropertyMap

Private Member Functions
void	_insert (bool force=false)

Static Private Member Functions
static void	_initRegistry ()

Private Attributes
std::string	_name
double	_lambdaEff

Static Private Attributes
static PropertyMap *	_propertyMap = NULL

Detailed Description

Describe the properties of a Filter (e.g. effective wavelength)

Definition at line 55 of file Filter.h.

Member Typedef Documentation

typedef std::tr1::unordered_map<std::string const, FilterProperty> lsst::afw::image::FilterProperty::PropertyMap

private

Definition at line 92 of file Filter.h.

Constructor & Destructor Documentation

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

inlineexplicit

Definition at line 60 of file Filter.h.

                                                                                       :
        _name(name), _lambdaEff(lambdaEff) { _insert(force); }

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 45 of file Filter.cc.

      : _name(name), _lambdaEff(-1)
{
    if (prop.exists("lambdaEff")) {
        _lambdaEff = prop.getAsDouble("lambdaEff");
    }
    _insert(force);
}

lsst::afw::image::FilterProperty::FilterProperty ( std::string const &  name, lsst::pex::policy::Policy const &  pol, bool  force = false  )

explicit

Create a new FilterProperty, setting values from a Policy

Parameters

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

Definition at line 61 of file Filter.cc.

                                : _name(name), _lambdaEff(-1)
{
    if (pol.exists("lambdaEff")) {
        _lambdaEff = pol.getDouble("lambdaEff");
    }
    _insert(force);
}

Member Function Documentation

void lsst::afw::image::FilterProperty::_initRegistry ( )

staticprivate

Initialise the Filter registry

Definition at line 112 of file Filter.cc.

{
    if (_propertyMap) {
        delete _propertyMap;
    }

    _propertyMap = new PropertyMap;
}

void lsst::afw::image::FilterProperty::_insert ( bool  force = false )

private

Insert FilterProperty into registry

Parameters

force

Allow this name to replace a previous one?

Definition at line 75 of file Filter.cc.

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

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

    if (keyVal != _propertyMap->end()) {
        if (keyVal->second == *this) {
            return;                     // OK, a redefinition with identical values
        }

        if (!force) {
            throw LSST_EXCEPT(pexEx::RuntimeError, "Filter " + getName() + " is already defined");
        }
        _propertyMap->erase(keyVal);
    }
    
    _propertyMap->insert(std::make_pair(getName(), *this));
}

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

inline

Return the filter's effective wavelength (nm)

Definition at line 75 of file Filter.h.

{ return _lambdaEff; }

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

inline

Return a filter's name

Definition at line 71 of file Filter.h.

{ return _name; }

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 124 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;
}

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

inline

Return true iff rhs != this

Parameters

rhs	Object to compare with this

Definition at line 83 of file Filter.h.

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

bool lsst::afw::image::FilterProperty::operator==

(

FilterProperty const &

rhs

)

const

Return true iff two FilterProperties are identical

Parameters

rhs	Object to compare with this

Definition at line 102 of file Filter.cc.

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

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

inlinestatic

Clear all definitions

Definition at line 88 of file Filter.h.

{ _initRegistry(); }

Member Data Documentation

double lsst::afw::image::FilterProperty::_lambdaEff

private

Definition at line 98 of file Filter.h.

std::string lsst::afw::image::FilterProperty::_name

private

Definition at line 97 of file Filter.h.

FilterProperty::PropertyMap * lsst::afw::image::FilterProperty::_propertyMap = NULL

staticprivate

Definition at line 100 of file Filter.h.

boost::shared_ptr<FilterProperty const> lsst::afw::image::FilterProperty::ConstPtr

Definition at line 58 of file Filter.h.

boost::shared_ptr<FilterProperty> lsst::afw::image::FilterProperty::Ptr

Definition at line 57 of file Filter.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/image/Filter.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/image/Filter.cc