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++ ()
size_t	operator- (SpatialCellCandidateIterator const &rhs) const
boost::shared_ptr < SpatialCellCandidate const >	operator* () const
boost::shared_ptr < SpatialCellCandidate >	operator* ()
	Return the CellCandidate::Ptr. More...
bool	operator== (SpatialCellCandidateIterator const &rhs) const
	Are two SpatialCellCandidateIterators equal? More...
bool	operator!= (SpatialCellCandidateIterator const &rhs) const
	Are two SpatialCellCandidateIterators unequal? More...

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

Private Types
typedef std::vector < boost::shared_ptr < SpatialCellCandidate > >	CandidateList

Private Attributes
CandidateList::iterator	_iterator
CandidateList::iterator	_end
bool	_ignoreBad

Friends
class	SpatialCell

Detailed Description

An iterator that only returns usable members of the SpatialCell.

Definition at line 247 of file SpatialCell.h.

Member Typedef Documentation

typedef std::vector<boost::shared_ptr< SpatialCellCandidate > > lsst::afw::math::SpatialCellCandidateIterator::CandidateList

private

Definition at line 249 of file SpatialCell.h.

Constructor & Destructor Documentation

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 324 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;
        }
    }
}

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 340 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

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

inline

Are two SpatialCellCandidateIterators unequal?

Definition at line 264 of file SpatialCell.h.

                                                                       {
            return _iterator != rhs._iterator;
        }

SpatialCellCandidate::ConstPtr 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 389 of file SpatialCell.cc.

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

    return *_iterator;
}

SpatialCellCandidate::Ptr lsst::afw::math::SpatialCellCandidateIterator::operator*

(

)

Return the CellCandidate::Ptr.

Definition at line 398 of file SpatialCell.cc.

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

    return *_iterator;
}

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

(

)

Advance the iterator, maybe skipping over candidates labelled BAD

Definition at line 356 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;
        }
    }
}

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

(

SpatialCellCandidateIterator const &

rhs

)

const

Return the number of candidate between this and rhs

Definition at line 373 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;
}

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

inline

Are two SpatialCellCandidateIterators equal?

Definition at line 260 of file SpatialCell.h.

                                                                       {
            return _iterator == rhs._iterator;
        }

Friends And Related Function Documentation

friend class SpatialCell

friend

Definition at line 248 of file SpatialCell.h.

Member Data Documentation

CandidateList::iterator lsst::afw::math::SpatialCellCandidateIterator::_end

private

Definition at line 274 of file SpatialCell.h.

bool lsst::afw::math::SpatialCellCandidateIterator::_ignoreBad

private

Definition at line 275 of file SpatialCell.h.

CandidateList::iterator lsst::afw::math::SpatialCellCandidateIterator::_iterator

private

Definition at line 273 of file SpatialCell.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/math/SpatialCell.h
• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/src/math/SpatialCell.cc