LSST Applications
21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
|
A container for an Image and its associated metadata. More...
#include <Image.h>
Public Member Functions | |
DecoratedImage (const lsst::geom::Extent2I &dimensions=lsst::geom::Extent2I()) | |
Create an image of the specified size. More... | |
DecoratedImage (const lsst::geom::Box2I &bbox) | |
Create an image of the specified size. More... | |
DecoratedImage (std::shared_ptr< Image< PixelT >> rhs) | |
Create a DecoratedImage wrapping rhs More... | |
DecoratedImage (DecoratedImage const &rhs, const bool deep=false) | |
Copy constructor. More... | |
DecoratedImage (std::string const &fileName, const int hdu=fits::DEFAULT_HDU, lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin const origin=PARENT, bool allowUnsafe=false) | |
Create a DecoratedImage from a FITS file. More... | |
DecoratedImage & | operator= (const DecoratedImage &image) |
Assignment operator. More... | |
std::shared_ptr< lsst::daf::base::PropertySet > | getMetadata () const |
void | setMetadata (std::shared_ptr< lsst::daf::base::PropertySet > metadata) |
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 | getX0 () const |
Return the image's column-origin. More... | |
int | getY0 () const |
Return the image's row-origin. More... | |
const lsst::geom::Extent2I | getDimensions () const |
Return the image's size; useful for passing to constructors. More... | |
void | swap (DecoratedImage &rhs) |
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 a FITS file. More... | |
void | writeFits (std::string const &fileName, fits::ImageWriteOptions const &options, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const |
Write a FITS file. More... | |
std::shared_ptr< Image< PixelT > > | getImage () |
Return a shared_ptr to the DecoratedImage's Image. More... | |
std::shared_ptr< Image< PixelT > const > | getImage () const |
Return a shared_ptr to the DecoratedImage's Image as const. More... | |
double | getGain () const |
Return the DecoratedImage's gain. More... | |
void | setGain (double gain) |
Set the DecoratedImage's gain. More... | |
A container for an Image and its associated metadata.
|
explicit |
Create an image of the specified size.
dimensions | desired number of columns. rows |
Definition at line 44 of file DecoratedImage.cc.
|
explicit |
Create an image of the specified size.
bbox | (width, height) and origin of the desired Image |
dimensions
member which may be conveniently used to make objects of an appropriate size Definition at line 49 of file DecoratedImage.cc.
|
explicit |
Create a DecoratedImage wrapping rhs
Note that this ctor shares pixels with the rhs; it isn't a deep copy
rhs | Image to go into DecoratedImage |
Definition at line 53 of file DecoratedImage.cc.
lsst::afw::image::DecoratedImage< PixelT >::DecoratedImage | ( | DecoratedImage< PixelT > const & | rhs, |
const bool | deep = false |
||
) |
Copy constructor.
Note that the lhs will share memory with the rhs unless deep
is true
rhs | right hand side |
deep | Make deep copy? |
Definition at line 57 of file DecoratedImage.cc.
|
explicit |
Create a DecoratedImage from a FITS file.
fileName | File to read |
hdu | The HDU to read |
bbox | Only read these pixels |
origin | Coordinate system of the bbox |
allowUnsafe | Permit reading into the requested pixel type even when on-disk values may overflow or truncate. |
Definition at line 86 of file DecoratedImage.cc.
|
inline |
|
inline |
Return the DecoratedImage's gain.
|
inline |
|
inline |
Return a shared_ptr to the DecoratedImage's Image.
|
inline |
Return a shared_ptr to the DecoratedImage's Image as const.
|
inline |
|
inline |
|
inline |
|
inline |
DecoratedImage< PixelT > & lsst::afw::image::DecoratedImage< PixelT >::operator= | ( | const DecoratedImage< PixelT > & | image | ) |
Assignment operator.
N.b. this is a shallow assignment; use set(src) if you want to copy the pixels
Definition at line 62 of file DecoratedImage.cc.
|
inline |
|
inline |
void lsst::afw::image::DecoratedImage< PixelT >::swap | ( | DecoratedImage< PixelT > & | rhs | ) |
void lsst::afw::image::DecoratedImage< PixelT >::writeFits | ( | std::string const & | fileName, |
fits::ImageWriteOptions const & | options, | ||
std::shared_ptr< lsst::daf::base::PropertySet const > | metadata = std::shared_ptr<lsst::daf::base::PropertySet const>() , |
||
std::string const & | mode = "w" |
||
) | const |
Write a FITS file.
[in] | fileName | the file to write |
[in] | options | Options controlling writing of FITS image. |
[in] | metadata | metadata to write to header; or NULL |
[in] | mode | "w" to write a new file; "a" to append |
Definition at line 103 of file DecoratedImage.cc.
void lsst::afw::image::DecoratedImage< PixelT >::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 a FITS file.
fileName | the file to write |
metadata | metadata to write to header; or NULL |
mode | "w" to write a new file; "a" to append |
Definition at line 95 of file DecoratedImage.cc.