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

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

#include <SpatialCell.h>

Public Types
using	CellList = std::vector<std::shared_ptr<SpatialCell>>

Public Member Functions
	SpatialCellSet (lsst::geom::Box2I const &region, int xSize, int ySize=0)
	Constructor.
	SpatialCellSet (SpatialCellSet const &)=default
	SpatialCellSet (SpatialCellSet &&)=default
SpatialCellSet &	operator= (SpatialCellSet const &)=default
SpatialCellSet &	operator= (SpatialCellSet &&)=default
virtual	~SpatialCellSet ()=default
	Destructor.
CellList &	getCellList ()
	Return our SpatialCells.
lsst::geom::Box2I	getBBox () const
	Return the bounding box of the image.
void	insertCandidate (std::shared_ptr< SpatialCellCandidate > candidate)
	Insert a candidate into the correct cell.
void	sortCandidates ()
	Rearrange the Candidates in all SpatialCells to reflect their current ratings.
void	visitCandidates (CandidateVisitor *visitor, int const nMaxPerCell=-1, bool const ignoreExceptions=false)
	Call the visitor's processCandidate method for each Candidate in the SpatialCellSet.
void	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)
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false)
	Call the visitor's processCandidate method for every Candidate in the SpatialCellSet.
void	visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false) const
	Call the visitor's processCandidate method for every Candidate in the SpatialCellSet (const version)
std::shared_ptr< SpatialCellCandidate >	getCandidateById (int id, bool noThrow=false)
	Return the SpatialCellCandidate with the specified id.
void	setIgnoreBad (bool ignoreBad)
	Set whether we should omit BAD candidates from candidate list when traversing.

Detailed Description

A collection of SpatialCells covering an entire image.

Definition at line 383 of file SpatialCell.h.

Member Typedef Documentation

CellList

using lsst::afw::math::SpatialCellSet::CellList = std::vector<std::shared_ptr<SpatialCell>>

Definition at line 385 of file SpatialCell.h.

Constructor & Destructor Documentation

SpatialCellSet() [1/3]

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

Constructor.

Parameters

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

Exceptions

lsst::pex::exceptions::LengthError

if nx or ny is non-positive

Definition at line 301 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;
            lsst::geom::Box2I bbox(lsst::geom::Point2I(x0, y0), lsst::geom::Point2I(x1, y1));
            std::string label = (boost::format("Cell %dx%d") % x % y).str();
 
            _cellList.push_back(std::make_shared<SpatialCell>(label, bbox));
 
            x0 = x1 + 1;
        }
        y0 = y1 + 1;
    }
}

SpatialCellSet() [2/3]

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

default

SpatialCellSet() [3/3]

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

default

~SpatialCellSet()

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

virtualdefault

Destructor.

Member Function Documentation

getBBox()

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

inline

Return the bounding box of the image.

Definition at line 416 of file SpatialCell.h.

{ return _region; };

getCandidateById()

std::shared_ptr< SpatialCellCandidate > lsst::afw::math::SpatialCellSet::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 (unless noThrow is true, in which case a null pointer is returned

Definition at line 414 of file SpatialCell.cc.

                                                                                         {
    for (auto const &cell : _cellList) {
        std::shared_ptr<SpatialCellCandidate> cand = cell->getCandidateById(id, true);
 
        if (cand) {
            return cand;
        }
    }
 
    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());
    }
}

getCellList()

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

inline

Return our SpatialCells.

Definition at line 411 of file SpatialCell.h.

{ return _cellList; }

insertCandidate()

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

(

std::shared_ptr< SpatialCellCandidate >

candidate

)

Insert a candidate into the correct cell.

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

operator=() [1/2]

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

default

operator=() [2/2]

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

default

setIgnoreBad()

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

(

bool

ignoreBad

)

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

Definition at line 431 of file SpatialCell.cc.

                                                {
    for (auto const &cell : _cellList) {
        cell->setIgnoreBad(ignoreBad);
    }
}

sortCandidates()

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

(

)

Rearrange the Candidates in all SpatialCells to reflect their current ratings.

Definition at line 372 of file SpatialCell.cc.

                                    {
    for (auto const &cell : _cellList) {
        cell->sortCandidates();
    }
}

visitAllCandidates() [1/2]

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

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

Parameters

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

See also

visitCandidates

Definition at line 397 of file SpatialCell.cc.

                                                                                              {
    visitor->reset();
 
    for (auto const &cell : _cellList) {
        cell->visitAllCandidates(visitor, ignoreExceptions, false);
    }
}

visitAllCandidates() [2/2]

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

                                                                                                    {
    visitor->reset();
 
    for (auto const &cell : _cellList) {
        SpatialCell const *ccell = cell.get();  // the SpatialCellSet's SpatialCells should be const too
        ccell->visitAllCandidates(visitor, ignoreExceptions, false);
    }
}

visitCandidates() [1/2]

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.

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

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

                                                                  {
    visitor->reset();
 
    for (auto const &cell : _cellList) {
        cell->visitCandidates(visitor, nMaxPerCell, ignoreExceptions, false);
    }
}

visitCandidates() [2/2]

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

                                                                        {
    visitor->reset();
 
    for (auto const &cell : _cellList) {
        SpatialCell const *ccell = cell.get();  // the SpatialCellSet's SpatialCells should be const too
        ccell->visitCandidates(visitor, nMaxPerCell, ignoreExceptions, false);
    }
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/math/SpatialCell.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/math/SpatialCell.cc