LSSTApplications
18.0.0+106,18.0.0+50,19.0.0,19.0.0+1,19.0.0+10,19.0.0+11,19.0.0+13,19.0.0+17,19.0.0+2,19.0.0-1-g20d9b18+6,19.0.0-1-g425ff20,19.0.0-1-g5549ca4,19.0.0-1-g580fafe+6,19.0.0-1-g6fe20d0+1,19.0.0-1-g7011481+9,19.0.0-1-g8c57eb9+6,19.0.0-1-gb5175dc+11,19.0.0-1-gdc0e4a7+9,19.0.0-1-ge272bc4+6,19.0.0-1-ge3aa853,19.0.0-10-g448f008b,19.0.0-12-g6990b2c,19.0.0-2-g0d9f9cd+11,19.0.0-2-g3d9e4fb2+11,19.0.0-2-g5037de4,19.0.0-2-gb96a1c4+3,19.0.0-2-gd955cfd+15,19.0.0-3-g2d13df8,19.0.0-3-g6f3c7dc,19.0.0-4-g725f80e+11,19.0.0-4-ga671dab3b+1,19.0.0-4-gad373c5+3,19.0.0-5-ga2acb9c+2,19.0.0-5-gfe96e6c+2,w.2020.01
LSSTDataManagementBasePackage
|
Class to ensure constraints for spatial modeling. More...
#include <SpatialCell.h>
Public Types | |
typedef std::vector< std::shared_ptr< SpatialCellCandidate > > | CandidateList |
typedef SpatialCellCandidateIterator | iterator |
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... | |
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.
Definition at line 227 of file SpatialCell.h.
typedef std::vector<std::shared_ptr<SpatialCellCandidate> > lsst::afw::math::SpatialCell::CandidateList |
Definition at line 229 of file SpatialCell.h.
Definition at line 230 of file SpatialCell.h.
lsst::afw::math::SpatialCell::SpatialCell | ( | std::string const & | label, |
lsst::geom::Box2I const & | bbox = lsst::geom::Box2I() , |
||
CandidateList const & | candidateList = CandidateList() |
||
) |
Constructor.
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 73 of file SpatialCell.cc.
|
default |
|
default |
|
virtualdefault |
Destructor.
|
inline |
Return an iterator to the beginning of the Candidates.
Definition at line 267 of file SpatialCell.h.
|
inline |
ignoreBad | If true, ignore BAD candidates |
Definition at line 270 of file SpatialCell.h.
bool lsst::afw::math::SpatialCell::empty | ( | ) | const |
Determine if cell has no usable candidates.
Definition at line 99 of file SpatialCell.cc.
|
inline |
Return an iterator to (one after) the end of the Candidates.
Definition at line 277 of file SpatialCell.h.
|
inline |
ignoreBad | If true, ignore BAD candidates |
Definition at line 280 of file SpatialCell.h.
|
inline |
std::shared_ptr< SpatialCellCandidate > lsst::afw::math::SpatialCell::getCandidateById | ( | int | id, |
bool | noThrow = false |
||
) |
Return the SpatialCellCandidate with the specified id.
id | The desired ID |
noThrow | Return NULL in case of error |
lsst::pex::exceptions::NotFoundError | if no candidate matches the id |
Definition at line 121 of file SpatialCell.cc.
|
inline |
Get whether we are omitting BAD candidates from candidate list when traversing.
Definition at line 300 of file SpatialCell.h.
|
inline |
void lsst::afw::math::SpatialCell::insertCandidate | ( | std::shared_ptr< SpatialCellCandidate > | candidate | ) |
Add a candidate to the list, preserving ranking.
Definition at line 83 of file SpatialCell.cc.
|
default |
|
default |
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 89 of file SpatialCell.cc.
|
inline |
Set whether we should omit BAD candidates from candidate list when traversing.
Definition at line 298 of file SpatialCell.h.
size_t lsst::afw::math::SpatialCell::size | ( | ) | const |
Return number of usable candidates in Cell.
Definition at line 113 of file SpatialCell.cc.
void lsst::afw::math::SpatialCell::sortCandidates | ( | ) |
Rearrange the candidates to reflect their current ratings.
Definition at line 81 of file SpatialCell.cc.
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.
visitor | Pass this object to every Candidate |
ignoreExceptions | Ignore any exceptions thrown by |
reset | Reset visitor before passing it around |
Definition at line 193 of file SpatialCell.cc.
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
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 215 of file SpatialCell.cc.
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.
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 136 of file SpatialCell.cc.
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
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 163 of file SpatialCell.cc.