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

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

#include <Filter.h>

Inheritance diagram for lsst::afw::image::Filter:

Public Member Functions
	Filter (std::string const &name, bool const force=false)
	Creates a Filter with the given name. More...
	Filter (int id=UNKNOWN)
	Creates a Filter with the given identifier. More...
	Filter (std::shared_ptr< lsst::daf::base::PropertySet const > metadata, bool const force=false)
	Create a Filter from a PropertySet (e.g. More...
	Filter (Filter const &)=default
	Filter (Filter &&) noexcept=default
Filter &	operator= (Filter const &)=default
Filter &	operator= (Filter &&) noexcept=default
	~Filter () noexcept=default
bool	operator== (Filter const &rhs) const noexcept
	Are two filters identical? More...
bool	operator!= (Filter const &rhs) const noexcept
std::size_t	hash_value () const noexcept override
	Return a hash of this object. More...
int	getId () const noexcept
	Return a Filter's integral id. More...
std::string const &	getName () const noexcept
	Return a Filter's name. More...
std::string const &	getCanonicalName () const
	Return a filter's canonical name. More...
std::vector< std::string >	getAliases () const
	Return all aliases by which this filter is known. More...
FilterProperty const &	getFilterProperty () const
	Return a Filter's FilterProperty. More...
std::shared_ptr< typehandling::Storable >	cloneStorable () const override
	Create a new Filter that is a copy of this one. More...
bool	equals (typehandling::Storable const &other) const noexcept override
	Compare this object to another Storable. More...
bool	isPersistable () const noexcept override
	Return true if this particular object can be persisted using afw::table::io. More...
virtual std::string	toString () const
	Create a string representation of this object (optional operation). More...
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

Static Public Member Functions
static void	reset ()
	Clear all definitions. More...
static int	define (FilterProperty const &filterProperty, int id=AUTO, bool force=false)
	Define a filter name to have the specified id. More...
static int	defineAlias (std::string const &oldName, std::string const &newName, bool force=false)
	Define an alias for a filter. More...
static std::vector< std::string >	getNames ()
	Return a list of known filters. More...

Static Public Attributes
static int const	AUTO = -1
static int const	UNKNOWN = -1

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory. More...
std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs. More...

Static Protected Member Functions
template<class T >
static bool	singleClassEquals (T const &lhs, Storable const &rhs)
	Test if a Storable is of a particular class and equal to another object. More...

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable. More...

Detailed Description

Holds an integer identifier for an LSST filter.

Definition at line 141 of file Filter.h.

Member Typedef Documentation

OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

Filter() [1/5]

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 149 of file Filter.h.

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

Filter() [2/5]

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 156 of file Filter.h.

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

Filter() [3/5]

lsst::afw::image::Filter::Filter ( std::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 122 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;
    }
}

Filter() [4/5]

lsst::afw::image::Filter::Filter ( Filter const &  )

default

Filter() [5/5]

lsst::afw::image::Filter::Filter ( Filter &&  )

defaultnoexcept

~Filter()

lsst::afw::image::Filter::~Filter ( )

defaultnoexcept

Member Function Documentation

cloneStorable()

std::shared_ptr< typehandling::Storable > lsst::afw::image::Filter::cloneStorable ( ) const

overridevirtual

Create a new Filter that is a copy of this one.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 176 of file Filter.cc.

                                                                {
    return std::make_unique<Filter>(*this);
}

define()

int lsst::afw::image::Filter::define ( FilterProperty const &  filterProperty, 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 256 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;
}

defineAlias()

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

equals()

bool lsst::afw::image::Filter::equals ( typehandling::Storable const &  other ) const

overridevirtualnoexcept

Compare this object to another Storable.

Returns

*this == other if other is a Filter; otherwise false.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 180 of file Filter.cc.

                                                                    {
    return singleClassEquals(*this, other);
}

getAliases()

std::vector< std::string > lsst::afw::image::Filter::getAliases

(

)

const

Return all aliases by which this filter is known.

The list excludes the canonical name

Definition at line 146 of file Filter.cc.

                                              {
    std::vector<std::string> aliases;
 
    std::string const& canonicalName = getCanonicalName();
    for (AliasMap::iterator ptr = _aliasMap->begin(), end = _aliasMap->end(); ptr != end; ++ptr) {
        if (ptr->second == canonicalName) {
            aliases.push_back(ptr->first);
        }
    }
 
    return aliases;
}

getCanonicalName()

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

inline

Return a filter's canonical name.

I.e. if this filter's an alias, return the name of the aliased Filter

Definition at line 195 of file Filter.h.

{ return _lookup(_id); }

getFilterProperty()

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

(

)

const

Return a Filter's FilterProperty.

Definition at line 355 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);
}

getId()

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

inlinenoexcept

Return a Filter's integral id.

Definition at line 185 of file Filter.h.

{ return _id; }

getName()

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

inlinenoexcept

Return a Filter's name.

Definition at line 189 of file Filter.h.

{ return _name; }

getNames()

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

static

Return a list of known filters.

Definition at line 159 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;
}

getPersistenceName()

std::string lsst::afw::image::Filter::getPersistenceName ( ) const

overrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 220 of file Filter.cc.

{ return _getPersistenceName(); }

getPythonModule()

std::string lsst::afw::image::Filter::getPythonModule ( ) const

overrideprotectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 222 of file Filter.cc.

{ return "lsst.afw.image"; };

hash_value()

std::size_t lsst::afw::image::Filter::hash_value ( ) const

overridevirtualnoexcept

Return a hash of this object.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 234 of file Filter.cc.

{ return std::hash<int>()(_id); }

isPersistable()

bool lsst::afw::image::Filter::isPersistable ( ) const

overridevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 218 of file Filter.cc.

{ return true; }

operator!=()

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

inlinenoexcept

Definition at line 177 of file Filter.h.

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

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

default

operator==()

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

noexcept

Are two filters identical?

Definition at line 232 of file Filter.cc.

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

reset()

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

inlinestatic

Clear all definitions.

Definition at line 210 of file Filter.h.

{ _initRegistry(); }

singleClassEquals()

template<class T >

static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const &  lhs, Storable const &  rhs  )

inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs

The objects to compare. Note that rhs need not be a T, while lhs must be.

Returns

true if rhs is a T and lhs == rhs; false otherwise.

Exception Safety

Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.

Note

This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

toString()

std::string lsst::afw::typehandling::Storable::toString ( ) const

virtualinherited

Create a string representation of this object (optional operation).

Exceptions

UnsupportedOperationException

Thrown if this object does not have a string representation.

Note

When called on Python classes, this method delegates to __repr__.

Reimplemented in lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::image::VisitInfo, lsst::afw::image::PhotoCalib, lsst::afw::image::FilterLabel, lsst::afw::geom::SkyWcs, and lsst::afw::geom::polygon::Polygon.

Definition at line 40 of file Storable.cc.

                                   {
    throw LSST_EXCEPT(UnsupportedOperationException, "No string representation available.");
}

write()

void lsst::afw::image::Filter::write ( OutputArchiveHandle &  handle ) const

overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 224 of file Filter.cc.

                                                    {
    PersistenceHelper const& keys = PersistenceHelper::get();
    table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    std::shared_ptr<table::BaseRecord> record = catalog.addNew();
    record->set(keys.name, getName());
    handle.saveCatalog(catalog);
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits &  fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager &  manager, std::string const &  mode = "w"  ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName, std::string const &  mode = "w"  ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  os, Storable const &  storable  )

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                        {
    return os << storable.toString();
}

Member Data Documentation

AUTO

int const lsst::afw::image::Filter::AUTO = -1

static

Definition at line 143 of file Filter.h.

UNKNOWN

int const lsst::afw::image::Filter::UNKNOWN = -1

static

Definition at line 144 of file Filter.h.

---

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

• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/afw/21.0.0-12-g51f5968d7+47cba9fc36/include/lsst/afw/image/Filter.h
• /j/snowflake/release/lsstsw/stack/0.2.1/Linux64/afw/21.0.0-12-g51f5968d7+47cba9fc36/src/image/Filter.cc