LSSTApplications  19.0.0-11-g2ce9f25+4,20.0.0+1,20.0.0+10,20.0.0+11,20.0.0+13,20.0.0+2,20.0.0+3,20.0.0+4,20.0.0+6,20.0.0-1-g10df615+10,20.0.0-1-g253301a+5,20.0.0-1-g596936a+11,20.0.0-1-g8a53f90+1,20.0.0-1-gc96f8cb+12,20.0.0-1-gd1c87d7+1,20.0.0-17-g41c5faf,20.0.0-2-g04cfba9+4,20.0.0-2-gd11eeda,20.0.0-2-gec03fae+3,20.0.0-3-g082faa5+1,20.0.0-3-gbdbfa727+3,20.0.0-3-gc53c7b6,20.0.0-4-gde602ef96+4,20.0.0-4-ge48a6ca+6,20.0.0-4-ge987224+1,20.0.0-8-g7eef53f7+7,20.0.0-9-g8e1b333,w.2020.28
LSSTDataManagementBasePackage
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)
 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
 
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

typedef io::OutputArchiveHandle 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

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::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 
)
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

Definition at line 89 of file VisitInfo.h.

95  : _exposureId(exposureId),
96  _exposureTime(exposureTime),
97  _darkTime(darkTime),
98  _date(date),
99  _ut1(ut1),
100  _era(era),
101  _boresightRaDec(boresightRaDec),
102  _boresightAzAlt(boresightAzAlt),
103  _boresightAirmass(boresightAirmass),
104  _boresightRotAngle(boresightRotAngle),
105  _rotType(rotType),
106  _observatory(observatory),
107  _weather(weather){};

◆ VisitInfo() [2/4]

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

Definition at line 315 of file VisitInfo.cc.

316  : _exposureId(0),
317  _exposureTime(nan), // don't use getDouble because str values are also accepted
318  _darkTime(getDouble(metadata, "DARKTIME")),
319  _date(),
320  _ut1(getDouble(metadata, "MJD-AVG-UT1")),
321  _era(getAngle(metadata, "AVG-ERA")),
322  _boresightRaDec(
323  lsst::geom::SpherePoint(getAngle(metadata, "BORE-RA"), getAngle(metadata, "BORE-DEC"))),
324  _boresightAzAlt(
325  lsst::geom::SpherePoint(getAngle(metadata, "BORE-AZ"), getAngle(metadata, "BORE-ALT"))),
326  _boresightAirmass(getDouble(metadata, "BORE-AIRMASS")),
327  _boresightRotAngle(getAngle(metadata, "BORE-ROTANG")),
328  _rotType(RotType::UNKNOWN),
329  _observatory(getAngle(metadata, "OBS-LONG"), getAngle(metadata, "OBS-LAT"),
330  getDouble(metadata, "OBS-ELEV")),
331  _weather(getDouble(metadata, "AIRTEMP"), getDouble(metadata, "AIRPRESS"),
332  getDouble(metadata, "HUMIDITY")) {
333  auto key = "EXPID";
334  if (metadata.exists(key)) {
335  _exposureId = metadata.getAsInt64(key);
336  }
337 
338  key = "EXPTIME";
339  if (metadata.exists(key)) {
340  try {
341  _exposureTime = metadata.getAsDouble(key);
342  } catch (lsst::pex::exceptions::TypeError& err) {
343  // some old exposures have EXPTIME stored as a string
344  std::string exptimeStr = metadata.getAsString(key);
345  _exposureTime = std::stod(exptimeStr);
346  }
347  }
348 
349  key = "DATE-AVG";
350  if (metadata.exists(key)) {
351  if (metadata.exists("TIMESYS")) {
352  auto timesysName = boost::algorithm::trim_right_copy(metadata.getAsString("TIMESYS"));
353  if (timesysName != "TAI") {
354  // rather than try to deal with all the possible choices, which requires
355  // appending or deleting a "Z", depending on the time system, just give up.
356  // VisitInfo should be used on FITS headers that have been sanitized!
358  os << "TIMESYS = \"" << timesysName
359  << "\"; VisitInfo requires TIMESYS to exist and to equal \"TAI\"";
361  }
362  } else {
364  "TIMESYS not found; VistitInfo requires TIMESYS to exist and to equal \"TAI\"");
365  }
366  _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::TAI);
367  } else {
368  // DATE-AVG not found. For backwards compatibility look for TIME-MID, an outdated LSST keyword
369  // whose time system was UTC, despite a FITS comment claiming it was TAI. Ignore TIMESYS.
370  key = "TIME-MID";
371  if (metadata.exists(key)) {
372  _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::UTC);
373  }
374  }
375 
376  key = "ROTTYPE";
377  if (metadata.exists(key)) {
378  _rotType = rotTypeEnumFromStr(metadata.getAsString(key));
379  }
380 }

◆ ~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 446 of file VisitInfo.cc.

446  {
447  return std::make_unique<VisitInfo>(*this);
448 }

◆ 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 }

◆ 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 450 of file VisitInfo.cc.

450  {
451  return singleClassEquals(*this, other);
452 }

◆ 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 152 of file VisitInfo.h.

152 { 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 148 of file VisitInfo.h.

148 { return _boresightAzAlt; }

◆ getBoresightHourAngle()

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

Definition at line 430 of file VisitInfo.cc.

430 { return getLocalEra() - getBoresightRaDec()[0]; }

◆ 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 432 of file VisitInfo.cc.

432  {
437  double _parallactic_y, _parallactic_x, result;
438  _parallactic_y = sin(getBoresightHourAngle().asRadians());
439  _parallactic_x =
440  cos((getBoresightRaDec()[1]).asRadians()) * tan(getObservatory().getLatitude().asRadians()) -
441  sin((getBoresightRaDec()[1]).asRadians()) * cos(getBoresightHourAngle().asRadians());
442  result = atan2(_parallactic_y, _parallactic_x);
443  return result * lsst::geom::radians;
444 }

◆ 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 144 of file VisitInfo.h.

144 { 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 160 of file VisitInfo.h.

160 { 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 131 of file VisitInfo.h.

131 { 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 134 of file VisitInfo.h.

134 { return _date; }

◆ getEra()

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

get earth rotation angle at middle of exposure

Definition at line 140 of file VisitInfo.h.

140 { return _era; }

◆ getExposureId()

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

get exposure ID

Definition at line 125 of file VisitInfo.h.

125 { return _exposureId; }

◆ getExposureTime()

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

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

Definition at line 128 of file VisitInfo.h.

128 { return _exposureTime; }

◆ getLocalEra()

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

Definition at line 428 of file VisitInfo.cc.

428 { return getEra() + getObservatory().getLongitude(); }

◆ getObservatory()

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

get observatory longitude, latitude and elevation

Definition at line 166 of file VisitInfo.h.

166 { 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 398 of file VisitInfo.cc.

398 { 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 163 of file VisitInfo.h.

163 { return _rotType; }

◆ getUt1()

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

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

Definition at line 137 of file VisitInfo.h.

137 { return _ut1; }

◆ getWeather()

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

get basic weather information

Definition at line 169 of file VisitInfo.h.

169 { 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 391 of file VisitInfo.cc.

391  {
392  // Completely arbitrary seed
393  return utils::hashCombine(17, _exposureId, _exposureTime, _darkTime, _date, _ut1, _era, _boresightRaDec,
394  _boresightAzAlt, _boresightAirmass, _boresightRotAngle, _rotType, _observatory,
395  _weather);
396 }

◆ 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 171 of file VisitInfo.h.

171 { return true; }

◆ operator!=()

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

Definition at line 119 of file VisitInfo.h.

119 { 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 382 of file VisitInfo.cc.

382  {
383  return _exposureId == other.getExposureId() && _exposureTime == other.getExposureTime() &&
384  _darkTime == other.getDarkTime() && _date == other.getDate() && _ut1 == other.getUt1() &&
385  _era == other.getEra() && _boresightRaDec == other.getBoresightRaDec() &&
386  _boresightAzAlt == other.getBoresightAzAlt() && _boresightAirmass == other.getBoresightAirmass() &&
387  _boresightRotAngle == other.getBoresightRotAngle() && _rotType == other.getRotType() &&
388  _observatory == other.getObservatory() && _weather == other.getWeather();
389 }

◆ 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  }

◆ 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\n 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 454 of file VisitInfo.cc.

454  {
455  std::stringstream buffer;
456  buffer << "VisitInfo(";
457  buffer << "exposureId=" << getExposureId() << ", ";
458  buffer << "exposureTime=" << getExposureTime() << ", ";
459  buffer << "darkTime=" << getDarkTime() << ", ";
460  buffer << "date=" << getDate().toString(daf::base::DateTime::TAI) << ", ";
461  buffer << "UT1=" << getUt1() << ", ";
462  buffer << "ERA=" << getEra() << ", ";
463  buffer << "boresightRaDec=" << getBoresightRaDec() << ", ";
464  buffer << "boresightAzAlt=" << getBoresightAzAlt() << ", ";
465  buffer << "boresightAirmass=" << getBoresightAirmass() << ", ";
466  buffer << "boresightRotAngle=" << getBoresightRotAngle() << ", ";
467  buffer << "rotType=" << static_cast<int>(getRotType()) << ", ";
468  buffer << "observatory=" << getObservatory() << ", ";
469  buffer << "weather=" << getWeather();
470  buffer << ")";
471  return buffer.str();
472 }

◆ 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 400 of file VisitInfo.cc.

400  {
401  VisitInfoSchema const& keys = VisitInfoSchema::get();
402  table::BaseCatalog cat = handle.makeCatalog(keys.schema);
403  std::shared_ptr<table::BaseRecord> record = cat.addNew();
404  record->set(keys.exposureId, getExposureId());
405  record->set(keys.exposureTime, getExposureTime());
406  record->set(keys.darkTime, getDarkTime());
407  record->set(keys.tai, getDate().nsecs(::DateTime::TAI));
408  record->set(keys.ut1, getUt1());
409  record->set(keys.era, getEra());
410  record->set(keys.boresightRaDec, getBoresightRaDec());
411  auto boresightAzAlt = getBoresightAzAlt();
412  record->set(keys.boresightAzAlt_az, boresightAzAlt[0]);
413  record->set(keys.boresightAzAlt_alt, boresightAzAlt[1]);
414  record->set(keys.boresightAirmass, getBoresightAirmass());
415  record->set(keys.boresightRotAngle, getBoresightRotAngle());
416  record->set(keys.rotType, static_cast<int>(getRotType()));
417  auto observatory = getObservatory();
418  record->set(keys.latitude, observatory.getLatitude());
419  record->set(keys.longitude, observatory.getLongitude());
420  record->set(keys.elevation, observatory.getElevation());
421  auto weather = getWeather();
422  record->set(keys.airTemperature, weather.getAirTemperature());
423  record->set(keys.airPressure, weather.getAirPressure());
424  record->set(keys.humidity, weather.getHumidity());
425  handle.saveCatalog(cat);
426 }

◆ 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 }

◆ 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:
lsst::afw::coord::Observatory::getLongitude
lsst::geom::Angle getLongitude() const noexcept
get telescope longitude (positive values are E of Greenwich)
Definition: Observatory.cc:48
lsst::afw::image::VisitInfo::getDate
daf::base::DateTime getDate() const
get uniform date and time at middle of exposure
Definition: VisitInfo.h:134
lsst::afw::table::io::Persistable::writeFits
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.
Definition: Persistable.cc:24
std::string
STL class.
std::shared_ptr
STL class.
lsst::sphgeom::sin
double sin(Angle const &a)
Definition: Angle.h:102
lsst::afw::image::VisitInfo::getUt1
double getUt1() const
get UT1 (universal time) MJD date at middle of exposure
Definition: VisitInfo.h:137
std::atan2
T atan2(T... args)
lsst::afw::image::VisitInfo::getExposureId
table::RecordId getExposureId() const
get exposure ID
Definition: VisitInfo.h:125
boresightAirmass
table::Key< double > boresightAirmass
Definition: VisitInfo.cc:167
era
table::Key< lsst::geom::Angle > era
Definition: VisitInfo.cc:163
lsst::afw::image::VisitInfo::getRotType
RotType getRotType() const
get rotation type of boresightRotAngle
Definition: VisitInfo.h:163
lsst::afw::image::VisitInfo::getEra
lsst::geom::Angle getEra() const
get earth rotation angle at middle of exposure
Definition: VisitInfo.h:140
std::stringstream
STL class.
lsst::afw::image::RotType::UNKNOWN
@ UNKNOWN
Rotation angle is unknown.
lsst::afw::image::VisitInfo::getExposureTime
double getExposureTime() const
get exposure duration (shutter open time); (sec)
Definition: VisitInfo.h:128
lsst::daf::base::DateTime::toString
std::string toString(Timescale scale) const
Get date as an ISO8601-formatted string.
Definition: DateTime.cc:499
astshim.keyMap.keyMapContinued.keys
def keys(self)
Definition: keyMapContinued.py:6
lsst::afw::image::VisitInfo::getBoresightRaDec
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:144
lsst::daf::base::DateTime
Class for handling dates/times, including MJD, UTC, and TAI.
Definition: DateTime.h:64
rotType
table::Key< int > rotType
Definition: VisitInfo.cc:169
ut1
table::Key< double > ut1
Definition: VisitInfo.cc:162
lsst::afw::image::VisitInfo::getWeather
coord::Weather getWeather() const
get basic weather information
Definition: VisitInfo.h:169
lsst::afw::fits::Fits::AUTO_CHECK
@ AUTO_CHECK
Definition: fits.h:308
lsst::afw::fits::Fits::AUTO_CLOSE
@ AUTO_CLOSE
Definition: fits.h:307
lsst::sphgeom::tan
double tan(Angle const &a)
Definition: Angle.h:104
lsst::afw::image::VisitInfo::getBoresightAzAlt
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:148
other
ItemVariant const * other
Definition: Schema.cc:56
lsst::afw::image::VisitInfo::getBoresightRotAngle
lsst::geom::Angle getBoresightRotAngle() const
Get rotation angle at boresight at middle of exposure.
Definition: VisitInfo.h:160
exposureId
table::Key< table::RecordId > exposureId
Definition: VisitInfo.cc:158
boresightRotAngle
table::Key< lsst::geom::Angle > boresightRotAngle
Definition: VisitInfo.cc:168
lsst::afw::image::VisitInfo::getBoresightHourAngle
lsst::geom::Angle getBoresightHourAngle() const
Definition: VisitInfo.cc:430
ptr
uint64_t * ptr
Definition: RangeSet.cc:88
exposureTime
table::Key< double > exposureTime
Definition: VisitInfo.cc:159
boresightRaDec
table::CoordKey boresightRaDec
Definition: VisitInfo.cc:164
result
py::object result
Definition: _schema.cc:429
darkTime
table::Key< double > darkTime
Definition: VisitInfo.cc:160
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::afw::image::VisitInfo::getBoresightAirmass
double getBoresightAirmass() const
get airmass at the boresight, relative to zenith at sea level (and at the middle of the exposure,...
Definition: VisitInfo.h:152
std::ostringstream
STL class.
os
std::ostream * os
Definition: Schema.cc:746
lsst::utils::hashCombine
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
lsst::afw::table::BaseCatalog
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:71
std::stod
T stod(T... args)
lsst::afw::table::io::PersistableFacade< VisitInfo >::dynamicCast
static std::shared_ptr< VisitInfo > dynamicCast(std::shared_ptr< Persistable > const &ptr)
Dynamically cast a shared_ptr.
Definition: Persistable.cc:18
lsst::daf::base::DateTime::TAI
@ TAI
Definition: DateTime.h:68
key
Key< U > key
Definition: Schema.cc:281
lsst::afw::image::VisitInfo::getLocalEra
lsst::geom::Angle getLocalEra() const
Definition: VisitInfo.cc:428
lsst::afw::image::VisitInfo::getDarkTime
double getDarkTime() const
get time from CCD flush to exposure readout, including shutter open time (despite the name); (sec)
Definition: VisitInfo.h:131
lsst::geom::radians
constexpr AngleUnit radians
constant with units of radians
Definition: Angle.h:108
std::stringstream::str
T str(T... args)
lsst::pex::exceptions::TypeError
Reports errors from accepting an object of an unexpected or inappropriate type.
Definition: Runtime.h:167
lsst::geom::SpherePoint
Point in an unspecified spherical coordinate system.
Definition: SpherePoint.h:57
lsst::afw::image::VisitInfo::getObservatory
coord::Observatory getObservatory() const
get observatory longitude, latitude and elevation
Definition: VisitInfo.h:166
lsst::sphgeom::cos
double cos(Angle const &a)
Definition: Angle.h:103
lsst::pex::exceptions::RuntimeError
Reports errors that are due to events beyond the control of the program.
Definition: Runtime.h:104
lsst::afw::typehandling::Storable::singleClassEquals
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