lsst::meas::base::FluxTransform Class Reference

#include <FluxUtilities.h>

Inheritance diagram for lsst::meas::base::FluxTransform:

Public Member Functions
	FluxTransform (std::string const &name, afw::table::SchemaMapper &mapper)
virtual void	operator() (afw::table::SourceCatalog const &inputCatalog, afw::table::BaseCatalog &outputCatalog, afw::image::Wcs const &wcs, afw::image::Calib const &calib) const
Public Member Functions inherited from lsst::meas::base::BaseTransform
	BaseTransform (std::string const &name)
virtual	~BaseTransform ()

Private Attributes
MagResultKey	_magKey

Additional Inherited Members
Protected Member Functions inherited from lsst::meas::base::BaseTransform
void	checkCatalogSize (afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
	Ensure that catalogs have the same size. More...
Protected Attributes inherited from lsst::meas::base::BaseTransform
std::string	_name

Detailed Description

Base for flux measurement transformations

Provides a basic transform from flux plus associated uncertainty to magnitude with uncertainty. The basic "flag" attribute for the measurement algorithm is propagated to the output

Subclasses should define a constructor which take a Control argument corresponding to the measurement algorithm being transformed and ensure that any other necessary flags are propagated.

Definition at line 191 of file FluxUtilities.h.

Constructor & Destructor Documentation

lsst::meas::base::FluxTransform::FluxTransform	(	std::string const &	name,
		afw::table::SchemaMapper &	mapper
	)

Definition at line 84 of file FluxUtilities.cc.

  :
    BaseTransform{name}
{
    // Map the flag through to the output
    mapper.addMapping(mapper.getInputSchema().find<afw::table::Flag>(name + "_flag").key);

    // Add keys for the magnitude and associated error
    _magKey = MagResultKey::addFields(mapper.editOutputSchema(), name);
}

Member Function Documentation

void lsst::meas::base::FluxTransform::operator() ( afw::table::SourceCatalog const &  inputCatalog, afw::table::BaseCatalog &  outputCatalog, afw::image::Wcs const &  wcs, afw::image::Calib const &  calib  ) const

virtual

Implements lsst::meas::base::BaseTransform.

Definition at line 97 of file FluxUtilities.cc.

        {
    checkCatalogSize(inputCatalog, outputCatalog);
    FluxResultKey fluxKey(inputCatalog.getSchema()[_name]);
    afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
    afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
    {
        // While noThrow is in scope, converting a negative flux to a magnitude
        // returns NaN rather than throwing.
        NoThrowOnNegativeFluxContext noThrow;
        for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
            FluxResult fluxResult = fluxKey.get(*inSrc);
            _magKey.set(*outSrc, calib.getMagnitude(fluxResult.flux, fluxResult.fluxSigma));
        }
    }
}

Member Data Documentation

MagResultKey lsst::meas::base::FluxTransform::_magKey

private

Definition at line 209 of file FluxUtilities.h.

---

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

• /home/lsstsw/stack/Linux64/meas_base/11.0.rc2+12/include/lsst/meas/base/FluxUtilities.h
• /home/lsstsw/stack/Linux64/meas_base/11.0.rc2+12/src/FluxUtilities.cc