lsst.afw  21.0.0-46-g27369044f+532d44eec1
Public Types | Public Member Functions | Protected Attributes | List of all members
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > Class Template Reference

A const locator for the MaskedImage. More...

#include <MaskedImage.h>

Inheritance diagram for lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >:
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference >

Public Types

typedef boost::tuple< typename ImageLocator::cached_location_t, typename MaskLocator::cached_location_t, typename VarianceLocator::cached_location_t > IMVCachedLocation
 
typedef _x_or_y_iterator< apply_x > x_iterator
 An x_iterator that provides a view of the xy_locator (i.e. advancing one advances the other) More...
 
typedef _x_or_y_iterator< apply_y > y_iterator
 A y_iterator that provides a view of the xy_locator (i.e. advancing one advances the other) More...
 
typedef boost::mpl::vector< ImagePixelT, MaskPixelT, VariancePixelT > PixelTVec
 

Public Member Functions

 const_MaskedImageLocator (MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > const &iter)
 
Pixel operator* ()
 Dereference a locator, returning a Pixel. More...
 
Pixel operator() (int x, int y)
 Dereference a locator, returning a Pixel offset by (x, y) from the locator. More...
 
Pixel operator[] (cached_location_t const &cached_loc)
 Dereference a locator, returning a Pixel offset by the amount set when we created the cached_location_t More...
 
x_iterator x ()
 Return an iterator that can be used to move (or dereference) a locator. More...
 
y_iterator y ()
 Return an iterator that can be used to move (or dereference) a locator. More...
 
cached_location_t cache_location (int x, int y) const
 Create a cached_location_t offset by (x, y) from locator. More...
 
ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type apply_IMV (cached_location_t const &cached_loc)
 
ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type apply_IMV ()
 
ConstReference< typename boost::mpl::at< PixelTVec, N >::type >::type apply_IMV (int x, int y)
 
ConstReference< ImagePixelT >::type image (cached_location_t const &cached_loc)
 Return a reference to the image at the offset set when we created the cached_location_t More...
 
ConstReference< ImagePixelT >::type image ()
 Return a reference to the image at the current position of the locator. More...
 
ConstReference< ImagePixelT >::type image (int x, int y)
 Return a reference to the image offset by (x, y) from the current position of the locator. More...
 
ConstReference< MaskPixelT >::type mask (cached_location_t const &cached_loc)
 Return a reference to the mask at the offset set when we created the cached_location_t More...
 
ConstReference< MaskPixelT >::type mask ()
 Return a reference to the mask at the current position of the locator. More...
 
ConstReference< MaskPixelT >::type mask (int x, int y)
 Return a reference to the mask offset by (x, y) from the current position of the locator. More...
 
ConstReference< VariancePixelT >::type variance (cached_location_t const &cached_loc)
 Return a reference to the variance at the offset set when we created the cached_location_t More...
 
ConstReference< VariancePixelT >::type variance ()
 Return a reference to the variance at the current position of the locator. More...
 
ConstReference< VariancePixelT >::type variance (int x, int y)
 Return a reference to the variance offset by (x, y) from the current position of the locator. More...
 
bool operator== (MaskedImageLocatorBase const &rhs)
 Return true iff two locators are equal. More...
 
bool operator!= (MaskedImageLocatorBase const &rhs)
 Return true iff two locators are not equal. More...
 
bool operator< (MaskedImageLocatorBase const &rhs)
 Return true iff lhs is less than rhs. More...
 
MaskedImageLocatorBaseoperator+= (pair2I const &p)
 Increment the locator's x and y positions by p More...
 
MaskedImageLocatorBaseoperator+= (detail::difference_type p)
 Increment the locator's x and y positions by p More...
 
IMVLocator const & getLoc () const
 

Protected Attributes

IMVLocator _loc
 

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageLocator, typename MaskLocator, typename VarianceLocator>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >

A const locator for the MaskedImage.

A const locator for a MaskedImage.

Definition at line 514 of file MaskedImage.h.

Member Typedef Documentation

◆ IMVCachedLocation

typedef boost::tuple<typename ImageLocator::cached_location_t, typename MaskLocator::cached_location_t, typename VarianceLocator::cached_location_t> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::IMVCachedLocation
inherited

Definition at line 353 of file MaskedImage.h.

◆ PixelTVec

typedef boost::mpl::vector<ImagePixelT, MaskPixelT, VariancePixelT> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::PixelTVec
inherited

Definition at line 420 of file MaskedImage.h.

◆ x_iterator

typedef _x_or_y_iterator<apply_x> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::x_iterator
inherited

An x_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition at line 355 of file MaskedImage.h.

◆ y_iterator

typedef _x_or_y_iterator<apply_y> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::y_iterator
inherited

A y_iterator that provides a view of the xy_locator (i.e. advancing one advances the other)

Definition at line 357 of file MaskedImage.h.

Constructor & Destructor Documentation

◆ const_MaskedImageLocator()

template<typename ImagePixelT , typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename ImageLocator , typename MaskLocator , typename VarianceLocator >
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::const_MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator >::const_MaskedImageLocator ( MaskedImageLocator< ImageLocator, MaskLocator, VarianceLocator > const &  iter)
inline

Definition at line 528 of file MaskedImage.h.

Member Function Documentation

◆ apply_IMV() [1/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV ( )
inlineinherited

Definition at line 429 of file MaskedImage.h.

◆ apply_IMV() [2/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV ( cached_location_t const &  cached_loc)
inlineinherited

Definition at line 423 of file MaskedImage.h.

◆ apply_IMV() [3/3]

ConstReference <typename boost::mpl::at<PixelTVec, N>::type>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::apply_IMV ( int  x,
int  y 
)
inlineinherited

Definition at line 434 of file MaskedImage.h.

◆ cache_location()

cached_location_t lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::cache_location ( int  x,
int  y 
) const
inlineinherited

Create a cached_location_t offset by (x, y) from locator.

Definition at line 414 of file MaskedImage.h.

◆ getLoc()

IMVLocator const& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::getLoc ( ) const
inlineinherited

Definition at line 496 of file MaskedImage.h.

◆ image() [1/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image ( )
inlineinherited

Return a reference to the image at the current position of the locator.

Definition at line 445 of file MaskedImage.h.

◆ image() [2/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image ( cached_location_t const &  cached_loc)
inlineinherited

Return a reference to the image at the offset set when we created the cached_location_t

Definition at line 441 of file MaskedImage.h.

◆ image() [3/3]

ConstReference <ImagePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::image ( int  x,
int  y 
)
inlineinherited

Return a reference to the image offset by (x, y) from the current position of the locator.

Definition at line 447 of file MaskedImage.h.

◆ mask() [1/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask ( )
inlineinherited

Return a reference to the mask at the current position of the locator.

Definition at line 454 of file MaskedImage.h.

◆ mask() [2/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask ( cached_location_t const &  cached_loc)
inlineinherited

Return a reference to the mask at the offset set when we created the cached_location_t

Definition at line 450 of file MaskedImage.h.

◆ mask() [3/3]

ConstReference <MaskPixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::mask ( int  x,
int  y 
)
inlineinherited

Return a reference to the mask offset by (x, y) from the current position of the locator.

Definition at line 456 of file MaskedImage.h.

◆ operator!=()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator!= ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const &  rhs)
inlineinherited

Return true iff two locators are not equal.

Definition at line 474 of file MaskedImage.h.

◆ operator()()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator() ( int  x,
int  y 
)
inlineinherited

Dereference a locator, returning a Pixel offset by (x, y) from the locator.

Definition at line 389 of file MaskedImage.h.

◆ operator*()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator* ( )
inlineinherited

Dereference a locator, returning a Pixel.

Definition at line 383 of file MaskedImage.h.

◆ operator+=() [1/2]

MaskedImageLocatorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator+= ( detail::difference_type  p)
inlineinherited

Increment the locator's x and y positions by p

Definition at line 486 of file MaskedImage.h.

◆ operator+=() [2/2]

MaskedImageLocatorBase& lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator+= ( pair2I const &  p)
inlineinherited

Increment the locator's x and y positions by p

Definition at line 481 of file MaskedImage.h.

◆ operator<()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator< ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const &  rhs)
inlineinherited

Return true iff lhs is less than rhs.

Definition at line 476 of file MaskedImage.h.

◆ operator==()

bool lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator== ( MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type, detail::const_locator_type< MaskLocator >::type, detail::const_locator_type< VarianceLocator >::type, ConstReference > const &  rhs)
inlineinherited

Return true iff two locators are equal.

Definition at line 470 of file MaskedImage.h.

◆ operator[]()

Pixel lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::operator[] ( cached_location_t const &  cached_loc)
inlineinherited

Dereference a locator, returning a Pixel offset by the amount set when we created the cached_location_t

Definition at line 396 of file MaskedImage.h.

◆ variance() [1/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance ( )
inlineinherited

Return a reference to the variance at the current position of the locator.

Definition at line 463 of file MaskedImage.h.

◆ variance() [2/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance ( cached_location_t const &  cached_loc)
inlineinherited

Return a reference to the variance at the offset set when we created the cached_location_t

Definition at line 459 of file MaskedImage.h.

◆ variance() [3/3]

ConstReference <VariancePixelT>::type lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::variance ( int  x,
int  y 
)
inlineinherited

Return a reference to the variance offset by (x, y) from the current position of the locator.

Definition at line 465 of file MaskedImage.h.

◆ x()

x_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::x ( )
inlineinherited

Return an iterator that can be used to move (or dereference) a locator.

Note
this x_locator is xy_locator::x_locator, not MaskedImage::x_locator

Definition at line 405 of file MaskedImage.h.

◆ y()

y_iterator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::y ( )
inlineinherited

Return an iterator that can be used to move (or dereference) a locator.

Note
this y_locator is xy_locator::y_locator, not MaskedImage::y_locator

Definition at line 411 of file MaskedImage.h.

Member Data Documentation

◆ _loc

IMVLocator lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< detail::const_locator_type< ImageLocator >::type , detail::const_locator_type< MaskLocator >::type , detail::const_locator_type< VarianceLocator >::type , ConstReference >::_loc
protectedinherited

Definition at line 499 of file MaskedImage.h.


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