LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Classes | Public Types | Public Member Functions | List of all members
lsst::afw::image::imageLocator Class Reference

An ImageBase locator. More...

Classes

struct  xy_x_iterator
 An x_iterator created from an xy_locator More...
 
struct  xy_y_iterator
 An y_iterator created from an xy_locator More...
 

Public Types

typedef void cached_location_t
 type to store relative location for efficient repeated access (not really void) More...
 

Public Member Functions

Image::Pixeloperator* ()
 Dereference a locator, returning a reference to a Pixel. More...
 
Image::Pixeloperator() (int x, int y)
 Dereference a pixel offset by (x, y) from the current locator, returning a reference to a Pixel. More...
 
xy_x_iterator x ()
 Return an x_iterator that can move an xy_locator More...
 
xy_y_iterator y ()
 Return an y_iterator that can move an xy_locator More...
 
cached_location_t cache_location (int x, int y)
 Store a relative location for faster repeated access. More...
 
Image::Pixeloperator[] (cached_location_t const &)
 Dereference a cached_location_t, returning a reference to a Pixel. More...
 

Detailed Description

An ImageBase locator.

Definition at line 56 of file iterators.cc.

Member Typedef Documentation

◆ cached_location_t

type to store relative location for efficient repeated access (not really void)

Definition at line 59 of file iterators.cc.

Member Function Documentation

◆ cache_location()

cached_location_t lsst::afw::image::imageLocator::cache_location ( int  x,
int  y 
)

Store a relative location for faster repeated access.

◆ operator()()

Image::Pixel& lsst::afw::image::imageLocator::operator() ( int  x,
int  y 
)

Dereference a pixel offset by (x, y) from the current locator, returning a reference to a Pixel.

As a locator ptr is moved through the image, expressions such as ptr(-1, -1) can be used to examine or set neighbouring pixels

◆ operator*()

Image::Pixel& lsst::afw::image::imageLocator::operator* ( )

Dereference a locator, returning a reference to a Pixel.

◆ operator[]()

Image::Pixel& lsst::afw::image::imageLocator::operator[] ( cached_location_t const &  )

Dereference a cached_location_t, returning a reference to a Pixel.

◆ x()

xy_x_iterator lsst::afw::image::imageLocator::x ( )

Return an x_iterator that can move an xy_locator

◆ y()

xy_y_iterator lsst::afw::image::imageLocator::y ( )

Return an y_iterator that can move an xy_locator


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