lsst.meas.base g876c692160+cd4578f6bd
Loading...
Searching...
No Matches
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.
 
bool getFlag (std::string const &name) const
 Return the flag value associated with the given flag name.
 
void setFlag (unsigned int index, bool value=true)
 Set the flag value associated with the given bit.
 
void unsetFlag (unsigned int index)
 Clear (i.e. set to false) the flag associated with the given bit.
 

Public Attributes

meas::base::Flux instFlux
 Measured instFlux in DN.
 
meas::base::FluxErrElement instFluxErr
 Standard deviation of instFlux in DN.
 

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

Member Function Documentation

◆ getFlag() [1/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 222 of file ApertureFlux.h.

◆ getFlag() [2/2]

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

Return the flag value associated with the given bit.

Definition at line 219 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 227 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 230 of file ApertureFlux.h.

Member Data Documentation

◆ instFlux

meas::base::Flux lsst::meas::base::FluxResult::instFlux
inherited

Measured instFlux in DN.

Definition at line 42 of file FluxUtilities.h.

◆ instFluxErr

meas::base::FluxErrElement lsst::meas::base::FluxResult::instFluxErr
inherited

Standard deviation of instFlux in DN.

Definition at line 43 of file FluxUtilities.h.


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