A collection of all the things that make an Exposure different from a MaskedImage. More...

#include <ExposureInfo.h>

Public Member Functions
bool	hasId () const noexcept
	Does this Exposure have an exposure id? More...

table::RecordId	getId () const
	Return the exposure ID. More...

void	setId (table::RecordId id)
	Set the exposure ID. More...

void	clearId () noexcept
	Unset the exposure ID, if any. More...

bool	hasWcs () const
	Does this exposure have a Wcs? More...

std::shared_ptr< geom::SkyWcs const >	getWcs () const
	Return the WCS of the exposure. More...

void	setWcs (std::shared_ptr< geom::SkyWcs const > wcs)
	Set the WCS of the exposure. More...

bool	hasDetector () const
	Does this exposure have Detector information? More...

std::shared_ptr< cameraGeom::Detector const >	getDetector () const
	Return the exposure's Detector information. More...

void	setDetector (std::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	hasFilterLabel () const
	Does this exposure have filter information? More...

std::shared_ptr< FilterLabel const >	getFilterLabel () const
	Return the exposure's filter information. More...

void	setFilterLabel (std::shared_ptr< FilterLabel const > filterLabel)
	Set the exposure's filter information. More...

bool	hasPhotoCalib () const
	Does this exposure have a photometric calibration? More...

std::shared_ptr< PhotoCalib const >	getPhotoCalib () const
	Return the exposure's photometric calibration. More...

void	setPhotoCalib (std::shared_ptr< PhotoCalib const > photoCalib)
	Set the Exposure's PhotoCalib object. More...

std::shared_ptr< daf::base::PropertySet >	getMetadata () const
	Return flexible metadata. More...

void	setMetadata (std::shared_ptr< daf::base::PropertySet > metadata)
	Set the flexible metadata. More...

bool	hasPsf () const
	Does this exposure have a Psf? More...

std::shared_ptr< detection::Psf const >	getPsf () const
	Return the exposure's point-spread function. More...

void	setPsf (std::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...

std::shared_ptr< geom::polygon::Polygon const >	getValidPolygon () const
	Return the valid Polygon. More...

void	setValidPolygon (std::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...

std::shared_ptr< ApCorrMap const >	getApCorrMap () const
	Return the exposure's aperture correction map (null pointer if !hasApCorrMap()) More...

void	setApCorrMap (std::shared_ptr< ApCorrMap const > apCorrMap)
	Set the exposure's aperture correction map (null pointer if !hasApCorrMap()) More...

void	initApCorrMap ()
	Set the exposure's aperture correction map to a new, empty map. More...

bool	hasCoaddInputs () const
	Does this exposure have coadd provenance catalogs? More...

void	setCoaddInputs (std::shared_ptr< CoaddInputs const > coaddInputs)
	Set the exposure's coadd provenance catalogs. More...

std::shared_ptr< CoaddInputs const >	getCoaddInputs () const
	Return a pair of catalogs that record the inputs, if this Exposure is a coadd (otherwise null). More...

std::shared_ptr< image::VisitInfo const >	getVisitInfo () const
	Return the exposure's visit info. More...

bool	hasVisitInfo () const
	Does this exposure have visit info? More...

void	setVisitInfo (std::shared_ptr< image::VisitInfo const > const visitInfo)
	Set the exposure's visit info. More...

bool	hasTransmissionCurve () const
	Does this exposure have a transmission curve? More...

std::shared_ptr< TransmissionCurve const >	getTransmissionCurve () const
	Return the exposure's transmission curve. More...

void	setTransmissionCurve (std::shared_ptr< TransmissionCurve const > tc)
	Set the exposure's transmission curve. More...

template<class T >
void	setComponent (typehandling::Key< std::string, std::shared_ptr< T >> const &key, std::shared_ptr< T > const &object)
	Add a generic component to the ExposureInfo. More...

template<class T >
bool	hasComponent (typehandling::Key< std::string, T > const &key) const
	Test whether a generic component is defined. More...

template<class T >
std::shared_ptr< T >	getComponent (typehandling::Key< std::string, std::shared_ptr< T >> const &key) const
	Retrieve a generic component from the ExposureInfo. More...

template<class T >
bool	removeComponent (typehandling::Key< std::string, T > const &key)
	Clear a generic component from the ExposureInfo. More...

	ExposureInfo (std::shared_ptr< geom::SkyWcs const > const &wcs=std::shared_ptr< geom::SkyWcs const >(), std::shared_ptr< detection::Psf const > const &psf=std::shared_ptr< detection::Psf const >(), std::shared_ptr< PhotoCalib const > const &photoCalib=std::shared_ptr< PhotoCalib const >(), std::shared_ptr< cameraGeom::Detector const > const &detector=std::shared_ptr< cameraGeom::Detector const >(), std::shared_ptr< geom::polygon::Polygon const > const &polygon=std::shared_ptr< geom::polygon::Polygon const >(), Filter const &filter=Filter(), std::shared_ptr< daf::base::PropertySet > const &metadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< CoaddInputs > const &coaddInputs=std::shared_ptr< CoaddInputs >(), std::shared_ptr< ApCorrMap > const &apCorrMap=std::shared_ptr< ApCorrMap >(), std::shared_ptr< image::VisitInfo const > const &visitInfo=std::shared_ptr< image::VisitInfo const >(), std::shared_ptr< TransmissionCurve const > const &transmissionCurve=std::shared_ptr< TransmissionCurve >())
	Construct an ExposureInfo from its various components. More...

	ExposureInfo (ExposureInfo const &other)
	Copy constructor; shares all components. More...

	ExposureInfo (ExposureInfo &&other)

	ExposureInfo (ExposureInfo const &other, bool copyMetadata)
	Copy constructor; shares everything except possibly the metadata. More...

ExposureInfo &	operator= (ExposureInfo const &other)
	Assignment; shares all components. More...

ExposureInfo &	operator= (ExposureInfo &&other)

	~ExposureInfo ()

Static Public Member Functions
static int	getFitsSerializationVersion ()
	Get the version of FITS serialization that this ExposureInfo understands. More...

static std::string const &	getFitsSerializationVersionName ()
	Get the version of FITS serialization version info name. More...

Static Public Attributes
static typehandling::Key< std::string, std::shared_ptr< geom::SkyWcs const > > const	KEY_WCS
	Standard key for looking up the Wcs. More...

static typehandling::Key< std::string, std::shared_ptr< detection::Psf const > > const	KEY_PSF
	Standard key for looking up the point-spread function. More...

static typehandling::Key< std::string, std::shared_ptr< PhotoCalib const > > const	KEY_PHOTO_CALIB
	Standard key for looking up the photometric calibration. More...

static typehandling::Key< std::string, std::shared_ptr< cameraGeom::Detector const > > const	KEY_DETECTOR
	Standard key for looking up the detector information. More...

static typehandling::Key< std::string, std::shared_ptr< geom::polygon::Polygon const > > const	KEY_VALID_POLYGON
	Standard key for looking up the valid polygon. More...

static typehandling::Key< std::string, std::shared_ptr< CoaddInputs const > > const	KEY_COADD_INPUTS
	Standard key for looking up coadd provenance catalogs. More...

static typehandling::Key< std::string, std::shared_ptr< ApCorrMap const > > const	KEY_AP_CORR_MAP
	Standard key for looking up the aperture correction map. More...

static typehandling::Key< std::string, std::shared_ptr< TransmissionCurve const > > const	KEY_TRANSMISSION_CURVE
	Standard key for looking up the transmission curve. More...

static typehandling::Key< std::string, std::shared_ptr< FilterLabel const > > const	KEY_FILTER
	Standard key for looking up filter information. More...

Friends
template<typename ImageT , typename MaskT , typename VarianceT >
class	Exposure

Detailed Description

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:

VisitInfo is immutable and is held by a const ptr and has a setter and getter.
Metadata is held by non-const pointer, and you can get a non-const pointer via a const member function accessor (i.e. constness is not propagated).
all other types are only accessible through non-const pointers

The setter for Wcs clones its input arguments (this is a departure from the previous behavior for 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 89 of file ExposureInfo.h.

Constructor & Destructor Documentation

◆ ExposureInfo() [1/4]

lsst::afw::image::ExposureInfo::ExposureInfo	(	std::shared_ptr< geom::SkyWcs const > const &	wcs = `std::shared_ptr<geom::SkyWcs const>()`,
		std::shared_ptr< detection::Psf const > const &	psf = `std::shared_ptr<detection::Psf const>()`,
		std::shared_ptr< PhotoCalib const > const &	photoCalib = `std::shared_ptr<PhotoCalib const>()`,
		std::shared_ptr< cameraGeom::Detector const > const &	detector = `std::shared_ptr<cameraGeom::Detector const>()`,
		std::shared_ptr< geom::polygon::Polygon const > const &	polygon = `std::shared_ptr<geom::polygon::Polygon const>()`,
		Filter const &	filter = `Filter()`,
		std::shared_ptr< daf::base::PropertySet > const &	metadata = `std::shared_ptr<daf::base::PropertySet>()`,
		std::shared_ptr< CoaddInputs > const &	coaddInputs = `std::shared_ptr<CoaddInputs>()`,
		std::shared_ptr< ApCorrMap > const &	apCorrMap = `std::shared_ptr<ApCorrMap>()`,
		std::shared_ptr< image::VisitInfo const > const &	visitInfo = `std::shared_ptr<image::VisitInfo const>()`,
		std::shared_ptr< TransmissionCurve const > const &	transmissionCurve = `std::shared_ptr<TransmissionCurve>()`
	)

explicit

Construct an ExposureInfo from its various components.

If a null PhotoCalib and/or PropertySet pointer is passed (the default), a new PhotoCalib and/or PropertyList will be created. To set these pointers to null, you must explicitly call setPhotoCalib or setMetadata after construction.

Definition at line 207 of file ExposureInfo.cc.

         : _exposureId(),
           _metadata(metadata ? metadata
                              : std::shared_ptr<daf::base::PropertySet>(new daf::base::PropertyList())),
           _visitInfo(visitInfo),
           _components(std::make_unique<MapClass>()) {
     // setFilter guards against default filters
     setFilter(filter);
     setWcs(wcs);
     setPsf(psf);
     setPhotoCalib(photoCalib);
     setDetector(detector);
     setValidPolygon(polygon);
     setCoaddInputs(coaddInputs);
     setApCorrMap(_cloneApCorrMap(apCorrMap));
     setTransmissionCurve(transmissionCurve);
 }

◆ ExposureInfo() [2/4]

lsst::afw::image::ExposureInfo::ExposureInfo ( ExposureInfo const & other )

Copy constructor; shares all components.

Definition at line 234 of file ExposureInfo.cc.

234 : ExposureInfo(other, false) {}

lsst::afw::image::ExposureInfo::ExposureInfo

ExposureInfo(std::shared_ptr< geom::SkyWcs const > const &wcs=std::shared_ptr< geom::SkyWcs const >(), std::shared_ptr< detection::Psf const > const &psf=std::shared_ptr< detection::Psf const >(), std::shared_ptr< PhotoCalib const > const &photoCalib=std::shared_ptr< PhotoCalib const >(), std::shared_ptr< cameraGeom::Detector const > const &detector=std::shared_ptr< cameraGeom::Detector const >(), std::shared_ptr< geom::polygon::Polygon const > const &polygon=std::shared_ptr< geom::polygon::Polygon const >(), Filter const &filter=Filter(), std::shared_ptr< daf::base::PropertySet > const &metadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< CoaddInputs > const &coaddInputs=std::shared_ptr< CoaddInputs >(), std::shared_ptr< ApCorrMap > const &apCorrMap=std::shared_ptr< ApCorrMap >(), std::shared_ptr< image::VisitInfo const > const &visitInfo=std::shared_ptr< image::VisitInfo const >(), std::shared_ptr< TransmissionCurve const > const &transmissionCurve=std::shared_ptr< TransmissionCurve >())

Construct an ExposureInfo from its various components.

Definition: ExposureInfo.cc:207

◆ ExposureInfo() [3/4]

lsst::afw::image::ExposureInfo::ExposureInfo ( ExposureInfo && other )

Definition at line 237 of file ExposureInfo.cc.

237 : ExposureInfo(other) {}

◆ ExposureInfo() [4/4]

lsst::afw::image::ExposureInfo::ExposureInfo	(	ExposureInfo const &	other,
		bool	copyMetadata
	)

Copy constructor; shares everything except possibly the metadata.

Definition at line 239 of file ExposureInfo.cc.

         : _exposureId(other._exposureId),
           _metadata(other._metadata),
           _visitInfo(other._visitInfo),
           // ExposureInfos can (historically) share objects, but should each have their own pointers to them
           _components(std::make_unique<MapClass>(*(other._components))) {
     if (copyMetadata) _metadata = _metadata->deepCopy();
 }

◆ ~ExposureInfo()

lsst::afw::image::ExposureInfo::~ExposureInfo ( )

default

Member Function Documentation

◆ clearId()

void lsst::afw::image::ExposureInfo::clearId ( )

noexcept

Unset the exposure ID, if any.

Definition at line 158 of file ExposureInfo.cc.

158 { _exposureId.reset(); }

◆ getApCorrMap()

std::shared_ptr< ApCorrMap const > lsst::afw::image::ExposureInfo::getApCorrMap ( ) const

Return the exposure's aperture correction map (null pointer if !hasApCorrMap())

Definition at line 114 of file ExposureInfo.cc.

114 { return getComponent(KEY_AP_CORR_MAP); }

lsst::afw::image::ExposureInfo::getComponent

std::shared_ptr< T > getComponent(typehandling::Key< std::string, std::shared_ptr< T >> const &key) const

Retrieve a generic component from the ExposureInfo.

Definition: ExposureInfo.h:336

lsst::afw::image::ExposureInfo::KEY_AP_CORR_MAP

static typehandling::Key< std::string, std::shared_ptr< ApCorrMap const > > const KEY_AP_CORR_MAP

Standard key for looking up the aperture correction map.

Definition: ExposureInfo.h:105

◆ getCoaddInputs()

std::shared_ptr< CoaddInputs const > lsst::afw::image::ExposureInfo::getCoaddInputs ( ) const

Return a pair of catalogs that record the inputs, if this Exposure is a coadd (otherwise null).

Definition at line 106 of file ExposureInfo.cc.

                                                                     {
     return getComponent(KEY_COADD_INPUTS);
 }

◆ getComponent()

template<class T >

std::shared_ptr<T> lsst::afw::image::ExposureInfo::getComponent ( typehandling::Key< std::string, std::shared_ptr< T >> const & key ) const

inline

Retrieve a generic component from the ExposureInfo.

Parameters

key	a strongly typed identifier for the component

Returns: the component identified by that key, or a null pointer if no such component exists.

Exception Safety: Provides strong exception safety.

Definition at line 336 of file ExposureInfo.h.

                                                                                                  {
         try {
             return _components->at(key);
         } catch (pex::exceptions::OutOfRangeError const& e) {
             return nullptr;
         }
     }

◆ getDetector()

std::shared_ptr< cameraGeom::Detector const > lsst::afw::image::ExposureInfo::getDetector ( ) const

Return the exposure's Detector information.

Definition at line 80 of file ExposureInfo.cc.

                                                                         {
     return getComponent(KEY_DETECTOR);
 }

◆ getFilter()

Filter lsst::afw::image::ExposureInfo::getFilter ( ) const

Return the exposure's filter.

Definition at line 164 of file ExposureInfo.cc.

                                      {
     std::shared_ptr<FilterLabel const> label = getFilterLabel();
     if (label) {
         return makeFilter(*label);
     } else {
         // Old exposures always had a Filter, even if only the default
         return Filter();
     }
 }

◆ getFilterLabel()

std::shared_ptr< FilterLabel const > lsst::afw::image::ExposureInfo::getFilterLabel ( ) const

Return the exposure's filter information.

Definition at line 179 of file ExposureInfo.cc.

179 { return getComponent(KEY_FILTER); }

lsst::afw::image::ExposureInfo::KEY_FILTER

static typehandling::Key< std::string, std::shared_ptr< FilterLabel const > > const KEY_FILTER

Standard key for looking up filter information.

Definition: ExposureInfo.h:110

◆ getFitsSerializationVersion()

int lsst::afw::image::ExposureInfo::getFitsSerializationVersion ( )

static

Get the version of FITS serialization that this ExposureInfo understands.

Definition at line 184 of file ExposureInfo.cc.

                                               {
     // Version history:
     // unversioned and 0: photometric calibration via Calib, WCS via SkyWcs using AST.
     // 1: photometric calibration via PhotoCalib, generic components
     // 2: remove Filter, replaced with (generic) FilterLabel
     static int const version = 2;
     return version;
 }

◆ getFitsSerializationVersionName()

std::string const & lsst::afw::image::ExposureInfo::getFitsSerializationVersionName ( )

static

Get the version of FITS serialization version info name.

Definition at line 193 of file ExposureInfo.cc.

                                                                {
     static std::string const versionName("EXPINFO_V");
     return versionName;
 }

◆ getId()

table::RecordId lsst::afw::image::ExposureInfo::getId ( ) const

Return the exposure ID.

Exposure IDs are unique per single-detector image, not per on-sky shutter opening.

Returns: The ID.

Exceptions

lsst::pex::exceptions::NotFoundError Thrown if the exposure does not have an ID.

Definition at line 133 of file ExposureInfo.cc.

                                         {
     if (_exposureId) {
         return *_exposureId;
     } else {
         throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError, "Exposure does not have an ID.");
     }
 }

◆ getMetadata()

std::shared_ptr<daf::base::PropertySet> lsst::afw::image::ExposureInfo::getMetadata ( ) const

inline

Return flexible metadata.

Definition at line 201 of file ExposureInfo.h.

201 { return _metadata; }

◆ getPhotoCalib()

std::shared_ptr< PhotoCalib const > lsst::afw::image::ExposureInfo::getPhotoCalib ( ) const

Return the exposure's photometric calibration.

Definition at line 69 of file ExposureInfo.cc.

                                                                   {
     return getComponent(KEY_PHOTO_CALIB);
 }

◆ getPsf()

std::shared_ptr< detection::Psf const > lsst::afw::image::ExposureInfo::getPsf ( ) const

Return the exposure's point-spread function.

Definition at line 62 of file ExposureInfo.cc.

62 { return getComponent(KEY_PSF); }

lsst::afw::image::ExposureInfo::KEY_PSF

static typehandling::Key< std::string, std::shared_ptr< detection::Psf const > > const KEY_PSF

Standard key for looking up the point-spread function.

Definition: ExposureInfo.h:94

◆ getTransmissionCurve()

std::shared_ptr< TransmissionCurve const > lsst::afw::image::ExposureInfo::getTransmissionCurve ( ) const

Return the exposure's transmission curve.

Definition at line 124 of file ExposureInfo.cc.

                                                                                 {
     return getComponent(KEY_TRANSMISSION_CURVE);
 }

◆ getValidPolygon()

std::shared_ptr< geom::polygon::Polygon const > lsst::afw::image::ExposureInfo::getValidPolygon ( ) const

Return the valid Polygon.

Definition at line 92 of file ExposureInfo.cc.

                                                                             {
     return getComponent(KEY_VALID_POLYGON);
 }

◆ getVisitInfo()

std::shared_ptr<image::VisitInfo const> lsst::afw::image::ExposureInfo::getVisitInfo ( ) const

inline

Return the exposure's visit info.

Definition at line 251 of file ExposureInfo.h.

251 { return _visitInfo; }

◆ getWcs()

std::shared_ptr< geom::SkyWcs const > lsst::afw::image::ExposureInfo::getWcs ( ) const

Return the WCS of the exposure.

Definition at line 55 of file ExposureInfo.cc.

55 { return getComponent(KEY_WCS); }

lsst::afw::image::ExposureInfo::KEY_WCS

static typehandling::Key< std::string, std::shared_ptr< geom::SkyWcs const > > const KEY_WCS

Standard key for looking up the Wcs.

Definition: ExposureInfo.h:92

◆ hasApCorrMap()

bool lsst::afw::image::ExposureInfo::hasApCorrMap ( ) const

Return true if the exposure has an aperture correction map.

Definition at line 113 of file ExposureInfo.cc.

113 { return hasComponent(KEY_AP_CORR_MAP); }

lsst::afw::image::ExposureInfo::hasComponent

bool hasComponent(typehandling::Key< std::string, T > const &key) const

Test whether a generic component is defined.

Definition: ExposureInfo.h:322

◆ hasCoaddInputs()

bool lsst::afw::image::ExposureInfo::hasCoaddInputs ( ) const

Does this exposure have coadd provenance catalogs?

Definition at line 102 of file ExposureInfo.cc.

102 { return hasComponent(KEY_COADD_INPUTS); }

◆ hasComponent()

template<class T >

bool lsst::afw::image::ExposureInfo::hasComponent ( typehandling::Key< std::string, T > const & key ) const

inline

Test whether a generic component is defined.

Parameters

key	a strongly typed identifier for the component

Returns: true if there is a component with key, false otherwise

Exception Safety: Provides strong exception safety.

Definition at line 322 of file ExposureInfo.h.

                                                                       {
         return _components->contains(key);
     }

◆ hasDetector()

bool lsst::afw::image::ExposureInfo::hasDetector ( ) const

Does this exposure have Detector information?

Definition at line 79 of file ExposureInfo.cc.

79 { return hasComponent(KEY_DETECTOR); }

◆ hasFilterLabel()

bool lsst::afw::image::ExposureInfo::hasFilterLabel ( ) const

Does this exposure have filter information?

Definition at line 178 of file ExposureInfo.cc.

178 { return hasComponent(KEY_FILTER); }

◆ hasId()

bool lsst::afw::image::ExposureInfo::hasId ( ) const

noexcept

Does this Exposure have an exposure id?

Exposure IDs are unique per single-detector image, not per on-sky shutter opening. Some Exposures, such as coadds, do not have an ID.

Returns: Whether or not this exposure has a defined ID.

Definition at line 131 of file ExposureInfo.cc.

131 { return _exposureId.has_value(); }

◆ hasPhotoCalib()

bool lsst::afw::image::ExposureInfo::hasPhotoCalib ( ) const

Does this exposure have a photometric calibration?

Definition at line 68 of file ExposureInfo.cc.

68 { return hasComponent(KEY_PHOTO_CALIB); }

◆ hasPsf()

bool lsst::afw::image::ExposureInfo::hasPsf ( ) const

Does this exposure have a Psf?

Definition at line 61 of file ExposureInfo.cc.

61 { return hasComponent(KEY_PSF); }

◆ hasTransmissionCurve()

bool lsst::afw::image::ExposureInfo::hasTransmissionCurve ( ) const

Does this exposure have a transmission curve?

Definition at line 123 of file ExposureInfo.cc.

123 { return hasComponent(KEY_TRANSMISSION_CURVE); }

◆ hasValidPolygon()

bool lsst::afw::image::ExposureInfo::hasValidPolygon ( ) const

Does this exposure have a valid Polygon.

Definition at line 91 of file ExposureInfo.cc.

91 { return hasComponent(KEY_VALID_POLYGON); }

◆ hasVisitInfo()

bool lsst::afw::image::ExposureInfo::hasVisitInfo ( ) const

inline

Does this exposure have visit info?

Definition at line 254 of file ExposureInfo.h.

254 { return static_cast<bool>(_visitInfo); }

◆ hasWcs()

bool lsst::afw::image::ExposureInfo::hasWcs ( ) const

Does this exposure have a Wcs?

Definition at line 54 of file ExposureInfo.cc.

54 { return hasComponent(KEY_WCS); }

◆ initApCorrMap()

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 261 of file ExposureInfo.cc.

261 { setApCorrMap(std::make_shared<ApCorrMap>()); }

◆ operator=() [1/2]

ExposureInfo & lsst::afw::image::ExposureInfo::operator= ( ExposureInfo && other )

Definition at line 259 of file ExposureInfo.cc.

259 { return *this = other; }

◆ operator=() [2/2]

ExposureInfo & lsst::afw::image::ExposureInfo::operator= ( ExposureInfo const & other )

Assignment; shares all components.

Definition at line 248 of file ExposureInfo.cc.

                                                                {
     if (&other != this) {
         _exposureId = other._exposureId;
         _metadata = other._metadata;
         _visitInfo = other._visitInfo;
         // ExposureInfos can (historically) share objects, but should each have their own pointers to them
         _components = std::make_unique<MapClass>(*(other._components));
     }
     return *this;
 }

◆ removeComponent()

template<class T >

bool lsst::afw::image::ExposureInfo::removeComponent ( typehandling::Key< std::string, T > const & key )

inline

Clear a generic component from the ExposureInfo.

Parameters

key	a strongly typed identifier for the component. Only components of a compatible type are removed.

Returns: true if a component was removed, false otherwise.

Exception Safety: Provides strong exception safety.

Definition at line 354 of file ExposureInfo.h.

                                                                    {
         return _components->erase(key);
     }

◆ setApCorrMap()

void lsst::afw::image::ExposureInfo::setApCorrMap ( std::shared_ptr< ApCorrMap const > apCorrMap )

Set the exposure's aperture correction map (null pointer if !hasApCorrMap())

Definition at line 115 of file ExposureInfo.cc.

                                                                         {
     setComponent(KEY_AP_CORR_MAP, apCorrMap);
 }

◆ setCoaddInputs()

void lsst::afw::image::ExposureInfo::setCoaddInputs ( std::shared_ptr< CoaddInputs const > coaddInputs )

Set the exposure's coadd provenance catalogs.

Definition at line 103 of file ExposureInfo.cc.

                                                                               {
     setComponent(KEY_COADD_INPUTS, coaddInputs);
 }

◆ setComponent()

template<class T >

void lsst::afw::image::ExposureInfo::setComponent	(	typehandling::Key< std::string, std::shared_ptr< T >> const &	key,
		std::shared_ptr< T > const &	object
	)

inline

Add a generic component to the ExposureInfo.

If another component is already present under the key, it is overwritten. If a component of a different type is present under the same name, this method raises an exception.

Template Parameters

T	a subclass of typehandling::Storable

Parameters

key	a strongly typed identifier for the component
object	the object to add.

Exceptions

pex::exceptions::TypeError	Thrown if a component of a different type is present under the requested name.
pex::exceptions::RuntimeError	Thrown if the insertion failed for implementation-dependent reasons.

Exception Safety: Provides basic exception safety (a pre-existing component may be removed).

Note: if object is a null pointer, then hasComponent(key) shall return false after this method returns. This is for compatibility with old ExposureInfo idioms, which often use assignment of null to indicate no data.

Definition at line 302 of file ExposureInfo.h.

                                                       {
         static_assert(std::is_base_of<typehandling::Storable, T>::value, "T must be a Storable");
         // "No data" always represented internally by absent key-value pair, not by mapping to null
         if (object != nullptr) {
             _setComponent(key, object);
         } else {
             removeComponent(key);
         }
     }

◆ setDetector()

void lsst::afw::image::ExposureInfo::setDetector ( std::shared_ptr< cameraGeom::Detector const > detector )

Set the exposure's Detector information.

Definition at line 83 of file ExposureInfo.cc.

                                                                                {
     setComponent(KEY_DETECTOR, detector);
 }

◆ setFilter()

void lsst::afw::image::ExposureInfo::setFilter ( Filter const & filter )

Set the exposure's filter.

Parameters

filter The filter to set. If this is the default filter ("_unknown_"), it is interpreted as "no filter".

Definition at line 174 of file ExposureInfo.cc.

174 { setFilterLabel(makeFilterLabel(filter)); }

lsst::afw::image::ExposureInfo::setFilterLabel

void setFilterLabel(std::shared_ptr< FilterLabel const > filterLabel)

Set the exposure's filter information.

Definition: ExposureInfo.cc:180

lsst::afw::image::makeFilterLabel

std::shared_ptr< FilterLabel > makeFilterLabel(Filter const &filter)

Convert an old-style Filter to a FilterLabel.

Definition: ExposureFitsReader.cc:122

◆ setFilterLabel()

void lsst::afw::image::ExposureInfo::setFilterLabel ( std::shared_ptr< FilterLabel const > filterLabel )

Set the exposure's filter information.

Definition at line 180 of file ExposureInfo.cc.

                                                                         {
     setComponent(KEY_FILTER, label);
 }

◆ setId()

void lsst::afw::image::ExposureInfo::setId ( table::RecordId id )

Set the exposure ID.

Exposure IDs are unique per single-detector image, not per on-sky shutter opening.

Parameters

id	The new exposure ID to set.

Definition at line 141 of file ExposureInfo.cc.

                                          {
     _exposureId = id;
     // Ensure consistency with VisitInfo::getExposureId() until the latter is removed in DM-32138.
     std::shared_ptr<VisitInfo const> oldVisitInfo = getVisitInfo();
     if (oldVisitInfo) {
         auto newVisitInfo = std::make_shared<VisitInfo>(
                 *_exposureId, oldVisitInfo->getExposureTime(), oldVisitInfo->getDarkTime(),
                 oldVisitInfo->getDate(), oldVisitInfo->getUt1(), oldVisitInfo->getEra(),
                 oldVisitInfo->getBoresightRaDec(), oldVisitInfo->getBoresightAzAlt(),
                 oldVisitInfo->getBoresightAirmass(), oldVisitInfo->getBoresightRotAngle(),
                 oldVisitInfo->getRotType(), oldVisitInfo->getObservatory(), oldVisitInfo->getWeather(),
                 oldVisitInfo->getInstrumentLabel(), oldVisitInfo->getId());
         // Do not call setVisitInfo, to avoid recursion
         _visitInfo = newVisitInfo;
     }
 }

◆ setMetadata()

void lsst::afw::image::ExposureInfo::setMetadata ( std::shared_ptr< daf::base::PropertySet > metadata )

inline

Set the flexible metadata.

Definition at line 204 of file ExposureInfo.h.

204 { _metadata = metadata; }

◆ setPhotoCalib()

void lsst::afw::image::ExposureInfo::setPhotoCalib ( std::shared_ptr< PhotoCalib const > photoCalib )

Set the Exposure's PhotoCalib object.

Definition at line 72 of file ExposureInfo.cc.

                                                                            {
     setComponent(KEY_PHOTO_CALIB, photoCalib);
 }

◆ setPsf()

void lsst::afw::image::ExposureInfo::setPsf ( std::shared_ptr< detection::Psf const > psf )

Set the exposure's point-spread function.

Definition at line 63 of file ExposureInfo.cc.

63 { setComponent(KEY_PSF, psf); }

◆ setTransmissionCurve()

void lsst::afw::image::ExposureInfo::setTransmissionCurve ( std::shared_ptr< TransmissionCurve const > tc )

Set the exposure's transmission curve.

Definition at line 127 of file ExposureInfo.cc.

                                                                                  {
     setComponent(KEY_TRANSMISSION_CURVE, tc);
 }

◆ setValidPolygon()

void lsst::afw::image::ExposureInfo::setValidPolygon ( std::shared_ptr< geom::polygon::Polygon const > polygon )

Set the exposure's valid Polygon.

Definition at line 95 of file ExposureInfo.cc.

                                                                                   {
     setComponent(KEY_VALID_POLYGON, polygon);
 }

◆ setVisitInfo()

void lsst::afw::image::ExposureInfo::setVisitInfo ( std::shared_ptr< image::VisitInfo const > const visitInfo )

inline

Set the exposure's visit info.

Definition at line 257 of file ExposureInfo.h.

                                                                            {
         _visitInfo = visitInfo;
         // Ensure consistency with getId() until the VisitInfo::getExposureId() is removed in DM-32138.
         if (_visitInfo != nullptr && _visitInfo->getExposureId() != 0) {
             // Do not call setId, to avoid recursion
             _exposureId = _visitInfo->getExposureId();
         } else {
             _exposureId.reset();
         }
     }

◆ setWcs()

void lsst::afw::image::ExposureInfo::setWcs ( std::shared_ptr< geom::SkyWcs const > wcs )

Set the WCS of the exposure.

Definition at line 56 of file ExposureInfo.cc.

56 { setComponent(KEY_WCS, wcs); }

Friends And Related Function Documentation

◆ Exposure

Initial value:

=

typehandling::makeKey<std::shared_ptr<geom::SkyWcs const>>("SKYWCS"s)

Standard key for looking up the Wcs.

Definition at line 92 of file ExposureInfo.h.

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

/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/image/ExposureInfo.h
/j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/image/ExposureInfo.cc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ExposureInfo() [1/4]

◆ ExposureInfo() [2/4]

◆ ExposureInfo() [3/4]

◆ ExposureInfo() [4/4]

◆ ~ExposureInfo()

Member Function Documentation

◆ clearId()

◆ getApCorrMap()

◆ getCoaddInputs()

◆ getComponent()

◆ getDetector()

◆ getFilter()

◆ getFilterLabel()

◆ getFitsSerializationVersion()

◆ getFitsSerializationVersionName()

◆ getId()

◆ getMetadata()

◆ getPhotoCalib()

◆ getPsf()

◆ getTransmissionCurve()

◆ getValidPolygon()

◆ getVisitInfo()

◆ getWcs()

◆ hasApCorrMap()

◆ hasCoaddInputs()

◆ hasComponent()

◆ hasDetector()

◆ hasFilterLabel()

◆ hasId()

◆ hasPhotoCalib()

◆ hasPsf()

◆ hasTransmissionCurve()

◆ hasValidPolygon()

◆ hasVisitInfo()

◆ hasWcs()

◆ initApCorrMap()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeComponent()

◆ setApCorrMap()

◆ setCoaddInputs()

◆ setComponent()

◆ setDetector()

◆ setFilter()

◆ setFilterLabel()

◆ setId()

◆ setMetadata()

◆ setPhotoCalib()

◆ setPsf()

◆ setTransmissionCurve()

◆ setValidPolygon()

◆ setVisitInfo()

◆ setWcs()

Friends And Related Function Documentation

◆ Exposure

Member Data Documentation

◆ KEY_AP_CORR_MAP

◆ KEY_COADD_INPUTS

◆ KEY_DETECTOR

◆ KEY_FILTER

◆ KEY_PHOTO_CALIB

◆ KEY_PSF

◆ KEY_TRANSMISSION_CURVE

◆ KEY_VALID_POLYGON

◆ KEY_WCS