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

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

#include <SpatialCell.h>

Public Types
typedef boost::shared_ptr < SpatialCell >	Ptr
typedef boost::shared_ptr < const SpatialCell >	ConstPtr
typedef std::vector < boost::shared_ptr < SpatialCellCandidate > >	CandidateList
typedef SpatialCellCandidateIterator	iterator

Public Member Functions
	SpatialCell (std::string const &label, lsst::afw::geom::Box2I const &bbox=lsst::afw::geom::Box2I(), CandidateList const &candidateList=CandidateList())
virtual	~SpatialCell ()
bool	empty () const
size_t	size () const
void	sortCandidates ()
SpatialCellCandidateIterator	begin ()
SpatialCellCandidateIterator	begin (bool ignoreBad)
SpatialCellCandidateIterator	end ()
SpatialCellCandidateIterator	end (bool ignoreBad)
void	insertCandidate (boost::shared_ptr< SpatialCellCandidate > candidate)
void	removeCandidate (boost::shared_ptr< SpatialCellCandidate > candidate)
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...
boost::shared_ptr < SpatialCellCandidate >	getCandidateById (int id, bool noThrow=false)
std::string const &	getLabel () const
lsst::afw::geom::Box2I const &	getBBox () const
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false, bool const reset=true)
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false, bool const reset=true) const
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false, bool const reset=true)
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false, bool const reset=true) const

Private Attributes
std::string	_label
lsst::afw::geom::Box2I	_bbox
CandidateList	_candidateList
bool	_ignoreBad

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

SpatialCellSetExample

Definition at line 290 of file SpatialCell.h.

Member Typedef Documentation

typedef std::vector<boost::shared_ptr< SpatialCellCandidate > > lsst::afw::math::SpatialCell::CandidateList

Definition at line 294 of file SpatialCell.h.

typedef boost::shared_ptr<const SpatialCell> lsst::afw::math::SpatialCell::ConstPtr

Definition at line 293 of file SpatialCell.h.

typedef SpatialCellCandidateIterator lsst::afw::math::SpatialCell::iterator

Examples:

spatialCellExample.cc.

Definition at line 295 of file SpatialCell.h.

typedef boost::shared_ptr<SpatialCell> lsst::afw::math::SpatialCell::Ptr

Examples:

spatialCellExample.cc.

Definition at line 292 of file SpatialCell.h.

Constructor & Destructor Documentation

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

Constructor

Ctor

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 80 of file SpatialCell.cc.

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

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

inlinevirtual

Destructor

Definition at line 306 of file SpatialCell.h.

{;};

Member Function Documentation

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

inline

Return an iterator to the beginning of the Candidates

Definition at line 315 of file SpatialCell.h.

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

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

inline

Parameters

ignoreBad

If true, ignore BAD candidates

Definition at line 318 of file SpatialCell.h.

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

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

(

)

const

Determine if cell has no usable candidates

Definition at line 128 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 (SpatialCellCandidateIterator ptr = mthis->begin(), end = mthis->end(); ptr != end; ++ptr) {
        if (!(_ignoreBad && (*ptr)->isBad())) { // found a good candidate, or don't care
            return false;
        }
    }

    return true;
}

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

inline

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

Definition at line 325 of file SpatialCell.h.

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

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

inline

Parameters

ignoreBad

If true, ignore BAD candidates

Definition at line 328 of file SpatialCell.h.

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

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

inline

Get SpatialCell's BBox

Definition at line 355 of file SpatialCell.h.

{ return _bbox; }

SpatialCellCandidate::Ptr lsst::afw::math::SpatialCell::getCandidateById	(	int	id,
		bool	noThrow = false
	)

Return the SpatialCellCandidate with the specified id

Exceptions

lsst::pex::exceptions::NotFoundError

if no candidate matches the id

Parameters

id	The desired ID
noThrow	Return NULL in case of error

Definition at line 159 of file SpatialCell.cc.

                                                         {
    for (SpatialCellCandidateIterator ptr = begin(), end = this->end(); ptr != end; ++ptr) {
        if ((*ptr)->getId() == id) {
            return *ptr;
        }
    }

    if (noThrow) {
        return SpatialCellCandidate::Ptr();
    } else {
        throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError,
                          (boost::format("Unable to find object with ID == %d") % id).str());
    }
}

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

inline

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

Definition at line 345 of file SpatialCell.h.

{ return _ignoreBad; }

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

inline

Get SpatialCell's label

Definition at line 351 of file SpatialCell.h.

{ return _label; }

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

(

boost::shared_ptr< SpatialCellCandidate >

candidate

)

Add a candidate to the list, preserving ranking

Definition at line 108 of file SpatialCell.cc.

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

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

(

boost::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 114 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);
}

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

inline

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

Definition at line 343 of file SpatialCell.h.

{ _ignoreBad = ignoreBad; }

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

(

)

const

Return number of usable candidates in Cell

Definition at line 145 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();
}

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

(

)

Rearrange the candidates to reflect their current ratings

Definition at line 99 of file SpatialCell.cc.

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

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

See Also

visitCandidates

Parameters

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

Definition at line 261 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;
            }
        }
    }
}

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

Todo:

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

Parameters

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

Definition at line 293 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
}

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

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)

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

Definition at line 183 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;
            }
        }
    }
}

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

Todo:

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

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

Definition at line 222 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
}

Member Data Documentation

lsst::afw::geom::Box2I lsst::afw::math::SpatialCell::_bbox

private

Definition at line 370 of file SpatialCell.h.

CandidateList lsst::afw::math::SpatialCell::_candidateList

private

Definition at line 371 of file SpatialCell.h.

bool lsst::afw::math::SpatialCell::_ignoreBad

private

Definition at line 372 of file SpatialCell.h.

std::string lsst::afw::math::SpatialCell::_label

private

Definition at line 369 of file SpatialCell.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/SpatialCell.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/SpatialCell.cc