lsst::meas::base::ApertureFluxTransform Class Reference

Measurement transformation for aperture fluxes. More...

#include <ApertureFlux.h>

Inheritance diagram for lsst::meas::base::ApertureFluxTransform:

Public Types
typedef ApertureFluxControl	Control

Public Member Functions
	ApertureFluxTransform (Control const &ctrl, 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. More...

Protected Attributes
std::string	_name

Detailed Description

Measurement transformation for aperture fluxes.

Transforms instFluxes with associated errors to magnitudes. Correctly handles multiple apertures. Flags are propagated from input to output.

Definition at line 242 of file ApertureFlux.h.

Member Typedef Documentation

Control

typedef ApertureFluxControl lsst::meas::base::ApertureFluxTransform::Control

Definition at line 244 of file ApertureFlux.h.

Constructor & Destructor Documentation

ApertureFluxTransform()

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

Definition at line 256 of file ApertureFlux.cc.

        : BaseTransform(name), _ctrl(ctrl) {
    for (std::size_t i = 0; i < _ctrl.radii.size(); ++i) {
        for (std::size_t j = 0; j < ApertureFluxAlgorithm::getFlagDefinitions().size(); j++) {
            FlagDefinition const &flag = ApertureFluxAlgorithm::getFlagDefinitions()[j];
            if (_ctrl.radii[i] > _ctrl.maxSincRadius &&
                flag == ApertureFluxAlgorithm::SINC_COEFFS_TRUNCATED) {
                continue;
            }
            mapper.addMapping(
                    mapper.getInputSchema()
                            .find<afw::table::Flag>(
                                    (boost::format("%s_%s") %
                                     ApertureFluxAlgorithm::makeFieldPrefix(name, _ctrl.radii[i]) % flag.name)
                                            .str())
                            .key);
        }
        _magKeys.push_back(MagResultKey::addFields(
                mapper.editOutputSchema(), ApertureFluxAlgorithm::makeFieldPrefix(name, _ctrl.radii[i])));
    }
}

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::ApertureFluxTransform::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 279 of file ApertureFlux.cc.

                                                                                   {
    checkCatalogSize(inputCatalog, outputCatalog);
    std::vector<FluxResultKey> instFluxKeys;
    for (std::size_t i = 0; i < _ctrl.radii.size(); ++i) {
        instFluxKeys.push_back(FluxResultKey(
                inputCatalog.getSchema()[ApertureFluxAlgorithm::makeFieldPrefix(_name, _ctrl.radii[i])]));
    }
    afw::table::SourceCatalog::const_iterator inSrc = inputCatalog.begin();
    afw::table::BaseCatalog::iterator outSrc = outputCatalog.begin();
    {
        for (; inSrc != inputCatalog.end() && outSrc != outputCatalog.end(); ++inSrc, ++outSrc) {
            for (std::size_t i = 0; i < _ctrl.radii.size(); ++i) {
                FluxResult instFluxResult = instFluxKeys[i].get(*inSrc);
                _magKeys[i].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-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/include/lsst/meas/base/ApertureFlux.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_base/22.0.1-25-gb120d7b+8b5510f75f/src/ApertureFlux.cc