Template Class MaskedImage::MaskedImageIteratorBase

Nested Relationships

This class is a nested type of Template Class MaskedImage.

Class Documentation

template<typename ImageIterator, typename MaskIterator, typename VarianceIterator, template<typename> class Ref = Reference>
class MaskedImageIteratorBase

The base class for MaskedImageIterators (const and non-const)

Public Types

template<>
typedef boost::zip_iterator<IMV_iterator_tuple>::reference IMV_tuple

The underlying iterator tuple

Note

not really for public consumption; could be made protected

template<>
typedef Pixel type

Type pointed to by the iterator.

Public Functions

template<>
MaskedImageIteratorBase(ImageIterator const &img, MaskIterator const &msk, VarianceIterator const &var)

Construct a MaskedImageIteratorBase from the image/mask/variance iterators.

template<>
Ref<ImagePixelT>::type image()

Return (a reference to) the image part of the Pixel pointed at by the iterator.

template<>
Ref<MaskPixelT>::type mask()

Return (a reference to) the mask part of the Pixel pointed at by the iterator.

template<>
Ref<VariancePixelT>::type variance()

Return (a reference to) the variance part of the Pixel pointed at by the iterator.

template<>
const IMV_iterator_tuple get_iterator_tuple() const

Return the underlying iterator tuple

Note

not really for public consumption; could be made protected

template<>
MaskedImageIteratorBase &operator+=(std::ptrdiff_t delta)

Increment the iterator by delta

Parameters

  • delta: how far to move the iterator

template<>
MaskedImageIteratorBase &operator-=(std::ptrdiff_t delta)

Decrement the iterator by delta

Parameters

  • delta: how far to move the iterator

template<>
MaskedImageIteratorBase &operator++()

Increment the iterator (prefix)

template<>
MaskedImageIteratorBase operator++(int)

Increment the iterator (postfix)

template<>
std::ptrdiff_t operator-(MaskedImageIteratorBase const &rhs)

Return the distance between two iterators.

template<>
bool operator==(MaskedImageIteratorBase const &rhs)

Return true if the lhs equals the rhs.

template<>
bool operator!=(MaskedImageIteratorBase const &rhs)

Return true if the lhs doesn’t equal the rhs.

template<>
bool operator<(MaskedImageIteratorBase const &rhs)

Return true if the lhs is less than the rhs.

template<>
operator Pixel() const

Convert an iterator to a Pixel.

template<>
Pixel operator*()

Dereference the iterator, returning a Pixel.

template<>
const Pixel operator*() const

Dereference the iterator, returning a const Pixel.

Protected Attributes

template<>
boost::zip_iterator<IMV_iterator_tuple> _iter

Friends

friend lsst::afw::image::MaskedImage::MaskedImageIteratorBase::const_MaskedImageIterator

The underlying const iterator tuple

Note

not really for public consumption; could be made protected