lsst::meas::base::ApertureFluxResult Struct Reference

#include <ApertureFlux.h>

Inheritance diagram for lsst::meas::base::ApertureFluxResult:

Public Member Functions
bool	getFlag (ApertureFluxAlgorithm::FlagBits bit) const
	Return the flag value associated with the given bit. More...
void	setFlag (ApertureFluxAlgorithm::FlagBits bit, bool value=true)
	Set the flag value associated with the given bit. More...
void	unsetFlag (ApertureFluxAlgorithm::FlagBits bit)
	Clear (i.e. set to false) the flag associated with the given bit. More...
Public Member Functions inherited from lsst::meas::base::FluxResult
	FluxResult ()
	Default constructor; initializes everything to NaN. More...
	FluxResult (Flux flux_, FluxErrElement fluxSigma_)
	Constructor from flux and its uncertainty. More...

Private Attributes
std::bitset < ApertureFluxAlgorithm::N_FLAGS >	_flags

Additional Inherited Members
Public Attributes inherited from lsst::meas::base::FluxResult
Flux	flux
	Measured flux in DN. More...
FluxErrElement	fluxSigma
	1-Sigma error (sqrt of variance) on flux in DN. More...

Detailed Description

A Result struct for running an aperture flux algorithm with a single radius.

This simply extends FluxResult to add the appropriate error flags for aperture fluxes.

Definition at line 248 of file ApertureFlux.h.

Member Function Documentation

bool lsst::meas::base::ApertureFluxResult::getFlag ( ApertureFluxAlgorithm::FlagBits  bit ) const

inline

Return the flag value associated with the given bit.

Definition at line 251 of file ApertureFlux.h.

{ return _flags[bit]; }

void lsst::meas::base::ApertureFluxResult::setFlag ( ApertureFluxAlgorithm::FlagBits  bit, bool  value = true  )

inline

Set the flag value associated with the given bit.

Definition at line 254 of file ApertureFlux.h.

{ _flags[bit] = value; }

void lsst::meas::base::ApertureFluxResult::unsetFlag ( ApertureFluxAlgorithm::FlagBits  bit )

inline

Clear (i.e. set to false) the flag associated with the given bit.

Definition at line 257 of file ApertureFlux.h.

{ _flags[bit] = false; }

Member Data Documentation

std::bitset<ApertureFluxAlgorithm::N_FLAGS> lsst::meas::base::ApertureFluxResult::_flags

private

Definition at line 260 of file ApertureFlux.h.

---

The documentation for this struct was generated from the following file:

• /home/lsstsw/stack/Linux64/meas_base/11.0+1/include/lsst/meas/base/ApertureFlux.h