LSSTApplications  19.0.0-10-g4a5fae6+3,19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+16,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+6,19.0.0-20-g5a5a17ab+14,19.0.0-21-g2644856+17,19.0.0-24-g0913cb1,19.0.0-24-g878c510+4,19.0.0-25-g6c8df7140+1,19.0.0-25-gb330496+4,19.0.0-3-g2b32d65+6,19.0.0-3-g8227491+15,19.0.0-3-g9c54d0d+15,19.0.0-3-gca68e65+11,19.0.0-3-gcfc5f51+6,19.0.0-3-ge110943+14,19.0.0-3-ge74d124,19.0.0-30-g9c3fd16+5,19.0.0-4-g06f5963+6,19.0.0-4-g10df615,19.0.0-4-g3d16501+17,19.0.0-4-g4a9c019+6,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+16,19.0.0-4-ge404a01+15,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gb9eeb60,19.0.0-5-gfb03ce7+16,19.0.0-6-gbaebbfb+15,19.0.0-61-gec4c6e08+5,19.0.0-7-g039c0b5+15,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+16,19.0.0-72-g37abf38+2,19.0.0-9-g463f923+15,v20.0.0.rc1
LSSTDataManagementBasePackage
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: