lsst::afw::detection::FootprintFunctor< ImageT > Class Template Reference

A functor class to allow users to process all the pixels in a Footprint. More...

#include <FootprintFunctor.h>

Public Member Functions
	FootprintFunctor (ImageT const &image)
virtual	~FootprintFunctor ()=0
virtual void	reset ()
virtual void	reset (Footprint const &)
void	apply (Footprint const &foot, int const margin=0)
	Apply operator() to each pixel in the Footprint. More...
ImageT const &	getImage () const
	Return the image. More...
virtual void	operator() (typename ImageT::xy_locator loc, int x, int y)=0

Private Attributes
ImageT const &	_image

Detailed Description

template<typename ImageT>
class lsst::afw::detection::FootprintFunctor< ImageT >

A functor class to allow users to process all the pixels in a Footprint.

There's an annotated example of a FootprintFunctor in action FootprintFunctors here

Examples:

footprintFunctor.cc.

Definition at line 40 of file FootprintFunctor.h.

Constructor & Destructor Documentation

template<typename ImageT>

lsst::afw::detection::FootprintFunctor< ImageT >::FootprintFunctor ( ImageT const &  image )

inline

Parameters

image

The image that the Footprint lives in

Definition at line 42 of file FootprintFunctor.h.

                      : _image(image) {}

template<typename ImageT >

lsst::afw::detection::FootprintFunctor< ImageT >::~FootprintFunctor ( )

pure virtual

Although FootprintFunctor is pure virtual, this is needed by subclasses

It wasn't defined in the class body as I want swig to know that the class is pure virtual

Definition at line 137 of file FootprintFunctor.h.

{}

Member Function Documentation

template<typename ImageT>

void lsst::afw::detection::FootprintFunctor< ImageT >::apply ( Footprint const &  foot, int const  margin = 0  )

inline

Apply operator() to each pixel in the Footprint.

Parameters

foot	The Footprint in question
margin	The required margin from the edge of the image

Definition at line 57 of file FootprintFunctor.h.

                {
        reset();
        reset(foot);

        if (foot.getSpans().empty()) {
            return;
        }

        geom::Box2I const bbox = foot.getBBox();
        geom::Box2I region = foot.getRegion();
        if (!region.isEmpty() &&
            (!region.contains(bbox.getMin()) || !region.contains(bbox.getMax()))) {
            throw LSST_EXCEPT(
                lsst::pex::exceptions::LengthError,
                (boost::format("Footprint with BBox (%d,%d) -- (%dx%d)"
                               "doesn't fit in image with BBox (%d,%d) -- (%dx%d)"
                               ) % bbox.getMinX() % bbox.getMinY() 
                               % bbox.getMaxX() % bbox.getMaxY() 
                               % region.getMinX() % region.getMinY() 
                               % region.getMaxX() % region.getMaxY()
                ).str()
            );
        }

        // Current position of the locator (in the SpanList loop)
        int ox1 = 0, oy = 0;            
        
        int const x0 = _image.getX0();
        int const y0 = _image.getY0();

        typename ImageT::xy_locator loc = _image.xy_at(-x0, -y0); // Origin of the Image's pixels

        int const width = _image.getWidth();
        int const height = _image.getHeight();
        for (Footprint::SpanList::const_iterator siter = foot.getSpans().begin();
             siter != foot.getSpans().end(); siter++) {
            Span::Ptr const span = *siter;

            int const y = span->getY();
            if (y - y0 < margin || y - y0 >= height - margin) {
                continue;
            }
            int sx0 = span->getX0();
            int sx1 = span->getX1();
            if (sx0 - x0 < margin) {
                sx0 = margin + x0;
            }
            if (sx1 - x0 >= width - margin) {
                sx1 = width + x0 - margin - 1;
            }

            loc += lsst::afw::image::pair2I(sx0 - ox1, y - oy);

            for (int x = sx0; x <= sx1; ++x, ++loc.x()) {
                operator()(loc, x, y);
            }

            ox1 = sx1 + 1; oy = y;
        }
    }

template<typename ImageT>

ImageT const& lsst::afw::detection::FootprintFunctor< ImageT >::getImage ( ) const

inline

Return the image.

Definition at line 120 of file FootprintFunctor.h.

{ return _image; }    

template<typename ImageT>

virtual void lsst::afw::detection::FootprintFunctor< ImageT >::operator() ( typename ImageT::xy_locator  loc, int  x, int  y  )

pure virtual

The operator to be applied to each pixel in the Footprint.

N.b. the coordinates (x, y) are relative to the origin of the image's parent if it exists (i.e. they obey getX0/getY0)

Implemented in lsst::meas::algorithms::FootprintWeightFlux< MaskedImageT, WeightImageT >, and lsst::meas::algorithms::FootprintFlux< MaskedImageT >.

template<typename ImageT>

virtual void lsst::afw::detection::FootprintFunctor< ImageT >::reset ( )

inlinevirtual

A function that's called at the beginning of apply; useful if apply calculates a per-footprint quantity

Reimplemented in lsst::meas::algorithms::FootprintWeightFlux< MaskedImageT, WeightImageT >, and lsst::meas::algorithms::FootprintFlux< MaskedImageT >.

Definition at line 51 of file FootprintFunctor.h.

{}

template<typename ImageT>

virtual void lsst::afw::detection::FootprintFunctor< ImageT >::reset ( Footprint const &  )

inlinevirtual

Reimplemented in lsst::meas::algorithms::FootprintWeightFlux< MaskedImageT, WeightImageT >, and lsst::meas::algorithms::FootprintFlux< MaskedImageT >.

Definition at line 52 of file FootprintFunctor.h.

{}

Member Data Documentation

template<typename ImageT>

ImageT const& lsst::afw::detection::FootprintFunctor< ImageT >::_image

private

Definition at line 128 of file FootprintFunctor.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/afw/master-gae20e2b580+3/include/lsst/afw/detection/FootprintFunctor.h