LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
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.

222 {
224 }
static FlagDefinitionList const & getFlagDefinitions()
FlagDefinition getDefinition(std::size_t index) const
get a reference to the FlagDefinition with specified index.

◆ 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.

219{ return _flags[index]; }

◆ 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.

227{ _flags[index] = value; }

◆ 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.

230{ _flags[index] = false; }

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: