lsst::afw::math::SpatialCellSet Class Reference

A collection of SpatialCells covering an entire image. More...

#include <SpatialCell.h>

Public Types
typedef boost::shared_ptr < SpatialCellSet >	Ptr
typedef boost::shared_ptr < const SpatialCellSet >	ConstPtr
typedef std::vector < boost::shared_ptr < SpatialCell > >	CellList

Public Member Functions
	SpatialCellSet (lsst::afw::geom::Box2I const &region, int xSize, int ySize=0)
virtual	~SpatialCellSet ()
CellList &	getCellList ()
lsst::afw::geom::Box2I	getBBox () const
void	insertCandidate (boost::shared_ptr< SpatialCellCandidate > candidate)
void	sortCandidates ()
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false)
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false) const
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false)
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false) const
boost::shared_ptr < SpatialCellCandidate >	getCandidateById (int id, bool noThrow=false)
void	setIgnoreBad (bool ignoreBad)
	Set whether we should omit BAD candidates from candidate list when traversing. More...

Private Attributes
lsst::afw::geom::Box2I	_region
CellList	_cellList

Detailed Description

A collection of SpatialCells covering an entire image.

Definition at line 378 of file SpatialCell.h.

Member Typedef Documentation

typedef std::vector<boost::shared_ptr< SpatialCell > > lsst::afw::math::SpatialCellSet::CellList

Definition at line 383 of file SpatialCell.h.

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

Definition at line 381 of file SpatialCell.h.

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

Definition at line 380 of file SpatialCell.h.

Constructor & Destructor Documentation

lsst::afw::math::SpatialCellSet::SpatialCellSet	(	lsst::afw::geom::Box2I const &	region,
		int	xSize,
		int	ySize = 0
	)

Constructor

Exceptions

lsst::pex::exceptions::LengthError

if nx or ny is non-positive

Parameters

region	Bounding box for image
xSize	size of cells in the column direction
ySize	size of cells in the row direction (0: == xSize)

Definition at line 413 of file SpatialCell.cc.

                                :
    _region(region), _cellList(CellList()) {
    if (ySize == 0) {
        ySize = xSize;
    }
    
    if (xSize <= 0 || ySize <= 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::LengthError,
                          (boost::format("Please specify cells that contain pixels, not %dx%d") %
                           xSize % ySize).str());
    }
    
    int nx = region.getWidth()/xSize;
    if (nx*xSize != region.getWidth()) {
        nx++;
    }

    int ny = region.getHeight()/ySize;
    if (ny*ySize != region.getHeight()) {
        ny++;
    }
    //
    // N.b. the SpatialCells will be sorted in y at the end of this
    //
    int y0 = region.getMinY();
    for (int y = 0; y < ny; ++y) {
        // ny may not be a factor of height
        int const y1 = (y == ny - 1) ? region.getMaxY() : y0 + ySize - 1; 
        int x0 = region.getMinX();
        for (int x = 0; x < nx; ++x) {
            // nx may not be a factor of width
            int const x1 = (x == nx - 1) ? region.getMaxX() : x0 + xSize - 1; 
            geom::Box2I bbox(geom::Point2I(x0, y0), geom::Point2I(x1, y1));
            std::string label = (boost::format("Cell %dx%d") % x % y).str();

            _cellList.push_back(SpatialCell::Ptr(new SpatialCell(label, bbox)));        

            x0 = x1 + 1;
        }
        y0 = y1 + 1;
    }
}

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

inlinevirtual

Destructor

Definition at line 390 of file SpatialCell.h.

{;};

Member Function Documentation

lsst::afw::geom::Box2I lsst::afw::math::SpatialCellSet::getBBox ( ) const

inline

Return the bounding box of the image

Definition at line 400 of file SpatialCell.h.

{ return _region; };

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

Return the SpatialCellCandidate with the specified id

Exceptions

lsst::pex::exceptions::NotFoundError

if no candidate matches the id (unless noThrow is true, in which case a Ptr(NULL) is returned

Parameters

id	The desired ID
noThrow	Return NULL in case of error

Definition at line 581 of file SpatialCell.cc.

                                                         {
    for (CellList::iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        SpatialCellCandidate::Ptr cand = (*cell)->getCandidateById(id, true);

        if (cand) {
            return cand;
        }
    }

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

CellList& lsst::afw::math::SpatialCellSet::getCellList ( )

inline

Return our SpatialCells

Definition at line 395 of file SpatialCell.h.

{ return _cellList; }

void lsst::afw::math::SpatialCellSet::insertCandidate

(

boost::shared_ptr< SpatialCellCandidate >

candidate

)

Insert a candidate into the correct cell

Definition at line 478 of file SpatialCell.cc.

                                                                      {
    CellList::iterator pos = std::find_if(_cellList.begin(), _cellList.end(), CellContains(candidate));

    if (pos == _cellList.end()) {
        throw LSST_EXCEPT(lsst::pex::exceptions::OutOfRangeError,
                          (boost::format("Unable to insert a candidate at (%.2f, %.2f)") %
                           candidate->getXCenter() % candidate->getYCenter()).str());
    }

    (*pos)->insertCandidate(candidate);
}

void lsst::afw::math::SpatialCellSet::setIgnoreBad

(

bool

ignoreBad

)

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

Definition at line 601 of file SpatialCell.cc.

                                                {
    for (CellList::iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        (*cell)->setIgnoreBad(ignoreBad);
    }
}

void lsst::afw::math::SpatialCellSet::sortCandidates

(

)

Rearrange the Candidates in all SpatialCells to reflect their current ratings

Definition at line 495 of file SpatialCell.cc.

{
    for (CellList::iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        (*cell)->sortCandidates();
    }
}

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

Call the visitor's processCandidate method for every Candidate in the SpatialCellSet

See Also

visitCandidates

Parameters

visitor	Pass this object to every Candidate
ignoreExceptions	Ignore any exceptions thrown by the processing

Definition at line 546 of file SpatialCell.cc.

                                      {
    visitor->reset();
    
    for (CellList::iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        (*cell)->visitAllCandidates(visitor, ignoreExceptions, false);
    }
}

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

Call the visitor's processCandidate method for every Candidate in the SpatialCellSet (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

Definition at line 562 of file SpatialCell.cc.

                                            {
    visitor->reset();

    for (CellList::const_iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        SpatialCell const *ccell = cell->get(); // the SpatialCellSet's SpatialCells should be const too
        ccell->visitAllCandidates(visitor, ignoreExceptions, false);
    }
}

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

Call the visitor's processCandidate method for each Candidate in the SpatialCellSet

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

Definition at line 510 of file SpatialCell.cc.

                                      {
    visitor->reset();
    
    for (CellList::iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        (*cell)->visitCandidates(visitor, nMaxPerCell, ignoreExceptions, false);
    }
}

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

Call the visitor's processCandidate method for each Candidate in the SpatialCellSet (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

Definition at line 527 of file SpatialCell.cc.

                                            {
    visitor->reset();

    for (CellList::const_iterator cell = _cellList.begin(), end = _cellList.end(); cell != end; ++cell) {
        SpatialCell const *ccell = cell->get(); // the SpatialCellSet's SpatialCells should be const too
        ccell->visitCandidates(visitor, nMaxPerCell, ignoreExceptions, false);
    }
}

Member Data Documentation

CellList lsst::afw::math::SpatialCellSet::_cellList

private

Definition at line 419 of file SpatialCell.h.

lsst::afw::geom::Box2I lsst::afw::math::SpatialCellSet::_region

private

Definition at line 418 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