A collection of SpatialCells covering an entire image.
More...
#include <SpatialCell.h>
A collection of SpatialCells covering an entire image.
Definition at line 383 of file SpatialCell.h.
◆ CellList
◆ 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
-
Definition at line 301 of file SpatialCell.cc.
◆ SpatialCellSet() [2/3]
lsst::afw::math::SpatialCellSet::SpatialCellSet |
( |
SpatialCellSet const & | | ) |
|
|
default |
◆ SpatialCellSet() [3/3]
◆ ~SpatialCellSet()
virtual lsst::afw::math::SpatialCellSet::~SpatialCellSet |
( |
| ) |
|
|
virtualdefault |
◆ getBBox()
Return the bounding box of the image.
Definition at line 416 of file SpatialCell.h.
◆ getCandidateById()
◆ getCellList()
CellList & lsst::afw::math::SpatialCellSet::getCellList |
( |
| ) |
|
|
inline |
◆ insertCandidate()
Insert a candidate into the correct cell.
Definition at line 359 of file SpatialCell.cc.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ 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.
◆ 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.
◆ 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.
◆ 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.
◆ 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.
◆ 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.
The documentation for this class was generated from the following files: