lsst::afw::detection::FootprintSet Class Reference

A set of Footprints, associated with a MaskedImage. More...

#include <FootprintSet.h>

Public Types
using	FootprintList = std::vector<std::shared_ptr<Footprint>>
	The FootprintSet's set of Footprints.

Public Member Functions
template<typename ImagePixelT>
	FootprintSet (image::Image< ImagePixelT > const &img, Threshold const &threshold, int const npixMin=1, bool const setPeaks=true, table::Schema const &peakSchema=PeakTable::makeMinimalSchema())
	Find a FootprintSet given an Image and a threshold.
template<typename MaskPixelT>
	FootprintSet (image::Mask< MaskPixelT > const &img, Threshold const &threshold, int const npixMin=1)
	Find a FootprintSet given a Mask and a threshold.
template<typename ImagePixelT, typename MaskPixelT>
	FootprintSet (image::MaskedImage< ImagePixelT, MaskPixelT > const &img, Threshold const &threshold, std::string const &planeName="", int const npixMin=1, bool const setPeaks=true)
	Find a FootprintSet given a MaskedImage and a threshold.
	FootprintSet (lsst::geom::Box2I region)
	Construct an empty FootprintSet given a region that its footprints would have lived in.
	FootprintSet (FootprintSet const &rhs)
	Copy constructor.
	FootprintSet (FootprintSet const &set, int rGrow, FootprintControl const &ctrl)
	FootprintSet (FootprintSet &&rhs)
	~FootprintSet ()
	FootprintSet (FootprintSet const &set, int rGrow, bool isotropic=true)
	Grow all the Footprints in the input FootprintSet, returning a new FootprintSet.
	FootprintSet (FootprintSet const &footprints1, FootprintSet const &footprints2, bool const includePeaks)
	Return the FootprintSet corresponding to the merge of two input FootprintSets.
FootprintSet &	operator= (FootprintSet const &rhs)
	Assignment operator.
FootprintSet &	operator= (FootprintSet &&rhs)
void	swap (FootprintSet &rhs) noexcept
void	swapFootprintList (FootprintList &rhs) noexcept
std::shared_ptr< FootprintList >	getFootprints ()
	: Return the Footprints of detected objects
void	setFootprints (std::shared_ptr< FootprintList > footprints)
	: Set the Footprints of detected objects
std::shared_ptr< FootprintList const > const	getFootprints () const
	Retun the Footprints of detected objects.
void	makeSources (afw::table::SourceCatalog &catalog) const
	Add a new record corresponding to each footprint to a SourceCatalog.
void	setRegion (lsst::geom::Box2I const &region)
	Set the corners of the FootprintSet's MaskedImage to region.
lsst::geom::Box2I const	getRegion () const
	Return the corners of the MaskedImage.
std::shared_ptr< image::Image< FootprintIdPixel > >	insertIntoImage () const
	Return an Image with pixels set to the Footprints in the FootprintSet.
template<typename MaskPixelT>
void	setMask (image::Mask< MaskPixelT > *mask, std::string const &planeName)
template<typename MaskPixelT>
void	setMask (std::shared_ptr< image::Mask< MaskPixelT > > mask, std::string const &planeName)
void	merge (FootprintSet const &rhs, int tGrow=0, int rGrow=0, bool isotropic=true)
	Merge a FootprintSet into *this.
template<typename ImagePixelT, typename MaskPixelT>
void	makeHeavy (image::MaskedImage< ImagePixelT, MaskPixelT > const &mimg, HeavyFootprintCtrl const *ctrl=nullptr)
	Convert all the Footprints in the FootprintSet to be HeavyFootprints.

Detailed Description

A set of Footprints, associated with a MaskedImage.

Definition at line 55 of file FootprintSet.h.

Member Typedef Documentation

FootprintList

using lsst::afw::detection::FootprintSet::FootprintList = std::vector<std::shared_ptr<Footprint>>

The FootprintSet's set of Footprints.

Definition at line 58 of file FootprintSet.h.

Constructor & Destructor Documentation

FootprintSet() [1/9]

template<typename ImagePixelT>

lsst::afw::detection::FootprintSet::FootprintSet	(	image::Image< ImagePixelT > const &	img,
		Threshold const &	threshold,
		int const	npixMin = 1,
		bool const	setPeaks = true,
		table::Schema const &	peakSchema = PeakTable::makeMinimalSchema() )

Find a FootprintSet given an Image and a threshold.

peakSchema is used to preserving the input peak schema when merging FootprintSets.

Parameters

img	Image to search for objects
threshold	threshold to find objects
npixMin	minimum number of pixels in an object
setPeaks	should I set the Peaks list?
peakSchema	Schema for peak records, even if we don't measure them here.

FootprintSet() [2/9]

template<typename MaskPixelT>

lsst::afw::detection::FootprintSet::FootprintSet	(	image::Mask< MaskPixelT > const &	img,
		Threshold const &	threshold,
		int const	npixMin = 1 )

Find a FootprintSet given a Mask and a threshold.

Parameters

img	Image to search for objects
threshold	threshold to find objects
npixMin	minimum number of pixels in an object

FootprintSet() [3/9]

template<typename ImagePixelT, typename MaskPixelT>

lsst::afw::detection::FootprintSet::FootprintSet	(	image::MaskedImage< ImagePixelT, MaskPixelT > const &	img,
		Threshold const &	threshold,
		std::string const &	planeName = "",
		int const	npixMin = 1,
		bool const	setPeaks = true )

Find a FootprintSet given a MaskedImage and a threshold.

Go through an image, finding sets of connected pixels above threshold and assembling them into Footprints; the resulting set of objects is returned

If threshold.getPolarity() is true, pixels above the Threshold are assembled into Footprints; if it's false, then pixels below Threshold are processed (Threshold will probably have to be below the background level for this to make sense, e.g. for difference imaging)

Parameters

img	MaskedImage to search for objects
threshold	threshold for footprints (controls size)
planeName	mask plane to set (if != "")
npixMin	minimum number of pixels in an object
setPeaks	should I set the Peaks list?

FootprintSet() [4/9]

lsst::afw::detection::FootprintSet::FootprintSet

(

lsst::geom::Box2I

region

)

Construct an empty FootprintSet given a region that its footprints would have lived in.

Parameters

region

the desired region

FootprintSet() [5/9]

lsst::afw::detection::FootprintSet::FootprintSet

(

FootprintSet const &

rhs

)

Copy constructor.

Parameters

rhs	the input FootprintSet

FootprintSet() [6/9]

lsst::afw::detection::FootprintSet::FootprintSet	(	FootprintSet const &	set,
		int	rGrow,
		FootprintControl const &	ctrl )

FootprintSet() [7/9]

lsst::afw::detection::FootprintSet::FootprintSet

(

FootprintSet &&

rhs

)

~FootprintSet()

lsst::afw::detection::FootprintSet::~FootprintSet

(

)

FootprintSet() [8/9]

lsst::afw::detection::FootprintSet::FootprintSet	(	FootprintSet const &	set,
		int	rGrow,
		bool	isotropic = true )

Grow all the Footprints in the input FootprintSet, returning a new FootprintSet.

The output FootprintSet may contain fewer Footprints, as some may well have been merged

Parameters

set	the input FootprintSet
rGrow	Grow Footprints by r pixels
isotropic	Grow isotropically (as opposed to a Manhattan metric)

Note

Isotropic grows are significantly slower

FootprintSet() [9/9]

lsst::afw::detection::FootprintSet::FootprintSet	(	FootprintSet const &	footprints1,
		FootprintSet const &	footprints2,
		bool const	includePeaks )

Return the FootprintSet corresponding to the merge of two input FootprintSets.

Todo

Implement this. There's RHL Pan-STARRS code to do it, but it isn't yet converted to LSST C++

Member Function Documentation

getFootprints() [1/2]

std::shared_ptr< FootprintList > lsst::afw::detection::FootprintSet::getFootprints ( )

inline

: Return the Footprints of detected objects

Definition at line 162 of file FootprintSet.h.

{ return _footprints; }

getFootprints() [2/2]

std::shared_ptr< FootprintList const > const lsst::afw::detection::FootprintSet::getFootprints ( ) const

inline

Retun the Footprints of detected objects.

Definition at line 172 of file FootprintSet.h.

{ return _footprints; }

getRegion()

lsst::geom::Box2I const lsst::afw::detection::FootprintSet::getRegion ( ) const

inline

Return the corners of the MaskedImage.

Definition at line 196 of file FootprintSet.h.

{ return _region; }

insertIntoImage()

std::shared_ptr< image::Image< FootprintIdPixel > > lsst::afw::detection::FootprintSet::insertIntoImage

(

)

const

Return an Image with pixels set to the Footprints in the FootprintSet.

Returns

an std::shared_ptr<image::Image>

makeHeavy()

template<typename ImagePixelT, typename MaskPixelT>

void lsst::afw::detection::FootprintSet::makeHeavy	(	image::MaskedImage< ImagePixelT, MaskPixelT > const &	mimg,
		HeavyFootprintCtrl const *	ctrl = nullptr )

Convert all the Footprints in the FootprintSet to be HeavyFootprints.

Parameters

mimg	the image providing pixel values
ctrl	Control how we manipulate HeavyFootprints

makeSources()

void lsst::afw::detection::FootprintSet::makeSources

(

afw::table::SourceCatalog &

catalog

)

const

Add a new record corresponding to each footprint to a SourceCatalog.

Parameters

[in,out]

catalog

Catalog to append new sources to.

The new sources will have their footprints set to point to the footprints in the footprint set; they will not be deep-copied.

merge()

void lsst::afw::detection::FootprintSet::merge	(	FootprintSet const &	rhs,
		int	tGrow = 0,
		int	rGrow = 0,
		bool	isotropic = true )

Merge a FootprintSet into *this.

Parameters

rhs	the Footprints to merge
tGrow	No. of pixels to grow this Footprints
rGrow	No. of pixels to grow rhs Footprints
isotropic	Grow isotropically (as opposed to a Manhattan metric)

operator=() [1/2]

FootprintSet & lsst::afw::detection::FootprintSet::operator=

(

FootprintSet &&

rhs

)

operator=() [2/2]

FootprintSet & lsst::afw::detection::FootprintSet::operator=

(

FootprintSet const &

rhs

)

Assignment operator.

setFootprints()

void lsst::afw::detection::FootprintSet::setFootprints ( std::shared_ptr< FootprintList > footprints )

inline

: Set the Footprints of detected objects

Definition at line 167 of file FootprintSet.h.

{ _footprints = footprints; }

setMask() [1/2]

template<typename MaskPixelT>

void lsst::afw::detection::FootprintSet::setMask ( image::Mask< MaskPixelT > * mask, std::string const & planeName )

inline

Parameters

mask	Set bits in the mask
planeName	Here's the name of the mask plane to fit

Definition at line 206 of file FootprintSet.h.

      {
        for (auto const& foot : *_footprints) {
            foot->getSpans()->setMask(*mask, image::Mask<MaskPixelT>::getPlaneBitMask(planeName));
        }
    }

setMask() [2/2]

template<typename MaskPixelT>

void lsst::afw::detection::FootprintSet::setMask ( std::shared_ptr< image::Mask< MaskPixelT > > mask, std::string const & planeName )

inline

Parameters

mask	Set bits in the mask
planeName	Here's the name of the mask plane to fit

Definition at line 215 of file FootprintSet.h.

      {
        setMask(mask.get(), planeName);
    }

setRegion()

void lsst::afw::detection::FootprintSet::setRegion

(

lsst::geom::Box2I const &

region

)

Set the corners of the FootprintSet's MaskedImage to region.

Parameters

region

desired region

Note

updates all the Footprints' regions too

swap()

void lsst::afw::detection::FootprintSet::swap ( FootprintSet & rhs )

inlinenoexcept

Definition at line 146 of file FootprintSet.h.

                                          {
        using std::swap;  // See Meyers, Effective C++, Item 25
        swap(*_footprints, *rhs.getFootprints());
        lsst::geom::Box2I rhsRegion = rhs.getRegion();
        rhs.setRegion(getRegion());
        setRegion(rhsRegion);
    }

swapFootprintList()

void lsst::afw::detection::FootprintSet::swapFootprintList ( FootprintList & rhs )

inlinenoexcept

Definition at line 154 of file FootprintSet.h.

                                                        {
        using std::swap;
        swap(*_footprints, rhs);
    }

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g083dd6704c+2e189452a7/include/lsst/afw/detection/FootprintSet.h