lsst::afw::image::FilterLabel Class Reference

A group of labels for a filter in an exposure or coadd. More...

#include <FilterLabel.h>

Inheritance diagram for lsst::afw::image::FilterLabel:

Classes
class	Factory

Public Member Functions
	FilterLabel (FilterLabel const &)
	FilterLabel (FilterLabel &&) noexcept
FilterLabel &	operator= (FilterLabel const &)
FilterLabel &	operator= (FilterLabel &&) noexcept
	~FilterLabel () noexcept
bool	hasBandLabel () const noexcept
	Return whether the filter label names a band.
std::string	getBandLabel () const
	Return the band label.
bool	hasPhysicalLabel () const noexcept
	Return whether the filter label names a physical filter.
std::string	getPhysicalLabel () const
	Return the physical filter label.
std::size_t	hash_value () const noexcept override
	Return a hash of this object.
std::string	toString () const override
	Return a string representation of this object.
std::shared_ptr< Storable >	cloneStorable () const override
	Create a new object that is a copy of this one.
bool	equals (Storable const &other) const noexcept override
bool	isPersistable () const noexcept override
	All filter labels are always persistable.
virtual bool	equals (Storable const &other) const noexcept
	Compare this object to another Storable.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.
bool	operator== (FilterLabel const &rhs) const noexcept
	Filter labels compare equal if their components are equal.
bool	operator!= (FilterLabel const &rhs) const noexcept
	Filter labels compare equal if their components are equal.

Static Public Member Functions
static std::shared_ptr< FilterLabel >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< FilterLabel >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< FilterLabel >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< FilterLabel >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.
static FilterLabel	fromBandPhysical (std::string const &band, std::string const &physical)
	Construct a FilterLabel from specific inputs.
static FilterLabel	fromBand (std::string const &band)
	Construct a FilterLabel from specific inputs.
static FilterLabel	fromPhysical (std::string const &physical)
	Construct a FilterLabel from specific inputs.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

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

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.

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

Detailed Description

A group of labels for a filter in an exposure or coadd.

This class provides only identifiers for filters. Other filter information can be retrieved from an Exposure object or a Butler repository.

FilterLabel does not expose a public constructor in C++, except for copy and move constructors. You can create a FilterLabel by calling one of the from* factory methods, or (in Python) through a keyword-only constructor.

Not all of a FilterLabel object's labels need be defined, but at least one is guaranteed to be present.

Definition at line 58 of file FilterLabel.h.

Member Typedef Documentation

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

FilterLabel() [1/2]

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

default

FilterLabel() [2/2]

lsst::afw::image::FilterLabel::FilterLabel ( FilterLabel && )

defaultnoexcept

~FilterLabel()

lsst::afw::image::FilterLabel::~FilterLabel ( )

defaultnoexcept

Member Function Documentation

cloneStorable()

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

overridevirtual

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

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

Definition at line 156 of file FilterLabel.cc.

                                                                     {
    return std::make_shared<FilterLabel>(*this);
}

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< FilterLabel >::dynamicCast ( std::shared_ptr< Persistable > const & ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

equals() [1/2]

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

virtualnoexceptinherited

Compare this object to another Storable.

Subclasses that implement equality comparison must override this method to give results consistent with operator== for all inputs that are accepted by both.

Returns

This implementation returns whether the two objects are the same.

Warning

This method compares an object to any type of Storable, although cross-class comparisons should usually return false. If cross-class comparisons are valid, implementers should take care that they are symmetric and will give the same result no matter what the compile-time types of the left- and right-hand sides are.

See also

singleClassEquals

Note

When called on Python classes, this method delegates to __eq__ if it exists.

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

Definition at line 48 of file Storable.cc.

{ return this == &other; }

equals() [2/2]

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

inlineoverridenoexcept

Definition at line 123 of file FilterLabel.h.

{ return singleClassEquals(*this, other); }

fromBand()

FilterLabel lsst::afw::image::FilterLabel::fromBand ( std::string const & band )

static

Construct a FilterLabel from specific inputs.

Definition at line 72 of file FilterLabel.cc.

{ return FilterLabel(true, band, false, ""s); }

fromBandPhysical()

FilterLabel lsst::afw::image::FilterLabel::fromBandPhysical ( std::string const & band, std::string const & physical )

static

Construct a FilterLabel from specific inputs.

Definition at line 68 of file FilterLabel.cc.

                                                                                          {
    return FilterLabel(true, band, true, physical);
}

fromPhysical()

FilterLabel lsst::afw::image::FilterLabel::fromPhysical ( std::string const & physical )

static

Construct a FilterLabel from specific inputs.

Definition at line 74 of file FilterLabel.cc.

                                                               {
    return FilterLabel(false, ""s, true, physical);
}

getBandLabel()

std::string lsst::afw::image::FilterLabel::getBandLabel

(

)

const

Return the band label.

In Python, this is replaced by the band read-only property.

Returns

The band label.

Exceptions

lsst::pex::exceptions::LogicError

Thrown if hasBandLabel() is false.

Definition at line 87 of file FilterLabel.cc.

                                          {
    // In no implementation I can think of will hasBandLabel() be an expensive test.
    if (hasBandLabel()) {
        return _band;
    } else {
        throw LSST_EXCEPT(pex::exceptions::LogicError, toString() + " has no band."s);
    }
}

getPersistenceName()

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

overrideprotectedvirtualnoexcept

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 232 of file FilterLabel.cc.

{ return _getPersistenceName(); }

getPhysicalLabel()

std::string lsst::afw::image::FilterLabel::getPhysicalLabel

(

)

const

Return the physical filter label.

In Python, this is replaced by the physicalLabel read-only property.

Returns

The physical filter label.

Exceptions

lsst::pex::exceptions::LogicError

Thrown if hasPhysicalLabel() is false.

Definition at line 98 of file FilterLabel.cc.

                                              {
    // In no implementation I can think of will hasBandLabel() be an expensive test.
    if (hasPhysicalLabel()) {
        return _physical;
    } else {
        throw LSST_EXCEPT(pex::exceptions::LogicError, toString() + " has no physical filter."s);
    }
}

getPythonModule()

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

overrideprotectedvirtualnoexcept

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 233 of file FilterLabel.cc.

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

hasBandLabel()

bool lsst::afw::image::FilterLabel::hasBandLabel ( ) const

noexcept

Return whether the filter label names a band.

Definition at line 85 of file FilterLabel.cc.

{ return _hasBand; }

hash_value()

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

overridevirtualnoexcept

Return a hash of this object.

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

Definition at line 126 of file FilterLabel.cc.

                                                 {
    // Do not count _name unless _hasName
    // (_has=false, _name="A") and (_has=false, _name="B") compare equal, so must have same hash
    return cpputils::hashCombine(42, _hasBand, _hasBand ? _band : ""s, _hasPhysical,
                              _hasPhysical ? _physical : ""s);
}

hasPhysicalLabel()

bool lsst::afw::image::FilterLabel::hasPhysicalLabel ( ) const

noexcept

Return whether the filter label names a physical filter.

Definition at line 96 of file FilterLabel.cc.

{ return _hasPhysical; }

isPersistable()

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

inlineoverridevirtualnoexcept

All filter labels are always persistable.

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

Definition at line 128 of file FilterLabel.h.

{ return true; }

operator!=()

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

inlinenoexcept

Filter labels compare equal if their components are equal.

Note

This operation does not test whether two filters are the same. Two FilterLabels corresponding to identically-named filters on different instruments will compare equal.

Definition at line 112 of file FilterLabel.h.

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

operator=() [1/2]

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

defaultnoexcept

operator=() [2/2]

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

default

operator==()

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

noexcept

Filter labels compare equal if their components are equal.

Note

This operation does not test whether two filters are the same. Two FilterLabels corresponding to identically-named filters on different instruments will compare equal.

Definition at line 107 of file FilterLabel.cc.

                                                                  {
    // Do not compare name unless _hasName for both
    if (_hasBand != rhs._hasBand) {
        return false;
    }
    if (_hasBand && _band != rhs._band) {
        return false;
    }
    if (_hasPhysical != rhs._hasPhysical) {
        return false;
    }
    if (_hasPhysical && _physical != rhs._physical) {
        return false;
    }
    return true;
}

readFits() [1/3]

static std::shared_ptr< FilterLabel > lsst::afw::table::io::PersistableFacade< FilterLabel >::readFits ( fits::Fits & fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

readFits() [2/3]

static std::shared_ptr< FilterLabel > lsst::afw::table::io::PersistableFacade< FilterLabel >::readFits ( fits::MemFileManager & manager, int hdu = fits::DEFAULT_HDU )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

readFits() [3/3]

static std::shared_ptr< FilterLabel > lsst::afw::table::io::PersistableFacade< FilterLabel >::readFits ( std::string const & fileName, int hdu = fits::DEFAULT_HDU )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

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::image::FilterLabel::toString ( ) const

overridevirtual

Return a string representation of this object.

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

Definition at line 137 of file FilterLabel.cc.

                                      {
    std::string buffer("FilterLabel(");
    bool comma = false;
 
    if (hasBandLabel()) {
        if (comma) buffer += ", "s;
        buffer += "band"s + "=\""s + getBandLabel() + "\""s;
        comma = true;
    }
    if (hasPhysicalLabel()) {
        if (comma) buffer += ", "s;
        buffer += "physical"s + "=\""s + getPhysicalLabel() + "\""s;
        comma = true;
    }
    buffer += ")"s;
 
    return buffer;
}

write()

void lsst::afw::image::FilterLabel::write ( table::io::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 235 of file FilterLabel.cc.

                                                                {
    PersistenceHelper const &keys = PersistenceHelper::get();
    table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    std::shared_ptr<table::BaseRecord> record = catalog.addNew();
 
    record->set(keys.band, std::make_pair(_hasBand, _band));
    record->set(keys.physical, std::make_pair(_hasPhysical, _physical));
    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 Symbol 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();
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g2160c40384+da0d0eec6b/include/lsst/afw/image/FilterLabel.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/g2160c40384+da0d0eec6b/src/image/FilterLabel.cc