LSSTApplications
10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
|
A collection of all the things that make an Exposure different from a MaskedImage. More...
#include <ExposureInfo.h>
Classes | |
struct | FitsWriteData |
A struct passed back and forth between Exposure and ExposureInfo when writing FITS files. More... | |
Public Member Functions | |
bool | hasWcs () const |
Does this exposure have a Wcs? More... | |
boost::shared_ptr< Wcs > | getWcs () |
Return the coordinate system of the exposure. More... | |
boost::shared_ptr< Wcs const > | getWcs () const |
Return the coordinate system of the exposure. More... | |
void | setWcs (boost::shared_ptr< Wcs const > wcs) |
Set the coordinate system of the exposure. More... | |
bool | hasDetector () const |
Does this exposure have Detector information? More... | |
boost::shared_ptr < cameraGeom::Detector const > | getDetector () const |
Return the exposure's Detector information. More... | |
void | setDetector (boost::shared_ptr< cameraGeom::Detector const > detector) |
Set the exposure's Detector information. More... | |
Filter | getFilter () const |
Return the exposure's filter. More... | |
void | setFilter (Filter const &filter) |
Set the exposure's filter. More... | |
bool | hasCalib () const |
Does this exposure have a Calib? More... | |
boost::shared_ptr< Calib > | getCalib () |
Return the exposure's photometric calibration. More... | |
boost::shared_ptr< Calib const > | getCalib () const |
Return the exposure's photometric calibration. More... | |
void | setCalib (boost::shared_ptr< Calib const > calib) |
Set the Exposure's Calib object. More... | |
boost::shared_ptr < daf::base::PropertySet > | getMetadata () const |
Return flexible metadata. More... | |
void | setMetadata (boost::shared_ptr< daf::base::PropertySet > metadata) |
Set the flexible metadata. More... | |
bool | hasPsf () const |
Does this exposure have a Psf? More... | |
boost::shared_ptr< detection::Psf > | getPsf () const |
Return the exposure's point-spread function. More... | |
void | setPsf (boost::shared_ptr< detection::Psf const > psf) |
Set the exposure's point-spread function. More... | |
bool | hasValidPolygon () const |
Does this exposure have a valid Polygon. More... | |
boost::shared_ptr < geom::polygon::Polygon const > | getValidPolygon () const |
Return the valid Polygon. More... | |
void | setValidPolygon (boost::shared_ptr< geom::polygon::Polygon const > polygon) |
Set the exposure's valid Polygon. More... | |
bool | hasApCorrMap () const |
Return true if the exposure has an aperture correction map. More... | |
boost::shared_ptr< ApCorrMap > | getApCorrMap () |
Return the exposure's aperture correction map (null pointer if !hasApCorrMap()) More... | |
boost::shared_ptr< ApCorrMap const > | getApCorrMap () const |
Return the exposure's aperture correction map (null pointer if !hasApCorrMap()) More... | |
void | setApCorrMap (boost::shared_ptr< ApCorrMap > apCorrMap) |
Set the exposure's aperture correction map (null pointer if !hasApCorrMap()) More... | |
void | initApCorrMap () |
bool | hasCoaddInputs () const |
Does this exposure have coadd provenance catalogs? More... | |
void | setCoaddInputs (boost::shared_ptr< CoaddInputs > coaddInputs) |
Set the exposure's coadd provenance catalogs. More... | |
boost::shared_ptr< CoaddInputs > | getCoaddInputs () const |
Return a pair of catalogs that record the inputs, if this Exposure is a coadd (otherwise null). More... | |
ExposureInfo (boost::shared_ptr< Wcs const > const &wcs=boost::shared_ptr< Wcs const >(), boost::shared_ptr< detection::Psf const > const &psf=boost::shared_ptr< detection::Psf const >(), boost::shared_ptr< Calib const > const &calib=boost::shared_ptr< Calib const >(), boost::shared_ptr< cameraGeom::Detector const > const &detector=boost::shared_ptr< cameraGeom::Detector const >(), boost::shared_ptr< geom::polygon::Polygon const > const &polygon=boost::shared_ptr< geom::polygon::Polygon const >(), Filter const &filter=Filter(), boost::shared_ptr< daf::base::PropertySet > const &metadata=boost::shared_ptr< daf::base::PropertySet >(), boost::shared_ptr< CoaddInputs > const &coaddInputs=boost::shared_ptr< CoaddInputs >(), boost::shared_ptr< ApCorrMap > const &apCorrMap=boost::shared_ptr< ApCorrMap >()) | |
Construct an ExposureInfo from its various components. More... | |
ExposureInfo (ExposureInfo const &other) | |
Copy constructor; deep-copies all components except the metadata. More... | |
ExposureInfo (ExposureInfo const &other, bool copyMetadata) | |
Copy constructor; deep-copies everything, possibly including the metadata. More... | |
ExposureInfo & | operator= (ExposureInfo const &other) |
Assignment; deep-copies all components except the metadata. More... | |
~ExposureInfo () | |
Private Member Functions | |
FitsWriteData | _startWriteFits (geom::Point2I const &xy0=geom::Point2I()) const |
Start the process of writing an exposure to FITS. More... | |
void | _finishWriteFits (fits::Fits &fitsfile, FitsWriteData const &data) const |
Write any additional non-image HDUs to a FITS file. More... | |
void | _readFits (fits::Fits &fitsfile, boost::shared_ptr< daf::base::PropertySet > metadata, boost::shared_ptr< daf::base::PropertySet > imageMetadata) |
Read from a FITS file and metadata. More... | |
Static Private Member Functions | |
static boost::shared_ptr< Calib > | _cloneCalib (boost::shared_ptr< Calib const > calib) |
static boost::shared_ptr< Wcs > | _cloneWcs (boost::shared_ptr< Wcs const > wcs) |
static boost::shared_ptr < ApCorrMap > | _cloneApCorrMap (boost::shared_ptr< ApCorrMap const > apCorrMap) |
Private Attributes | |
boost::shared_ptr< Wcs > | _wcs |
boost::shared_ptr< detection::Psf > | _psf |
boost::shared_ptr< Calib > | _calib |
boost::shared_ptr < cameraGeom::Detector const > | _detector |
boost::shared_ptr < geom::polygon::Polygon const > | _validPolygon |
Filter | _filter |
boost::shared_ptr < daf::base::PropertySet > | _metadata |
boost::shared_ptr< CoaddInputs > | _coaddInputs |
boost::shared_ptr< ApCorrMap > | _apCorrMap |
Friends | |
template<typename ImageT , typename MaskT , typename VarianceT > | |
class | Exposure |
A collection of all the things that make an Exposure different from a MaskedImage.
The constness semantics of the things held by ExposureInfo are admittedly a bit of a mess, but they're that way to preserve backwards compatibility for now. Eventually I'd like to make a lot of these things immutable, but in the meantime, here's the summary:
The setters for Wcs and Calib clone their input arguments (this is a departure from the previous behavior for Calib and Wcs but it's safer w.r.t. aliasing and it matches the old (and current) behavior of the Exposure and ExposureInfo constructors, which clone their arguments. The setter for Psf and constructors do not clone the Psf, as Psfs are immutable and hence we don't need to ensure strict ownership. The setter for Detector does not clone its input argument, because while it technically isn't, we can safely consider a Detector to be immutable once it's attached to an ExposureInfo.
Definition at line 80 of file ExposureInfo.h.
|
explicit |
Construct an ExposureInfo from its various components.
If a null Calib and/or PropertySet pointer is passed (the default), a new Calib and/or PropertyList will be created. To set these pointers to null, you must explicitly call setCalib or setMetadata after construction.
Definition at line 73 of file ExposureInfo.cc.
lsst.afw.image::ExposureInfo::ExposureInfo | ( | ExposureInfo const & | other | ) |
Copy constructor; deep-copies all components except the metadata.
Definition at line 94 of file ExposureInfo.cc.
lsst.afw.image::ExposureInfo::ExposureInfo | ( | ExposureInfo const & | other, |
bool | copyMetadata | ||
) |
Copy constructor; deep-copies everything, possibly including the metadata.
Definition at line 106 of file ExposureInfo.cc.
lsst.afw.image::ExposureInfo::~ExposureInfo | ( | ) |
Definition at line 139 of file ExposureInfo.cc.
|
staticprivate |
Definition at line 66 of file ExposureInfo.cc.
|
staticprivate |
Definition at line 60 of file ExposureInfo.cc.
|
private |
Write any additional non-image HDUs to a FITS file.
[in] | fitsfile | Open FITS object to write to. Does not need to be positioned to any particular HDU. |
The additional HDUs will be appended to the FITS file, and should line up with the HDU index keys included in the result of getFitsMetadata() if this is called after writing the MaskedImage HDUs.
Definition at line 220 of file ExposureInfo.cc.
|
private |
Read from a FITS file and metadata.
This operates in-place on this instead of returning a new object, because it will usually only be called by the exposure constructor, which starts by default-constructing the ExposureInfo.
Definition at line 224 of file ExposureInfo.cc.
|
private |
Start the process of writing an exposure to FITS.
[in] | xy0 | The origin of the exposure associated with this object, used to install a linear offset-only WCS in the FITS header. |
We need to define these keywords properly! XXX
Definition at line 142 of file ExposureInfo.cc.
|
inline |
Return the exposure's aperture correction map (null pointer if !hasApCorrMap())
Definition at line 154 of file ExposureInfo.h.
|
inline |
Return the exposure's aperture correction map (null pointer if !hasApCorrMap())
Definition at line 157 of file ExposureInfo.h.
|
inline |
|
inline |
|
inline |
Return a pair of catalogs that record the inputs, if this Exposure is a coadd (otherwise null).
Definition at line 177 of file ExposureInfo.h.
|
inline |
Return the exposure's Detector information.
Definition at line 99 of file ExposureInfo.h.
|
inline |
|
inline |
Return flexible metadata.
Definition at line 123 of file ExposureInfo.h.
|
inline |
Return the exposure's point-spread function.
Definition at line 132 of file ExposureInfo.h.
|
inline |
Return the valid Polygon.
Definition at line 145 of file ExposureInfo.h.
|
inline |
|
inline |
|
inline |
Return true if the exposure has an aperture correction map.
Definition at line 151 of file ExposureInfo.h.
|
inline |
|
inline |
Does this exposure have coadd provenance catalogs?
Definition at line 171 of file ExposureInfo.h.
|
inline |
Does this exposure have Detector information?
Definition at line 96 of file ExposureInfo.h.
|
inline |
Does this exposure have a Psf?
Definition at line 129 of file ExposureInfo.h.
|
inline |
Does this exposure have a valid Polygon.
Definition at line 142 of file ExposureInfo.h.
|
inline |
void lsst.afw.image::ExposureInfo::initApCorrMap | ( | ) |
Set the exposure's aperture correction map to a new, empty map
Note that the ExposureInfo constructors do not create an empty aperture correction map, so this method provide a convenient way to initialize one before filling it.
Definition at line 135 of file ExposureInfo.cc.
ExposureInfo & lsst.afw.image::ExposureInfo::operator= | ( | ExposureInfo const & | other | ) |
Assignment; deep-copies all components except the metadata.
Definition at line 120 of file ExposureInfo.cc.
|
inline |
Set the exposure's aperture correction map (null pointer if !hasApCorrMap())
Definition at line 160 of file ExposureInfo.h.
|
inline |
Set the Exposure's Calib object.
Definition at line 120 of file ExposureInfo.h.
|
inline |
Set the exposure's coadd provenance catalogs.
Definition at line 174 of file ExposureInfo.h.
|
inline |
Set the exposure's Detector information.
Definition at line 102 of file ExposureInfo.h.
|
inline |
|
inline |
Set the flexible metadata.
Definition at line 126 of file ExposureInfo.h.
|
inline |
Set the exposure's point-spread function.
Definition at line 135 of file ExposureInfo.h.
|
inline |
Set the exposure's valid Polygon.
Definition at line 148 of file ExposureInfo.h.
|
inline |
Set the coordinate system of the exposure.
Definition at line 93 of file ExposureInfo.h.
|
friend |
Definition at line 212 of file ExposureInfo.h.
|
private |
Definition at line 284 of file ExposureInfo.h.
|
private |
Definition at line 278 of file ExposureInfo.h.
|
private |
Definition at line 283 of file ExposureInfo.h.
|
private |
Definition at line 279 of file ExposureInfo.h.
|
private |
Definition at line 281 of file ExposureInfo.h.
|
private |
Definition at line 282 of file ExposureInfo.h.
|
private |
Definition at line 277 of file ExposureInfo.h.
|
private |
Definition at line 280 of file ExposureInfo.h.
|
private |
Definition at line 276 of file ExposureInfo.h.