lsst::afw::image::Filter Class Reference

Holds an integer identifier for an LSST filter. More...

#include <Filter.h>

Public Types
enum	{ AUTO =-1, UNKNOWN =-1 }

Public Member Functions
	Filter (std::string const &name, bool const force=false)
	Filter (int id=UNKNOWN)
	Filter (boost::shared_ptr< lsst::daf::base::PropertySet const >, bool const force=false)
bool	operator== (Filter const &rhs) const
bool	operator!= (Filter const &rhs) const
int	getId () const
std::string const &	getName () const
FilterProperty const &	getFilterProperty () const

Static Public Member Functions
static void	reset ()
static int	define (FilterProperty const &filterProperty, int id=AUTO, bool force=false)
static int	defineAlias (std::string const &oldName, std::string const &newName, bool force=false)
static std::vector< std::string >	getNames ()

Private Types
typedef std::tr1::unordered_map < std::string const, std::string const >	AliasMap
typedef std::tr1::unordered_map < std::string const, unsigned int const >	NameMap
typedef std::tr1::unordered_map < unsigned int const, std::string const >	IdMap

Static Private Member Functions
static void	_initRegistry ()
static int	_lookup (std::string const &name, bool const force=false)
static std::string const &	_lookup (int id)

Private Attributes
int	_id
std::string	_name

Static Private Attributes
static int	_id0 = Filter::UNKNOWN
static AliasMap *	_aliasMap = NULL
static IdMap *	_idMap = NULL
static NameMap *	_nameMap = NULL

Detailed Description

Holds an integer identifier for an LSST filter.

Definition at line 107 of file Filter.h.

Member Typedef Documentation

typedef std::tr1::unordered_map<std::string const, std::string const> lsst::afw::image::Filter::AliasMap

private

Definition at line 158 of file Filter.h.

typedef std::tr1::unordered_map<unsigned int const, std::string const> lsst::afw::image::Filter::IdMap

private

Definition at line 160 of file Filter.h.

typedef std::tr1::unordered_map<std::string const, unsigned int const> lsst::afw::image::Filter::NameMap

private

Definition at line 159 of file Filter.h.

Member Enumeration Documentation

anonymous enum

Enumerator
AUTO
UNKNOWN

Definition at line 110 of file Filter.h.

{ AUTO=-1, UNKNOWN=-1 };

Constructor & Destructor Documentation

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

inlineexplicit

Creates a Filter with the given name

Parameters

name	Name of filter
force	Allow us to construct an unknown Filter

Definition at line 114 of file Filter.h.

                     : _id(_lookup(name, force)), _name(name) {}

lsst::afw::image::Filter::Filter ( int  id = UNKNOWN )

inlineexplicit

Creates a Filter with the given identifier

Parameters

id	Id number of desired filter

Definition at line 120 of file Filter.h.

                     : _id(id), _name(_lookup(id)) {}

lsst::afw::image::Filter::Filter ( boost::shared_ptr< lsst::daf::base::PropertySet const >  metadata, bool const  force = false  )

explicit

Create a Filter from a PropertySet (e.g. a FITS header)

Parameters

metadata	Metadata to process (e.g. a IFITS header)
force	Allow us to construct an unknown Filter

Definition at line 149 of file Filter.cc.

{
    std::string const key = "FILTER";
    if( metadata->exists(key) ) {
        std::string filterName = boost::algorithm::trim_right_copy(metadata->getAsString(key));
        _id = _lookup(filterName, force);
        _name = filterName;
    }
}

Member Function Documentation

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

staticprivate

Initialise the Filter registry

Definition at line 213 of file Filter.cc.

{
    _id0 = UNKNOWN;
    delete _aliasMap;
    delete _nameMap;
    delete _idMap;

    _aliasMap = new AliasMap;
    _nameMap = new NameMap;
    _idMap = new IdMap;
    
    define(FilterProperty(unknownFilter, lsst::pex::policy::Policy(), true));
}

int lsst::afw::image::Filter::_lookup ( std::string const &  name, bool const  force = false  )

staticprivate

Lookup the ID associated with a name

Definition at line 319 of file Filter.cc.

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

    NameMap::iterator keyVal = _nameMap->find(name);

    if (keyVal == _nameMap->end()) {
        AliasMap::iterator aliasKeyVal = _aliasMap->find(name);
        if (aliasKeyVal != _aliasMap->end()) {
            return _lookup(aliasKeyVal->second);
        }

        if (force) {
            return UNKNOWN;
        } else {
            throw LSST_EXCEPT(pexEx::NotFoundError, "Unable to find filter " + name);
        }
    }
    
    return keyVal->second;
}

std::string const & lsst::afw::image::Filter::_lookup ( int  id )

staticprivate

Lookup the name associated with an ID

Definition at line 348 of file Filter.cc.

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

    IdMap::iterator keyVal = _idMap->find(id);

    if (keyVal == _idMap->end()) {
        throw LSST_EXCEPT(pexEx::NotFoundError, (boost::format("Unable to find filter %d") % id).str());
    }
    
    return keyVal->second;
}

int lsst::afw::image::Filter::define ( FilterProperty const &  fp, int  id = AUTO, bool  force = false  )

static

Define a filter name to have the specified id

If id == Filter::AUTO a value will be chosen for you.

It is an error to attempt to change a name's id (unless you specify force)

Definition at line 245 of file Filter.cc.

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

    std::string const& name = fp.getName();
    NameMap::iterator keyVal = _nameMap->find(name);

    if (keyVal != _nameMap->end()) {
        int oid = keyVal->second;

        if (id == oid || id == AUTO) {
            return oid;                 // OK, same value as before
        }

        if (!force) {
            throw LSST_EXCEPT(pexEx::RuntimeError, "Filter " + name + " is already defined");
        }
        _nameMap->erase(keyVal);
        _idMap->erase(oid);
    }

    if (id == AUTO) {
        id = _id0;
        ++_id0;
    }
    
    _nameMap->insert(std::make_pair(name, id));
    _idMap->insert(std::make_pair(id, name));

    return id;
}

int lsst::afw::image::Filter::defineAlias ( std::string const &  oldName, std::string const &  newName, bool  force = false  )

static

Define an alias for a filter

Parameters

oldName	old name for Filter
newName	new name for Filter
force	force an alias even if newName is already in use

Definition at line 282 of file Filter.cc.

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

    // Lookup oldName
    NameMap::iterator keyVal = _nameMap->find(oldName);
    if (keyVal == _nameMap->end()) {
        throw LSST_EXCEPT(pexEx::NotFoundError, "Unable to find filter " + oldName);
    }
    int const id = keyVal->second;

    // Lookup oldName in aliasMap
    AliasMap::iterator aliasKeyVal = _aliasMap->find(newName);
    if (aliasKeyVal != _aliasMap->end()) {
        if (aliasKeyVal->second == oldName) {
            return id;                  // OK, same value as before
        }

        if (!force) {
            throw LSST_EXCEPT(pexEx::NotFoundError, "Filter " + newName + " is already defined");
        }
        _aliasMap->erase(aliasKeyVal);
    }
    
    _aliasMap->insert(std::make_pair(newName, oldName));

    return id;
}

FilterProperty const & lsst::afw::image::Filter::getFilterProperty

(

)

const

Return a Filter's FilterProperty

Definition at line 365 of file Filter.cc.

                                                      {
    //
    // Map name to its ID and back to resolve aliases
    //
    int const id = _lookup(_name, true);
    std::string const& name = (id == UNKNOWN) ? _name : _lookup(id);

    return FilterProperty::lookup(name);
}

int lsst::afw::image::Filter::getId ( ) const

inline

Return a Filter's integral id

Definition at line 136 of file Filter.h.

{ return _id; }

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

inline

Return a Filter's name

Definition at line 140 of file Filter.h.

{ return _name; }

std::vector< std::string > lsst::afw::image::Filter::getNames ( )

static

Return a list of known filters

Definition at line 184 of file Filter.cc.

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

    std::vector<std::string> names;

    for (NameMap::const_iterator ptr = _nameMap->begin(), end = _nameMap->end(); ptr != end; ++ptr) {
        if (ptr->first != unknownFilter) {
            names.push_back(ptr->first);
        }
    }
    std::sort(names.begin(), names.end());

    return names;
}

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

inline

Definition at line 131 of file Filter.h.

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

bool lsst::afw::image::Filter::operator==

(

Filter const &

rhs

)

const

Are two filters identical?

Definition at line 205 of file Filter.cc.

                                               {
    return _id != UNKNOWN && _id == rhs._id;
}

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

inlinestatic

Clear all definitions

Definition at line 146 of file Filter.h.

{ _initRegistry(); }

Member Data Documentation

Filter::AliasMap * lsst::afw::image::Filter::_aliasMap = NULL

staticprivate

Definition at line 170 of file Filter.h.

int lsst::afw::image::Filter::_id

private

Definition at line 166 of file Filter.h.

int lsst::afw::image::Filter::_id0 = Filter::UNKNOWN

staticprivate

Definition at line 169 of file Filter.h.

Filter::IdMap * lsst::afw::image::Filter::_idMap = NULL

staticprivate

Definition at line 171 of file Filter.h.

std::string lsst::afw::image::Filter::_name

private

Definition at line 167 of file Filter.h.

Filter::NameMap * lsst::afw::image::Filter::_nameMap = NULL

staticprivate

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