lsst::meas::algorithms::Algorithm Class Reference

Base class for source measurement algorithms. More...

#include <Algorithm.h>

Inheritance diagram for lsst::meas::algorithms::Algorithm:

Public Member Functions
	Algorithm (AlgorithmControl const &ctrl)
virtual	~Algorithm ()
AlgorithmControl const &	getControl () const
	Return a clone of the control object used to construct the algorithm. More...
template<typename PixelT >
void	apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	Run the algorithm, filling appropriate fields in the given source. More...

Protected Member Functions
template<typename PixelT >
void	_apply (afw::table::SourceRecord &source, afw::image::Exposure< PixelT > const &exposure, afw::geom::Point2D const &center) const
	Simulated virtual function that all algorithms must implement. More...

Private Member Functions
virtual void	_applyT (lsst::afw::table::SourceRecord &, lsst::afw::image::Exposure< float > const &, lsst::afw::geom::Point2D const &center) const =0
virtual void	_applyT (lsst::afw::table::SourceRecord &, lsst::afw::image::Exposure< double > const &, lsst::afw::geom::Point2D const &center) const =0

Private Attributes
boost::shared_ptr < AlgorithmControl const >	_ctrl

Detailed Description

Base class for source measurement algorithms.

Algorithm simulates template virtual functions, with the following mechanism:

• Users call the public, templated, non-virtual "apply" member function, which is defined only in the base class.
• "apply" delegates to the overloaded, non-templated, virtual "_applyT" member functions.
• "_applyT" delegates to the private, templated, non-virtual "_apply" member function, which must be defined by the derived class.

Algorithm subclasses will generally declare and define "_applyT" using the macro LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE (in the private or protected section of the class declaration). Similarly, LSST_MEAS_ALGORITHM_PRIVATE_IMPLEMENTATION (at namespace scope in the same source file that contains the implementation of "_apply") will ensure that the needed versions of "_apply" are instantiated.

Algorithms should generally be immutable; this will prevent letting Python have access to CONST_PTR(Algorithm) objects from causing problems.

Most algorithms will have a constructor that takes a control object, a non-const reference to an afw::table::Schema, and a PTR(daf::base::PropertyList). This is effectively enforced by the signature of AlgorithmControl::makeAlgorithm.

Definition at line 106 of file Algorithm.h.

Constructor & Destructor Documentation

lsst::meas::algorithms::Algorithm::Algorithm ( AlgorithmControl const &  ctrl )

inlineexplicit

Definition at line 236 of file Algorithm.h.

: _ctrl(ctrl.clone()) {}

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

inlinevirtual

Definition at line 111 of file Algorithm.h.

{}

Member Function Documentation

template<typename PixelT >

void lsst::meas::algorithms::Algorithm::_apply ( afw::table::SourceRecord &  source, afw::image::Exposure< PixelT > const &  exposure, afw::geom::Point2D const &  center  ) const

inlineprotected

Simulated virtual function that all algorithms must implement.

Definition at line 142 of file Algorithm.h.

            {
        // This declaration is exposition only; subclasses must implement to allow the 
        // LSST_MEAS_ALGORITHM_PRIVATE_INTERFACE macro to do its work.
        BOOST_STATIC_ASSERT(sizeof(PixelT) < 0);
    }

virtual void lsst::meas::algorithms::Algorithm::_applyT ( lsst::afw::table::SourceRecord &  , lsst::afw::image::Exposure< float > const &  , lsst::afw::geom::Point2D const &  center  ) const

privatepure virtual

virtual void lsst::meas::algorithms::Algorithm::_applyT ( lsst::afw::table::SourceRecord &  , lsst::afw::image::Exposure< double > const &  , lsst::afw::geom::Point2D const &  center  ) const

privatepure virtual

template<typename PixelT >

void lsst::meas::algorithms::Algorithm::apply ( afw::table::SourceRecord &  source, afw::image::Exposure< PixelT > const &  exposure, afw::geom::Point2D const &  center  ) const

inline

Run the algorithm, filling appropriate fields in the given source.

This is the public interface to the algorithm; it delegates to virtual functions that are overloaded for all the allowed template types. These in turn delegate the templated _apply function.

Definition at line 130 of file Algorithm.h.

            {
        this->_applyT(source, exposure, center);
    }

AlgorithmControl const& lsst::meas::algorithms::Algorithm::getControl ( ) const

inline

Return a clone of the control object used to construct the algorithm.

The returned reference can be considered completely immutable, and should never be changed. Subclasses that reimplement to cast to a derived type should use returnCopy (in p_lsstSwig.i) to prevent dangling references and keep Python from const-casting the result.

Definition at line 120 of file Algorithm.h.

{ return *_ctrl; }

Member Data Documentation

boost::shared_ptr< AlgorithmControl const> lsst::meas::algorithms::Algorithm::_ctrl

private

Definition at line 157 of file Algorithm.h.

---

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/Algorithm.h