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

#include <FootprintSet.h>

Inheritance diagram for lsst::afw::detection::FootprintSet:

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

enum	{ magicSentinel = 0xdeadbeef }

typedef unsigned long	memId
	Type of the block's ID. More...

typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...

typedef memId(*	memCallback) (const Citizen *ptr)

Public Member Functions
template<typename ImagePixelT >
	FootprintSet (image::Image< ImagePixelT > const &img, Threshold const &threshold, int const npixMin=1, bool const setPeaks=true)
	Find a FootprintSet given an Image and a threshold. More...

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. More...

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. More...

	FootprintSet (lsst::geom::Box2I region)
	Construct an empty FootprintSet given a region that its footprints would have lived in. More...

	FootprintSet (FootprintSet const &rhs)
	Copy constructor. More...

	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. More...

	FootprintSet (FootprintSet const &footprints1, FootprintSet const &footprints2, bool const includePeaks)
	Return the FootprintSet corresponding to the merge of two input FootprintSets. More...

FootprintSet &	operator= (FootprintSet const &rhs)
	Assignment operator. More...

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 More...

void	setFootprints (std::shared_ptr< FootprintList > footprints)
	: Set the Footprints of detected objects More...

std::shared_ptr< FootprintList const > const	getFootprints () const
	Retun the Footprints of detected objects. More...

void	makeSources (afw::table::SourceCatalog &catalog) const
	Add a new record corresponding to each footprint to a SourceCatalog. More...

void	setRegion (lsst::geom::Box2I const &region)
	Set the corners of the FootprintSet's MaskedImage to region. More...

lsst::geom::Box2I const	getRegion () const
	Return the corners of the MaskedImage. More...

std::shared_ptr< image::Image< FootprintIdPixel > >	insertIntoImage (const bool relativeIDs) const
	Return an Image with pixels set to the Footprints in the FootprintSet. More...

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. More...

template<typename ImagePixelT , typename MaskPixelT >
void	makeHeavy (image::MaskedImage< ImagePixelT, MaskPixelT > const &mimg, HeavyFootprintCtrl const *ctrl=NULL)
	Convert all the Footprints in the FootprintSet to be HeavyFootprints. More...

std::string	repr () const
	Return a string representation of a Citizen. More...

void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...

memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...

static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...

static int	init ()
	Called once when the memory system is being initialised. More...

Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...

static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...

static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...

callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...

static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...

callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...

static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...

static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

A set of Footprints, associated with a MaskedImage.

Definition at line 53 of file FootprintSet.h.

Member Typedef Documentation

◆ FootprintList

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

The FootprintSet's set of Footprints.

Definition at line 56 of file FootprintSet.h.

◆ memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

◆ memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

◆ memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

88 { magicSentinel = 0xdeadbeef };

lsst::daf::base::Citizen::magicSentinel

Definition: Citizen.h:88

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`
	)

Find a FootprintSet given an Image and a threshold.

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?

◆ 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

◆ census() [1/3]

int lsst::daf::base::Citizen::census	(	int	,
		memId	startingMemId = `0`
	)

staticinherited

How many active Citizens are there?

Parameters

startingMemId Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

   {
     if (startingMemId == 0) {  // easy
         ReadGuard guard(citizenLock);
         return _activeCitizens.size();
     }
 
     int n = 0;
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_CitizenId >= startingMemId) {
             n++;
         }
     }
 
     return n;
 }

◆ census() [2/3]

void lsst::daf::base::Citizen::census	(	std::ostream &	stream,
		memId	startingMemId = `0`
	)

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

   {
     ReadGuard guard(citizenLock);
 
     std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());
 
     for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
          citizen != end; ++citizen) {
         if ((*citizen)->getId() >= startingMemId) {
             stream << (*citizen)->repr() << "\n";
         }
     }
 }

◆ census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                                {
     std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
     ReadGuard guard(citizenLock);
     vec->reserve(_activeCitizens.size());
 
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         vec->push_back(dynamic_cast<Citizen const*>(cur->first));
     }
 
     std::sort(vec->begin(), vec->end(), cmpId);
 
     return vec;
 }

◆ getFootprints() [1/2]

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

inline

: Return the Footprints of detected objects

Definition at line 156 of file FootprintSet.h.

156 { 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 166 of file FootprintSet.h.

166 { return _footprints; }

◆ getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

206 { return _CitizenId; }

◆ getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

209 { return _nextMemId(); }

◆ getRegion()

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

inline

Return the corners of the MaskedImage.

Definition at line 190 of file FootprintSet.h.

190 { return _region; }

◆ hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                       {
     ReadGuard guard(citizenLock);
     for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
     for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
         if (cur->first->_hasBeenCorrupted()) {
             return true;
         }
     }
 
     return false;
 }

◆ init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                          {
     volatile int dummy = 1;
     return dummy;
 }

◆ insertIntoImage()

std::shared_ptr<image::Image<FootprintIdPixel> > lsst::afw::detection::FootprintSet::insertIntoImage ( const bool relativeIDs ) const

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

Parameters

relativeIDs Use IDs starting at 0 (rather than the ones in the Footprints)

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 = `NULL`
	)

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.

◆ markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                         {
     WriteGuard guard(citizenLock);
     _persistentCitizens[this] = _activeCitizens[this];
     _activeCitizens.erase(this);
 }

◆ 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	Use (expensive) isotropic grow

◆ operator=() [1/2]

FootprintSet& lsst::afw::detection::FootprintSet::operator= ( FootprintSet const & rhs )

Assignment operator.

◆ operator=() [2/2]

FootprintSet& lsst::afw::detection::FootprintSet::operator= ( FootprintSet && rhs )

◆ repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                      {
     return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                       lsst::utils::demangleType(_typeName));
 }

◆ setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

   {
     Citizen::memCallback old = _corruptionCallback;
     _corruptionCallback = func;
 
     return old;
 }

◆ setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

   {
     Citizen::memCallback old = _deleteCallback;
     _deleteCallback = func;
 
     return old;
 }

◆ setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _deleteId;
     _deleteId = id;
 
     return oldId;
 }

◆ setFootprints()

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

inline

: Set the Footprints of detected objects

Definition at line 161 of file FootprintSet.h.

161 { _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 201 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 210 of file FootprintSet.h.

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

◆ setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

   {
     Citizen::memNewCallback old = _newCallback;
     _newCallback = func;
 
     return old;
 }

◆ setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

   {
     WriteGuard guard(citizenLock);
     Citizen::memId oldId = _newId;
     _newId = id;
 
     return oldId;
 }

◆ 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 140 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 148 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/Linux64/afw/17.0.1-30-g596af8797/include/lsst/afw/detection/FootprintSet.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ FootprintList

◆ memCallback

◆ memId

◆ memNewCallback

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FootprintSet() [1/9]

◆ FootprintSet() [2/9]

◆ FootprintSet() [3/9]

◆ FootprintSet() [4/9]

◆ FootprintSet() [5/9]

◆ FootprintSet() [6/9]

◆ FootprintSet() [7/9]

◆ ~FootprintSet()

◆ FootprintSet() [8/9]

◆ FootprintSet() [9/9]

Member Function Documentation

◆ census() [1/3]

◆ census() [2/3]

◆ census() [3/3]

◆ getFootprints() [1/2]

◆ getFootprints() [2/2]

◆ getId()

◆ getNextMemId()

◆ getRegion()

◆ hasBeenCorrupted()

◆ init()

◆ insertIntoImage()

◆ makeHeavy()

◆ makeSources()

◆ markPersistent()

◆ merge()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ repr()

◆ setCorruptionCallback()

◆ setDeleteCallback()

◆ setDeleteCallbackId()

◆ setFootprints()

◆ setMask() [1/2]

◆ setMask() [2/2]

◆ setNewCallback()

◆ setNewCallbackId()

◆ setRegion()

◆ swap()

◆ swapFootprintList()