LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Related Functions | List of all members
lsst::afw::image::VisitInfo Class Reference

Information about a single exposure of an imaging camera. More...

#include <VisitInfo.h>

Inheritance diagram for lsst::afw::image::VisitInfo:
lsst::afw::table::io::PersistableFacade< VisitInfo > lsst::afw::typehandling::Storable lsst::afw::table::io::Persistable

Public Member Functions

 VisitInfo (table::RecordId exposureId, double exposureTime, double darkTime, daf::base::DateTime const &date, double ut1, lsst::geom::Angle const &era, lsst::geom::SpherePoint const &boresightRaDec, lsst::geom::SpherePoint const &boresightAzAlt, double boresightAirmass, lsst::geom::Angle const &boresightRotAngle, RotType const &rotType, coord::Observatory const &observatory, coord::Weather const &weather, std::string const &instrumentLabel, table::RecordId const &id)
 Construct a VisitInfo. More...
 
 VisitInfo (daf::base::PropertySet const &metadata)
 
 ~VisitInfo () override=default
 
 VisitInfo (VisitInfo const &)=default
 
 VisitInfo (VisitInfo &&)=default
 
VisitInfooperator= (VisitInfo const &)=default
 
VisitInfooperator= (VisitInfo &&)=default
 
bool operator== (VisitInfo const &other) const
 
bool operator!= (VisitInfo const &other) const
 
std::size_t hash_value () const noexcept override
 Return a hash of this object. More...
 
table::RecordId getExposureId () const
 get exposure ID More...
 
double getExposureTime () const
 get exposure duration (shutter open time); (sec) More...
 
double getDarkTime () const
 get time from CCD flush to exposure readout, including shutter open time (despite the name); (sec) More...
 
daf::base::DateTime getDate () const
 get uniform date and time at middle of exposure More...
 
double getUt1 () const
 get UT1 (universal time) MJD date at middle of exposure More...
 
lsst::geom::Angle getEra () const
 get earth rotation angle at middle of exposure More...
 
lsst::geom::SpherePoint getBoresightRaDec () const
 get ICRS RA/Dec position at the boresight (and at the middle of the exposure, if it varies with time) More...
 
lsst::geom::SpherePoint getBoresightAzAlt () const
 get refracted apparent topocentric Az/Alt position at the boresight (and at the middle of the exposure, if it varies with time) More...
 
double getBoresightAirmass () const
 get airmass at the boresight, relative to zenith at sea level (and at the middle of the exposure, if it varies with time) More...
 
lsst::geom::Angle getBoresightRotAngle () const
 Get rotation angle at boresight at middle of exposure. More...
 
RotType getRotType () const
 get rotation type of boresightRotAngle More...
 
coord::Observatory getObservatory () const
 get observatory longitude, latitude and elevation More...
 
coord::Weather getWeather () const
 get basic weather information More...
 
bool isPersistable () const noexcept override
 Return true if this particular object can be persisted using afw::table::io. More...
 
lsst::geom::Angle getLocalEra () const
 
lsst::geom::Angle getBoresightHourAngle () const
 
std::string getInstrumentLabel () const
 
table::RecordId getId () const
 
lsst::geom::Angle getBoresightParAngle () const
 Get parallactic angle at the boresight. More...
 
std::shared_ptr< typehandling::StorablecloneStorable () const override
 Create a new VisitInfo that is a copy of this one. More...
 
std::string toString () const override
 Create a string representation of this object. More...
 
bool equals (typehandling::Storable const &other) const noexcept override
 Compare this object to another Storable. More...
 
void writeFits (std::string const &fileName, std::string const &mode="w") const
 Write the object to a regular FITS file. More...
 
void writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
 Write the object to a FITS image in memory. More...
 
void writeFits (fits::Fits &fitsfile) const
 Write the object to an already-open FITS object. More...
 

Static Public Member Functions

static std::shared_ptr< VisitInforeadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object. More...
 
static std::shared_ptr< VisitInforeadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file. More...
 
static std::shared_ptr< VisitInforeadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory. More...
 
static std::shared_ptr< VisitInfodynamicCast (std::shared_ptr< Persistable > const &ptr)
 Dynamically cast a shared_ptr. More...
 

Protected Types

using OutputArchiveHandle = io::OutputArchiveHandle
 

Protected Member Functions

std::string getPersistenceName () const override
 Return the unique name used to persist this object and look up its factory. More...
 
void write (OutputArchiveHandle &handle) const override
 Write the object to one or more catalogs. More...
 
virtual std::string getPythonModule () const
 Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More...
 

Static Protected Member Functions

template<class T >
static bool singleClassEquals (T const &lhs, Storable const &rhs)
 Test if a Storable is of a particular class and equal to another object. More...
 

Related Functions

(Note that these are not member functions.)

std::ostreamoperator<< (std::ostream &os, Storable const &storable)
 Output operator for Storable. More...
 

Detailed Description

Information about a single exposure of an imaging camera.

Includes exposure duration and date, and telescope pointing and orientation.

All information is for the middle of the exposure and at the boresight (center of the focal plane). Thus for a mosaic camera VisitInfo is the same for all detectors in the mosaic.

VisitInfo is immutable.

Definition at line 68 of file VisitInfo.h.

Member Typedef Documentation

◆ OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle
protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

◆ VisitInfo() [1/4]

lsst::afw::image::VisitInfo::VisitInfo ( table::RecordId  exposureId,
double  exposureTime,
double  darkTime,
daf::base::DateTime const &  date,
double  ut1,
lsst::geom::Angle const &  era,
lsst::geom::SpherePoint const &  boresightRaDec,
lsst::geom::SpherePoint const &  boresightAzAlt,
double  boresightAirmass,
lsst::geom::Angle const &  boresightRotAngle,
RotType const &  rotType,
coord::Observatory const &  observatory,
coord::Weather const &  weather,
std::string const &  instrumentLabel,
table::RecordId const &  id 
)
inlineexplicit

Construct a VisitInfo.

Parameters
[in]exposureIdexposure ID
[in]exposureTimeexposure duration (shutter open time); (sec)
[in]darkTimetime from CCD flush to readout, including shutter open time (despite the name); (sec)
[in]dateTAI (international atomic time) MJD date at middle of exposure
[in]ut1UT1 (universal time) MJD date at middle of exposure
[in]eraearth rotation angle at middle of exposure
[in]boresightRaDecICRS RA/Dec of boresight at middle of exposure
[in]boresightAzAltrefracted apparent topocentric Az/Alt of boresight at middle of exposure
[in]boresightAirmassairmass at the boresight, relative to zenith at sea level
[in]boresightRotAnglerotation angle at boresight at middle of exposure; see getBoresightRotAngle for details
[in]rotTyperotation type
[in]observatoryobservatory longitude, latitude and altitude
[in]weatherbasic weather information for computing air mass
[in]instrumentLabelThe short name of the instrument that took this data (e.g. "HSC")
[in]idThe identifier of this full focal plane data.

Definition at line 92 of file VisitInfo.h.

99  : _exposureId(exposureId),
100  _exposureTime(exposureTime),
101  _darkTime(darkTime),
102  _date(date),
103  _ut1(ut1),
104  _era(era),
105  _boresightRaDec(boresightRaDec),
106  _boresightAzAlt(boresightAzAlt),
107  _boresightAirmass(boresightAirmass),
108  _boresightRotAngle(boresightRotAngle),
109  _rotType(rotType),
110  _observatory(observatory),
111  _weather(weather),
112  _instrumentLabel(instrumentLabel),
113  _id(id){};
table::Key< double > exposureTime
Definition: VisitInfo.cc:200
table::Key< lsst::geom::Angle > era
Definition: VisitInfo.cc:204
table::Key< int > rotType
Definition: VisitInfo.cc:210
table::Key< double > darkTime
Definition: VisitInfo.cc:201
table::Key< std::string > instrumentLabel
Definition: VisitInfo.cc:220
table::CoordKey boresightRaDec
Definition: VisitInfo.cc:205
table::Key< double > boresightAirmass
Definition: VisitInfo.cc:208
table::Key< lsst::geom::Angle > boresightRotAngle
Definition: VisitInfo.cc:209
table::Key< double > ut1
Definition: VisitInfo.cc:203
table::Key< table::RecordId > exposureId
Definition: VisitInfo.cc:199

◆ VisitInfo() [2/4]

lsst::afw::image::VisitInfo::VisitInfo ( daf::base::PropertySet const &  metadata)
explicit

Definition at line 402 of file VisitInfo.cc.

403  : _exposureId(0),
404  _exposureTime(nan), // don't use getDouble because str values are also accepted
405  _darkTime(getDouble(metadata, "DARKTIME")),
406  _date(),
407  _ut1(getDouble(metadata, "MJD-AVG-UT1")),
408  _era(getAngle(metadata, "AVG-ERA")),
409  _boresightRaDec(
410  lsst::geom::SpherePoint(getAngle(metadata, "BORE-RA"), getAngle(metadata, "BORE-DEC"))),
411  _boresightAzAlt(
412  lsst::geom::SpherePoint(getAngle(metadata, "BORE-AZ"), getAngle(metadata, "BORE-ALT"))),
413  _boresightAirmass(getDouble(metadata, "BORE-AIRMASS")),
414  _boresightRotAngle(getAngle(metadata, "BORE-ROTANG")),
415  _rotType(RotType::UNKNOWN),
416  _observatory(getAngle(metadata, "OBS-LONG"), getAngle(metadata, "OBS-LAT"),
417  getDouble(metadata, "OBS-ELEV")),
418  _weather(getDouble(metadata, "AIRTEMP"), getDouble(metadata, "AIRPRESS"),
419  getDouble(metadata, "HUMIDITY")),
420  _instrumentLabel(getString(metadata, "INSTRUMENT")),
421  _id(0) {
422  auto key = "EXPID";
423  if (metadata.exists(key)) {
424  _exposureId = metadata.getAsInt64(key);
425  }
426  key = "IDNUM";
427  if (metadata.exists(key)) {
428  _id = metadata.getAsInt64(key);
429  }
430 
431  key = "EXPTIME";
432  if (metadata.exists(key)) {
433  try {
434  _exposureTime = metadata.getAsDouble(key);
435  } catch (lsst::pex::exceptions::TypeError& err) {
436  // some old exposures have EXPTIME stored as a string
437  std::string exptimeStr = metadata.getAsString(key);
438  _exposureTime = std::stod(exptimeStr);
439  }
440  }
441 
442  key = "DATE-AVG";
443  if (metadata.exists(key)) {
444  if (metadata.exists("TIMESYS")) {
445  auto timesysName = boost::algorithm::trim_right_copy(metadata.getAsString("TIMESYS"));
446  if (timesysName != "TAI") {
447  // rather than try to deal with all the possible choices, which requires
448  // appending or deleting a "Z", depending on the time system, just give up.
449  // VisitInfo should be used on FITS headers that have been sanitized!
451  os << "TIMESYS = \"" << timesysName
452  << "\"; VisitInfo requires TIMESYS to exist and to equal \"TAI\"";
454  }
455  } else {
457  "TIMESYS not found; VistitInfo requires TIMESYS to exist and to equal \"TAI\"");
458  }
459  _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::TAI);
460  } else {
461  // DATE-AVG not found. For backwards compatibility look for TIME-MID, an outdated LSST keyword
462  // whose time system was UTC, despite a FITS comment claiming it was TAI. Ignore TIMESYS.
463  key = "TIME-MID";
464  if (metadata.exists(key)) {
465  _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::UTC);
466  }
467  }
468 
469  key = "ROTTYPE";
470  if (metadata.exists(key)) {
471  _rotType = rotTypeEnumFromStr(metadata.getAsString(key));
472  }
473 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
std::ostream * os
Definition: Schema.cc:557
Class for handling dates/times, including MJD, UTC, and TAI.
Definition: DateTime.h:64
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104
Reports errors from accepting an object of an unexpected or inappropriate type.
Definition: Runtime.h:167
@ UNKNOWN
Rotation angle is unknown.
T stod(T... args)

◆ ~VisitInfo()

lsst::afw::image::VisitInfo::~VisitInfo ( )
overridedefault

◆ VisitInfo() [3/4]

lsst::afw::image::VisitInfo::VisitInfo ( VisitInfo const &  )
default

◆ VisitInfo() [4/4]

lsst::afw::image::VisitInfo::VisitInfo ( VisitInfo &&  )
default

Member Function Documentation

◆ cloneStorable()

std::shared_ptr< typehandling::Storable > lsst::afw::image::VisitInfo::cloneStorable ( ) const
overridevirtual

Create a new VisitInfo that is a copy of this one.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 563 of file VisitInfo.cc.

563  {
564  return std::make_unique<VisitInfo>(*this);
565 }

◆ dynamicCast()

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf the dynamic cast fails.

Definition at line 218 of file Persistable.cc.

18  {
19  auto result = std::dynamic_pointer_cast<T>(ptr);
20  if (!result) {
21  throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
22  }
23  return result;
24 }
py::object result
Definition: _schema.cc:429
uint64_t * ptr
Definition: RangeSet.cc:88

◆ equals()

bool lsst::afw::image::VisitInfo::equals ( typehandling::Storable const &  other) const
overridevirtualnoexcept

Compare this object to another Storable.

Returns
*this == other if other is a VisitInfo; otherwise false.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 567 of file VisitInfo.cc.

567  {
568  return singleClassEquals(*this, other);
569 }
static bool singleClassEquals(T const &lhs, Storable const &rhs)
Test if a Storable is of a particular class and equal to another object.
Definition: Storable.h:151

◆ getBoresightAirmass()

double lsst::afw::image::VisitInfo::getBoresightAirmass ( ) const
inline

get airmass at the boresight, relative to zenith at sea level (and at the middle of the exposure, if it varies with time)

Definition at line 165 of file VisitInfo.h.

165 { return _boresightAirmass; }

◆ getBoresightAzAlt()

lsst::geom::SpherePoint lsst::afw::image::VisitInfo::getBoresightAzAlt ( ) const
inline

get refracted apparent topocentric Az/Alt position at the boresight (and at the middle of the exposure, if it varies with time)

Definition at line 161 of file VisitInfo.h.

161 { return _boresightAzAlt; }

◆ getBoresightHourAngle()

lsst::geom::Angle lsst::afw::image::VisitInfo::getBoresightHourAngle ( ) const

Definition at line 547 of file VisitInfo.cc.

547 { return getLocalEra() - getBoresightRaDec()[0]; }
lsst::geom::Angle getLocalEra() const
Definition: VisitInfo.cc:545
lsst::geom::SpherePoint getBoresightRaDec() const
get ICRS RA/Dec position at the boresight (and at the middle of the exposure, if it varies with time)
Definition: VisitInfo.h:157

◆ getBoresightParAngle()

lsst::geom::Angle lsst::afw::image::VisitInfo::getBoresightParAngle ( ) const

Get parallactic angle at the boresight.

Equal to the angle between the North celestial pole and Zenith at the boresight. Or, the angular separation between two great circle arcs that meet at the object: One passing through the North celestial pole, and the other through zenith. For an object on the meridian the angle is zero if it is South of zenith and pi if it is North of zenith The angle is positive for objects East of the meridian, and negative for objects to the West.

Compute the parallactic angle. Defined as the angle between the North celestial pole and Zenith at the boresight.

Definition at line 549 of file VisitInfo.cc.

549  {
554  double _parallactic_y, _parallactic_x, result;
555  _parallactic_y = sin(getBoresightHourAngle().asRadians());
556  _parallactic_x =
557  cos((getBoresightRaDec()[1]).asRadians()) * tan(getObservatory().getLatitude().asRadians()) -
558  sin((getBoresightRaDec()[1]).asRadians()) * cos(getBoresightHourAngle().asRadians());
559  result = atan2(_parallactic_y, _parallactic_x);
560  return result * lsst::geom::radians;
561 }
T atan2(T... args)
lsst::geom::Angle getBoresightHourAngle() const
Definition: VisitInfo.cc:547
coord::Observatory getObservatory() const
get observatory longitude, latitude and elevation
Definition: VisitInfo.h:179
constexpr AngleUnit radians
constant with units of radians
Definition: Angle.h:108
double sin(Angle const &a)
Definition: Angle.h:102
double tan(Angle const &a)
Definition: Angle.h:104
double cos(Angle const &a)
Definition: Angle.h:103

◆ getBoresightRaDec()

lsst::geom::SpherePoint lsst::afw::image::VisitInfo::getBoresightRaDec ( ) const
inline

get ICRS RA/Dec position at the boresight (and at the middle of the exposure, if it varies with time)

Definition at line 157 of file VisitInfo.h.

157 { return _boresightRaDec; }

◆ getBoresightRotAngle()

lsst::geom::Angle lsst::afw::image::VisitInfo::getBoresightRotAngle ( ) const
inline

Get rotation angle at boresight at middle of exposure.

The meaning of rotation angle depends on rotType. For example, if rotType is SKY the angle is the position angle of the focal plane +Y with respect to North.

Definition at line 173 of file VisitInfo.h.

173 { return _boresightRotAngle; }

◆ getDarkTime()

double lsst::afw::image::VisitInfo::getDarkTime ( ) const
inline

get time from CCD flush to exposure readout, including shutter open time (despite the name); (sec)

Definition at line 144 of file VisitInfo.h.

144 { return _darkTime; }

◆ getDate()

daf::base::DateTime lsst::afw::image::VisitInfo::getDate ( ) const
inline

get uniform date and time at middle of exposure

Definition at line 147 of file VisitInfo.h.

147 { return _date; }

◆ getEra()

lsst::geom::Angle lsst::afw::image::VisitInfo::getEra ( ) const
inline

get earth rotation angle at middle of exposure

Definition at line 153 of file VisitInfo.h.

153 { return _era; }

◆ getExposureId()

table:: RecordId lsst::afw::image::VisitInfo::getExposureId ( ) const
inline

get exposure ID

Definition at line 136 of file VisitInfo.h.

136  {
137  return _exposureId;
138  }

◆ getExposureTime()

double lsst::afw::image::VisitInfo::getExposureTime ( ) const
inline

get exposure duration (shutter open time); (sec)

Definition at line 141 of file VisitInfo.h.

141 { return _exposureTime; }

◆ getId()

table::RecordId lsst::afw::image::VisitInfo::getId ( ) const
inline

Definition at line 194 of file VisitInfo.h.

194 { return _id; }

◆ getInstrumentLabel()

std::string lsst::afw::image::VisitInfo::getInstrumentLabel ( ) const
inline

Definition at line 192 of file VisitInfo.h.

192 { return _instrumentLabel; }

◆ getLocalEra()

lsst::geom::Angle lsst::afw::image::VisitInfo::getLocalEra ( ) const

Definition at line 545 of file VisitInfo.cc.

545 { return getEra() + getObservatory().getLongitude(); }
lsst::geom::Angle getLongitude() const noexcept
get telescope longitude (positive values are E of Greenwich)
Definition: Observatory.cc:48
lsst::geom::Angle getEra() const
get earth rotation angle at middle of exposure
Definition: VisitInfo.h:153

◆ getObservatory()

coord::Observatory lsst::afw::image::VisitInfo::getObservatory ( ) const
inline

get observatory longitude, latitude and elevation

Definition at line 179 of file VisitInfo.h.

179 { return _observatory; }

◆ getPersistenceName()

std::string lsst::afw::image::VisitInfo::getPersistenceName ( ) const
overrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 512 of file VisitInfo.cc.

512 { return getVisitInfoPersistenceName(); }

◆ getPythonModule()

std::string lsst::afw::table::io::Persistable::getPythonModule ( ) const
protectedvirtualinherited

◆ getRotType()

RotType lsst::afw::image::VisitInfo::getRotType ( ) const
inline

get rotation type of boresightRotAngle

Definition at line 176 of file VisitInfo.h.

176 { return _rotType; }

◆ getUt1()

double lsst::afw::image::VisitInfo::getUt1 ( ) const
inline

get UT1 (universal time) MJD date at middle of exposure

Definition at line 150 of file VisitInfo.h.

150 { return _ut1; }

◆ getWeather()

coord::Weather lsst::afw::image::VisitInfo::getWeather ( ) const
inline

get basic weather information

Definition at line 182 of file VisitInfo.h.

182 { return _weather; }

◆ hash_value()

std::size_t lsst::afw::image::VisitInfo::hash_value ( ) const
overridevirtualnoexcept

Return a hash of this object.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 505 of file VisitInfo.cc.

505  {
506  // Completely arbitrary seed
507  return utils::hashCombine(17, _exposureId, _exposureTime, _darkTime, _date, _ut1, _era, _boresightRaDec,
508  _boresightAzAlt, _boresightAirmass, _boresightRotAngle, _rotType, _observatory,
509  _weather, _instrumentLabel, _id);
510 }
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35

◆ isPersistable()

bool lsst::afw::image::VisitInfo::isPersistable ( ) const
inlineoverridevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 184 of file VisitInfo.h.

184 { return true; }

◆ operator!=()

bool lsst::afw::image::VisitInfo::operator!= ( VisitInfo const &  other) const
inline

Definition at line 125 of file VisitInfo.h.

125 { return !(*this == other); };

◆ operator=() [1/2]

VisitInfo& lsst::afw::image::VisitInfo::operator= ( VisitInfo &&  )
default

◆ operator=() [2/2]

VisitInfo& lsst::afw::image::VisitInfo::operator= ( VisitInfo const &  )
default

◆ operator==()

bool lsst::afw::image::VisitInfo::operator== ( VisitInfo const &  other) const

Definition at line 493 of file VisitInfo.cc.

493  {
494  return _exposureId == other.getExposureId() && _eqOrNan(_exposureTime, other.getExposureTime()) &&
495  _eqOrNan(_darkTime, other.getDarkTime()) && _date == other.getDate() &&
496  _eqOrNan(_ut1, other.getUt1()) && _eqOrNan(_era, other.getEra()) &&
497  _eqOrNonFinite(_boresightRaDec, other.getBoresightRaDec()) &&
498  _eqOrNonFinite(_boresightAzAlt, other.getBoresightAzAlt()) &&
499  _eqOrNan(_boresightAirmass, other.getBoresightAirmass()) &&
500  _eqOrNan(_boresightRotAngle, other.getBoresightRotAngle()) && _rotType == other.getRotType() &&
501  _observatory == other.getObservatory() && _weather == other.getWeather() &&
502  _instrumentLabel == other.getInstrumentLabel() && _id == other.getId();
503 }
bool _eqOrNonFinite(lsst::geom::SpherePoint const &lhs, lsst::geom::SpherePoint const &rhs) noexcept
Test whether two SpherePoints are exactly equal or invalid.
Definition: VisitInfo.cc:489
bool _eqOrNan(double lhs, double rhs) noexcept
Test whether two numbers are exactly equal or both NaN.
Definition: VisitInfo.cc:481

◆ readFits() [1/3]

static std::shared_ptr<VisitInfo > lsst::afw::table::io::PersistableFacade< VisitInfo >::readFits ( fits::Fits fitsfile)
inlinestaticinherited

Read an object from an already open FITS object.

Parameters
[in]fitsfileFITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

183  {
184  return dynamicCast(Persistable::_readFits(fitsfile));
185  }
static std::shared_ptr< VisitInfo > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18

◆ readFits() [2/3]

static std::shared_ptr<VisitInfo > lsst::afw::table::io::PersistableFacade< VisitInfo >::readFits ( fits::MemFileManager manager,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a FITS file in memory.

Parameters
[in]managerManager for the memory to read from.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

205  {
206  return dynamicCast(Persistable::_readFits(manager, hdu));
207  }

◆ readFits() [3/3]

static std::shared_ptr<VisitInfo > lsst::afw::table::io::PersistableFacade< VisitInfo >::readFits ( std::string const &  fileName,
int  hdu = fits::DEFAULT_HDU 
)
inlinestaticinherited

Read an object from a regular FITS file.

Parameters
[in]fileNameName of the file to read.
[in]hduHDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

194  {
195  return dynamicCast(Persistable::_readFits(fileName, hdu));
196  }

◆ singleClassEquals()

template<class T >
static bool lsst::afw::typehandling::Storable::singleClassEquals ( T const &  lhs,
Storable const &  rhs 
)
inlinestaticprotectedinherited

Test if a Storable is of a particular class and equal to another object.

This method template simplifies implementations of equals that delegate to operator== without supporting cross-class comparisons.

Template Parameters
TThe class expected of the two objects to be compared.
Parameters
lhs,rhsThe objects to compare. Note that rhs need not be a T, while lhs must be.
Returns
true if rhs is a T and lhs == rhs; false otherwise.
Exception Safety
Provides the same level of exception safety as operator==. Most implementations of operator== do not throw.
Note
This method template calls operator== with both arguments of compile-time type T const&. Its use is not recommended if there would be any ambiguity as to which operator== gets picked by overload resolution.

This method template is typically called from equals as:

bool MyType::equals(Storable const& other) const noexcept {
    return singleClassEquals(*this, other);
}

Definition at line 151 of file Storable.h.

151  {
152  auto typedRhs = dynamic_cast<T const*>(&rhs);
153  if (typedRhs != nullptr) {
154  return lhs == *typedRhs;
155  } else {
156  return false;
157  }
158  }

◆ toString()

std::string lsst::afw::image::VisitInfo::toString ( ) const
overridevirtual

Create a string representation of this object.

Reimplemented from lsst::afw::typehandling::Storable.

Definition at line 571 of file VisitInfo.cc.

571  {
572  std::stringstream buffer;
573  buffer << "VisitInfo(";
574  buffer << "exposureId=" << getExposureId() << ", ";
575  buffer << "exposureTime=" << getExposureTime() << ", ";
576  buffer << "darkTime=" << getDarkTime() << ", ";
577  buffer << "date=" << (getDate().isValid() ? getDate().toString(daf::base::DateTime::TAI) : "<invalid>")
578  << ", ";
579  buffer << "UT1=" << getUt1() << ", ";
580  buffer << "ERA=" << getEra() << ", ";
581  buffer << "boresightRaDec=" << getBoresightRaDec() << ", ";
582  buffer << "boresightAzAlt=" << getBoresightAzAlt() << ", ";
583  buffer << "boresightAirmass=" << getBoresightAirmass() << ", ";
584  buffer << "boresightRotAngle=" << getBoresightRotAngle() << ", ";
585  buffer << "rotType=" << static_cast<int>(getRotType()) << ", ";
586  buffer << "observatory=" << getObservatory() << ", ";
587  buffer << "weather=" << getWeather() << ", ";
588  buffer << "instrumentLabel='" << getInstrumentLabel() << "', ";
589  buffer << "id=" << getId();
590  buffer << ")";
591  return buffer.str();
592 }
daf::base::DateTime getDate() const
get uniform date and time at middle of exposure
Definition: VisitInfo.h:147
coord::Weather getWeather() const
get basic weather information
Definition: VisitInfo.h:182
table::RecordId getExposureId() const
get exposure ID
Definition: VisitInfo.h:136
double getUt1() const
get UT1 (universal time) MJD date at middle of exposure
Definition: VisitInfo.h:150
double getBoresightAirmass() const
get airmass at the boresight, relative to zenith at sea level (and at the middle of the exposure,...
Definition: VisitInfo.h:165
lsst::geom::Angle getBoresightRotAngle() const
Get rotation angle at boresight at middle of exposure.
Definition: VisitInfo.h:173
table::RecordId getId() const
Definition: VisitInfo.h:194
double getExposureTime() const
get exposure duration (shutter open time); (sec)
Definition: VisitInfo.h:141
RotType getRotType() const
get rotation type of boresightRotAngle
Definition: VisitInfo.h:176
lsst::geom::SpherePoint getBoresightAzAlt() const
get refracted apparent topocentric Az/Alt position at the boresight (and at the middle of the exposur...
Definition: VisitInfo.h:161
std::string getInstrumentLabel() const
Definition: VisitInfo.h:192
double getDarkTime() const
get time from CCD flush to exposure readout, including shutter open time (despite the name); (sec)
Definition: VisitInfo.h:144
std::string toString(Timescale scale) const
Get date as an ISO8601-formatted string.
Definition: DateTime.cc:500
bool isValid() const
Is this date valid?
Definition: DateTime.h:203
T str(T... args)

◆ write()

void lsst::afw::image::VisitInfo::write ( OutputArchiveHandle handle) const
overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 514 of file VisitInfo.cc.

514  {
515  VisitInfoSchema const& keys = VisitInfoSchema::get();
516  table::BaseCatalog cat = handle.makeCatalog(keys.schema);
517  std::shared_ptr<table::BaseRecord> record = cat.addNew();
518  record->set(keys.exposureId, getExposureId());
519  record->set(keys.exposureTime, getExposureTime());
520  record->set(keys.darkTime, getDarkTime());
521  record->set(keys.tai, getDate().nsecs(::DateTime::TAI));
522  record->set(keys.ut1, getUt1());
523  record->set(keys.era, getEra());
524  record->set(keys.boresightRaDec, getBoresightRaDec());
525  auto boresightAzAlt = getBoresightAzAlt();
526  record->set(keys.boresightAzAlt_az, boresightAzAlt[0]);
527  record->set(keys.boresightAzAlt_alt, boresightAzAlt[1]);
528  record->set(keys.boresightAirmass, getBoresightAirmass());
529  record->set(keys.boresightRotAngle, getBoresightRotAngle());
530  record->set(keys.rotType, static_cast<int>(getRotType()));
531  auto observatory = getObservatory();
532  record->set(keys.latitude, observatory.getLatitude());
533  record->set(keys.longitude, observatory.getLongitude());
534  record->set(keys.elevation, observatory.getElevation());
535  auto weather = getWeather();
536  record->set(keys.airTemperature, weather.getAirTemperature());
537  record->set(keys.airPressure, weather.getAirPressure());
538  record->set(keys.humidity, weather.getHumidity());
539  record->set(keys.instrumentLabel, getInstrumentLabel());
540  record->set(keys.version, SERIALIZATION_VERSION);
541  record->set(keys.idnum, getId());
542  handle.saveCatalog(cat);
543 }
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:72

◆ writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits fitsfile) const
inherited

Write the object to an already-open FITS object.

Parameters
[in]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18  {
19  OutputArchive archive;
20  archive.put(this);
21  archive.writeFits(fitsfile);
22 }

◆ writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager manager,
std::string const &  mode = "w" 
) const
inherited

Write the object to a FITS image in memory.

Parameters
[in]managerName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

29  {
30  fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31  writeFits(fitsfile);
32 }
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24

◆ writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName,
std::string const &  mode = "w" 
) const
inherited

Write the object to a regular FITS file.

Parameters
[in]fileNameName of the file to write to.
[in]modeIf "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

24  {
25  fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
26  writeFits(fitsfile);
27 }

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<< ( std::ostream os,
Storable const &  storable 
)
related

Output operator for Storable.

Parameters
osthe desired output stream
storablethe object to print
Returns
a reference to os
Exceptions
UnsupportedOperationExceptionThrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

174  {
175  return os << storable.toString();
176 }

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