LSST Applications g034a557a3c+dd8dd8f11d,g0afe43252f+b86e4b8053,g11f7dcd041+017865fdd3,g1cd03abf6b+8446defddb,g1ce3e0751c+f991eae79d,g28da252d5a+ca8a1a9fb3,g2bbee38e9b+b6588ad223,g2bc492864f+b6588ad223,g2cdde0e794+8523d0dbb4,g347aa1857d+b6588ad223,g35bb328faa+b86e4b8053,g3a166c0a6a+b6588ad223,g461a3dce89+b86e4b8053,g52b1c1532d+b86e4b8053,g7f3b0d46df+ad13c1b82d,g80478fca09+f29c5d6c70,g858d7b2824+293f439f82,g8cd86fa7b1+af721d2595,g965a9036f2+293f439f82,g979bb04a14+51ed57f74c,g9ddcbc5298+f24b38b85a,gae0086650b+b86e4b8053,gbb886bcc26+b97e247655,gc28159a63d+b6588ad223,gc30aee3386+a2f0f6cab9,gcaf7e4fdec+293f439f82,gcd45df26be+293f439f82,gcdd4ae20e8+70b5def7e6,gce08ada175+da9c58a417,gcf0d15dbbd+70b5def7e6,gdaeeff99f8+006e14e809,gdbce86181e+6a170ce272,ge3d4d395c2+224150c836,ge5f7162a3a+bb2241c923,ge6cb8fbbf7+d119aed356,ge79ae78c31+b6588ad223,gf048a9a2f4+40ffced2b8,gf0baf85859+b4cca3d10f,w.2024.30
LSST Data Management Base Package
|
Class to ensure constraints for spatial modeling. More...
#include <SpatialCell.h>
Public Types | |
using | CandidateList = std::vector<std::shared_ptr<SpatialCellCandidate>> |
using | iterator = SpatialCellCandidateIterator |
Public Member Functions | |
SpatialCell (std::string const &label, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), CandidateList const &candidateList=CandidateList()) | |
Constructor. | |
SpatialCell (SpatialCell const &)=default | |
SpatialCell (SpatialCell &&)=default | |
SpatialCell & | operator= (SpatialCell const &)=default |
SpatialCell & | operator= (SpatialCell &&)=default |
virtual | ~SpatialCell ()=default |
Destructor. | |
bool | empty () const |
Determine if cell has no usable candidates. | |
size_t | size () const |
Return number of usable candidates in Cell. | |
void | sortCandidates () |
Rearrange the candidates to reflect their current ratings. | |
SpatialCellCandidateIterator | begin () |
Return an iterator to the beginning of the Candidates. | |
SpatialCellCandidateIterator | begin (bool ignoreBad) |
SpatialCellCandidateIterator | end () |
Return an iterator to (one after) the end of the Candidates. | |
SpatialCellCandidateIterator | end (bool ignoreBad) |
void | insertCandidate (std::shared_ptr< SpatialCellCandidate > candidate) |
Add a candidate to the list, preserving ranking. | |
void | removeCandidate (std::shared_ptr< SpatialCellCandidate > candidate) |
Remove a candidate from the list. | |
void | setIgnoreBad (bool ignoreBad) |
Set whether we should omit BAD candidates from candidate list when traversing. | |
bool | getIgnoreBad () const |
Get whether we are omitting BAD candidates from candidate list when traversing. | |
std::shared_ptr< SpatialCellCandidate > | getCandidateById (int id, bool noThrow=false) |
Return the SpatialCellCandidate with the specified id. | |
std::string const & | getLabel () const |
Get SpatialCell's label. | |
lsst::geom::Box2I const & | getBBox () const |
Get SpatialCell's BBox. | |
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. | |
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) | |
void | visitAllCandidates (CandidateVisitor *visitor, bool const ignoreExceptions=false, bool const reset=true) |
Call the visitor's processCandidate method for every Candidate in the SpatialCell. | |
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) | |
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 223 of file SpatialCell.h.
using lsst::afw::math::SpatialCell::CandidateList = std::vector<std::shared_ptr<SpatialCellCandidate>> |
Definition at line 225 of file SpatialCell.h.
Definition at line 226 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 71 of file SpatialCell.cc.
|
default |
|
default |
|
virtualdefault |
Destructor.
|
inline |
Return an iterator to the beginning of the Candidates.
Definition at line 263 of file SpatialCell.h.
|
inline |
ignoreBad | If true, ignore BAD candidates |
Definition at line 266 of file SpatialCell.h.
bool lsst::afw::math::SpatialCell::empty | ( | ) | const |
Determine if cell has no usable candidates.
Definition at line 97 of file SpatialCell.cc.
|
inline |
Return an iterator to (one after) the end of the Candidates.
Definition at line 273 of file SpatialCell.h.
|
inline |
ignoreBad | If true, ignore BAD candidates |
Definition at line 276 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 119 of file SpatialCell.cc.
|
inline |
Get whether we are omitting BAD candidates from candidate list when traversing.
Definition at line 296 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 81 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 87 of file SpatialCell.cc.
|
inline |
Set whether we should omit BAD candidates from candidate list when traversing.
Definition at line 294 of file SpatialCell.h.
size_t lsst::afw::math::SpatialCell::size | ( | ) | const |
Return number of usable candidates in Cell.
Definition at line 111 of file SpatialCell.cc.
void lsst::afw::math::SpatialCell::sortCandidates | ( | ) |
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 191 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 213 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 134 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 161 of file SpatialCell.cc.