lsst::meas::algorithms::ScaledFlux Class Reference

An abstract base class for flux algorithms that need to be scaled to a common system. More...

#include <ScaledFlux.h>

Classes
struct	KeyTuple

Public Member Functions
virtual int	getFluxCount () const
	Return the number of normalizable flux measurements provided by this algorithm. More...
virtual afw::table::KeyTuple < afw::table::Flux >	getFluxKeys (int n=0) const =0
	Return the keys that correspond to the nth flux measurement. More...
virtual KeyTuple	getFluxCorrectionKeys (int n=0) const =0
	Return the flux-correction keys that correspond to the nth flux measurement. More...
virtual	~ScaledFlux ()

Detailed Description

An abstract base class for flux algorithms that need to be scaled to a common system.

This is intended as an extra (i.e multiple-inheritance) base class for flux measurement algorithms, but it doesn't inherit from Algorithm itself so there should be no diamond hierarchy problems.

Algorithms that inherit from ScaledFlux must also apply themselves to the PSF model, storing the "flux" and an error flag using keys available through the ScaledFlux interface. The actual fluxes and flux errors will then be corrected using this "PSF factor" measurement and the measured aperture corrections at the aperture corrections stage.

Inheriting from ScaledFlux is now what marks a flux measurement as one that requires aperture corrections, unlike the previous system, in which fluxes to correct were part of the aperture correction configuration.

Definition at line 54 of file ScaledFlux.h.

Constructor & Destructor Documentation

virtual lsst::meas::algorithms::ScaledFlux::~ScaledFlux ( )

inlinevirtual

Definition at line 91 of file ScaledFlux.h.

{}

Member Function Documentation

virtual KeyTuple lsst::meas::algorithms::ScaledFlux::getFluxCorrectionKeys ( int  n = 0 ) const

pure virtual

Return the flux-correction keys that correspond to the nth flux measurement.

virtual int lsst::meas::algorithms::ScaledFlux::getFluxCount ( ) const

inlinevirtual

Return the number of normalizable flux measurements provided by this algorithm.

Definition at line 83 of file ScaledFlux.h.

{ return 1; }

virtual afw::table::KeyTuple<afw::table::Flux> lsst::meas::algorithms::ScaledFlux::getFluxKeys ( int  n = 0 ) const

pure virtual

Return the keys that correspond to the nth flux measurement.

---

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

• /lsst/home/lsstsw/stack/Linux64/meas_algorithms/master-g7bce1f4e06+57/include/lsst/meas/algorithms/ScaledFlux.h