LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Private Types | List of all members
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocator< typename, typename, typename > Class Template Reference

A locator for the MaskedImage. More...

#include <MaskedImage.h>

Inheritance diagram for lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocator< typename, typename, typename >:
lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator >

Public Member Functions

 MaskedImageLocator (ImageLocator &img, MaskLocator &msk, VarianceLocator &var)
 
- Public Member Functions inherited from lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator >
 MaskedImageLocatorBase (ImageLocator const &img, MaskLocator const &msk, VarianceLocator const &var)
 Construct a MaskedImageLocator from image/mask/variance locators. More...
 
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 ()
 
y_iterator y ()
 
cached_location_t cache_location (int x, int y) const
 Create a cached_location_t offset by (x, y) from locator. More...
 
Reference< typename
boost::mpl::at< PixelTVec, N >
::type >::type 
apply_IMV (cached_location_t const &cached_loc)
 
Reference< typename
boost::mpl::at< PixelTVec, N >
::type >::type 
apply_IMV ()
 
Reference< typename
boost::mpl::at< PixelTVec, N >
::type >::type 
apply_IMV (int x, int y)
 
Reference< 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...
 
Reference< ImagePixelT >::type image ()
 Return a reference to the image at the current position of the locator. More...
 
Reference< 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...
 
Reference< 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...
 
Reference< MaskPixelT >::type mask ()
 Return a reference to the mask at the current position of the locator. More...
 
Reference< 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...
 
Reference< 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...
 
Reference< VariancePixelT >::type variance ()
 Return a reference to the variance at the current position of the locator. More...
 
Reference< 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...
 

Private Types

typedef MaskedImageLocatorBase
< ImageLocator, MaskLocator,
VarianceLocator > 
MaskedImageLocatorBase_t
 

Additional Inherited Members

- Public Types inherited from lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator >
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
 
- Protected Attributes inherited from lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator >
IMVLocator _loc
 

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename, typename, typename>
class lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocator< typename, typename, typename >

A locator for the MaskedImage.

A locator for a MaskedImage.

Definition at line 113 of file MaskedImage.h.

Member Typedef Documentation

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
template<typename , typename , typename >
typedef MaskedImageLocatorBase<ImageLocator, MaskLocator, VarianceLocator> lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT >::MaskedImageLocator< typename, typename, typename >::MaskedImageLocatorBase_t
private

Definition at line 528 of file MaskedImage.h.

Constructor & Destructor Documentation

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

Definition at line 530 of file MaskedImage.h.

530  :
531  MaskedImageLocatorBase_t(img, msk, var) {
532  }
MaskedImageLocatorBase< ImageLocator, MaskLocator, VarianceLocator > MaskedImageLocatorBase_t
Definition: MaskedImage.h:528

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