LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
A class to specify a slice of an image. More...
#include <ImageSlice.h>
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, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const |
Write an image to a regular FITS file. More... | |
void | writeFits (fits::MemFileManager &manager, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const |
Write an image to a FITS RAM file. More... | |
void | writeFits (fits::Fits &fitsfile, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >()) const |
Write an image to an open FITS file object. More... | |
void | writeFits (std::string const &filename, fits::ImageWriteOptions const &options, std::string const &mode="w", std::shared_ptr< daf::base::PropertySet const > header=nullptr, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const |
Write an image to a regular FITS file. More... | |
void | writeFits (fits::MemFileManager &manager, fits::ImageWriteOptions const &options, std::string const &mode="w", std::shared_ptr< daf::base::PropertySet const > header=nullptr, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const |
Write an image to a FITS RAM file. More... | |
void | writeFits (fits::Fits &fitsfile, fits::ImageWriteOptions const &options, std::shared_ptr< daf::base::PropertySet const > header=nullptr, std::shared_ptr< Mask< MaskPixel > const > mask=nullptr) const |
Write an image to an open FITS file object. More... | |
void | swap (Image &rhs) |
void | swap (ImageBase &rhs) |
Image & | operator+= (PixelT const rhs) |
Add scalar rhs to lhs. More... | |
virtual Image & | operator+= (Image< PixelT > const &rhs) |
Add Image rhs to lhs. More... | |
Image & | operator+= (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... | |
Image & | operator-= (PixelT const rhs) |
Subtract scalar rhs from lhs. More... | |
Image & | operator-= (Image< PixelT > const &rhs) |
Subtract Image rhs from lhs. More... | |
Image & | operator-= (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... | |
Image & | operator*= (PixelT const rhs) |
Multiply lhs by scalar rhs. More... | |
Image & | operator*= (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... | |
Image & | operator/= (PixelT const rhs) |
Divide lhs by scalar rhs. More... | |
Image & | operator/= (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) |
A class to specify a slice of an image.
Definition at line 46 of file ImageSlice.h.
|
inherited |
A mutable ndarray representation of the image.
Definition at line 149 of file ImageBase.h.
|
inherited |
An STL compliant const iterator.
Definition at line 127 of file ImageBase.h.
|
inherited |
An STL compliant const reverse iterator.
Definition at line 131 of file ImageBase.h.
|
inherited |
A const iterator for traversing the pixels in a row.
Definition at line 141 of file ImageBase.h.
|
inherited |
A const_xy_locator.
Definition at line 123 of file ImageBase.h.
|
inherited |
A const iterator for traversing the pixels in a column.
Definition at line 147 of file ImageBase.h.
|
inherited |
An immutable ndarray representation of the image.
Definition at line 151 of file ImageBase.h.
|
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.
|
inherited |
|
inherited |
An STL compliant iterator.
Definition at line 125 of file ImageBase.h.
|
inherited |
A pixel in this ImageBase.
Definition at line 115 of file ImageBase.h.
|
inherited |
A ConstReference to a PixelT.
Definition at line 119 of file ImageBase.h.
|
inherited |
A Reference to a PixelT.
Definition at line 117 of file ImageBase.h.
|
inherited |
An STL compliant reverse iterator.
Definition at line 129 of file ImageBase.h.
|
inherited |
A single Pixel of the same type as those in the ImageBase.
Definition at line 113 of file ImageBase.h.
|
inherited |
An iterator for traversing the pixels in a row.
Definition at line 133 of file ImageBase.h.
|
inherited |
An xy_locator.
Definition at line 121 of file ImageBase.h.
|
inherited |
An iterator for traversing the pixels in a row, created from an xy_locator.
Definition at line 139 of file ImageBase.h.
|
inherited |
An iterator for traversing the pixels in a row, created from an xy_locator.
Definition at line 145 of file ImageBase.h.
|
inherited |
An iterator for traversing the pixels in a column.
Definition at line 143 of file ImageBase.h.
enum lsst::afw::image::ImageSlice::ImageSliceType |
|
explicit |
Constructor for ImageSlice.
img | The image to represent as a slice. |
Definition at line 41 of file ImageSlice.cc.
|
inlineoverride |
Definition at line 56 of file ImageSlice.h.
|
staticprotectedinherited |
Definition at line 45 of file Image.cc.
|
inlineprotectedinherited |
Definition at line 465 of file ImageBase.h.
|
staticprotectedinherited |
Definition at line 65 of file Image.cc.
|
inherited |
Copy pixels from another image to a specified subregion of this image.
[in] | rhs | source image whose pixels are to be copied into this image (the destination) |
[in] | bbox | subregion of this image to set; if empty (the default) then all pixels are set |
[in] | origin | origin 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 |
lsst::pex::exceptions::LengthError | if the dimensions of rhs and the specified subregion of this image do not match. |
Definition at line 153 of file Image.cc.
|
inherited |
|
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
|
inherited |
Return a fast STL compliant iterator to the start of the image which must be contiguous.
contiguous | Pixels are contiguous (must be true) |
lsst::pex::exceptions::RuntimeError | Argument contiguous is false, or the pixels are not in fact contiguous |
Definition at line 275 of file Image.cc.
|
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.
|
inlineinherited |
|
inherited |
|
inherited |
Return a fast STL compliant iterator to the end of the image which must be contiguous.
contiguous | Pixels are contiguous (must be true) |
lsst::pex::exceptions::RuntimeError | Argument contiguous is false, or the pixels are not in fact contiguous |
Definition at line 287 of file Image.cc.
|
inherited |
Return a reference to a single pixel (with no bounds check).
Definition at line 209 of file Image.cc.
|
inherited |
|
inlineinherited |
Return the area of the image.
Definition at line 298 of file ImageBase.h.
|
inherited |
Definition at line 476 of file ImageBase.h.
|
inherited |
Definition at line 491 of file ImageBase.h.
|
inlineinherited |
Definition at line 445 of file ImageBase.h.
|
inlineinherited |
Return the image's size; useful for passing to constructors.
Definition at line 356 of file ImageBase.h.
|
inlineinherited |
Return the number of rows in the image.
Definition at line 296 of file ImageBase.h.
|
inline |
Definition at line 57 of file ImageSlice.h.
|
inlineinherited |
Return the number of columns in the image.
Definition at line 294 of file ImageBase.h.
|
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.
|
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.
|
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.
|
inlineinherited |
Convert image index to image position.
The LSST indexing convention is:
ind | image index |
xy | Is this a column or row coordinate? |
Definition at line 349 of file ImageBase.h.
|
inlineprotectedinherited |
Definition at line 467 of file ImageBase.h.
|
inherited |
Return a reference to the pixel (x, y)
in LOCAL coordinates.
Definition at line 171 of file Image.cc.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Multiply lhs by scalar rhs.
Definition at line 544 of file Image.cc.
|
virtualinherited |
|
inherited |
Add a Function2(x, y) to an Image.
function | function to add |
Definition at line 473 of file Image.cc.
|
inherited |
Add scalar rhs to lhs.
Definition at line 454 of file Image.cc.
|
inherited |
|
inherited |
|
inherited |
Subtract scalar rhs from lhs.
Definition at line 499 of file Image.cc.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Divide lhs by scalar rhs.
Definition at line 576 of file Image.cc.
|
inlineinherited |
Return a subimage corresponding to the given box (interpreted as PARENT coordinates).
Definition at line 224 of file Image.h.
|
inlineinherited |
Return a reference to a single pixel in PARENT coordinates (with no bounds check).
Definition at line 288 of file ImageBase.h.
|
inlineinherited |
Return a reference to a single pixel in PARENT coordinates (with no bounds check).
Definition at line 291 of file ImageBase.h.
|
inlinestaticinherited |
Convert a type to our SinglePixel type.
Definition at line 158 of file ImageBase.h.
|
inlineinherited |
Convert image position to index (nearest integer and fractional parts)
pos | image position |
xy | Is this a column or row coordinate? |
Definition at line 330 of file ImageBase.h.
|
inherited |
|
inlinestaticinherited |
Read an Image from a FITS RAM file.
[in] | manager | Object that manages the memory to be read. |
[in] | hdu | Number 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". |
|
inlinestaticinherited |
Read an Image from a regular FITS file.
[in] | filename | Name of the file to read. |
[in] | hdu | Number 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". |
|
inherited |
|
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.
|
inlineinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inlineinherited |
Set the ImageBase's origin.
The origin is usually set by the constructor, so you shouldn't need this function
Definition at line 443 of file ImageBase.h.
|
inlineinherited |
Set the ImageBase's origin.
The origin is usually set by the constructor, so you shouldn't need this function
Definition at line 434 of file ImageBase.h.
|
inherited |
|
inlineinherited |
Return a subimage corresponding to the given box.
bbox | Bounding box of the subimage returned. |
origin | Origin bbox is rleative to; PARENT accounts for xy0, LOCAL does not. |
This method is wrapped as getitem in Python.
Definition at line 219 of file Image.h.
|
inherited |
|
inherited |
|
inherited |
Write an image to an open FITS file object.
[in] | fitsfile | A FITS file already open to the desired HDU. |
[in] | options | Options controlling writing of FITS image. |
[in] | header | Additional values to write to the header (may be null). |
[in] | mask | Mask, for calculation of statistics. |
|
inherited |
Write an image to an open FITS file object.
[in] | fitsfile | A FITS file already open to the desired HDU. |
[in] | metadata | Additional values to write to the header (may be null). |
|
inherited |
Write an image to a FITS RAM file.
[in] | manager | Manager object for the memory block to write to. |
[in] | options | Options controlling writing of FITS image. |
[in] | header | Additional values to write to the header (may be null). |
[in] | mode | "w"=Create a new file; "a"=Append a new HDU. |
[in] | mask | Mask, for calculation of statistics. |
|
inherited |
Write an image to a FITS RAM file.
[in] | manager | Manager object for the memory block to write to. |
[in] | metadata | Additional values to write to the header (may be null). |
[in] | mode | "w"=Create a new file; "a"=Append a new HDU. |
|
inherited |
Write an image to a regular FITS file.
[in] | filename | Name of the file to write. |
[in] | options | Options controlling writing of FITS image. |
[in] | mode | "w"=Create a new file; "a"=Append a new HDU. |
[in] | header | Additional values to write to the header (may be null). |
[in] | mask | Mask, for calculation of statistics. |
|
inherited |
Write an image to a regular FITS file.
[in] | fileName | Name of the file to write. |
[in] | metadata | Additional values to write to the header (may be null). |
[in] | mode | "w"=Create a new file; "a"=Append a new HDU. |
|
inlineinherited |
Return an x_iterator
to the point (x, y)
in the image.
Definition at line 407 of file ImageBase.h.
|
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.
|
inlineinherited |
Return an y_iterator
to the point (x, y)
in the image.
Definition at line 419 of file ImageBase.h.