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
|
Information about a single exposure of an imaging camera. More...
#include <VisitInfo.h>
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 | |
VisitInfo & | operator= (VisitInfo const &)=default |
VisitInfo & | operator= (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::Storable > | cloneStorable () 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< VisitInfo > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< VisitInfo > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< VisitInfo > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< VisitInfo > | dynamicCast (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::ostream & | operator<< (std::ostream &os, Storable const &storable) |
Output operator for Storable. More... | |
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.
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
inlineexplicit |
Construct a VisitInfo.
[in] | exposureId | exposure ID |
[in] | exposureTime | exposure duration (shutter open time); (sec) |
[in] | darkTime | time from CCD flush to readout, including shutter open time (despite the name); (sec) |
[in] | date | TAI (international atomic time) MJD date at middle of exposure |
[in] | ut1 | UT1 (universal time) MJD date at middle of exposure |
[in] | era | earth rotation angle at middle of exposure |
[in] | boresightRaDec | ICRS RA/Dec of boresight at middle of exposure |
[in] | boresightAzAlt | refracted apparent topocentric Az/Alt of boresight at middle of exposure |
[in] | boresightAirmass | airmass at the boresight, relative to zenith at sea level |
[in] | boresightRotAngle | rotation angle at boresight at middle of exposure; see getBoresightRotAngle for details |
[in] | rotType | rotation type |
[in] | observatory | observatory longitude, latitude and altitude |
[in] | weather | basic weather information for computing air mass |
[in] | instrumentLabel | The short name of the instrument that took this data (e.g. "HSC") |
[in] | id | The identifier of this full focal plane data. |
Definition at line 92 of file VisitInfo.h.
|
explicit |
Definition at line 402 of file VisitInfo.cc.
|
overridedefault |
|
default |
|
default |
|
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.
|
staticinherited |
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
overridevirtualnoexcept |
Compare this object to another Storable.
*this == other
if other
is a VisitInfo; otherwise false
. Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 567 of file VisitInfo.cc.
|
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.
|
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.
lsst::geom::Angle lsst::afw::image::VisitInfo::getBoresightHourAngle | ( | ) | const |
Definition at line 547 of file VisitInfo.cc.
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.
|
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.
|
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.
|
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.
|
inline |
get uniform date and time at middle of exposure
Definition at line 147 of file VisitInfo.h.
|
inline |
get earth rotation angle at middle of exposure
Definition at line 153 of file VisitInfo.h.
|
inline |
|
inline |
get exposure duration (shutter open time); (sec)
Definition at line 141 of file VisitInfo.h.
|
inline |
Definition at line 194 of file VisitInfo.h.
|
inline |
Definition at line 192 of file VisitInfo.h.
lsst::geom::Angle lsst::afw::image::VisitInfo::getLocalEra | ( | ) | const |
Definition at line 545 of file VisitInfo.cc.
|
inline |
get observatory longitude, latitude and elevation
Definition at line 179 of file VisitInfo.h.
|
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.
|
protectedvirtualinherited |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.
Will be ignored if empty.
Reimplemented in lsst::meas::modelfit::Mixture, lsst::meas::algorithms::WarpedPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::CoaddBoundedField, lsst::afw::typehandling::StorableHelper< Base >, lsst::afw::math::WarpingControl, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::TransformBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::Kernel, lsst::afw::math::Function< ReturnT >, lsst::afw::math::ChebyshevBoundedField, lsst::afw::image::TransmissionCurve, lsst::afw::image::CoaddInputs, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::geom::SkyWcs, lsst::afw::detection::GaussianPsf, lsst::afw::detection::Footprint, lsst::afw::cameraGeom::DetectorCollection, and lsst::afw::image::FilterLabel.
Definition at line 36 of file Persistable.cc.
|
inline |
get rotation type of boresightRotAngle
Definition at line 176 of file VisitInfo.h.
|
inline |
get UT1 (universal time) MJD date at middle of exposure
Definition at line 150 of file VisitInfo.h.
|
inline |
|
overridevirtualnoexcept |
Return a hash of this object.
Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 505 of file VisitInfo.cc.
|
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.
|
inline |
Definition at line 125 of file VisitInfo.h.
bool lsst::afw::image::VisitInfo::operator== | ( | VisitInfo const & | other | ) | const |
Definition at line 493 of file VisitInfo.cc.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[in] | manager | Manager for the memory to read from. |
[in] | hdu | HDU 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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[in] | fileName | Name of the file to read. |
[in] | hdu | HDU 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.
|
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.
T | The class expected of the two objects to be compared. |
lhs,rhs | The objects to compare. Note that rhs need not be a T , while lhs must be. |
true
if rhs
is a T
and lhs == rhs
; false
otherwise.operator==
. Most implementations of operator==
do not throw.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.
|
overridevirtual |
Create a string representation of this object.
Reimplemented from lsst::afw::typehandling::Storable.
Definition at line 571 of file VisitInfo.cc.
|
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.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[in] | manager | Name of the file to write to. |
[in] | mode | If "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.
|
inherited |
Write the object to a regular FITS file.
[in] | fileName | Name of the file to write to. |
[in] | mode | If "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.
|
related |
Output operator for Storable.
os | the desired output stream |
storable | the object to print |
os
UnsupportedOperationException | Thrown if storable does not have an implementation of Storable::toString. |
Definition at line 174 of file Storable.h.