#include <ExposureInfo.h>

Inheritance diagram for lsst::ap::match::ExposureInfo:

Public Types
typedef boost::shared_ptr < ExposureInfo >	Ptr

typedef boost::shared_ptr < ExposureInfo const >	ConstPtr

Public Member Functions
	ExposureInfo (lsst::daf::base::PropertySet::Ptr props, std::string const &idKey=DEF_ID_KEY)

	ExposureInfo (lsst::daf::base::PropertySet::Ptr props, int64_t id)

	~ExposureInfo ()

int64_t	getId () const
	Return the unique integer identifier for the exposure. More...

lsst::afw::image::Filter const &	getFilter () const
	Return the filter of the exposure. UNKNOWN for multi-band. More...

double	getEpoch () const
	Return the exposure mid-point, MJD TAI. NaN for coadds. More...

double	getExposureTime () const
	Return the exposure time, s. NaN for coadds. More...

lsst::afw::coord::IcrsCoord const &	getCenter () const
	Return the ICRS coordinates of the image center (rad). More...

Eigen::Vector3d const &	getEarthPosition () const
	Return the SSB coordinates of the earth at t = getEpoch(). More...

bool	canCalibrateFlux () const
	Is there enough information to calibrate fluxes? More...

double	calibrateFlux (double flux, double fluxScale) const

std::pair< double, double > const	calibrateFlux (double flux, double fluxSigma, double fluxScale) const

virtual double	getMinCoord0 () const

virtual double	getMaxCoord0 () const

virtual double	getMinCoord1 () const

virtual double	getMaxCoord1 () const


int	getWidth () const
	Get exposure width and/or height. More...

int	getHeight () const
	Get exposure width and/or height. More...

lsst::afw::geom::Extent2I const	getExtent () const
	Get exposure width and/or height. More...


int	getX0 () const
	Get pixel coordinates of sub-image pixel (0,0) in the parent exposure. More...

int	getY0 () const
	Get pixel coordinates of sub-image pixel (0,0) in the parent exposure. More...

lsst::afw::geom::Point2I const	getXY0 () const
	Get pixel coordinates of sub-image pixel (0,0) in the parent exposure. More...


lsst::afw::image::Wcs::ConstPtr	getWcs () const
	Return the exposure WCS. More...

lsst::afw::image::Wcs::Ptr	getWcs ()
	Return the exposure WCS. More...

Public Member Functions inherited from lsst::ap::match::BBox
virtual	~BBox ()

Static Public Attributes
static std::string const	DEF_ID_KEY

Private Member Functions
Eigen::Vector3d const	_pixToSky (double x, double y) const

void	_init (lsst::daf::base::PropertySet::Ptr props)

Private Attributes
lsst::afw::coord::IcrsCoord	_center

lsst::afw::geom::Angle	_radius

lsst::afw::geom::Angle	_alpha

Eigen::Vector3d	_earthPos

int64_t	_id

double	_epoch

double	_expTime

double	_fluxMag0

double	_fluxMag0Sigma

lsst::afw::geom::Extent2I	_extent

lsst::afw::geom::Point2I	_xy0

lsst::afw::image::Wcs::Ptr	_wcs

lsst::afw::image::Filter	_filter

int	_filterId

bool	_canCalibrateFlux

bool	_epValid

Detailed Description

Class that bundles together the WCS, extents, time and flux calibration information from an exposure (typically a CCD). No pixel access is provided. The lsst::daf::base::PropertySet containing the FITS header cards from which instances are created is not stored.

This provides a relatively memory efficient representation of the CCD metadata AP cares about, which is important since metadata for tens of thousands of CCDs may need to be kept in memory simultaneously.

Definition at line 61 of file ExposureInfo.h.

Member Typedef Documentation

typedef boost::shared_ptr<ExposureInfo const> lsst::ap::match::ExposureInfo::ConstPtr

Definition at line 64 of file ExposureInfo.h.

typedef boost::shared_ptr<ExposureInfo> lsst::ap::match::ExposureInfo::Ptr

Definition at line 63 of file ExposureInfo.h.

Constructor & Destructor Documentation

lsst::ap::match::ExposureInfo::ExposureInfo	(	lsst::daf::base::PropertySet::Ptr	metadata,
		std::string const &	idKey = `DEF_ID_KEY`
	)

Parameters

metadata	FITS metadata for image
idKey	Metadata key for unique integer image id

Definition at line 130 of file ExposureInfo.cc.

   :
     _center(),
     _earthPos(),
     _id(metadata->getAsInt64(idKey)),
     _epoch(std::numeric_limits<double>::quiet_NaN()),
     _expTime(std::numeric_limits<double>::quiet_NaN()),
     _fluxMag0(std::numeric_limits<double>::quiet_NaN()),
     _fluxMag0Sigma(std::numeric_limits<double>::quiet_NaN()),
     _extent(),
     _xy0(0, 0),
     _wcs(lsst::afw::image::makeWcs(metadata, false)),
     _filter(),
     _canCalibrateFlux(false),
     _epValid(false)
 {
     _init(metadata);
 }

lsst::ap::match::ExposureInfo::ExposureInfo	(	lsst::daf::base::PropertySet::Ptr	metadata,
		int64_t	id
	)

Parameters

metadata	FITS metadata for image
id	Unique integer image id

Definition at line 151 of file ExposureInfo.cc.

   :
     _center(),
     _earthPos(),
     _id(id),
     _epoch(std::numeric_limits<double>::quiet_NaN()),
     _expTime(std::numeric_limits<double>::quiet_NaN()),
     _fluxMag0(std::numeric_limits<double>::quiet_NaN()),
     _fluxMag0Sigma(std::numeric_limits<double>::quiet_NaN()),
     _extent(),
     _xy0(0, 0),
     _wcs(lsst::afw::image::makeWcs(metadata, false)),
     _filter(),
     _canCalibrateFlux(false),
     _epValid(false)
 {
     _init(metadata);
 }

lsst::ap::match::ExposureInfo::~ExposureInfo ( )

Definition at line 172 of file ExposureInfo.cc.

172 { }

Member Function Documentation

void lsst::ap::match::ExposureInfo::_init ( lsst::daf::base::PropertySet::Ptr props )

private

Definition at line 71 of file ExposureInfo.cc.

                                                            {
     if (metadata->exists("FILTER")) {
         _filter = Filter(trim_copy(metadata->getAsString("FILTER")), false);
     }
     // get image extents
     _extent.setX(metadata->getAsInt("NAXIS1"));
     _extent.setY(metadata->getAsInt("NAXIS2"));
     if (metadata->exists("LTV1")) {
         _xy0.setX(-metadata->getAsInt("LTV1"));
     }
     if (metadata->exists("LTV2")) {
         _xy0.setY(-metadata->getAsInt("LTV2"));
     }
     // get image exposure time and mid-point
     if (metadata->exists("TIME-MID")) {
         DateTime mid(metadata->getAsString("TIME-MID"));
         _epoch = mid.get(DateTime::MJD, DateTime::TAI);
     }
     if (metadata->exists("EXPTIME")) {
         _expTime = metadata->getAsDouble("EXPTIME");
     }
     // get image flux
     if (metadata->exists("FLUXMAG0")) {
         if (metadata->exists("FLUXMAG0ERR")) {
             _fluxMag0Sigma = metadata->getAsDouble("FLUXMAG0ERR");
             if (_fluxMag0Sigma < 0.0) {
                 throw LSST_EXCEPT(InvalidParameterError,
                                   "negative magnitude zero point error");
             }
         } else {
             _fluxMag0Sigma = 0.0;
         }
         _fluxMag0 = metadata->getAsDouble("FLUXMAG0");
         if (_fluxMag0 <= 0.0) {
             throw LSST_EXCEPT(InvalidParameterError,
                               "magnitude zero point is negative or zero");
         }
         _canCalibrateFlux = true;
     }
     // compute image center and corners
     Eigen::Vector3d c = _pixToSky(_xy0.getX() + 0.5*_extent.getX() + PixelZeroPos,
                                   _xy0.getY() + 0.5*_extent.getY() + PixelZeroPos);
     Eigen::Vector3d llc = _pixToSky(_xy0.getX() + PixelZeroPos - 0.5,
                                     _xy0.getY() + PixelZeroPos - 0.5);
     Eigen::Vector3d ulc = _pixToSky(_xy0.getX() + PixelZeroPos - 0.5,
                                     _xy0.getY() + _extent.getY() - 0.5 + PixelZeroPos);
     Eigen::Vector3d lrc = _pixToSky(_xy0.getX() + _extent.getX() - 0.5 + PixelZeroPos,
                                     _xy0.getY() + PixelZeroPos - 0.5);
     Eigen::Vector3d urc = _pixToSky(_xy0.getX() + _extent.getX() - 0.5 + PixelZeroPos,
                                     _xy0.getY() + _extent.getY() - 0.5 + PixelZeroPos);
     // compute bounding box from bounding circle
     _center = cartesianToIcrs(c);
     _radius = angularSeparation(c, llc);
     _radius = max(_radius, angularSeparation(c, ulc));
     _radius = max(_radius, angularSeparation(c, lrc));
     _radius = max(_radius, angularSeparation(c, urc));
     _alpha = maxAlpha(_radius, _center.getLatitude());
 }

Eigen::Vector3d const lsst::ap::match::ExposureInfo::_pixToSky	(	double	x,
		double	y
	)		const

private

Definition at line 227 of file ExposureInfo.cc.

                                                                     {
     return _wcs->pixelToSky(x, y)->toIcrs().getVector().asEigen();
 }

double lsst::ap::match::ExposureInfo::calibrateFlux	(	double	flux,
		double	fluxScale
	)		const

Returns a flux value calibrated using the flux of a zero magnitude object associated with this exposure.

Parameters

flux	flux to calibrate, DN
fluxScale	flux scaling factor, must be > 0.0

Definition at line 174 of file ExposureInfo.cc.

                                                                       {
     if (fluxScale <= 0.0) {
         throw LSST_EXCEPT(InvalidParameterError, "flux "
                           "scaling factor is <= 0");
     }
     if (!canCalibrateFlux()) {
         throw LSST_EXCEPT(RuntimeError, "Cannot calibrate "
                           "flux without fluxMag0");
     }
     return fluxScale*flux/_fluxMag0;
 }

std::pair< double, double > const lsst::ap::match::ExposureInfo::calibrateFlux	(	double	flux,
		double	fluxSigma,
		double	fluxScale
	)		const

Returns a calibrated flux and its variance. The flux of a zero magnitude object associated with this exposure is used to perform the calibration.

Parameters

flux	flux to calibrate, DN
fluxSigma	standard deviation of flux
fluxScale	flux scaling factor, must be > 0.0

Definition at line 186 of file ExposureInfo.cc.

         {
     if (fluxScale <= 0.0) {
         throw LSST_EXCEPT(InvalidParameterError, "flux "
                           "scaling factor is <= 0");
     }
     if (fluxSigma <= 0.0) {
         throw LSST_EXCEPT(InvalidParameterError, "flux error is <= 0");
     }
     if (!canCalibrateFlux()) {
         throw LSST_EXCEPT(RuntimeError, "Cannot calibrate "
                           "flux without fluxMag0");
     }
     // Use delta method to estimate the variance oF flux/fluxMag0.
     double f02 = _fluxMag0*_fluxMag0;
     double f0Var = _fluxMag0Sigma*_fluxMag0Sigma;
     double f2 = flux*flux;
     double fVar = fluxSigma*fluxSigma;
     double var = (fVar*f02 + f0Var*f2)/(f02*f02);
     return std::make_pair(fluxScale*flux/_fluxMag0, fluxScale*fluxScale*var);
 }

bool lsst::ap::match::ExposureInfo::canCalibrateFlux ( ) const

inline

Is there enough information to calibrate fluxes?

Definition at line 116 of file ExposureInfo.h.

116 { return _canCalibrateFlux; }

lsst::ap::match::ExposureInfo::_canCalibrateFlux

bool _canCalibrateFlux

Definition: ExposureInfo.h:173

lsst::afw::coord::IcrsCoord const& lsst::ap::match::ExposureInfo::getCenter ( ) const

inline

Return the ICRS coordinates of the image center (rad).

Definition at line 88 of file ExposureInfo.h.

                                                     {
         return _center;
     }

Eigen::Vector3d const& lsst::ap::match::ExposureInfo::getEarthPosition ( ) const

inline

Return the SSB coordinates of the earth at t = getEpoch().

Definition at line 93 of file ExposureInfo.h.

                                                    {
         if (!_epValid) {
             _earthPos = lsst::ap::utils::earthPosition(_epoch);
             _epValid = true;
         }
         return _earthPos;
     }

double lsst::ap::match::ExposureInfo::getEpoch ( ) const

inline

Return the exposure mid-point, MJD TAI. NaN for coadds.

Definition at line 82 of file ExposureInfo.h.

82 { return _epoch; }

lsst::ap::match::ExposureInfo::_epoch

double _epoch

Definition: ExposureInfo.h:164

double lsst::ap::match::ExposureInfo::getExposureTime ( ) const

inline

Return the exposure time, s. NaN for coadds.

Definition at line 85 of file ExposureInfo.h.

85 { return _expTime; }

lsst::ap::match::ExposureInfo::_expTime

double _expTime

Definition: ExposureInfo.h:165

lsst::afw::geom::Extent2I const lsst::ap::match::ExposureInfo::getExtent ( ) const

inline

Get exposure width and/or height.

Definition at line 105 of file ExposureInfo.h.

105 { return _extent; }

lsst::ap::match::ExposureInfo::_extent

lsst::afw::geom::Extent2I _extent

Definition: ExposureInfo.h:168

lsst::afw::image::Filter const& lsst::ap::match::ExposureInfo::getFilter ( ) const

inline

Return the filter of the exposure. UNKNOWN for multi-band.

Definition at line 79 of file ExposureInfo.h.

79 { return _filter; }

lsst::ap::match::ExposureInfo::_filter

lsst::afw::image::Filter _filter

Definition: ExposureInfo.h:171

int lsst::ap::match::ExposureInfo::getHeight ( ) const

inline

Get exposure width and/or height.

Definition at line 104 of file ExposureInfo.h.

104 { return _extent.getY(); }

lsst::ap::match::ExposureInfo::_extent

lsst::afw::geom::Extent2I _extent

Definition: ExposureInfo.h:168

int64_t lsst::ap::match::ExposureInfo::getId ( ) const

inline

Return the unique integer identifier for the exposure.

Definition at line 75 of file ExposureInfo.h.

75 { return _id; }

lsst::ap::match::ExposureInfo::_id

int64_t _id

Definition: ExposureInfo.h:163

double lsst::ap::match::ExposureInfo::getMaxCoord0 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 215 of file ExposureInfo.cc.

                                         {
     return static_cast<double>(_center.getLongitude() + _alpha);
 }

double lsst::ap::match::ExposureInfo::getMaxCoord1 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 223 of file ExposureInfo.cc.

                                         {
     return static_cast<double>(_center.getLatitude() + _radius);
 }

double lsst::ap::match::ExposureInfo::getMinCoord0 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 211 of file ExposureInfo.cc.

                                         {
     return static_cast<double>(_center.getLongitude() - _alpha);
 }

double lsst::ap::match::ExposureInfo::getMinCoord1 ( ) const

virtual

Implements lsst::ap::match::BBox.

Definition at line 219 of file ExposureInfo.cc.

                                         {
     return static_cast<double>(_center.getLatitude() - _radius);
 }

lsst::afw::image::Wcs::ConstPtr lsst::ap::match::ExposureInfo::getWcs ( ) const

inline

Return the exposure WCS.

Definition at line 137 of file ExposureInfo.h.

                                            {
         return _wcs;
     }

lsst::afw::image::Wcs::Ptr lsst::ap::match::ExposureInfo::getWcs ( )

inline

Return the exposure WCS.

Definition at line 140 of file ExposureInfo.h.

                                 {
         return _wcs;
     }

int lsst::ap::match::ExposureInfo::getWidth ( ) const

inline

Get exposure width and/or height.

Definition at line 103 of file ExposureInfo.h.

103 { return _extent.getX(); }

lsst::ap::match::ExposureInfo::_extent

lsst::afw::geom::Extent2I _extent

Definition: ExposureInfo.h:168

int lsst::ap::match::ExposureInfo::getX0 ( ) const

inline

Get pixel coordinates of sub-image pixel (0,0) in the parent exposure.

Definition at line 110 of file ExposureInfo.h.

110 { return _xy0.getX(); }

lsst::ap::match::ExposureInfo::_xy0

lsst::afw::geom::Point2I _xy0

Definition: ExposureInfo.h:169

lsst::afw::geom::Point2I const lsst::ap::match::ExposureInfo::getXY0 ( ) const

inline

Get pixel coordinates of sub-image pixel (0,0) in the parent exposure.

Definition at line 112 of file ExposureInfo.h.

112 { return _xy0; }

lsst::ap::match::ExposureInfo::_xy0

lsst::afw::geom::Point2I _xy0

Definition: ExposureInfo.h:169

int lsst::ap::match::ExposureInfo::getY0 ( ) const

inline

Get pixel coordinates of sub-image pixel (0,0) in the parent exposure.

Definition at line 111 of file ExposureInfo.h.

111 { return _xy0.getY(); }

lsst::ap::match::ExposureInfo::_xy0

lsst::afw::geom::Point2I _xy0

Definition: ExposureInfo.h:169

Member Data Documentation

lsst::afw::geom::Angle lsst::ap::match::ExposureInfo::_alpha

private

Definition at line 161 of file ExposureInfo.h.

bool lsst::ap::match::ExposureInfo::_canCalibrateFlux

private

Definition at line 173 of file ExposureInfo.h.

lsst::afw::coord::IcrsCoord lsst::ap::match::ExposureInfo::_center

private

Definition at line 159 of file ExposureInfo.h.

Eigen::Vector3d lsst::ap::match::ExposureInfo::_earthPos

mutableprivate

Definition at line 162 of file ExposureInfo.h.

double lsst::ap::match::ExposureInfo::_epoch

private

Definition at line 164 of file ExposureInfo.h.

bool lsst::ap::match::ExposureInfo::_epValid

mutableprivate

Definition at line 174 of file ExposureInfo.h.

double lsst::ap::match::ExposureInfo::_expTime

private

Definition at line 165 of file ExposureInfo.h.

lsst::afw::geom::Extent2I lsst::ap::match::ExposureInfo::_extent

private

Definition at line 168 of file ExposureInfo.h.

lsst::afw::image::Filter lsst::ap::match::ExposureInfo::_filter

private

Definition at line 171 of file ExposureInfo.h.

int lsst::ap::match::ExposureInfo::_filterId

private

Definition at line 172 of file ExposureInfo.h.

double lsst::ap::match::ExposureInfo::_fluxMag0

private

Definition at line 166 of file ExposureInfo.h.

double lsst::ap::match::ExposureInfo::_fluxMag0Sigma

private

Definition at line 167 of file ExposureInfo.h.

int64_t lsst::ap::match::ExposureInfo::_id

private

Definition at line 163 of file ExposureInfo.h.

lsst::afw::geom::Angle lsst::ap::match::ExposureInfo::_radius

private

Definition at line 160 of file ExposureInfo.h.

lsst::afw::image::Wcs::Ptr lsst::ap::match::ExposureInfo::_wcs

private

Definition at line 170 of file ExposureInfo.h.

lsst::afw::geom::Point2I lsst::ap::match::ExposureInfo::_xy0

private

Definition at line 169 of file ExposureInfo.h.

std::string const lsst::ap::match::ExposureInfo::DEF_ID_KEY

static

Definition at line 66 of file ExposureInfo.h.

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

/home/lsstsw/stack/Linux64/ap/10.0+224/include/lsst/ap/match/ExposureInfo.h
/home/lsstsw/stack/Linux64/ap/10.0+224/src/match/ExposureInfo.cc

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation