lsst::meas::base::FlagHandler Class Reference

Utility class for handling flag fields that indicate the failure modes of an algorithm. More...

#include <FlagHandler.h>

Public Member Functions
	FlagHandler ()
	Each error should have a corresponding static FlagDefinition object. More...
	FlagHandler (afw::table::SubSchema const &s, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
	Construct a FlagHandler to manage fields already added to a schema. More...
unsigned int	getFlagNumber (std::string const &flagName) const
	Return the index of a flag with the given flag name. More...
std::string	getFlagName (std::size_t i) const
	Return the value of the flag name corresponding to the given flag index. More...
bool	getValue (afw::table::BaseRecord const &record, std::size_t i) const
	Return the value of the flag field corresponding to the given flag index. More...
bool	getValue (afw::table::BaseRecord const &record, std::string const &flagName) const
	Return the value of the flag field with the given flag name. More...
void	setValue (afw::table::BaseRecord &record, std::size_t i, bool value) const
	Set the flag field corresponding to the given flag index. More...
void	setValue (afw::table::BaseRecord &record, std::string const &flagName, bool value) const
	Set the flag field corresponding to the given flag name. More...
std::size_t	getFailureFlagNumber () const
	Get the index of the General Failure flag, if one is defined. More...
void	handleFailure (afw::table::BaseRecord &record, MeasurementError const *error=nullptr) const
	Handle an expected or unexpected Exception thrown by a measurement algorithm. More...

Static Public Member Functions
static std::string const &	getFailureFlagName ()
	Define the universal name of the general failure flag. More...
static FlagHandler	addFields (afw::table::Schema &schema, std::string const &prefix, FlagDefinitionList const &flagDefs, FlagDefinitionList const &exclDefs=FlagDefinitionList::getEmptyList())
	Add Flag fields to a schema, creating a FlagHandler object to manage them. More...

Public Attributes
std::size_t	failureFlagNumber

Detailed Description

Utility class for handling flag fields that indicate the failure modes of an algorithm.

The typical pattern for using FlagHandler within an Algorithm is:

• Add a FlagHandler object as a data member.
• Create a FlagDefinitionList to specify the name and doc for each flag Add a "general" failure flag if one is needed (this indicates that some failure occurred). Add specific error flags for each type of error (these indicate a specific failure).
• Initialize the FlagHandler data member within the Algorithm's constructor, using the static addFields method to add the flags from the FlagDefinitionList to the schema.

See PsfFluxAlgorithm for a complete example.

Definition at line 148 of file FlagHandler.h.

Constructor & Destructor Documentation

FlagHandler() [1/2]

lsst::meas::base::FlagHandler::FlagHandler ( )

inline

Each error should have a corresponding static FlagDefinition object.

In the Algorithm header file, this will be defined like this:

static FlagDefinition const & FAILURE;
static FlagDefinition const & SOME_OTHER_FAILURE_MODE;
    ...

A static FlagDefinitionList is created in the Algorithm .cc file, like this:

FlagDefinitionList flagDefinitions;
FlagDefinition const FAILURE = flagDefinitions.addFailureFlag();
FlagDefinition const FAILURE_MODE = flagDefinitions.add("flag_mode", "Specific failure flag");

Default constructor for delayed initialization.

This constructor creates an invalid, unusable FlagHandler in the same way a const_iterator default constructor constructs an invalid const_iterator. Its only purpose is to delay construction of the FlagHandler from an Algorithm constructor's initializer list to the constructor body, which can be necessary when the list of possible flags depends on the algorithm's configuration. To use this constructor to delay initialization, simply use it in the initializer list, and then assign the result of a call to addFields() to the FlagHandler data member later in the constructor.

Definition at line 176 of file FlagHandler.h.

: failureFlagNumber(FlagDefinition::number_undefined) {}

FlagHandler() [2/2]

lsst::meas::base::FlagHandler::FlagHandler	(	afw::table::SubSchema const &	s,
		FlagDefinitionList const &	flagDefs,
		FlagDefinitionList const &	exclDefs = FlagDefinitionList::getEmptyList()
	)

Construct a FlagHandler to manage fields already added to a schema.

This is primarily intended for use by forced measurement algorithms that need to parse the flags of the single-frame measurement algorithms providing their reference parameters.

Parameters

[in]	A	SubSchema object that holds the fields to extract and their namespace. Obtainable from the arguments to addFields() as "schema[prefix]".
[in]	flagDefs	Reference to a FlagDefinitionList
[in]	exclDefs	optional FlagDefinitionList of flags to exclude

As with addFields(), pointers must be valid only for the duration of this constructor call.

Definition at line 58 of file FlagHandler.cc.

        : failureFlagNumber(FlagDefinition::number_undefined) {
    _vector.reserve(flagDefs.size());
    for (std::size_t i = 0; i < flagDefs.size(); i++) {
        FlagDefinition const& flagDef = flagDefs[i];
        if (exclDefs.hasDefinition(flagDef.name)) {
            afw::table::Key<afw::table::Flag> key;
            _vector.push_back(std::make_pair(flagDef.name, key));
        } else {
            _vector.push_back(std::make_pair(flagDef.name, s[flagDef.name]));
            if (flagDef.name == FlagHandler::getFailureFlagName()) {
                failureFlagNumber = i;
            }
        }
    }
}

Member Function Documentation

addFields()

FlagHandler lsst::meas::base::FlagHandler::addFields ( afw::table::Schema &  schema, std::string const &  prefix, FlagDefinitionList const &  flagDefs, FlagDefinitionList const &  exclDefs = FlagDefinitionList::getEmptyList()  )

static

Add Flag fields to a schema, creating a FlagHandler object to manage them.

This is the way FlagHandlers will typically be constructed for new algorithms.

Parameters

[out]	schema	Schema to which fields should be added.
[in]	prefix	String name of the algorithm or algorithm component. Field names will be constructed by using schema.join() on this and the flag name from the FlagDefinition array.
[in]	flagDefs	Reference to a FlagDefinitionList
[in]	exclDefs	optional FlagDefinitionList of flags to exclude

If the set of flags depends on the algorithm configuration, a flag may be excluded from the schema using the optional exclDefs parameter. This can be specified using an initializer_list, as in: _flagHandler = FlagHandler::addFields(schema, prefix, flagDefs, {NO_PSF})

Definition at line 37 of file FlagHandler.cc.

                                                                                                           {
    FlagHandler r;
    r._vector.reserve(flagDefs.size());
    for (std::size_t i = 0; i < flagDefs.size(); i++) {
        FlagDefinition const& flagDef = flagDefs[i];
        if (exclDefs.hasDefinition(flagDef.name)) {
            afw::table::Key<afw::table::Flag> key;
            r._vector.push_back(std::make_pair(flagDef.name, key));
        } else {
            afw::table::Key<afw::table::Flag> key(
                    schema.addField<afw::table::Flag>(schema.join(prefix, flagDef.name), flagDef.doc));
            r._vector.push_back(std::make_pair(flagDef.name, key));
            if (flagDef.name == FlagHandler::getFailureFlagName()) {
                r.failureFlagNumber = i;
            }
        }
    }
    return r;
}

getFailureFlagName()

static std::string const& lsst::meas::base::FlagHandler::getFailureFlagName ( )

inlinestatic

Define the universal name of the general failure flag.

Definition at line 181 of file FlagHandler.h.

                                                 {
        static std::string name = "flag";
        return name;
    }

getFailureFlagNumber()

std::size_t lsst::meas::base::FlagHandler::getFailureFlagNumber ( ) const

inline

Get the index of the General Failure flag, if one is defined.

This flag is defined by most algorithms, and if defined, is set whenever an error is caught by the FlagHandler. If no General Failure flag is defined, this routine will return FlagDefinition::number_undefined

Definition at line 286 of file FlagHandler.h.

{ return failureFlagNumber; }

getFlagName()

std::string lsst::meas::base::FlagHandler::getFlagName ( std::size_t  i ) const

inline

Return the value of the flag name corresponding to the given flag index.

Definition at line 233 of file FlagHandler.h.

                                             {
        if (i < _vector.size() && _vector[i].second.isValid()) {
            return _vector[i].first;
        }
        throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
    }

getFlagNumber()

unsigned int lsst::meas::base::FlagHandler::getFlagNumber ( std::string const &  flagName ) const

inline

Return the index of a flag with the given flag name.

Definition at line 222 of file FlagHandler.h.

                                                                {
        for (unsigned int i = 0; i < _vector.size(); i++) {
            if (_vector[i].first == flagName && _vector[i].second.isValid()) {
                return i;
            }
        }
        throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
    }

getValue() [1/2]

bool lsst::meas::base::FlagHandler::getValue ( afw::table::BaseRecord const &  record, std::size_t  i  ) const

inline

Return the value of the flag field corresponding to the given flag index.

Definition at line 242 of file FlagHandler.h.

                                                                       {
        if (i < _vector.size() && _vector[i].second.isValid()) {
            return record.get(_vector[i].second);
        }
        throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
    }

getValue() [2/2]

bool lsst::meas::base::FlagHandler::getValue ( afw::table::BaseRecord const &  record, std::string const &  flagName  ) const

inline

Return the value of the flag field with the given flag name.

Definition at line 251 of file FlagHandler.h.

                                                                                     {
        for (std::size_t i = 0; i < _vector.size(); i++) {
            if (_vector[i].first == flagName && _vector[i].second.isValid()) {
                return record.get(_vector[i].second);
            }
        }
        throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
    }

handleFailure()

void lsst::meas::base::FlagHandler::handleFailure	(	afw::table::BaseRecord &	record,
		MeasurementError const *	error = nullptr
	)		const

Handle an expected or unexpected Exception thrown by a measurement algorithm.

If the exception is expected, it should inherit from MeasurementError and can be passed here; this allows handleFailure to extract the failure mode enum value from the exception and set the corresponding flag. The general failure flag will be set regardless of whether the "error" argument is nullptr (which happens when an unexpected error occurs).

Definition at line 76 of file FlagHandler.cc.

                                                                                               {
    std::size_t const numFlags = _vector.size();
    if (failureFlagNumber != FlagDefinition::number_undefined) {
        record.set(_vector[failureFlagNumber].second, true);
    }
    if (error && error->getFlagBit() != FlagDefinition::number_undefined) {
        assert(numFlags > error->getFlagBit());  // We need the particular flag
        record.set(_vector[error->getFlagBit()].second, true);
    }
}

setValue() [1/2]

void lsst::meas::base::FlagHandler::setValue ( afw::table::BaseRecord &  record, std::size_t  i, bool  value  ) const

inline

Set the flag field corresponding to the given flag index.

Definition at line 262 of file FlagHandler.h.

                                                                             {
        if (i < _vector.size() && _vector[i].second.isValid()) {
            record.set(_vector[i].second, value);
            return;
        }
        throw FatalAlgorithmError("No legal FlagHandler entry number " + std::to_string(i));
    }

setValue() [2/2]

void lsst::meas::base::FlagHandler::setValue ( afw::table::BaseRecord &  record, std::string const &  flagName, bool  value  ) const

inline

Set the flag field corresponding to the given flag name.

Definition at line 272 of file FlagHandler.h.

                                                                                           {
        for (std::size_t i = 0; i < _vector.size(); i++) {
            if (_vector[i].first == flagName && _vector[i].second.isValid()) {
                record.set(_vector[i].second, value);
                return;
            }
        }
        throw FatalAlgorithmError("No FlagHandler entry for " + flagName);
    }

Member Data Documentation

failureFlagNumber

std::size_t lsst::meas::base::FlagHandler::failureFlagNumber

Definition at line 297 of file FlagHandler.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-19-g93a5c75+d23f2fb6d8/include/lsst/meas/base/FlagHandler.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-19-g93a5c75+d23f2fb6d8/src/FlagHandler.cc