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

Base for instFlux measurement transformations. More...

#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::geom::SkyWcs const &wcs, afw::image::PhotoCalib const &photoCalib) const

Protected Member Functions
void	checkCatalogSize (afw::table::BaseCatalog const &cat1, afw::table::BaseCatalog const &cat2) const
	Ensure that catalogs have the same size.

Protected Attributes
std::string	_name

Detailed Description

Base for instFlux measurement transformations.

Provides a basic transform from instFlux 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 187 of file FluxUtilities.h.

Constructor & Destructor Documentation

FluxTransform()

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

Definition at line 79 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

checkCatalogSize()

void lsst::meas::base::BaseTransform::checkCatalogSize ( afw::table::BaseCatalog const & cat1, afw::table::BaseCatalog const & cat2 ) const

inlineprotectedinherited

Ensure that catalogs have the same size.

Parameters

[in]	cat1	Catalog for comparison
[in]	cat2	Catalog for comparison

Exceptions

LengthError

Catalog sizes do not match

Definition at line 102 of file Transform.h.

                                                                                                  {
        if (cat1.size() != cat2.size()) {
            throw LSST_EXCEPT(pex::exceptions::LengthError, "Catalog size mismatch");
        }
    }

operator()()

void lsst::meas::base::FluxTransform::operator() ( afw::table::SourceCatalog const & inputCatalog, afw::table::BaseCatalog & outputCatalog, afw::geom::SkyWcs const & wcs, afw::image::PhotoCalib const & photoCalib ) const

virtual

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

Definition at line 88 of file FluxUtilities.cc.

                                                                           {
    checkCatalogSize(inputCatalog, outputCatalog);
    FluxResultKey instFluxKey(inputCatalog.getSchema()[_name]);
    afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
    afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
    {
        for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
            FluxResult instFluxResult = instFluxKey.get(*inSrc);
            _magKey.set(*outSrc,
                        photoCalib.instFluxToMagnitude(instFluxResult.instFlux, instFluxResult.instFluxErr));
        }
    }
}

Member Data Documentation

_name

std::string lsst::meas::base::BaseTransform::_name

protectedinherited

Definition at line 107 of file Transform.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/meas_base/gd315a588df+5b65d88fe4/include/lsst/meas/base/FluxUtilities.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/meas_base/gd315a588df+5b65d88fe4/src/FluxUtilities.cc