lsst.afw g401a67a369+49cb0b2ce6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | List of all members
lsst::afw::image::ImageSlice< PixelT > Class Template Reference

A class to specify a slice of an image. More...

#include <ImageSlice.h>

Inheritance diagram for lsst::afw::image::ImageSlice< PixelT >:
lsst::afw::image::Image< PixelT > lsst::afw::image::ImageBase< PixelT >

Public Types

enum  ImageSliceType { ROW , COLUMN }
 
using image_category = detail::Image_tag
 
using SinglePixel = PixelT
 A single Pixel of the same type as those in the ImageBase. More...
 
using Pixel = PixelT
 A pixel in this ImageBase. More...
 
using PixelReference = typename Reference< PixelT >::type
 A Reference to a PixelT. More...
 
using PixelConstReference = typename ConstReference< PixelT >::type
 A ConstReference to a PixelT. More...
 
using xy_locator = typename _view_t::xy_locator
 An xy_locator. More...
 
using const_xy_locator = typename _view_t::xy_locator::const_t
 A const_xy_locator. More...
 
using iterator = typename _view_t::iterator
 An STL compliant iterator. More...
 
using const_iterator = typename _const_view_t::iterator
 An STL compliant const iterator. More...
 
using reverse_iterator = typename _view_t::reverse_iterator
 An STL compliant reverse iterator. More...
 
using const_reverse_iterator = typename _const_view_t::reverse_iterator
 An STL compliant const reverse iterator. More...
 
using x_iterator = typename _view_t::x_iterator
 An iterator for traversing the pixels in a row. More...
 
using fast_iterator = x_iterator
 A fast STL compliant iterator for contiguous images N.b. More...
 
using xy_x_iterator = typename _view_t::x_iterator
 An iterator for traversing the pixels in a row, created from an xy_locator. More...
 
using const_x_iterator = typename _const_view_t::x_iterator
 A const iterator for traversing the pixels in a row. More...
 
using y_iterator = typename _view_t::y_iterator
 An iterator for traversing the pixels in a column. More...
 
using xy_y_iterator = typename _view_t::y_iterator
 An iterator for traversing the pixels in a row, created from an xy_locator. More...
 
using const_y_iterator = typename _const_view_t::y_iterator
 A const iterator for traversing the pixels in a column. More...
 
using Array = typename ndarray::Array< PixelT, 2, 1 >
 A mutable ndarray representation of the image. More...
 
using ConstArray = typename ndarray::Array< const PixelT, 2, 1 >
 An immutable ndarray representation of the image. More...
 

Public Member Functions

 ImageSlice (Image< PixelT > const &img)
 Constructor for ImageSlice. More...
 
 ~ImageSlice () override
 
ImageSliceType getImageSliceType () const
 
Image subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
 Return a subimage corresponding to the given box. More...
 
Image operator[] (lsst::geom::Box2I const &bbox) const
 Return a subimage corresponding to the given box (interpreted as PARENT coordinates). More...
 
PixelReference operator[] (lsst::geom::Point2I const &index)
 Return a reference to a single pixel in PARENT coordinates (with no bounds check). More...
 
PixelConstReference operator[] (lsst::geom::Point2I const &index) const
 Return a reference to a single pixel in PARENT coordinates (with no bounds check). More...
 
void writeFits (std::string const &fileName, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
 Write an image to a regular FITS file. More...
 
void writeFits (std::string const &fileName, std::shared_ptr< daf::base::PropertySet const > metadata, std::string const &mode="w") const
 
void writeFits (fits::MemFileManager &manager, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const
 Write an image to a FITS RAM file. More...
 
void writeFits (fits::MemFileManager &manager, std::shared_ptr< daf::base::PropertySet const > metadata, std::string const &mode="w") const
 
void writeFits (fits::Fits &fitsfile, daf::base::PropertySet const *metadata=nullptr) const
 Write an image to an open FITS file object. More...
 
void writeFits (fits::Fits &fitsfile, std::shared_ptr< daf::base::PropertySet const > metadata) const
 
void writeFits (std::string const &filename, fits::ImageWriteOptions const &options, std::string const &mode="w", daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
 Write an image to a regular FITS file. More...
 
void writeFits (std::string const &filename, fits::ImageWriteOptions const &options, std::string const &mode, std::shared_ptr< daf::base::PropertySet const > header, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const
 
void writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &options, std::string const &mode="w", daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
 Write an image to a FITS RAM file. More...
 
void writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &options, std::string const &mode, std::shared_ptr< daf::base::PropertySet const > header, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const
 
void writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &options, daf::base::PropertySet const *header=nullptr, Mask< MaskPixel > const *mask=nullptr) const
 Write an image to an open FITS file object. More...
 
void writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &options, std::shared_ptr< daf::base::PropertySet const > header, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const
 
void swap (Image &rhs)
 
void swap (ImageBase &rhs)
 
Imageoperator+= (PixelT const rhs)
 Add scalar rhs to lhs. More...
 
virtual Imageoperator+= (Image< PixelT > const &rhs)
 Add Image rhs to lhs. More...
 
Imageoperator+= (lsst::afw::math::Function2< double > const &function)
 Add a Function2(x, y) to an Image. More...
 
void scaledPlus (PixelT const c, Image< PixelT > const &rhs)
 Add Image c*rhs to lhs. More...
 
Imageoperator-= (PixelT const rhs)
 Subtract scalar rhs from lhs. More...
 
Imageoperator-= (Image< PixelT > const &rhs)
 Subtract Image rhs from lhs. More...
 
Imageoperator-= (lsst::afw::math::Function2< double > const &function)
 Subtract a Function2(x, y) from an Image. More...
 
void scaledMinus (PixelT const c, Image< PixelT > const &rhs)
 Subtract Image c*rhs from lhs. More...
 
Imageoperator*= (PixelT const rhs)
 Multiply lhs by scalar rhs. More...
 
Imageoperator*= (Image< PixelT > const &rhs)
 Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication) More...
 
void scaledMultiplies (PixelT const c, Image< PixelT > const &rhs)
 Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication) More...
 
Imageoperator/= (PixelT const rhs)
 Divide lhs by scalar rhs. More...
 
Imageoperator/= (Image< PixelT > const &rhs)
 Divide lhs by Image rhs (i.e. pixel-by-pixel division) More...
 
Image< double > & operator/= (double const rhs)
 
Image< float > & operator/= (float const rhs)
 
void scaledDivides (PixelT const c, Image< PixelT > const &rhs)
 Divide lhs by Image c*rhs (i.e. pixel-by-pixel division) More...
 
void sqrt ()
 
void assign (ImageBase const &rhs, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
 Copy pixels from another image to a specified subregion of this image. More...
 
PixelReference operator() (int x, int y)
 Return a reference to the pixel (x, y) in LOCAL coordinates. More...
 
PixelReference operator() (int x, int y, CheckIndices const &)
 Return a reference to the pixel (x, y) in LOCAL coordinates with bounds checking. More...
 
PixelConstReference operator() (int x, int y) const
 Return a const reference to the pixel (x, y) in LOCAL coordinates. More...
 
PixelConstReference operator() (int x, int y, CheckIndices const &) const
 Return a const reference to the pixel (x, y) in LOCAL coordinates with bounds checking. More...
 
PixelReference get (lsst::geom::Point2I const &index, ImageOrigin origin)
 Return a reference to a single pixel (with no bounds check). More...
 
PixelConstReference get (lsst::geom::Point2I const &index, ImageOrigin origin) const
 Return a const reference to a single pixel (with no bounds check). More...
 
int getWidth () const
 Return the number of columns in the image. More...
 
int getHeight () const
 Return the number of rows in the image. More...
 
int getArea () const
 Return the area of the image. More...
 
int getX0 () const
 Return the image's column-origin. More...
 
int getY0 () const
 Return the image's row-origin. More...
 
lsst::geom::Point2I getXY0 () const
 Return the image's origin. More...
 
std::pair< int, double > positionToIndex (double const pos, lsst::afw::image::xOrY const xy) const
 Convert image position to index (nearest integer and fractional parts) More...
 
double indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
 Convert image index to image position. More...
 
lsst::geom::Extent2I getDimensions () const
 Return the image's size; useful for passing to constructors. More...
 
Array getArray ()
 
ConstArray getArray () const
 
iterator begin () const
 Return an STL compliant iterator to the start of the image. More...
 
fast_iterator begin (bool contiguous) const
 Return a fast STL compliant iterator to the start of the image which must be contiguous. More...
 
iterator end () const
 Return an STL compliant iterator to the end of the image. More...
 
fast_iterator end (bool contiguous) const
 Return a fast STL compliant iterator to the end of the image which must be contiguous. More...
 
reverse_iterator rbegin () const
 Return an STL compliant reverse iterator to the start of the image. More...
 
reverse_iterator rend () const
 Return an STL compliant reverse iterator to the end of the image. More...
 
iterator at (int x, int y) const
 Return an STL compliant iterator at the point (x, y) More...
 
x_iterator row_begin (int y) const
 Return an x_iterator to the start of the y'th row. More...
 
x_iterator row_end (int y) const
 Return an x_iterator to the end of the y'th row. More...
 
x_iterator x_at (int x, int y) const
 Return an x_iterator to the point (x, y) in the image. More...
 
y_iterator col_begin (int x) const
 Return an y_iterator to the start of the y'th row. More...
 
y_iterator col_end (int x) const
 Return an y_iterator to the start of the y'th row. More...
 
y_iterator y_at (int x, int y) const
 Return an y_iterator to the point (x, y) in the image. More...
 
xy_locator xy_at (int x, int y) const
 Return an xy_locator at the point (x, y) in the image. More...
 
void setXY0 (lsst::geom::Point2I const origin)
 Set the ImageBase's origin. More...
 
void setXY0 (int const x0, int const y0)
 Set the ImageBase's origin. More...
 
lsst::geom::Box2I getBBox (ImageOrigin origin=PARENT) const
 

Static Public Member Functions

static Image readFits (std::string const &filename, int hdu=fits::DEFAULT_HDU)
 Read an Image from a regular FITS file. More...
 
static Image readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an Image from a FITS RAM file. More...
 
template<typename SinglePixelT >
static SinglePixel PixelCast (SinglePixelT rhs)
 Convert a type to our SinglePixel type. More...
 

Protected Member Functions

_view_t _getRawView () const
 
bool isContiguous () const
 

Static Protected Member Functions

static _view_t _allocateView (lsst::geom::Extent2I const &dimensions, Manager::Ptr &manager)
 
static _view_t _makeSubView (lsst::geom::Extent2I const &dimensions, lsst::geom::Extent2I const &offset, const _view_t &view)
 

Detailed Description

template<typename PixelT>
class lsst::afw::image::ImageSlice< PixelT >

A class to specify a slice of an image.

Definition at line 46 of file ImageSlice.h.

Member Typedef Documentation

◆ Array

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::Array = typename ndarray::Array<PixelT, 2, 1>
inherited

A mutable ndarray representation of the image.

Definition at line 149 of file ImageBase.h.

◆ const_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::const_iterator = typename _const_view_t::iterator
inherited

An STL compliant const iterator.

Definition at line 127 of file ImageBase.h.

◆ const_reverse_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::const_reverse_iterator = typename _const_view_t::reverse_iterator
inherited

An STL compliant const reverse iterator.

Definition at line 131 of file ImageBase.h.

◆ const_x_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::const_x_iterator = typename _const_view_t::x_iterator
inherited

A const iterator for traversing the pixels in a row.

Definition at line 141 of file ImageBase.h.

◆ const_xy_locator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::const_xy_locator = typename _view_t::xy_locator::const_t
inherited

A const_xy_locator.

Definition at line 123 of file ImageBase.h.

◆ const_y_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::const_y_iterator = typename _const_view_t::y_iterator
inherited

A const iterator for traversing the pixels in a column.

Definition at line 147 of file ImageBase.h.

◆ ConstArray

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::ConstArray = typename ndarray::Array<const PixelT, 2, 1>
inherited

An immutable ndarray representation of the image.

Definition at line 151 of file ImageBase.h.

◆ fast_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::fast_iterator = x_iterator
inherited

A fast STL compliant iterator for contiguous images N.b.

The order of pixel access is undefined

Definition at line 137 of file ImageBase.h.

◆ image_category

template<typename PixelT >
using lsst::afw::image::Image< PixelT >::image_category = detail::Image_tag
inherited

Definition at line 56 of file Image.h.

◆ iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::iterator = typename _view_t::iterator
inherited

An STL compliant iterator.

Definition at line 125 of file ImageBase.h.

◆ Pixel

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::Pixel = PixelT
inherited

A pixel in this ImageBase.

Definition at line 115 of file ImageBase.h.

◆ PixelConstReference

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::PixelConstReference = typename ConstReference<PixelT>::type
inherited

A ConstReference to a PixelT.

Definition at line 119 of file ImageBase.h.

◆ PixelReference

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::PixelReference = typename Reference<PixelT>::type
inherited

A Reference to a PixelT.

Definition at line 117 of file ImageBase.h.

◆ reverse_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::reverse_iterator = typename _view_t::reverse_iterator
inherited

An STL compliant reverse iterator.

Definition at line 129 of file ImageBase.h.

◆ SinglePixel

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::SinglePixel = PixelT
inherited

A single Pixel of the same type as those in the ImageBase.

Definition at line 113 of file ImageBase.h.

◆ x_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::x_iterator = typename _view_t::x_iterator
inherited

An iterator for traversing the pixels in a row.

Definition at line 133 of file ImageBase.h.

◆ xy_locator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::xy_locator = typename _view_t::xy_locator
inherited

An xy_locator.

Definition at line 121 of file ImageBase.h.

◆ xy_x_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::xy_x_iterator = typename _view_t::x_iterator
inherited

An iterator for traversing the pixels in a row, created from an xy_locator.

Definition at line 139 of file ImageBase.h.

◆ xy_y_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::xy_y_iterator = typename _view_t::y_iterator
inherited

An iterator for traversing the pixels in a row, created from an xy_locator.

Definition at line 145 of file ImageBase.h.

◆ y_iterator

template<typename PixelT >
using lsst::afw::image::ImageBase< PixelT >::y_iterator = typename _view_t::y_iterator
inherited

An iterator for traversing the pixels in a column.

Definition at line 143 of file ImageBase.h.

Member Enumeration Documentation

◆ ImageSliceType

template<typename PixelT >
enum lsst::afw::image::ImageSlice::ImageSliceType
Enumerator
ROW 
COLUMN 

Definition at line 48 of file ImageSlice.h.

Constructor & Destructor Documentation

◆ ImageSlice()

template<typename PixelT >
lsst::afw::image::ImageSlice< PixelT >::ImageSlice ( image::Image< PixelT > const &  img)
explicit

Constructor for ImageSlice.

Parameters
imgThe image to represent as a slice.

Definition at line 41 of file ImageSlice.cc.

◆ ~ImageSlice()

template<typename PixelT >
lsst::afw::image::ImageSlice< PixelT >::~ImageSlice ( )
inlineoverride

Definition at line 56 of file ImageSlice.h.

Member Function Documentation

◆ _allocateView()

template<typename PixelT >
ImageBase< PixelT >::_view_t lsst::afw::image::ImageBase< PixelT >::_allocateView ( lsst::geom::Extent2I const &  dimensions,
Manager::Ptr &  manager 
)
staticprotectedinherited

Definition at line 45 of file Image.cc.

◆ _getRawView()

template<typename PixelT >
_view_t lsst::afw::image::ImageBase< PixelT >::_getRawView ( ) const
inlineprotectedinherited

Definition at line 465 of file ImageBase.h.

◆ _makeSubView()

template<typename PixelT >
ImageBase< PixelT >::_view_t lsst::afw::image::ImageBase< PixelT >::_makeSubView ( lsst::geom::Extent2I const &  dimensions,
lsst::geom::Extent2I const &  offset,
const _view_t &  view 
)
staticprotectedinherited

Definition at line 65 of file Image.cc.

◆ assign()

template<typename PixelT >
void lsst::afw::image::ImageBase< PixelT >::assign ( ImageBase< PixelT > const &  rhs,
lsst::geom::Box2I const &  bbox = lsst::geom::Box2I(),
ImageOrigin  origin = PARENT 
)
inherited

Copy pixels from another image to a specified subregion of this image.

Parameters
[in]rhssource image whose pixels are to be copied into this image (the destination)
[in]bboxsubregion of this image to set; if empty (the default) then all pixels are set
[in]originorigin of bbox: if PARENT then the lower left pixel of this image is at xy0 if LOCAL then the lower left pixel of this image is at 0,0
Exceptions
lsst::pex::exceptions::LengthErrorif the dimensions of rhs and the specified subregion of this image do not match.

Definition at line 153 of file Image.cc.

◆ at()

template<typename PixelT >
ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::at ( int  x,
int  y 
) const
inherited

Return an STL compliant iterator at the point (x, y)

Definition at line 270 of file Image.cc.

◆ begin() [1/2]

template<typename PixelT >
ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::begin
inherited

Return an STL compliant iterator to the start of the image.

Note that this isn't especially efficient; see Image Iterators for a discussion

Definition at line 250 of file Image.cc.

◆ begin() [2/2]

template<typename PixelT >
ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::begin ( bool  contiguous) const
inherited

Return a fast STL compliant iterator to the start of the image which must be contiguous.

Parameters
contiguousPixels are contiguous (must be true)
Exceptions
lsst::pex::exceptions::RuntimeErrorArgument contiguous is false, or the pixels are not in fact contiguous

Definition at line 275 of file Image.cc.

◆ col_begin()

template<typename PixelT >
y_iterator lsst::afw::image::ImageBase< PixelT >::col_begin ( int  x) const
inlineinherited

Return an y_iterator to the start of the y'th row.

Incrementing an y_iterator moves it up the column

Definition at line 413 of file ImageBase.h.

◆ col_end()

template<typename PixelT >
y_iterator lsst::afw::image::ImageBase< PixelT >::col_end ( int  x) const
inlineinherited

Return an y_iterator to the start of the y'th row.

Definition at line 416 of file ImageBase.h.

◆ end() [1/2]

template<typename PixelT >
ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::end
inherited

Return an STL compliant iterator to the end of the image.

Definition at line 255 of file Image.cc.

◆ end() [2/2]

template<typename PixelT >
ImageBase< PixelT >::fast_iterator lsst::afw::image::ImageBase< PixelT >::end ( bool  contiguous) const
inherited

Return a fast STL compliant iterator to the end of the image which must be contiguous.

Parameters
contiguousPixels are contiguous (must be true)
Exceptions
lsst::pex::exceptions::RuntimeErrorArgument contiguous is false, or the pixels are not in fact contiguous

Definition at line 287 of file Image.cc.

◆ get() [1/2]

template<typename PixelT >
ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::get ( lsst::geom::Point2I const &  index,
ImageOrigin  origin 
)
inherited

Return a reference to a single pixel (with no bounds check).

Definition at line 209 of file Image.cc.

◆ get() [2/2]

template<typename PixelT >
ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::get ( lsst::geom::Point2I const &  index,
ImageOrigin  origin 
) const
inherited

Return a const reference to a single pixel (with no bounds check).

Definition at line 221 of file Image.cc.

◆ getArea()

template<typename PixelT >
int lsst::afw::image::ImageBase< PixelT >::getArea ( ) const
inlineinherited

Return the area of the image.

Definition at line 298 of file ImageBase.h.

◆ getArray() [1/2]

template<typename PixelT >
ImageBase< PixelT >::Array lsst::afw::image::ImageBase< PixelT >::getArray
inherited

Definition at line 476 of file ImageBase.h.

◆ getArray() [2/2]

template<typename PixelT >
ImageBase< PixelT >::ConstArray lsst::afw::image::ImageBase< PixelT >::getArray
inherited

Definition at line 491 of file ImageBase.h.

◆ getBBox()

template<typename PixelT >
lsst::geom::Box2I lsst::afw::image::ImageBase< PixelT >::getBBox ( ImageOrigin  origin = PARENT) const
inlineinherited

Definition at line 445 of file ImageBase.h.

◆ getDimensions()

template<typename PixelT >
lsst::geom::Extent2I lsst::afw::image::ImageBase< PixelT >::getDimensions ( ) const
inlineinherited

Return the image's size; useful for passing to constructors.

Definition at line 356 of file ImageBase.h.

◆ getHeight()

template<typename PixelT >
int lsst::afw::image::ImageBase< PixelT >::getHeight ( ) const
inlineinherited

Return the number of rows in the image.

Definition at line 296 of file ImageBase.h.

◆ getImageSliceType()

template<typename PixelT >
ImageSliceType lsst::afw::image::ImageSlice< PixelT >::getImageSliceType ( ) const
inline

Definition at line 57 of file ImageSlice.h.

◆ getWidth()

template<typename PixelT >
int lsst::afw::image::ImageBase< PixelT >::getWidth ( ) const
inlineinherited

Return the number of columns in the image.

Definition at line 294 of file ImageBase.h.

◆ getX0()

template<typename PixelT >
int lsst::afw::image::ImageBase< PixelT >::getX0 ( ) const
inlineinherited

Return the image's column-origin.

This will usually be 0 except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 306 of file ImageBase.h.

◆ getXY0()

template<typename PixelT >
lsst::geom::Point2I lsst::afw::image::ImageBase< PixelT >::getXY0 ( ) const
inlineinherited

Return the image's origin.

This will usually be (0, 0) except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 323 of file ImageBase.h.

◆ getY0()

template<typename PixelT >
int lsst::afw::image::ImageBase< PixelT >::getY0 ( ) const
inlineinherited

Return the image's row-origin.

This will usually be 0 except for images created using the ImageBase(fileName, hdu, BBox, mode) ctor or ImageBase(ImageBase, BBox) cctor The origin can be reset with setXY0

Definition at line 314 of file ImageBase.h.

◆ indexToPosition()

template<typename PixelT >
double lsst::afw::image::ImageBase< PixelT >::indexToPosition ( double  ind,
lsst::afw::image::xOrY const  xy 
) const
inlineinherited

Convert image index to image position.

The LSST indexing convention is:

  • the index of the bottom left pixel is 0,0
  • the position of the center of the bottom left pixel is PixelZeroPos, PixelZeroPos
Returns
image position
Parameters
indimage index
xyIs this a column or row coordinate?

Definition at line 349 of file ImageBase.h.

◆ isContiguous()

template<typename PixelT >
bool lsst::afw::image::ImageBase< PixelT >::isContiguous ( ) const
inlineprotectedinherited

Definition at line 467 of file ImageBase.h.

◆ operator()() [1/4]

template<typename PixelT >
ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::operator() ( int  x,
int  y 
)
inherited

Return a reference to the pixel (x, y) in LOCAL coordinates.

Definition at line 171 of file Image.cc.

◆ operator()() [2/4]

template<typename PixelT >
ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator() ( int  x,
int  y 
) const
inherited

Return a const reference to the pixel (x, y) in LOCAL coordinates.

Definition at line 191 of file Image.cc.

◆ operator()() [3/4]

template<typename PixelT >
ImageBase< PixelT >::PixelReference lsst::afw::image::ImageBase< PixelT >::operator() ( int  x,
int  y,
CheckIndices const &  check 
)
inherited

Return a reference to the pixel (x, y) in LOCAL coordinates with bounds checking.

Definition at line 177 of file Image.cc.

◆ operator()() [4/4]

template<typename PixelT >
ImageBase< PixelT >::PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator() ( int  x,
int  y,
CheckIndices const &  check 
) const
inherited

Return a const reference to the pixel (x, y) in LOCAL coordinates with bounds checking.

Definition at line 196 of file Image.cc.

◆ operator*=() [1/2]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator*= ( Image< PixelT > const &  rhs)
inherited

Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication)

Definition at line 591 of file Image.cc.

◆ operator*=() [2/2]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator*= ( PixelT const  rhs)
inherited

Multiply lhs by scalar rhs.

Definition at line 585 of file Image.cc.

◆ operator+=() [1/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+= ( Image< PixelT > const &  rhs)
virtualinherited

Add Image rhs to lhs.

Definition at line 501 of file Image.cc.

◆ operator+=() [2/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+= ( lsst::afw::math::Function2< double > const &  function)
inherited

Add a Function2(x, y) to an Image.

Parameters
functionfunction to add

Definition at line 514 of file Image.cc.

◆ operator+=() [3/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator+= ( PixelT const  rhs)
inherited

Add scalar rhs to lhs.

Definition at line 495 of file Image.cc.

◆ operator-=() [1/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-= ( Image< PixelT > const &  rhs)
inherited

Subtract Image rhs from lhs.

Definition at line 546 of file Image.cc.

◆ operator-=() [2/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-= ( lsst::afw::math::Function2< double > const &  function)
inherited

Subtract a Function2(x, y) from an Image.

Parameters
functionfunction to add

Definition at line 572 of file Image.cc.

◆ operator-=() [3/3]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator-= ( PixelT const  rhs)
inherited

Subtract scalar rhs from lhs.

Definition at line 540 of file Image.cc.

◆ operator/=() [1/4]

Image< double > & lsst::afw::image::Image< double >::operator/= ( double const  rhs)
inherited

Definition at line 625 of file Image.cc.

◆ operator/=() [2/4]

Image< float > & lsst::afw::image::Image< float >::operator/= ( float const  rhs)
inherited

Definition at line 632 of file Image.cc.

◆ operator/=() [3/4]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator/= ( Image< PixelT > const &  rhs)
inherited

Divide lhs by Image rhs (i.e. pixel-by-pixel division)

Definition at line 639 of file Image.cc.

◆ operator/=() [4/4]

template<typename PixelT >
Image< PixelT > & lsst::afw::image::Image< PixelT >::operator/= ( PixelT const  rhs)
inherited

Divide lhs by scalar rhs.

Note
Floating point types implement this by multiplying by the 1/rhs

Definition at line 617 of file Image.cc.

◆ operator[]() [1/3]

template<typename PixelT >
Image lsst::afw::image::Image< PixelT >::operator[] ( lsst::geom::Box2I const &  bbox) const
inlineinherited

Return a subimage corresponding to the given box (interpreted as PARENT coordinates).

Definition at line 224 of file Image.h.

◆ operator[]() [2/3]

template<typename PixelT >
PixelReference lsst::afw::image::ImageBase< PixelT >::operator[] ( lsst::geom::Point2I const &  index)
inlineinherited

Return a reference to a single pixel in PARENT coordinates (with no bounds check).

Definition at line 288 of file ImageBase.h.

◆ operator[]() [3/3]

template<typename PixelT >
PixelConstReference lsst::afw::image::ImageBase< PixelT >::operator[] ( lsst::geom::Point2I const &  index) const
inlineinherited

Return a reference to a single pixel in PARENT coordinates (with no bounds check).

Definition at line 291 of file ImageBase.h.

◆ PixelCast()

template<typename PixelT >
template<typename SinglePixelT >
static SinglePixel lsst::afw::image::ImageBase< PixelT >::PixelCast ( SinglePixelT  rhs)
inlinestaticinherited

Convert a type to our SinglePixel type.

Definition at line 158 of file ImageBase.h.

◆ positionToIndex()

template<typename PixelT >
std::pair< int, double > lsst::afw::image::ImageBase< PixelT >::positionToIndex ( double const  pos,
lsst::afw::image::xOrY const  xy 
) const
inlineinherited

Convert image position to index (nearest integer and fractional parts)

Returns
std::pair(nearest integer index, fractional part)
Parameters
posimage position
xyIs this a column or row coordinate?

Definition at line 330 of file ImageBase.h.

◆ rbegin()

template<typename PixelT >
ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rbegin
inherited

Return an STL compliant reverse iterator to the start of the image.

Definition at line 260 of file Image.cc.

◆ readFits() [1/2]

template<typename PixelT >
static Image lsst::afw::image::Image< PixelT >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an Image from a FITS RAM file.

Parameters
[in]managerObject that manages the memory to be read.
[in]hduNumber of the "header-data unit" to read (where 0 is the Primary HDU). The default value of afw::fits::DEFAULT_HDU is interpreted as "the first HDU with NAXIS != 0".

Definition at line 354 of file Image.h.

◆ readFits() [2/2]

template<typename PixelT >
static Image lsst::afw::image::Image< PixelT >::readFits ( std::string const &  filename,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an Image from a regular FITS file.

Parameters
[in]filenameName of the file to read.
[in]hduNumber of the "header-data unit" to read (where 0 is the Primary HDU). The default value of afw::fits::DEFAULT_HDU is interpreted as "the first HDU with NAXIS != 0".

Definition at line 342 of file Image.h.

◆ rend()

template<typename PixelT >
ImageBase< PixelT >::reverse_iterator lsst::afw::image::ImageBase< PixelT >::rend
inherited

Return an STL compliant reverse iterator to the end of the image.

Definition at line 265 of file Image.cc.

◆ row_begin()

template<typename PixelT >
x_iterator lsst::afw::image::ImageBase< PixelT >::row_begin ( int  y) const
inlineinherited

Return an x_iterator to the start of the y'th row.

Incrementing an x_iterator moves it across the row

Definition at line 401 of file ImageBase.h.

◆ row_end()

template<typename PixelT >
x_iterator lsst::afw::image::ImageBase< PixelT >::row_end ( int  y) const
inlineinherited

Return an x_iterator to the end of the y'th row.

Definition at line 404 of file ImageBase.h.

◆ scaledDivides()

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::scaledDivides ( PixelT const  c,
Image< PixelT > const &  rhs 
)
inherited

Divide lhs by Image c*rhs (i.e. pixel-by-pixel division)

Definition at line 652 of file Image.cc.

◆ scaledMinus()

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::scaledMinus ( PixelT const  c,
Image< PixelT > const &  rhs 
)
inherited

Subtract Image c*rhs from lhs.

Definition at line 559 of file Image.cc.

◆ scaledMultiplies()

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::scaledMultiplies ( PixelT const  c,
Image< PixelT > const &  rhs 
)
inherited

Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication)

Definition at line 604 of file Image.cc.

◆ scaledPlus()

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::scaledPlus ( PixelT const  c,
Image< PixelT > const &  rhs 
)
inherited

Add Image c*rhs to lhs.

Definition at line 527 of file Image.cc.

◆ setXY0() [1/2]

template<typename PixelT >
void lsst::afw::image::ImageBase< PixelT >::setXY0 ( int const  x0,
int const  y0 
)
inlineinherited

Set the ImageBase's origin.

The origin is usually set by the constructor, so you shouldn't need this function

Note
There are use cases (e.g. memory overlays) that may want to set these values, but don't do so unless you are an Expert.

Definition at line 443 of file ImageBase.h.

◆ setXY0() [2/2]

template<typename PixelT >
void lsst::afw::image::ImageBase< PixelT >::setXY0 ( lsst::geom::Point2I const  origin)
inlineinherited

Set the ImageBase's origin.

The origin is usually set by the constructor, so you shouldn't need this function

Note
There are use cases (e.g. memory overlays) that may want to set these values, but don't do so unless you are an Expert.

Definition at line 434 of file ImageBase.h.

◆ sqrt()

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::sqrt
inherited

Definition at line 489 of file Image.cc.

◆ subset()

template<typename PixelT >
Image lsst::afw::image::Image< PixelT >::subset ( lsst::geom::Box2I const &  bbox,
ImageOrigin  origin = PARENT 
) const
inlineinherited

Return a subimage corresponding to the given box.

Parameters
bboxBounding box of the subimage returned.
originOrigin bbox is rleative to; PARENT accounts for xy0, LOCAL does not.
Returns
A subimage view into this.

This method is wrapped as getitem in Python.

Note
This method permits mutable views to be obtained from const references to images (just as the copy constructor does). This is an intrinsic flaw in Image's design.

Definition at line 219 of file Image.h.

◆ swap() [1/2]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::swap ( Image< PixelT > &  rhs)
inherited

Definition at line 477 of file Image.cc.

◆ swap() [2/2]

template<typename PixelT >
void lsst::afw::image::ImageBase< PixelT >::swap ( ImageBase< PixelT > &  rhs)
inherited

Definition at line 233 of file Image.cc.

◆ writeFits() [1/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::Fits fitsfile,
daf::base::PropertySet const *  metadata = nullptr 
) const
inherited

Write an image to an open FITS file object.

Parameters
[in]fitsfileA FITS file already open to the desired HDU.
[in]metadataAdditional values to write to the header (may be null).

◆ writeFits() [2/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::Fits fitsfile,
fits::ImageWriteOptions const &  options,
daf::base::PropertySet const *  header = nullptr,
Mask< MaskPixel > const *  mask = nullptr 
) const
inherited

Write an image to an open FITS file object.

Parameters
[in]fitsfileA FITS file already open to the desired HDU.
[in]optionsOptions controlling writing of FITS image.
[in]headerAdditional values to write to the header (may be null).
[in]maskMask, for calculation of statistics.

◆ writeFits() [3/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::Fits fitsfile,
fits::ImageWriteOptions const &  options,
std::shared_ptr< daf::base::PropertySet const >  header,
std::shared_ptr< Mask< MaskPixel > const >  mask = nullptr 
) const
inherited

◆ writeFits() [4/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::Fits fitsfile,
std::shared_ptr< daf::base::PropertySet const >  metadata 
) const
inherited

◆ writeFits() [5/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::MemFileManager manager,
daf::base::PropertySet const *  metadata = nullptr,
std::string const &  mode = "w" 
) const
inherited

Write an image to a FITS RAM file.

Parameters
[in]managerManager object for the memory block to write to.
[in]metadataAdditional values to write to the header (may be null).
[in]mode"w"=Create a new file; "a"=Append a new HDU.

◆ writeFits() [6/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::MemFileManager manager,
fits::ImageWriteOptions const &  options,
std::string const &  mode,
std::shared_ptr< daf::base::PropertySet const >  header,
std::shared_ptr< Mask< MaskPixel > const >  mask = nullptr 
) const
inherited

◆ writeFits() [7/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::MemFileManager manager,
fits::ImageWriteOptions const &  options,
std::string const &  mode = "w",
daf::base::PropertySet const *  header = nullptr,
Mask< MaskPixel > const *  mask = nullptr 
) const
inherited

Write an image to a FITS RAM file.

Parameters
[in]managerManager object for the memory block to write to.
[in]optionsOptions controlling writing of FITS image.
[in]headerAdditional values to write to the header (may be null).
[in]mode"w"=Create a new file; "a"=Append a new HDU.
[in]maskMask, for calculation of statistics.

◆ writeFits() [8/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( fits::MemFileManager manager,
std::shared_ptr< daf::base::PropertySet const >  metadata,
std::string const &  mode = "w" 
) const
inherited

◆ writeFits() [9/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( std::string const &  fileName,
daf::base::PropertySet const *  metadata = nullptr,
std::string const &  mode = "w" 
) const
inherited

Write an image to a regular FITS file.

Parameters
[in]fileNameName of the file to write.
[in]metadataAdditional values to write to the header (may be null).
[in]mode"w"=Create a new file; "a"=Append a new HDU.

◆ writeFits() [10/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( std::string const &  filename,
fits::ImageWriteOptions const &  options,
std::string const &  mode,
std::shared_ptr< daf::base::PropertySet const >  header,
std::shared_ptr< Mask< MaskPixel > const >  mask = nullptr 
) const
inherited

◆ writeFits() [11/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( std::string const &  filename,
fits::ImageWriteOptions const &  options,
std::string const &  mode = "w",
daf::base::PropertySet const *  header = nullptr,
Mask< MaskPixel > const *  mask = nullptr 
) const
inherited

Write an image to a regular FITS file.

Parameters
[in]filenameName of the file to write.
[in]optionsOptions controlling writing of FITS image.
[in]mode"w"=Create a new file; "a"=Append a new HDU.
[in]headerAdditional values to write to the header (may be null).
[in]maskMask, for calculation of statistics.

◆ writeFits() [12/12]

template<typename PixelT >
void lsst::afw::image::Image< PixelT >::writeFits ( std::string const &  fileName,
std::shared_ptr< daf::base::PropertySet const >  metadata,
std::string const &  mode = "w" 
) const
inherited

◆ x_at()

template<typename PixelT >
x_iterator lsst::afw::image::ImageBase< PixelT >::x_at ( int  x,
int  y 
) const
inlineinherited

Return an x_iterator to the point (x, y) in the image.

Definition at line 407 of file ImageBase.h.

◆ xy_at()

template<typename PixelT >
xy_locator lsst::afw::image::ImageBase< PixelT >::xy_at ( int  x,
int  y 
) const
inlineinherited

Return an xy_locator at the point (x, y) in the image.

Locators may be used to access a patch in an image

Definition at line 425 of file ImageBase.h.

◆ y_at()

template<typename PixelT >
y_iterator lsst::afw::image::ImageBase< PixelT >::y_at ( int  x,
int  y 
) const
inlineinherited

Return an y_iterator to the point (x, y) in the image.

Definition at line 419 of file ImageBase.h.


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