lsst::afw::math::SpatialCellCandidateIterator Class Reference

An iterator that only returns usable members of the SpatialCell. More...

#include <SpatialCell.h>

Public Member Functions
void	operator++ ()
	Advance the iterator, maybe skipping over candidates labelled BAD.
size_t	operator- (SpatialCellCandidateIterator const &rhs) const
	Return the number of candidate between this and rhs.
std::shared_ptr< SpatialCellCandidate const >	operator* () const
	Dereference the iterator to return the Candidate (if there is one)
std::shared_ptr< SpatialCellCandidate >	operator* ()
	Return the std::shared_ptr<CellCandidate>
bool	operator== (SpatialCellCandidateIterator const &rhs) const
	Are two SpatialCellCandidateIterators equal?
bool	operator!= (SpatialCellCandidateIterator const &rhs) const
	Are two SpatialCellCandidateIterators unequal?

Protected Member Functions
	SpatialCellCandidateIterator (CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad)
	ctor; designed to be used to pass begin to SpatialCellCandidateIterator
	SpatialCellCandidateIterator (CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad, bool)
	ctor; designed to be used to pass end to SpatialCellCandidateIterator

Friends
class	SpatialCell

Detailed Description

An iterator that only returns usable members of the SpatialCell.

Definition at line 159 of file SpatialCell.h.

Constructor & Destructor Documentation

SpatialCellCandidateIterator() [1/2]

lsst::afw::math::SpatialCellCandidateIterator::SpatialCellCandidateIterator ( CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad )

protected

ctor; designed to be used to pass begin to SpatialCellCandidateIterator

Parameters

iterator	Where this iterator should start
end	One-past-the-end of iterator's range
ignoreBad	Should we pass over bad Candidates?

Definition at line 239 of file SpatialCell.cc.

        : _iterator(iterator), _end(end), _ignoreBad(ignoreBad) {
    for (; _iterator != _end; ++_iterator) {
        (*_iterator)->instantiate();
 
        if (!(_ignoreBad && (*_iterator)->isBad())) {  // found a good candidate, or don't care
            return;
        }
    }
}

SpatialCellCandidateIterator() [2/2]

lsst::afw::math::SpatialCellCandidateIterator::SpatialCellCandidateIterator ( CandidateList::iterator iterator, CandidateList::iterator end, bool ignoreBad, bool  )

protected

ctor; designed to be used to pass end to SpatialCellCandidateIterator

Parameters

iterator	start of of iterator's range; not used
end	Where this iterator should start
ignoreBad	Should we pass over bad Candidates?

Definition at line 251 of file SpatialCell.cc.

        : _iterator(end), _end(end), _ignoreBad(ignoreBad) {
    if (ignoreBad) {
        // We could decrement end if there are bad Candidates at the end of the list, but it's probably
        // not worth the trouble
    }
}

Member Function Documentation

operator!=()

bool lsst::afw::math::SpatialCellCandidateIterator::operator!= ( SpatialCellCandidateIterator const & rhs ) const

inline

Are two SpatialCellCandidateIterators unequal?

Definition at line 186 of file SpatialCell.h.

{ return _iterator != rhs._iterator; }

operator*() [1/2]

std::shared_ptr< SpatialCellCandidate > lsst::afw::math::SpatialCellCandidateIterator::operator*

(

)

Return the std::shared_ptr<CellCandidate>

Definition at line 293 of file SpatialCell.cc.

                                                                            {
    if (_iterator == _end) {
        throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError, "Iterator points to end");
    }
 
    return *_iterator;
}

operator*() [2/2]

std::shared_ptr< SpatialCellCandidate const > lsst::afw::math::SpatialCellCandidateIterator::operator*

(

)

const

Dereference the iterator to return the Candidate (if there is one)

Exceptions

lsst::pex::exceptions::NotFoundError

if no candidate is available

Definition at line 285 of file SpatialCell.cc.

                                                                                        {
    if (_iterator == _end) {
        throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError, "Iterator points to end");
    }
 
    return *_iterator;
}

operator++()

void lsst::afw::math::SpatialCellCandidateIterator::operator++

(

)

Advance the iterator, maybe skipping over candidates labelled BAD.

Definition at line 260 of file SpatialCell.cc.

                                              {
    if (_iterator != _end) {
        ++_iterator;
    }
 
    for (; _iterator != _end; ++_iterator) {
        (*_iterator)->instantiate();
 
        if (!(_ignoreBad && (*_iterator)->isBad())) {  // found a good candidate, or don't care
            return;
        }
    }
}

operator-()

size_t lsst::afw::math::SpatialCellCandidateIterator::operator-

(

SpatialCellCandidateIterator const &

rhs

)

const

Return the number of candidate between this and rhs.

Definition at line 274 of file SpatialCell.cc.

                                                                                            {
    size_t n = 0;
    for (SpatialCellCandidateIterator ptr = rhs; ptr != *this; ++ptr) {
        if (!(_ignoreBad && (*ptr)->isBad())) {  // found a good candidate, or don't care
            ++n;
        }
    }
 
    return n;
}

operator==()

bool lsst::afw::math::SpatialCellCandidateIterator::operator== ( SpatialCellCandidateIterator const & rhs ) const

inline

Are two SpatialCellCandidateIterators equal?

Definition at line 184 of file SpatialCell.h.

{ return _iterator == rhs._iterator; }

Friends And Related Symbol Documentation

SpatialCell

friend class SpatialCell

friend

Definition at line 160 of file SpatialCell.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/math/SpatialCell.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/math/SpatialCell.cc