lsst.meas.base  14.0-17-g4f4ea82+5
Public Member Functions | Public Attributes | List of all members
lsst::meas::base::ApertureFluxResult Struct Reference

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

#include <ApertureFlux.h>

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

Public Member Functions

bool getFlag (unsigned int index) const
 Return the flag value associated with the given bit. More...
 
bool getFlag (std::string const &name) const
 Return the flag value associated with the given flag name. More...
 
void setFlag (unsigned int index, bool value=true)
 Set the flag value associated with the given bit. More...
 
void unsetFlag (unsigned int index)
 Clear (i.e. set to false) the flag associated with the given bit. More...
 

Public Attributes

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 251 of file ApertureFlux.h.

Member Function Documentation

◆ getFlag() [1/2]

bool lsst::meas::base::ApertureFluxResult::getFlag ( unsigned int  index) const
inline

Return the flag value associated with the given bit.

Definition at line 254 of file ApertureFlux.h.

◆ getFlag() [2/2]

bool lsst::meas::base::ApertureFluxResult::getFlag ( std::string const &  name) const
inline

Return the flag value associated with the given flag name.

Definition at line 257 of file ApertureFlux.h.

◆ setFlag()

void lsst::meas::base::ApertureFluxResult::setFlag ( unsigned int  index,
bool  value = true 
)
inline

Set the flag value associated with the given bit.

Definition at line 262 of file ApertureFlux.h.

◆ unsetFlag()

void lsst::meas::base::ApertureFluxResult::unsetFlag ( unsigned int  index)
inline

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

Definition at line 265 of file ApertureFlux.h.

Member Data Documentation

◆ flux

Flux lsst::meas::base::FluxResult::flux
inherited

Measured flux in DN.

Definition at line 38 of file FluxUtilities.h.

◆ fluxSigma

FluxErrElement lsst::meas::base::FluxResult::fluxSigma
inherited

1-Sigma error (sqrt of variance) on flux in DN.

Definition at line 39 of file FluxUtilities.h.


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