lsst.afw g87b8406481+196bea11fd
Loading...
Searching...
No Matches
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, double focusZ, std::string const &observationType, std::string const &scienceProgram, std::string const &observationReason, std::string const &object, bool hasSimulatedContent)
 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
 
double getFocusZ () const
 
std::string getObservationType () const
 
std::string getScienceProgram () const
 
std::string getObservationReason () const
 
std::string getObject () const
 
bool getHasSimulatedContent () 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,
double  focusZ,
std::string const &  observationType,
std::string const &  scienceProgram,
std::string const &  observationReason,
std::string const &  object,
bool  hasSimulatedContent 
)
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]instrumentLabelShort name of the instrument that took this data (e.g. "HSC")
[in]idIdentifier of this full focal plane data.
[in]focusZDefocal distance of main-cam hexapod in mm. 0 is in focus.; Extra-focal is negative while intra-focal is positive.
[in]observationTypeType of this observation (e.g. science, dark, flat, bias, focus).
[in]scienceProgramObserving program (survey or proposal) identifier.
[in]observationReasonReason this observation was taken, or its purpose ('science' and 'calibration' are common values).
[in]objectObject of interest or field name.
[in]hasSimulatedContentWas any part of this observation simulated?

Definition at line 100 of file VisitInfo.h.

◆ VisitInfo() [2/4]

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

Definition at line 467 of file VisitInfo.cc.

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

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

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

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

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

◆ getBoresightHourAngle()

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

Definition at line 635 of file VisitInfo.cc.

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

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

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

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

◆ getDate()

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

get uniform date and time at middle of exposure

Definition at line 164 of file VisitInfo.h.

◆ getEra()

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

get earth rotation angle at middle of exposure

Definition at line 170 of file VisitInfo.h.

◆ getExposureId()

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

get exposure ID

Definition at line 153 of file VisitInfo.h.

◆ getExposureTime()

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

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

Definition at line 158 of file VisitInfo.h.

◆ getFocusZ()

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

Definition at line 214 of file VisitInfo.h.

◆ getHasSimulatedContent()

bool lsst::afw::image::VisitInfo::getHasSimulatedContent ( ) const
inline

Definition at line 220 of file VisitInfo.h.

◆ getId()

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

Definition at line 211 of file VisitInfo.h.

◆ getInstrumentLabel()

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

Definition at line 209 of file VisitInfo.h.

◆ getLocalEra()

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

Definition at line 633 of file VisitInfo.cc.

◆ getObject()

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

Definition at line 219 of file VisitInfo.h.

◆ getObservationReason()

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

Definition at line 218 of file VisitInfo.h.

◆ getObservationType()

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

Definition at line 216 of file VisitInfo.h.

◆ getObservatory()

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

get observatory longitude, latitude and elevation

Definition at line 196 of file VisitInfo.h.

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

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

◆ getScienceProgram()

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

Definition at line 217 of file VisitInfo.h.

◆ getUt1()

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

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

Definition at line 167 of file VisitInfo.h.

◆ getWeather()

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

get basic weather information

Definition at line 199 of file VisitInfo.h.

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

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

◆ operator!=()

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

Definition at line 142 of file VisitInfo.h.

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

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

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

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

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

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

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

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

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

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

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.


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