lsst.afw.image::ExposureInfo Class Reference

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	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 >(), 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 >())
	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)

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
Filter	_filter
boost::shared_ptr < daf::base::PropertySet >	_metadata
boost::shared_ptr< CoaddInputs >	_coaddInputs

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:

• Wcs, Calib, and Psf are held by non-const pointer, and you can get a non-const pointer via a non-const member function accessor and a const pointer via a const member function accessor.
• Detector is held by const pointer and only returned by const pointer (but if you're in Python, SWIG will have casted all that constness away).
• Filter is held and returned by value.
• 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).

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 75 of file ExposureInfo.h.

Constructor & Destructor Documentation

lsst.afw.image::ExposureInfo::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>(), 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 >()  )

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

  : _wcs(_cloneWcs(wcs)),
    _psf(boost::const_pointer_cast<detection::Psf>(psf)),
    _calib(calib ? _cloneCalib(calib) : PTR(Calib)(new Calib())),
    _detector(detector),
    _filter(filter),
    _metadata(metadata ? metadata : PTR(daf::base::PropertySet)(new daf::base::PropertyList())),
    _coaddInputs(coaddInputs)
{}

lsst.afw.image::ExposureInfo::ExposureInfo

(

ExposureInfo const &

other

)

Copy constructor; deep-copies all components except the metadata.

Definition at line 81 of file ExposureInfo.cc.

                                                     : 
    _wcs(_cloneWcs(other._wcs)),
    _psf(other._psf),
    _calib(_cloneCalib(other._calib)),
    _detector(other._detector),
    _filter(other._filter),
    _metadata(other._metadata),
    _coaddInputs(other._coaddInputs)
{}

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

Copy constructor; deep-copies everything, possibly including the metadata.

Definition at line 91 of file ExposureInfo.cc.

                                                                        :
    _wcs(_cloneWcs(other._wcs)),
    _psf(other._psf),
    _calib(_cloneCalib(other._calib)),
    _detector(other._detector),
    _filter(other._filter),
    _metadata(other._metadata),
    _coaddInputs(other._coaddInputs)
{
    if (copyMetadata) _metadata = _metadata->deepCopy();
}

lsst.afw.image::ExposureInfo::~ExposureInfo

(

)

Definition at line 116 of file ExposureInfo.cc.

{}

Member Function Documentation

boost::shared_ptr< Calib > lsst.afw.image::ExposureInfo::_cloneCalib ( boost::shared_ptr< Calib const >  calib )

staticprivate

Definition at line 52 of file ExposureInfo.cc.

                                                           {
    if (calib)
        return PTR(Calib)(new Calib(*calib));
    return PTR(Calib)();
}

boost::shared_ptr< Wcs > lsst.afw.image::ExposureInfo::_cloneWcs ( boost::shared_ptr< Wcs const >  wcs )

staticprivate

Definition at line 58 of file ExposureInfo.cc.

                                                   {
    if (wcs)
        return wcs->clone();
    return PTR(Wcs)();
}

void lsst.afw.image::ExposureInfo::_finishWriteFits ( fits::Fits &  fitsfile, FitsWriteData const &  data  ) const

private

Write any additional non-image HDUs to a FITS file.

Parameters

[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.

See Also

FitsWriteData

Definition at line 189 of file ExposureInfo.cc.

                                                                                         {
    data.archive.writeFits(fitsfile);
}

void lsst.afw.image::ExposureInfo::_readFits ( fits::Fits &  fitsfile, boost::shared_ptr< daf::base::PropertySet >  metadata, boost::shared_ptr< daf::base::PropertySet >  imageMetadata  )

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

  {
    // true: strip keywords that are related to the created WCS from the input metadata
    _wcs = makeWcs(imageMetadata, true);

    if (!imageMetadata->exists("INHERIT")) {
        // New-style exposures put everything but the Wcs in the primary HDU, use
        // INHERIT keyword in the others.  For backwards compatibility, if we don't
        // find the INHERIT keyword, we ignore the primary HDU metadata and expect
        // everything to be in the image HDU metadata.  Note that we can't merge them,
        // because they're probably duplicates.
        metadata = imageMetadata;
    }

    _filter = Filter(metadata, true);
    detail::stripFilterKeywords(metadata);

    PTR(Calib) newCalib(new Calib(metadata));
    setCalib(newCalib);
    detail::stripCalibKeywords(metadata);

    int archiveHdu = popInt(*metadata, "AR_HDU");

    if (archiveHdu) {
        fitsfile.setHdu(archiveHdu);
        table::io::InputArchive archive = table::io::InputArchive::readFits(fitsfile);
        // Load the Psf and Wcs from the archive; id=0 results in a null pointer.
        // Note that the binary table Wcs, if present, clobbers the FITS header one,
        // because the former might be an approximation to something we can't represent
        // using the FITS WCS standard but can represent with binary tables.
        int psfId = popInt(*metadata, "PSF_ID");
        try {
            _psf = archive.get<detection::Psf>(psfId);
        } catch (pex::exceptions::NotFoundError & err) {
            pex::logging::Log::getDefaultLog().warn(
                boost::format("Could not read PSF; setting to null: %s") % err.what()
            );
        }
        int wcsId = popInt(*metadata, "WCS_ID");
        try {
            _wcs = archive.get<Wcs>(wcsId);
        } catch (pex::exceptions::NotFoundError & err) {
            pex::logging::Log::getDefaultLog().warn(
                boost::format("Could not read WCS; setting to null: %s") % err.what()
            );
        }
        int coaddInputsId = popInt(*metadata, "COADD_INPUTS_ID");
        try {
            _coaddInputs = archive.get<CoaddInputs>(coaddInputsId);
        } catch (pex::exceptions::NotFoundError & err) {
            pex::logging::Log::getDefaultLog().warn(
                boost::format("Could not read CoaddInputs; setting to null: %s") % err.what()
            );
        }
    }

    _metadata = metadata;
}

ExposureInfo::FitsWriteData lsst.afw.image::ExposureInfo::_startWriteFits ( geom::Point2I const &  xy0 = geom::Point2I() ) const

private

Start the process of writing an exposure to FITS.

Parameters

[in]

xy0

The origin of the exposure associated with this object, used to install a linear offset-only WCS in the FITS header.

See Also

FitsWriteData

We need to define these keywords properly! XXX

Definition at line 119 of file ExposureInfo.cc.

                                                              {
    
    FitsWriteData data;

    data.metadata.reset(new daf::base::PropertyList());
    data.imageMetadata.reset(new daf::base::PropertyList());
    data.maskMetadata = data.imageMetadata;
    data.varianceMetadata = data.imageMetadata;

    data.metadata->combine(getMetadata());

    // In the future, we might not have exactly three image HDUs, but we always do right now,
    // so 1=primary, 2=image, 3=mask, 4=variance, 5+=archive
    data.metadata->set("AR_HDU", 5, "HDU containing the archive used to store ancillary objects");
    if (hasCoaddInputs()) {
        int coaddInputsId = data.archive.put(getCoaddInputs());
        data.metadata->set("COADD_INPUTS_ID", coaddInputsId, "archive ID for coadd inputs catalogs");
    }
    if (hasPsf() && getPsf()->isPersistable()) {
        int psfId = data.archive.put(getPsf());
        data.metadata->set("PSF_ID", psfId, "archive ID for the Exposure's main Psf");
    }
    if (hasWcs() && getWcs()->isPersistable()) {
        int wcsId = data.archive.put(getWcs());
        data.metadata->set("WCS_ID", wcsId, "archive ID for the Exposure's main Wcs");
    }

    //LSST convention is that Wcs is in pixel coordinates (i.e relative to bottom left
    //corner of parent image, if any). The Wcs/Fits convention is that the Wcs is in
    //image coordinates. When saving an image we convert from pixel to index coordinates.
    //In the case where this image is a parent image, the reference pixels are unchanged
    //by this transformation
    if (hasWcs()) {
        PTR(Wcs) newWcs = getWcs()->clone(); //Create a copy
        newWcs->shiftReferencePixel(-xy0.getX(), -xy0.getY() );

        // We want the WCS to appear in all HDUs
        data.imageMetadata->combine(newWcs->getFitsMetadata());
    }

    //Store _x0 and _y0. If this exposure is a portion of a larger image, _x0 and _y0
    //indicate the origin (the position of the bottom left corner) of the sub-image with
    //respect to the origin of the parent image.
    //This is stored in the fits header using the LTV convention used by STScI
    //(see \S2.6.2 of HST Data Handbook for STIS, version 5.0
    // http://www.stsci.edu/hst/stis/documents/handbooks/currentDHB/ch2_stis_data7.html#429287).
    //This is not a fits standard keyword, but is recognised by ds9
    //LTV keywords use the opposite convention to the LSST, in that they represent
    //the position of the origin of the parent image relative to the origin of the sub-image.
    // _x0, _y0 >= 0, while LTV1 and LTV2 <= 0
  
    data.imageMetadata->set("LTV1", -xy0.getX());
    data.imageMetadata->set("LTV2", -xy0.getY());

    data.metadata->set("FILTER", getFilter().getName());
    if (hasDetector()) {
        data.metadata->set("DETNAME", getDetector()->getName());
        data.metadata->set("DETSER", getDetector()->getSerial());
    }
    data.metadata->set("TIME-MID", getCalib()->getMidTime().toString());
    data.metadata->set("EXPTIME", getCalib()->getExptime());
    data.metadata->set("FLUXMAG0", getCalib()->getFluxMag0().first);
    data.metadata->set("FLUXMAG0ERR", getCalib()->getFluxMag0().second);
    
    return data;
}

boost::shared_ptr< Calib > lsst.afw.image::ExposureInfo::getCalib ( )

inline

Return the exposure's photometric calibration.

Definition at line 109 of file ExposureInfo.h.

{ return _calib; }

boost::shared_ptr< Calib const> lsst.afw.image::ExposureInfo::getCalib ( ) const

inline

Return the exposure's photometric calibration.

Definition at line 112 of file ExposureInfo.h.

{ return _calib; }

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

inline

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

Definition at line 143 of file ExposureInfo.h.

{ return _coaddInputs; }

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

inline

Return the exposure's Detector information.

Definition at line 94 of file ExposureInfo.h.

{ return _detector; }

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

inline

Return the exposure's filter.

Definition at line 100 of file ExposureInfo.h.

{ return _filter; }

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

inline

Return flexible metadata.

Definition at line 118 of file ExposureInfo.h.

{ return _metadata; }

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

inline

Return the exposure's point-spread function.

Definition at line 127 of file ExposureInfo.h.

{ return _psf; }

boost::shared_ptr< Wcs > lsst.afw.image::ExposureInfo::getWcs ( )

inline

Return the coordinate system of the exposure.

Definition at line 82 of file ExposureInfo.h.

{ return _wcs; }

boost::shared_ptr< Wcs const> lsst.afw.image::ExposureInfo::getWcs ( ) const

inline

Return the coordinate system of the exposure.

Definition at line 85 of file ExposureInfo.h.

{ return _wcs; }

bool lsst.afw.image::ExposureInfo::hasCalib ( ) const

inline

Does this exposure have a Calib?

Definition at line 106 of file ExposureInfo.h.

{ return static_cast<bool>(_calib); }

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

inline

Does this exposure have coadd provenance catalogs?

Definition at line 137 of file ExposureInfo.h.

{ return static_cast<bool>(_coaddInputs); }

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

inline

Does this exposure have Detector information?

Definition at line 91 of file ExposureInfo.h.

{ return static_cast<bool>(_detector); }

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

inline

Does this exposure have a Psf?

Definition at line 124 of file ExposureInfo.h.

{ return static_cast<bool>(_psf); }

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

inline

Does this exposure have a Wcs?

Definition at line 79 of file ExposureInfo.h.

{ return static_cast<bool>(_wcs); }

ExposureInfo & lsst.afw.image::ExposureInfo::operator=

(

ExposureInfo const &

other

)

Assignment; deep-copies all components except the metadata.

Definition at line 103 of file ExposureInfo.cc.

                                                                 {
    if (&other != this) {
        _wcs = _cloneWcs(other._wcs);
        _psf = other._psf;
        _calib = _cloneCalib(other._calib);
        _detector = other._detector;
        _filter = other._filter;
        _metadata = other._metadata;
        _coaddInputs = other._coaddInputs;
    }
    return *this;
}

void lsst.afw.image::ExposureInfo::setCalib ( boost::shared_ptr< Calib const >  calib )

inline

Set the Exposure's Calib object.

Definition at line 115 of file ExposureInfo.h.

{ _calib = _cloneCalib(calib); }

void lsst.afw.image::ExposureInfo::setCoaddInputs ( boost::shared_ptr< CoaddInputs >  coaddInputs )

inline

Set the exposure's coadd provenance catalogs.

Definition at line 140 of file ExposureInfo.h.

{ _coaddInputs = coaddInputs; }

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

inline

Set the exposure's Detector information.

Definition at line 97 of file ExposureInfo.h.

{ _detector = detector; }

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

inline

Set the exposure's filter.

Definition at line 103 of file ExposureInfo.h.

{ _filter = filter; }

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

inline

Set the flexible metadata.

Definition at line 121 of file ExposureInfo.h.

{ _metadata = metadata; }

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

inline

Set the exposure's point-spread function.

Definition at line 130 of file ExposureInfo.h.

                                             {
        // Psfs are immutable, so this is always safe; it'd be better to always just pass around
        // const or non-const pointers, instead of both, but this is more backwards-compatible.
        _psf = boost::const_pointer_cast<detection::Psf>(psf);
    }

void lsst.afw.image::ExposureInfo::setWcs ( boost::shared_ptr< Wcs const >  wcs )

inline

Set the coordinate system of the exposure.

Definition at line 88 of file ExposureInfo.h.

{ _wcs = _cloneWcs(wcs); }

Friends And Related Function Documentation

template<typename ImageT , typename MaskT , typename VarianceT >

friend class Exposure

friend

Definition at line 176 of file ExposureInfo.h.

Member Data Documentation

boost::shared_ptr< Calib > lsst.afw.image::ExposureInfo::_calib

private

Definition at line 241 of file ExposureInfo.h.

boost::shared_ptr< CoaddInputs > lsst.afw.image::ExposureInfo::_coaddInputs

private

Definition at line 245 of file ExposureInfo.h.

boost::shared_ptr< cameraGeom::Detector const> lsst.afw.image::ExposureInfo::_detector

private

Definition at line 242 of file ExposureInfo.h.

Filter lsst.afw.image::ExposureInfo::_filter

private

Definition at line 243 of file ExposureInfo.h.

boost::shared_ptr< daf::base::PropertySet > lsst.afw.image::ExposureInfo::_metadata

private

Definition at line 244 of file ExposureInfo.h.

boost::shared_ptr< detection::Psf > lsst.afw.image::ExposureInfo::_psf

private

Definition at line 240 of file ExposureInfo.h.

boost::shared_ptr< Wcs > lsst.afw.image::ExposureInfo::_wcs

private

Definition at line 239 of file ExposureInfo.h.

---

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

• /home/lsstsw/stack/Linux64/afw/10.0-40-g4349866+2/include/lsst/afw/image/ExposureInfo.h
• /home/lsstsw/stack/Linux64/afw/10.0-40-g4349866+2/src/image/ExposureInfo.cc