LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Friends | List of all members
lsst::afw::image::Image< PixelT > Class Template Reference

A class to represent a 2-dimensional array of pixels. More...

#include <Image.h>

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

Classes

struct  ImageTypeFactory
 A templated class to return this classes' type (present in Image/Mask/MaskedImage) More...
 

Public Types

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

Public Member Functions

 Image (unsigned int width, unsigned int height, PixelT initialValue=0)
 Create an initialised Image of the specified size.
 
 Image (lsst::geom::Extent2I const &dimensions=lsst::geom::Extent2I(), PixelT initialValue=0)
 Create an initialised Image of the specified size.
 
 Image (lsst::geom::Box2I const &bbox, PixelT initialValue=0)
 Create an initialized Image of the specified size.
 
 Image (Image const &rhs, lsst::geom::Box2I const &bbox, ImageOrigin const origin=PARENT, const bool deep=false)
 Copy constructor to make a copy of part of an Image.
 
 Image (const Image &rhs, const bool deep=false)
 Copy constructor.
 
 Image (Image &&rhs)
 
 Image (std::string const &fileName, int hdu=fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Construct an Image by reading a regular FITS file.
 
 Image (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Construct an Image by reading a FITS image in memory.
 
 Image (fits::Fits &fitsfile, std::shared_ptr< lsst::daf::base::PropertySet > metadata=std::shared_ptr< lsst::daf::base::PropertySet >(), lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
 Construct an Image from an already-open FITS object.
 
template<typename OtherPixelT >
 Image (Image< OtherPixelT > const &rhs, const bool deep)
 
 Image (ndarray::Array< PixelT, 2, 1 > const &array, bool deep=false, lsst::geom::Point2I const &xy0=lsst::geom::Point2I())
 
 ~Image () override=default
 
Imageoperator= (const PixelT rhs)
 Set the image's pixels to rhs.
 
Imageoperator= (const Image &rhs)
 Assignment operator.
 
Imageoperator= (Image &&rhs)
 
Image subset (lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
 Return a subimage corresponding to the given box.
 
Image operator[] (lsst::geom::Box2I const &bbox) const
 Return a subimage corresponding to the given box (interpreted as PARENT coordinates).
 
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.
 
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.
 
void writeFits (fits::Fits &fitsfile, daf::base::PropertySet const *metadata=nullptr) const
 Write an image to an open FITS file object.
 
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.
 
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.
 
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.
 
void swap (Image &rhs)
 
Imageoperator+= (PixelT const rhs)
 Add scalar rhs to lhs.
 
virtual Imageoperator+= (Image< PixelT > const &rhs)
 Add Image rhs to lhs.
 
Imageoperator+= (lsst::afw::math::Function2< double > const &function)
 Add a Function2(x, y) to an Image.
 
void scaledPlus (PixelT const c, Image< PixelT > const &rhs)
 Add Image c*rhs to lhs.
 
Imageoperator-= (PixelT const rhs)
 Subtract scalar rhs from lhs.
 
Imageoperator-= (Image< PixelT > const &rhs)
 Subtract Image rhs from lhs.
 
Imageoperator-= (lsst::afw::math::Function2< double > const &function)
 Subtract a Function2(x, y) from an Image.
 
void scaledMinus (PixelT const c, Image< PixelT > const &rhs)
 Subtract Image c*rhs from lhs.
 
Imageoperator*= (PixelT const rhs)
 Multiply lhs by scalar rhs.
 
Imageoperator*= (Image< PixelT > const &rhs)
 Multiply lhs by Image rhs (i.e. pixel-by-pixel multiplication)
 
void scaledMultiplies (PixelT const c, Image< PixelT > const &rhs)
 Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication)
 
Imageoperator/= (PixelT const rhs)
 Divide lhs by scalar rhs.
 
Imageoperator/= (Image< PixelT > const &rhs)
 Divide lhs by Image rhs (i.e. pixel-by-pixel division)
 
void scaledDivides (PixelT const c, Image< PixelT > const &rhs)
 Divide lhs by Image c*rhs (i.e. pixel-by-pixel division)
 
void sqrt ()
 
Image< double > & operator/= (double const rhs)
 
Image< float > & operator/= (float const rhs)
 
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.
 
PixelReference operator() (int x, int y)
 Return a reference to the pixel (x, y) in LOCAL coordinates.
 
PixelReference operator() (int x, int y, CheckIndices const &)
 Return a reference to the pixel (x, y) in LOCAL coordinates with bounds checking.
 
PixelConstReference operator() (int x, int y) const
 Return a const reference to the pixel (x, y) in LOCAL coordinates.
 
PixelConstReference operator() (int x, int y, CheckIndices const &) const
 Return a const reference to the pixel (x, y) in LOCAL coordinates with bounds checking.
 
PixelReference get (lsst::geom::Point2I const &index, ImageOrigin origin)
 Return a reference to a single pixel (with no bounds check).
 
PixelConstReference get (lsst::geom::Point2I const &index, ImageOrigin origin) const
 Return a const reference to a single pixel (with no bounds check).
 
PixelReference operator[] (lsst::geom::Point2I const &index)
 Return a reference to a single pixel in PARENT coordinates (with no bounds check).
 
PixelConstReference operator[] (lsst::geom::Point2I const &index) const
 Return a reference to a single pixel in PARENT coordinates (with no bounds check).
 
int getWidth () const
 Return the number of columns in the image.
 
int getHeight () const
 Return the number of rows in the image.
 
int getArea () const
 Return the area of the image.
 
int getX0 () const
 Return the image's column-origin.
 
int getY0 () const
 Return the image's row-origin.
 
lsst::geom::Point2I getXY0 () const
 Return the image's origin.
 
std::pair< int, doublepositionToIndex (double const pos, lsst::afw::image::xOrY const xy) const
 Convert image position to index (nearest integer and fractional parts)
 
double indexToPosition (double ind, lsst::afw::image::xOrY const xy) const
 Convert image index to image position.
 
lsst::geom::Extent2I getDimensions () const
 Return the image's size; useful for passing to constructors.
 
void swap (ImageBase &rhs)
 
Array getArray ()
 
ConstArray getArray () const
 
iterator begin () const
 Return an STL compliant iterator to the start of the image.
 
fast_iterator begin (bool contiguous) const
 Return a fast STL compliant iterator to the start of the image which must be contiguous.
 
iterator end () const
 Return an STL compliant iterator to the end of the image.
 
fast_iterator end (bool contiguous) const
 Return a fast STL compliant iterator to the end of the image which must be contiguous.
 
reverse_iterator rbegin () const
 Return an STL compliant reverse iterator to the start of the image.
 
reverse_iterator rend () const
 Return an STL compliant reverse iterator to the end of the image.
 
iterator at (int x, int y) const
 Return an STL compliant iterator at the point (x, y)
 
x_iterator row_begin (int y) const
 Return an x_iterator to the start of the y'th row.
 
x_iterator row_end (int y) const
 Return an x_iterator to the end of the y'th row.
 
x_iterator x_at (int x, int y) const
 Return an x_iterator to the point (x, y) in the image.
 
y_iterator col_begin (int x) const
 Return an y_iterator to the start of the y'th row.
 
y_iterator col_end (int x) const
 Return an y_iterator to the start of the y'th row.
 
y_iterator y_at (int x, int y) const
 Return an y_iterator to the point (x, y) in the image.
 
xy_locator xy_at (int x, int y) const
 Return an xy_locator at the point (x, y) in the image.
 
void setXY0 (lsst::geom::Point2I const origin)
 Set the ImageBase's origin.
 
void setXY0 (int const x0, int const y0)
 Set the ImageBase's origin.
 
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.
 
static Image readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an Image from a FITS RAM file.
 
template<typename SinglePixelT >
static SinglePixel PixelCast (SinglePixelT rhs)
 Convert a type to our SinglePixel type.
 

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)
 

Friends

template<typename , typename , typename >
class MaskedImage
 
template<typename OtherPixelT >
class Image
 

Detailed Description

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

A class to represent a 2-dimensional array of pixels.

Definition at line 51 of file Image.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

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.

Constructor & Destructor Documentation

◆ Image() [1/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( unsigned int width,
unsigned int height,
PixelT initialValue = 0 )
explicit

Create an initialised Image of the specified size.

Parameters
widthnumber of columns
heightnumber of rows
initialValueInitial value
Note
Many lsst::afw::image and lsst::afw::math objects define a dimensions member which may be conveniently used to make objects of an appropriate size

Definition at line 309 of file Image.cc.

310 : ImageBase<PixelT>(lsst::geom::ExtentI(width, height)) {
311 *this = initialValue;
312}
typename ndarray::Array< PixelT, 2, 1 > Array
A mutable ndarray representation of the image.
Definition ImageBase.h:149

◆ Image() [2/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( lsst::geom::Extent2I const & dimensions = lsst::geom::Extent2I(),
PixelT initialValue = 0 )
explicit

Create an initialised Image of the specified size.

Parameters
dimensionsNumber of columns, rows
initialValueInitial value
Note
Many lsst::afw::image and lsst::afw::math objects define a dimensions member which may be conveniently used to make objects of an appropriate size

Definition at line 315 of file Image.cc.

316 : ImageBase<PixelT>(dimensions) {
317 *this = initialValue;
318}

◆ Image() [3/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( lsst::geom::Box2I const & bbox,
PixelT initialValue = 0 )
explicit

Create an initialized Image of the specified size.

Parameters
bboxdimensions and origin of desired Image
initialValueInitial value

Definition at line 321 of file Image.cc.

322 *this = initialValue;
323}
AmpInfoBoxKey bbox
Definition Amplifier.cc:117

◆ Image() [4/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( Image< PixelT > const & rhs,
lsst::geom::Box2I const & bbox,
ImageOrigin const origin = PARENT,
const bool deep = false )
explicit

Copy constructor to make a copy of part of an Image.

The bbox ignores X0/Y0 if origin == LOCAL, and uses it if origin == PARENT.

Parameters
rhsRight-hand-side Image
bboxSpecify desired region
originCoordinate system of the bbox
deepIf false, new ImageBase shares storage with rhs; if true make a new, standalone, ImageBase
Note
Unless deep is true, the new image will share the old image's pixels; this is probably what you want

Definition at line 332 of file Image.cc.

334 : ImageBase<PixelT>(rhs, bbox, origin, deep) {}

◆ Image() [5/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( const Image< PixelT > & rhs,
const bool deep = false )

Copy constructor.

Parameters
rhsRight-hand-side Image
deepIf false, new Image shares storage with rhs; if true make a new, standalone, ImageBase
Note
Unless deep is true, the new image will share the old image's pixels; this may not be what you want. See also assign(rhs) to copy pixels between Images

Definition at line 326 of file Image.cc.

326: ImageBase<PixelT>(rhs, deep) {}

◆ Image() [6/11]

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

Definition at line 329 of file Image.cc.

329: Image(rhs, false) {}
friend class Image
Definition Image.h:65

◆ Image() [7/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( std::string const & fileName,
int hdu = fits::DEFAULT_HDU,
std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptrlsst::daf::base::PropertySet >(),
lsst::geom::Box2I const & bbox = lsst::geom::Box2I(),
ImageOrigin origin = PARENT,
bool allowUnsafe = false )
explicit

Construct an Image by reading a regular FITS file.

Parameters
[in]fileNameFile to read.
[in]hduHDU to read, 0-indexed (i.e. 0=Primary HDU). The special value of afw::fits::DEFAULT_HDU reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

◆ Image() [8/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( fits::MemFileManager & manager,
int hdu = fits::DEFAULT_HDU,
std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptrlsst::daf::base::PropertySet >(),
lsst::geom::Box2I const & bbox = lsst::geom::Box2I(),
ImageOrigin origin = PARENT,
bool allowUnsafe = false )
explicit

Construct an Image by reading a FITS image in memory.

Parameters
[in]managerAn object that manages the memory buffer to read.
[in]hduHDU to read, 0-indexed (i.e. 0=Primary HDU). The special value of afw::fits::DEFAULT_HDU reads the Primary HDU unless it is empty, in which case it reads the first extension HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

◆ Image() [9/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( fits::Fits & fitsfile,
std::shared_ptr< lsst::daf::base::PropertySet > metadata = std::shared_ptrlsst::daf::base::PropertySet >(),
lsst::geom::Box2I const & bbox = lsst::geom::Box2I(),
ImageOrigin origin = PARENT,
bool allowUnsafe = false )
explicit

Construct an Image from an already-open FITS object.

Parameters
[in]fitsfileA FITS object to read from, already at the desired HDU.
[in,out]metadataMetadata read from the header (may be null).
[in]bboxIf non-empty, read only the pixels within the bounding box.
[in]originCoordinate system of the bounding box; if PARENT, the bounding box should take into account the xy0 saved with the image.
[in]allowUnsafePermit reading into the requested pixel type even when on-disk values may overflow or truncate.

◆ Image() [10/11]

template<typename PixelT >
template<typename OtherPixelT >
lsst::afw::image::Image< PixelT >::Image ( Image< OtherPixelT > const & rhs,
const bool deep )
inline

Definition at line 182 of file Image.h.

The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition ImageBase.h:102

◆ Image() [11/11]

template<typename PixelT >
lsst::afw::image::Image< PixelT >::Image ( ndarray::Array< PixelT, 2, 1 > const & array,
bool deep = false,
lsst::geom::Point2I const & xy0 = lsst::geom::Point2I() )
inlineexplicit

Definition at line 184 of file Image.h.

186 : image::ImageBase<PixelT>(array, deep, xy0) {}

◆ ~Image()

template<typename PixelT >
lsst::afw::image::Image< PixelT >::~Image ( )
overridedefault

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.

46 {
47 if (dimensions.getX() < 0 || dimensions.getY() < 0) {
48 throw LSST_EXCEPT(pex::exceptions::LengthError,
49 str(boost::format("Both width and height must be non-negative: %d, %d") %
50 dimensions.getX() % dimensions.getY()));
51 }
52 if (dimensions.getX() != 0 && dimensions.getY() > std::numeric_limits<int>::max() / dimensions.getX()) {
53 throw LSST_EXCEPT(pex::exceptions::LengthError,
54 str(boost::format("Image dimensions (%d x %d) too large; int overflow detected.") %
55 dimensions.getX() % dimensions.getY()));
56 }
58 ndarray::SimpleManager<PixelT>::allocate(dimensions.getX() * dimensions.getY());
59 manager = r.first;
60 return boost::gil::interleaved_view(dimensions.getX(), dimensions.getY(),
61 (typename _view_t::value_type*)r.second,
62 dimensions.getX() * sizeof(PixelT));
63}
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48

◆ _getRawView()

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

Definition at line 465 of file ImageBase.h.

465{ return _gilView; }

◆ _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.

67 {
68 if (offset.getX() < 0 || offset.getY() < 0 || offset.getX() + dimensions.getX() > view.width() ||
69 offset.getY() + dimensions.getY() > view.height()) {
70 throw LSST_EXCEPT(
71 pex::exceptions::LengthError,
72 (boost::format(
73 "Box2I(Point2I(%d,%d),lsst::geom::Extent2I(%d,%d)) doesn't fit in image %dx%d") %
74 offset.getX() % offset.getY() % dimensions.getX() % dimensions.getY() % view.width() %
75 view.height())
76 .str());
77 }
78 if (dimensions.getX() == 0 && dimensions.getY() == 0
79 && view.width() == 0 && view.height() == 0) {
80 // Getting a zero-extent subview of a zero-extent view returns itself
81 return view;
82 } else {
83 return boost::gil::subimage_view(view, offset.getX(), offset.getY(), dimensions.getX(),
84 dimensions.getY());
85 }
86}

◆ 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.

153 {
154 auto lhsDim = bbox.isEmpty() ? getDimensions() : bbox.getDimensions();
155 if (lhsDim != rhs.getDimensions()) {
156 throw LSST_EXCEPT(pex::exceptions::LengthError,
157 (boost::format("Dimension mismatch: %dx%d v. %dx%d") % lhsDim.getX() %
158 lhsDim.getY() % rhs.getWidth() % rhs.getHeight())
159 .str());
160 }
161 if (bbox.isEmpty()) {
162 copy_pixels(rhs._gilView, _gilView);
163 } else {
164 auto lhsOff = (origin == PARENT) ? bbox.getMin() - _origin : lsst::geom::Extent2I(bbox.getMin());
165 auto lhsGilView = _makeSubView(lhsDim, lhsOff, _gilView);
166 copy_pixels(rhs._gilView, lhsGilView);
167 }
168}
static _view_t _makeSubView(lsst::geom::Extent2I const &dimensions, lsst::geom::Extent2I const &offset, const _view_t &view)
Definition Image.cc:65
lsst::geom::Extent2I getDimensions() const
Return the image's size; useful for passing to constructors.
Definition ImageBase.h:356
Extent< int, 2 > Extent2I
Definition Extent.h:397

◆ 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.

270 {
271 return _gilView.at(x, y);
272}
int y
Definition SpanSet.cc:48

◆ begin() [1/2]

template<typename PixelT >
ImageBase< PixelT >::iterator lsst::afw::image::ImageBase< PixelT >::begin ( ) const
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.

250 {
251 return _gilView.begin();
252}

◆ 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.

275 {
276 if (!contiguous) {
277 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Only contiguous == true makes sense");
278 }
279 if (!this->isContiguous()) {
280 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Image's pixels are not contiguous");
281 }
282
283 return row_begin(0);
284}
x_iterator row_begin(int y) const
Return an x_iterator to the start of the y'th row.
Definition ImageBase.h:401

◆ 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.

413{ return _gilView.col_begin(x); }

◆ 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.

416{ return _gilView.col_end(x); }

◆ end() [1/2]

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

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

Definition at line 255 of file Image.cc.

255 {
256 return _gilView.end();
257}

◆ 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.

287 {
288 if (!contiguous) {
289 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Only contiguous == true makes sense");
290 }
291 if (!this->isContiguous()) {
292 throw LSST_EXCEPT(pex::exceptions::RuntimeError, "Image's pixels are not contiguous");
293 }
294
295 return row_end(getHeight() - 1);
296}
int getHeight() const
Return the number of rows in the image.
Definition ImageBase.h:296
x_iterator row_end(int y) const
Return an x_iterator to the end of the y'th row.
Definition ImageBase.h:404

◆ 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.

210 {
211 int x = index.getX();
212 int y = index.getY();
213 if (origin == PARENT) {
214 x -= getX0();
215 y -= getY0();
216 }
217 return _gilView(x, y)[0];
218}
int getX0() const
Return the image's column-origin.
Definition ImageBase.h:306
int getY0() const
Return the image's row-origin.
Definition ImageBase.h:314

◆ 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.

222 {
223 int x = index.getX();
224 int y = index.getY();
225 if (origin == PARENT) {
226 x -= getX0();
227 y -= getY0();
228 }
229 return _gilView(x, y)[0];
230}

◆ 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.

298{ return getWidth()*getHeight(); }
int getWidth() const
Return the number of columns in the image.
Definition ImageBase.h:294

◆ getArray() [1/2]

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

Definition at line 476 of file ImageBase.h.

476 {
477 int rowStride = 1;
478 PixelT * data = nullptr;
479 if (getArea() > 0) {
480 data = reinterpret_cast<PixelT*>(row_begin(0));
481 }
482 if (getHeight() > 1) {
483 rowStride = reinterpret_cast<PixelT*>(row_begin(1)) - reinterpret_cast<PixelT*>(row_begin(0));
484 }
485 return ndarray::external(data,
486 ndarray::makeVector(getHeight(), getWidth()), ndarray::makeVector(rowStride, 1),
487 this->_manager);
488}
char * data
Definition BaseRecord.cc:61
int getArea() const
Return the area of the image.
Definition ImageBase.h:298

◆ getArray() [2/2]

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

Definition at line 491 of file ImageBase.h.

491 {
492 int rowStride = 1;
493 PixelT * data = nullptr;
494 if (getArea() > 0) {
495 data = reinterpret_cast<PixelT*>(row_begin(0));
496 }
497 if (getHeight() > 1) {
498 rowStride = reinterpret_cast<PixelT*>(row_begin(1)) - reinterpret_cast<PixelT*>(row_begin(0));
499 }
500 return ndarray::external(data,
501 ndarray::makeVector(getHeight(), getWidth()), ndarray::makeVector(rowStride, 1),
502 this->_manager);
503}

◆ 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.

445 {
446 if (origin == PARENT) {
447 return lsst::geom::Box2I(_origin, getDimensions());
448 } else
450 }
An integer coordinate rectangle.
Definition Box.h:55

◆ 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.

296{ return _gilView.height(); }

◆ 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.

294{ return _gilView.width(); }

◆ 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.

306{ return _origin.getX(); }

◆ 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.

323{ return _origin; }

◆ 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.

314{ return _origin.getY(); }

◆ 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.

351 {
352 return ind + PixelZeroPos + (xy == X ? getX0() : getY0());
353 }
const double PixelZeroPos
position of center of pixel 0
Definition ImageUtils.h:44

◆ isContiguous()

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

Definition at line 467 of file ImageBase.h.

467{ return begin() + getWidth() * getHeight() == end(); }
iterator end() const
Return an STL compliant iterator to the end of the image.
Definition Image.cc:255
iterator begin() const
Return an STL compliant iterator to the start of the image.
Definition Image.cc:250

◆ 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.

171 {
172 return const_cast<typename ImageBase<PixelT>::PixelReference>(
173 static_cast<typename ImageBase<PixelT>::PixelConstReference>(_gilView(x, y)[0]));
174}
typename Reference< PixelT >::type PixelReference
A Reference to a PixelT.
Definition ImageBase.h:117
typename ConstReference< PixelT >::type PixelConstReference
A ConstReference to a PixelT.
Definition ImageBase.h:119

◆ 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.

191 {
192 return _gilView(x, y)[0];
193}

◆ 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.

178 {
179 if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
180 throw LSST_EXCEPT(pex::exceptions::LengthError,
181 (boost::format("Index (%d, %d) is out of range [0--%d], [0--%d]") % x % y %
182 (getWidth() - 1) % (getHeight() - 1))
183 .str());
184 }
185
186 return const_cast<typename ImageBase<PixelT>::PixelReference>(
187 static_cast<typename ImageBase<PixelT>::PixelConstReference>(_gilView(x, y)[0]));
188}

◆ 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.

197 {
198 if (check && (x < 0 || x >= getWidth() || y < 0 || y >= getHeight())) {
199 throw LSST_EXCEPT(pex::exceptions::LengthError,
200 (boost::format("Index (%d, %d) is out of range [0--%d], [0--%d]") % x % y %
201 (this->getWidth() - 1) % (this->getHeight() - 1))
202 .str());
203 }
204
205 return _gilView(x, y)[0];
206}

◆ operator*=() [1/2]

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

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

Definition at line 551 of file Image.cc.

551 {
552 if (this->getDimensions() != rhs.getDimensions()) {
553 throw LSST_EXCEPT(pex::exceptions::LengthError,
554 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
555 this->getHeight() % rhs.getWidth() % rhs.getHeight())
556 .str());
557 }
558 transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
559 [](PixelT const& l, PixelT const& r) -> PixelT { return l * r; });
560 return *this;
561}
_view_t _getRawView() const
Definition ImageBase.h:465

◆ operator*=() [2/2]

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

Multiply lhs by scalar rhs.

Definition at line 545 of file Image.cc.

545 {
546 transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l * rhs; });
547 return *this;
548}

◆ operator+=() [1/3]

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

Add Image rhs to lhs.

Definition at line 461 of file Image.cc.

461 {
462 if (this->getDimensions() != rhs.getDimensions()) {
463 throw LSST_EXCEPT(pex::exceptions::LengthError,
464 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
465 this->getHeight() % rhs.getWidth() % rhs.getHeight())
466 .str());
467 }
468 transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
469 [](PixelT const& l, PixelT const& r) -> PixelT { return l + r; });
470 return *this;
471}

◆ operator+=() [2/3]

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

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

Parameters
functionfunction to add

Definition at line 474 of file Image.cc.

474 {
475 for (int y = 0; y != this->getHeight(); ++y) {
476 double const yPos = this->indexToPosition(y, Y);
477 double xPos = this->indexToPosition(0, X);
478 for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y); ptr != end;
479 ++ptr, ++xPos) {
480 *ptr += function(xPos, yPos);
481 }
482 }
483 return *this;
484}
uint64_t * ptr
Definition RangeSet.cc:95
double indexToPosition(double ind, lsst::afw::image::xOrY const xy) const
Convert image index to image position.
Definition ImageBase.h:349

◆ operator+=() [3/3]

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

Add scalar rhs to lhs.

Definition at line 455 of file Image.cc.

455 {
456 transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l + rhs; });
457 return *this;
458}

◆ operator-=() [1/3]

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

Subtract Image rhs from lhs.

Definition at line 506 of file Image.cc.

506 {
507 if (this->getDimensions() != rhs.getDimensions()) {
508 throw LSST_EXCEPT(pex::exceptions::LengthError,
509 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
510 this->getHeight() % rhs.getWidth() % rhs.getHeight())
511 .str());
512 }
513 transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
514 [](PixelT const& l, PixelT const& r) -> PixelT { return l - r; });
515 return *this;
516}

◆ operator-=() [2/3]

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

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

Parameters
functionfunction to add

Definition at line 532 of file Image.cc.

532 {
533 for (int y = 0; y != this->getHeight(); ++y) {
534 double const yPos = this->indexToPosition(y, Y);
535 double xPos = this->indexToPosition(0, X);
536 for (typename Image<PixelT>::x_iterator ptr = this->row_begin(y), end = this->row_end(y); ptr != end;
537 ++ptr, ++xPos) {
538 *ptr -= function(xPos, yPos);
539 }
540 }
541 return *this;
542}

◆ operator-=() [3/3]

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

Subtract scalar rhs from lhs.

Definition at line 500 of file Image.cc.

500 {
501 transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l - rhs; });
502 return *this;
503}

◆ operator/=() [1/4]

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

Definition at line 585 of file Image.cc.

585 {
586 double const irhs = 1 / rhs;
587 *this *= irhs;
588 return *this;
589}

◆ operator/=() [2/4]

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

Definition at line 592 of file Image.cc.

592 {
593 float const irhs = 1 / rhs;
594 *this *= irhs;
595 return *this;
596}

◆ operator/=() [3/4]

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

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

Definition at line 599 of file Image.cc.

599 {
600 if (this->getDimensions() != rhs.getDimensions()) {
601 throw LSST_EXCEPT(pex::exceptions::LengthError,
602 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
603 this->getHeight() % rhs.getWidth() % rhs.getHeight())
604 .str());
605 }
606 transform_pixels(_getRawView(), rhs._getRawView(), _getRawView(),
607 [](PixelT const& l, PixelT const& r) -> PixelT { return l / r; });
608 return *this;
609}

◆ operator/=() [4/4]

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

Divide lhs by scalar rhs.

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

Definition at line 577 of file Image.cc.

577 {
578 transform_pixels(_getRawView(), _getRawView(), [&rhs](PixelT const& l) -> PixelT { return l / rhs; });
579 return *this;
580}

◆ operator=() [1/3]

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

Assignment operator.

Note
that this has the effect of making the lhs share pixels with the rhs which may not be what you intended; to copy the pixels, use assign(rhs)
this behaviour is required to make the swig interface work, otherwise I'd declare this function private

Definition at line 344 of file Image.cc.

344 {
346
347 return *this;
348}
ImageBase & operator=(const ImageBase &rhs)
Shallow assignment operator.
Definition Image.cc:140

◆ operator=() [2/3]

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

Set the image's pixels to rhs.

Definition at line 337 of file Image.cc.

337 {
339
340 return *this;
341}

◆ operator=() [3/3]

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

Definition at line 351 of file Image.cc.

351 {
352 return *this = rhs;
353}

◆ operator[]() [1/3]

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

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

Definition at line 224 of file Image.h.

224{ return subset(bbox); }
Image subset(lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
Return a subimage corresponding to the given box.
Definition Image.h:219

◆ 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.

288{ return get(index, PARENT); }
PixelReference get(lsst::geom::Point2I const &index, ImageOrigin origin)
Return a reference to a single pixel (with no bounds check).
Definition Image.cc:209

◆ 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.

291{ return get(index, PARENT); }

◆ 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.

158 {
159 return SinglePixel(rhs);
160 }
PixelT SinglePixel
A single Pixel of the same type as those in the ImageBase.
Definition ImageBase.h:113

◆ 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.

333 {
334 double const fullIndex = pos - PixelZeroPos - (xy == X ? getX0() : getY0());
335 int const roundedIndex = static_cast<int>(fullIndex + 0.5);
336 double const residual = fullIndex - roundedIndex;
338 }

◆ rbegin()

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

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

Definition at line 260 of file Image.cc.

260 {
261 return _gilView.rbegin();
262}

◆ readFits() [1/2]

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

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 330 of file Image.h.

330 {
331 return Image<PixelT>(manager, hdu);
332 }

◆ readFits() [2/2]

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

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 318 of file Image.h.

318 {
319 return Image<PixelT>(filename, hdu);
320 }

◆ rend()

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

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

Definition at line 265 of file Image.cc.

265 {
266 return _gilView.rend();
267}

◆ 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.

401{ return _gilView.row_begin(y); }

◆ 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.

404{ return _gilView.row_end(y); }

◆ scaledDivides()

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

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

Definition at line 612 of file Image.cc.

612 {
613 if (this->getDimensions() != rhs.getDimensions()) {
614 throw LSST_EXCEPT(pex::exceptions::LengthError,
615 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
616 this->getHeight() % rhs.getWidth() % rhs.getHeight())
617 .str());
618 }
620 _getRawView(), rhs._getRawView(), _getRawView(),
621 [&c](PixelT const& l, PixelT const& r) -> PixelT { return l / (c * r); });
622}

◆ scaledMinus()

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

Subtract Image c*rhs from lhs.

Definition at line 519 of file Image.cc.

519 {
520 if (this->getDimensions() != rhs.getDimensions()) {
521 throw LSST_EXCEPT(pex::exceptions::LengthError,
522 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
523 this->getHeight() % rhs.getWidth() % rhs.getHeight())
524 .str());
525 }
527 _getRawView(), rhs._getRawView(), _getRawView(),
528 [&c](PixelT const& l, PixelT const& r) -> PixelT { return l - (c * r); });
529}

◆ scaledMultiplies()

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

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

Definition at line 564 of file Image.cc.

564 {
565 if (this->getDimensions() != rhs.getDimensions()) {
566 throw LSST_EXCEPT(pex::exceptions::LengthError,
567 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
568 this->getHeight() % rhs.getWidth() % rhs.getHeight())
569 .str());
570 }
572 _getRawView(), rhs._getRawView(), _getRawView(),
573 [&c](PixelT const& l, PixelT const& r) -> PixelT { return l * (c * r); });
574}

◆ scaledPlus()

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

Add Image c*rhs to lhs.

Definition at line 487 of file Image.cc.

487 {
488 if (this->getDimensions() != rhs.getDimensions()) {
489 throw LSST_EXCEPT(pex::exceptions::LengthError,
490 (boost::format("Images are of different size, %dx%d v %dx%d") % this->getWidth() %
491 this->getHeight() % rhs.getWidth() % rhs.getHeight())
492 .str());
493 }
495 _getRawView(), rhs._getRawView(), _getRawView(),
496 [&c](PixelT const& l, PixelT const& r) -> PixelT { return l + (c * r); });
497}

◆ 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.

443{ setXY0(lsst::geom::Point2I(x0, y0)); }
void setXY0(lsst::geom::Point2I const origin)
Set the ImageBase's origin.
Definition ImageBase.h:434

◆ 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.

434{ _origin = origin; }

◆ sqrt()

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

Definition at line 449 of file Image.cc.

449 {
451 [](PixelT const& l) -> PixelT { return static_cast<PixelT>(std::sqrt(l)); });
452}
T sqrt(T... args)

◆ subset()

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

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.

219 {
220 return Image(*this, bbox, origin, false);
221 }

◆ swap() [1/2]

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

Definition at line 437 of file Image.cc.

437 {
438 using std::swap; // See Meyers, Effective C++, Item 25
440}
void swap(ImageBase &rhs)
Definition Image.cc:233
T swap(T... args)

◆ 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.

233 {
234 using std::swap; // See Meyers, Effective C++, Item 25
235
236 swap(_manager, rhs._manager); // just swapping the pointers
237 swap(_gilView, rhs._gilView);
238 swap(_origin, rhs._origin);
239}

◆ writeFits() [1/6]

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

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/6]

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

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/6]

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

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() [4/6]

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

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() [5/6]

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

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() [6/6]

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

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.

◆ 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.

407{ return _gilView.x_at(x, y); }

◆ 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.

425{ return xy_locator(_gilView.xy_at(x, y)); }
typename _view_t::xy_locator xy_locator
An xy_locator.
Definition ImageBase.h:121

◆ 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.

419{ return _gilView.y_at(x, y); }

Friends And Related Symbol Documentation

◆ Image

template<typename PixelT >
template<typename OtherPixelT >
friend class Image
friend

Definition at line 65 of file Image.h.

◆ MaskedImage

template<typename PixelT >
template<typename , typename , typename >
friend class MaskedImage
friend

Definition at line 54 of file Image.h.


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