lsst::afw::math::SpatialCell Class Reference

Class to ensure constraints for spatial modeling. More...

#include <SpatialCell.h>

Public Types
using	CandidateList = std::vector< std::shared_ptr< SpatialCellCandidate > >
using	iterator = SpatialCellCandidateIterator

Public Member Functions
	SpatialCell (std::string const &label, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), CandidateList const &candidateList=CandidateList())
	Constructor. More...
	SpatialCell (SpatialCell const &)=default
	SpatialCell (SpatialCell &&)=default
SpatialCell &	operator= (SpatialCell const &)=default
SpatialCell &	operator= (SpatialCell &&)=default
virtual	~SpatialCell ()=default
	Destructor. More...
bool	empty () const
	Determine if cell has no usable candidates. More...
size_t	size () const
	Return number of usable candidates in Cell. More...
void	sortCandidates ()
	Rearrange the candidates to reflect their current ratings. More...
SpatialCellCandidateIterator	begin ()
	Return an iterator to the beginning of the Candidates. More...
SpatialCellCandidateIterator	begin (bool ignoreBad)
SpatialCellCandidateIterator	end ()
	Return an iterator to (one after) the end of the Candidates. More...
SpatialCellCandidateIterator	end (bool ignoreBad)
void	insertCandidate (std::shared_ptr< SpatialCellCandidate > candidate)
	Add a candidate to the list, preserving ranking. More...
void	removeCandidate (std::shared_ptr< SpatialCellCandidate > candidate)
	Remove a candidate from the list. More...
void	setIgnoreBad (bool ignoreBad)
	Set whether we should omit BAD candidates from candidate list when traversing. More...
bool	getIgnoreBad () const
	Get whether we are omitting BAD candidates from candidate list when traversing. More...
std::shared_ptr< SpatialCellCandidate >	getCandidateById (int id, bool noThrow=false)
	Return the SpatialCellCandidate with the specified id. More...
std::string const &	getLabel () const
	Get SpatialCell's label. More...
lsst::geom::Box2I const &	getBBox () const
	Get SpatialCell's BBox. More...
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false, bool const reset=true)
	Call the visitor's processCandidate method for each Candidate in the SpatialCell. More...
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false, bool const reset=true) const
	Call the visitor's processCandidate method for each Candidate in the SpatialCell (const version) More...
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false, bool const reset=true)
	Call the visitor's processCandidate method for every Candidate in the SpatialCell. More...
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false, bool const reset=true) const
	Call the visitor's processCandidate method for each Candidate in the SpatialCell (const version) More...

Detailed Description

Class to ensure constraints for spatial modeling.

A given image is divided up into cells, with each cell represented by an instance of this class. Each cell itself contains a list of instances of classes derived from SpatialCellCandidate. One class member from each cell will be chosen to fit to a spatial model. In case of a poor fit, the next class instance in the list will be fit for. If all instances in a list are rejected from the spatial model, the best one will be used.

See also

The SpatialCellSet example in the module documentation.

Definition at line 223 of file SpatialCell.h.

Member Typedef Documentation

CandidateList

using lsst::afw::math::SpatialCell::CandidateList = std::vector<std::shared_ptr<SpatialCellCandidate> >

Definition at line 225 of file SpatialCell.h.

iterator

using lsst::afw::math::SpatialCell::iterator = SpatialCellCandidateIterator

Definition at line 226 of file SpatialCell.h.

Constructor & Destructor Documentation

SpatialCell() [1/3]

lsst::afw::math::SpatialCell::SpatialCell	(	std::string const &	label,
		lsst::geom::Box2I const &	bbox = lsst::geom::Box2I(),
		CandidateList const &	candidateList = CandidateList()
	)

Constructor.

Parameters

label	string representing "name" of cell
bbox	Bounding box of cell in overall image
candidateList	list of candidates to represent this cell

Definition at line 72 of file SpatialCell.cc.

        : _label(label), _bbox(bbox), _candidateList(candidateList), _ignoreBad(true) {
    LOGL_DEBUG("lsst.afw.math.SpatialCell", "Cell %s : created with %d candidates", this->_label.c_str(),
               this->_candidateList.size());
    sortCandidates();
}

SpatialCell() [2/3]

lsst::afw::math::SpatialCell::SpatialCell ( SpatialCell const &  )

default

SpatialCell() [3/3]

lsst::afw::math::SpatialCell::SpatialCell ( SpatialCell &&  )

default

~SpatialCell()

virtual lsst::afw::math::SpatialCell::~SpatialCell ( )

virtualdefault

Destructor.

Member Function Documentation

begin() [1/2]

SpatialCellCandidateIterator lsst::afw::math::SpatialCell::begin ( )

inline

Return an iterator to the beginning of the Candidates.

Definition at line 263 of file SpatialCell.h.

                                         {
        return SpatialCellCandidateIterator(_candidateList.begin(), _candidateList.end(), _ignoreBad);
    }

begin() [2/2]

SpatialCellCandidateIterator lsst::afw::math::SpatialCell::begin ( bool  ignoreBad )

inline

Parameters

ignoreBad

If true, ignore BAD candidates

Definition at line 266 of file SpatialCell.h.

      {
        return SpatialCellCandidateIterator(_candidateList.begin(), _candidateList.end(), ignoreBad);
    }

empty()

bool lsst::afw::math::SpatialCell::empty

(

)

const

Determine if cell has no usable candidates.

Definition at line 98 of file SpatialCell.cc.

                              {
    // Cast away const;  end is only non-const as it provides access to the Candidates
    // and we don't (yet) have SpatialCellCandidateConstIterator
    SpatialCell *mthis = const_cast<SpatialCell *>(this);
 
    for (auto && mthi : *mthis) {
        if (!(_ignoreBad && (mthi)->isBad())) {  // found a good candidate, or don't care
            return false;
        }
    }
 
    return true;
}

end() [1/2]

SpatialCellCandidateIterator lsst::afw::math::SpatialCell::end ( )

inline

Return an iterator to (one after) the end of the Candidates.

Definition at line 273 of file SpatialCell.h.

                                       {
        return SpatialCellCandidateIterator(_candidateList.begin(), _candidateList.end(), _ignoreBad, true);
    }

end() [2/2]

SpatialCellCandidateIterator lsst::afw::math::SpatialCell::end ( bool  ignoreBad )

inline

Parameters

ignoreBad

If true, ignore BAD candidates

Definition at line 276 of file SpatialCell.h.

      {
        return SpatialCellCandidateIterator(_candidateList.begin(), _candidateList.end(), ignoreBad, true);
    }

getBBox()

lsst::geom::Box2I const& lsst::afw::math::SpatialCell::getBBox ( ) const

inline

Get SpatialCell's BBox.

Definition at line 314 of file SpatialCell.h.

{ return _bbox; }

getCandidateById()

std::shared_ptr< SpatialCellCandidate > lsst::afw::math::SpatialCell::getCandidateById	(	int	id,
		bool	noThrow = false
	)

Return the SpatialCellCandidate with the specified id.

Parameters

id	The desired ID
noThrow	Return NULL in case of error

Exceptions

lsst::pex::exceptions::NotFoundError

if no candidate matches the id

Definition at line 120 of file SpatialCell.cc.

                                                                                      {
    for (SpatialCellCandidateIterator ptr = begin(), end = this->end(); ptr != end; ++ptr) {
        if ((*ptr)->getId() == id) {
            return *ptr;
        }
    }
 
    if (noThrow) {
        return std::shared_ptr<SpatialCellCandidate>();
    } else {
        throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError,
                          (boost::format("Unable to find object with ID == %d") % id).str());
    }
}

getIgnoreBad()

bool lsst::afw::math::SpatialCell::getIgnoreBad ( ) const

inline

Get whether we are omitting BAD candidates from candidate list when traversing.

Definition at line 296 of file SpatialCell.h.

{ return _ignoreBad; }

getLabel()

std::string const& lsst::afw::math::SpatialCell::getLabel ( ) const

inline

Get SpatialCell's label.

Definition at line 310 of file SpatialCell.h.

{ return _label; }

insertCandidate()

void lsst::afw::math::SpatialCell::insertCandidate

(

std::shared_ptr< SpatialCellCandidate >

candidate

)

Add a candidate to the list, preserving ranking.

Definition at line 82 of file SpatialCell.cc.

                                                                               {
    CandidateList::iterator pos =
            std::lower_bound(_candidateList.begin(), _candidateList.end(), candidate, CandidatePtrMore());
    _candidateList.insert(pos, candidate);
}

operator=() [1/2]

SpatialCell& lsst::afw::math::SpatialCell::operator= ( SpatialCell &&  )

default

operator=() [2/2]

SpatialCell& lsst::afw::math::SpatialCell::operator= ( SpatialCell const &  )

default

removeCandidate()

void lsst::afw::math::SpatialCell::removeCandidate

(

std::shared_ptr< SpatialCellCandidate >

candidate

)

Remove a candidate from the list.

This is not a particularly efficient operation, since we're using a std::vector, but should not hurt too much if the number of candidates in a cell is small.

Definition at line 88 of file SpatialCell.cc.

                                                                               {
    CandidateList::iterator pos = std::find(_candidateList.begin(), _candidateList.end(), candidate);
    if (pos == _candidateList.end()) {
        throw LSST_EXCEPT(
                lsst::pex::exceptions::NotFoundError,
                (boost::format("Unable to find candidate with ID == %d") % candidate->getId()).str());
    }
    _candidateList.erase(pos);
}

setIgnoreBad()

void lsst::afw::math::SpatialCell::setIgnoreBad ( bool  ignoreBad )

inline

Set whether we should omit BAD candidates from candidate list when traversing.

Definition at line 294 of file SpatialCell.h.

{ _ignoreBad = ignoreBad; }

size()

size_t lsst::afw::math::SpatialCell::size

(

)

const

Return number of usable candidates in Cell.

Definition at line 112 of file SpatialCell.cc.

                               {
    // Cast away const; begin/end is only non-const as they provide access to the Candidates
    // and we don't (yet) have SpatialCellCandidateConstIterator
    SpatialCell *mthis = const_cast<SpatialCell *>(this);
 
    return mthis->end() - mthis->begin();
}

sortCandidates()

void lsst::afw::math::SpatialCell::sortCandidates

(

)

Rearrange the candidates to reflect their current ratings.

Definition at line 80 of file SpatialCell.cc.

{ sort(_candidateList.begin(), _candidateList.end(), CandidatePtrMore()); }

visitAllCandidates() [1/2]

void lsst::afw::math::SpatialCell::visitAllCandidates	(	CandidateVisitor *	visitor,
		bool const	ignoreExceptions = false,
		bool const	reset = true
	)

Call the visitor's processCandidate method for every Candidate in the SpatialCell.

Parameters

visitor	Pass this object to every Candidate
ignoreExceptions	Ignore any exceptions thrown by
reset	Reset visitor before passing it around

See also

visitCandidates

Definition at line 192 of file SpatialCell.cc.

                                                       {
    if (reset) {
        visitor->reset();
    }
 
    int i = 0;
    for (SpatialCell::iterator candidate = begin(false), candidateEnd = end(false); candidate != candidateEnd;
         ++candidate, ++i) {
        try {
            visitor->processCandidate((*candidate).get());
        } catch (lsst::pex::exceptions::LengthError &e) {
            if (ignoreExceptions) {
                ;
            } else {
                LSST_EXCEPT_ADD(e, "Visiting candidate");
                throw e;
            }
        }
    }
}

visitAllCandidates() [2/2]

void lsst::afw::math::SpatialCell::visitAllCandidates	(	CandidateVisitor *	visitor,
		bool const	ignoreExceptions = false,
		bool const	reset = true
	)		const

Call the visitor's processCandidate method for each Candidate in the SpatialCell (const version)

This is the const version of SpatialCellSet::visitAllCandidates

Parameters

visitor	Pass this object to every Candidate
ignoreExceptions	Ignore any exceptions thrown by the processing
reset	Reset visitor before passing it around

Todo:

This is currently implemented via a const_cast (arghhh). The problem is that SpatialCell::begin() const isn't yet implemented

Definition at line 214 of file SpatialCell.cc.

                                                             {
#if 1
    //
    // This const_cast must go!
    //
    SpatialCell *mthis = const_cast<SpatialCell *>(this);
    mthis->visitAllCandidates(visitor, ignoreExceptions, reset);
#else
    int i = 0;
    for (SpatialCell::const_iterator candidate = (*cell)->begin(false), candidateEnd = (*cell)->end(false);
         candidate != candidateEnd; ++candidate, ++i) {
        try {
            visitor->processCandidate((*candidate).get());
        } catch (lsst::pex::exceptions::LengthError &e) {
            if (ignoreExceptions) {
                ;
            } else {
                LSST_EXCEPT_ADD(e, "Visiting candidate");
                throw e;
            }
        }
    }
#endif
}

visitCandidates() [1/2]

void lsst::afw::math::SpatialCell::visitCandidates	(	CandidateVisitor *	visitor,
		int const	nMaxPerCell = -1,
		bool const	ignoreExceptions = false,
		bool const	reset = true
	)

Call the visitor's processCandidate method for each Candidate in the SpatialCell.

Parameters

visitor	Pass this object to every Candidate
nMaxPerCell	Visit no more than this many Candidates (<= 0: all)
ignoreExceptions	Ignore any exceptions thrown by the processing
reset	Reset visitor before passing it around

Note

This is obviously similar to the Design Patterns (Go4) Visitor pattern, but we've simplified the double dispatch (i.e. we don't call a virtual method on SpatialCellCandidate that in turn calls processCandidate(*this), but can be re-defined)

Definition at line 135 of file SpatialCell.cc.

                                                                                 {
    if (reset) {
        visitor->reset();
    }
 
    int i = 0;
    for (SpatialCell::iterator candidate = begin(), candidateEnd = end(); candidate != candidateEnd;
         ++candidate, ++i) {
        if (nMaxPerCell > 0 && i == nMaxPerCell) {  // we've processed all the candidates we want
            return;
        }
 
        try {
            visitor->processCandidate((*candidate).get());
        } catch (lsst::pex::exceptions::Exception &e) {
            if (ignoreExceptions) {
                ;
            } else {
                LSST_EXCEPT_ADD(e, "Visiting candidate");
                throw e;
            }
        }
    }
}

visitCandidates() [2/2]

void lsst::afw::math::SpatialCell::visitCandidates	(	CandidateVisitor *	visitor,
		int const	nMaxPerCell = -1,
		bool const	ignoreExceptions = false,
		bool const	reset = true
	)		const

Call the visitor's processCandidate method for each Candidate in the SpatialCell (const version)

This is the const version of SpatialCellSet::visitCandidates

Parameters

visitor	Pass this object to every Candidate
nMaxPerCell	Visit no more than this many Candidates (-ve: all)
ignoreExceptions	Ignore any exceptions thrown by the processing
reset	Reset visitor before passing it around

Todo:

This is currently implemented via a const_cast (arghhh). The problem is that SpatialCell::begin() const isn't yet implemented

Definition at line 162 of file SpatialCell.cc.

                                                                                       {
#if 1
    //
    // This const_cast must go!
    //
    SpatialCell *mthis = const_cast<SpatialCell *>(this);
    mthis->visitCandidates(visitor, nMaxPerCell, ignoreExceptions, reset);
#else
    int i = 0;
    for (SpatialCell::const_iterator candidate = (*cell)->begin(), candidateEnd = (*cell)->end();
         candidate != candidateEnd; ++candidate, ++i) {
        if (i == nMaxPerCell) {  // we've processed all the candidates we want
            return;
        }
 
        try {
            visitor->processCandidate((*candidate).get());
        } catch (lsst::pex::exceptions::LengthError &e) {
            if (ignoreExceptions) {
                ;
            } else {
                LSST_EXCEPT_ADD(e, "Visiting candidate");
                throw e;
            }
        }
    }
#endif
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/math/SpatialCell.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/math/SpatialCell.cc