LSST Applications
21.0.0+04719a4bac,21.0.0-1-ga51b5d4+f5e6047307,21.0.0-11-g2b59f77+a9c1acf22d,21.0.0-11-ga42c5b2+86977b0b17,21.0.0-12-gf4ce030+76814010d2,21.0.0-13-g1721dae+760e7a6536,21.0.0-13-g3a573fe+768d78a30a,21.0.0-15-g5a7caf0+f21cbc5713,21.0.0-16-g0fb55c1+b60e2d390c,21.0.0-19-g4cded4ca+71a93a33c0,21.0.0-2-g103fe59+bb20972958,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+3ad5d60fb1,21.0.0-2-g7f82c8f+8babb168e8,21.0.0-2-g8f08a60+06509c8b61,21.0.0-2-g8faa9b5+616205b9df,21.0.0-2-ga326454+8babb168e8,21.0.0-2-gde069b7+5e4aea9c2f,21.0.0-2-gecfae73+1d3a86e577,21.0.0-2-gfc62afb+3ad5d60fb1,21.0.0-25-g1d57be3cd+e73869a214,21.0.0-3-g357aad2+ed88757d29,21.0.0-3-g4a4ce7f+3ad5d60fb1,21.0.0-3-g4be5c26+3ad5d60fb1,21.0.0-3-g65f322c+e0b24896a3,21.0.0-3-g7d9da8d+616205b9df,21.0.0-3-ge02ed75+a9c1acf22d,21.0.0-4-g591bb35+a9c1acf22d,21.0.0-4-g65b4814+b60e2d390c,21.0.0-4-gccdca77+0de219a2bc,21.0.0-4-ge8a399c+6c55c39e83,21.0.0-5-gd00fb1e+05fce91b99,21.0.0-6-gc675373+3ad5d60fb1,21.0.0-64-g1122c245+4fb2b8f86e,21.0.0-7-g04766d7+cd19d05db2,21.0.0-7-gdf92d54+04719a4bac,21.0.0-8-g5674e7b+d1bd76f71f,master-gac4afde19b+a9c1acf22d,w.2021.13
LSST Data Management Base Package
|
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 |
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 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.