LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
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. | |
DecoratedImage (const lsst::geom::Box2I &bbox) | |
Create an image of the specified size. | |
DecoratedImage (std::shared_ptr< Image< PixelT > > rhs) | |
Create a DecoratedImage wrapping rhs | |
DecoratedImage (DecoratedImage const &rhs, const bool deep=false) | |
Copy constructor. | |
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. | |
DecoratedImage & | operator= (const DecoratedImage &image) |
Assignment operator. | |
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. | |
int | getHeight () const |
Return the number of rows in the image. | |
int | getX0 () const |
Return the image's column-origin. | |
int | getY0 () const |
Return the image's row-origin. | |
const lsst::geom::Extent2I | getDimensions () const |
Return the image's size; useful for passing to constructors. | |
void | swap (DecoratedImage &rhs) |
void | writeFits (std::string const &fileName, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const |
Write a FITS file. | |
void | writeFits (std::string const &fileName, fits::ImageWriteOptions const &options, daf::base::PropertySet const *metadata=nullptr, std::string const &mode="w") const |
Write a FITS file. | |
std::shared_ptr< Image< PixelT > > | getImage () |
Return a shared_ptr to the DecoratedImage's Image. | |
std::shared_ptr< Image< PixelT > const > | getImage () const |
Return a shared_ptr to the DecoratedImage's Image as const. | |
double | getGain () const |
Return the DecoratedImage's gain. | |
void | setGain (double gain) |
Set the DecoratedImage's gain. | |
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.
Definition at line 516 of file Image.h.
|
inline |
|
inline |
Return a shared_ptr to the DecoratedImage's Image.
Definition at line 507 of file Image.h.
|
inline |
Return a shared_ptr to the DecoratedImage's Image as const.
Definition at line 509 of file Image.h.
|
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, |
daf::base::PropertySet const * | metadata = nullptr, | ||
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.
void lsst::afw::image::DecoratedImage< PixelT >::writeFits | ( | std::string const & | fileName, |
fits::ImageWriteOptions const & | options, | ||
daf::base::PropertySet const * | metadata = nullptr, | ||
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.