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:

Public Member Functions
	VisitInfo (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.
	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.
double	getExposureTime () const
	get exposure duration (shutter open time); (sec)
double	getDarkTime () const
	get time from CCD flush to exposure readout, including shutter open time (despite the name); (sec)
daf::base::DateTime	getDate () const
	get uniform date and time at middle of exposure
double	getUt1 () const
	get UT1 (universal time) MJD date at middle of exposure
lsst::geom::Angle	getEra () const
	get earth rotation angle at middle of exposure
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)
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)
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)
lsst::geom::Angle	getBoresightRotAngle () const
	Get rotation angle at boresight at middle of exposure.
RotType	getRotType () const
	get rotation type of boresightRotAngle
coord::Observatory	getObservatory () const
	get observatory longitude, latitude and elevation
coord::Weather	getWeather () const
	get basic weather information
bool	isPersistable () const noexcept override
	Return true if this particular object can be persisted using afw::table::io.
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.
std::shared_ptr< typehandling::Storable >	cloneStorable () const override
	Create a new VisitInfo that is a copy of this one.
std::string	toString () const override
	Create a string representation of this object.
bool	equals (typehandling::Storable const &other) const noexcept override
	Compare this object to another Storable.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.

Static Public Member Functions
static std::shared_ptr< VisitInfo >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< VisitInfo >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< VisitInfo >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< VisitInfo >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

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.
void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs.
virtual std::string	getPythonModule () const
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

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.

Related Symbols
(Note that these are not member symbols.)
std::ostream &	operator<< (std::ostream &os, Storable const &storable)
	Output operator for Storable.

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 ( 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]	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	Short name of the instrument that took this data (e.g. "HSC")
[in]	id	Identifier of this full focal plane data.
[in]	focusZ	Defocal distance of main-cam hexapod in mm. 0 is in focus.; Extra-focal is negative while intra-focal is positive.
[in]	observationType	Type of this observation (e.g. science, dark, flat, bias, focus).
[in]	scienceProgram	Observing program (survey or proposal) identifier.
[in]	observationReason	Reason this observation was taken, or its purpose ('science' and 'calibration' are common values).
[in]	object	Object of interest or field name.
[in]	hasSimulatedContent	Was any part of this observation simulated?

Definition at line 98 of file VisitInfo.h.

            : _exposureTime(exposureTime),
              _darkTime(darkTime),
              _date(date),
              _ut1(ut1),
              _era(era),
              _boresightRaDec(boresightRaDec),
              _boresightAzAlt(boresightAzAlt),
              _boresightAirmass(boresightAirmass),
              _boresightRotAngle(boresightRotAngle),
              _rotType(rotType),
              _observatory(observatory),
              _weather(weather),
              _instrumentLabel(instrumentLabel),
              _id(id),
              _focusZ(focusZ),
              _observationType(observationType),
              _scienceProgram(scienceProgram),
              _observationReason(observationReason),
              _object(object),
              _hasSimulatedContent(hasSimulatedContent) {}

VisitInfo() [2/4]

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

explicit

Definition at line 453 of file VisitInfo.cc.

        : _exposureTime(nan),  // don't use getDouble because str values are also accepted
          _darkTime(getDouble(metadata, "DARKTIME")),
          _date(),
          _ut1(getDouble(metadata, "MJD-AVG-UT1")),
          _era(getAngle(metadata, "AVG-ERA")),
          _boresightRaDec(
                  lsst::geom::SpherePoint(getAngle(metadata, "BORE-RA"), getAngle(metadata, "BORE-DEC"))),
          _boresightAzAlt(
                  lsst::geom::SpherePoint(getAngle(metadata, "BORE-AZ"), getAngle(metadata, "BORE-ALT"))),
          _boresightAirmass(getDouble(metadata, "BORE-AIRMASS")),
          _boresightRotAngle(getAngle(metadata, "BORE-ROTANG")),
          _rotType(RotType::UNKNOWN),
          _observatory(getAngle(metadata, "OBS-LONG"), getAngle(metadata, "OBS-LAT"),
                       getDouble(metadata, "OBS-ELEV")),
          _weather(getDouble(metadata, "AIRTEMP"), getDouble(metadata, "AIRPRESS"),
                   getDouble(metadata, "HUMIDITY")),
          _instrumentLabel(getString(metadata, "INSTRUMENT")),
          _id(0),
          _focusZ(getDouble(metadata, "FOCUSZ")),
          _observationType(getString(metadata, "OBSTYPE")),
          _scienceProgram(getString(metadata, "PROGRAM")),
          _observationReason(getString(metadata, "REASON")),
          _object(getString(metadata, "OBJECT")),
          // default false for backwards compatibility
          _hasSimulatedContent(false) {
    auto key = "IDNUM";
    if (metadata.exists(key) && !metadata.isUndefined(key)) {
        _id = metadata.getAsInt64(key);
    }
 
    key = "EXPTIME";
    if (metadata.exists(key) && !metadata.isUndefined(key)) {
        try {
            _exposureTime = metadata.getAsDouble(key);
        } catch (lsst::pex::exceptions::TypeError& err) {
            // some old exposures have EXPTIME stored as a string
            std::string exptimeStr = metadata.getAsString(key);
            _exposureTime = std::stod(exptimeStr);
        }
    }
 
    key = "DATE-AVG";
    if (metadata.exists(key) && !metadata.isUndefined(key)) {
        if (metadata.exists("TIMESYS")) {
            auto timesysName = boost::algorithm::trim_right_copy(metadata.getAsString("TIMESYS"));
            if (timesysName != "TAI") {
                // rather than try to deal with all the possible choices, which requires
                // appending or deleting a "Z", depending on the time system, just give up.
                // VisitInfo should be used on FITS headers that have been sanitized!
                std::ostringstream os;
                os << "TIMESYS = \"" << timesysName
                   << "\"; VisitInfo requires TIMESYS to exist and to equal \"TAI\"";
                throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError, os.str());
            }
        } else {
            throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                              "TIMESYS not found; VistitInfo requires TIMESYS to exist and to equal \"TAI\"");
        }
        _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::TAI);
    } else {
        // DATE-AVG not found. For backwards compatibility look for TIME-MID, an outdated LSST keyword
        // whose time system was UTC, despite a FITS comment claiming it was TAI. Ignore TIMESYS.
        key = "TIME-MID";
        if (metadata.exists(key) && !metadata.isUndefined(key)) {
            _date = ::DateTime(boost::algorithm::trim_right_copy(metadata.getAsString(key)), ::DateTime::UTC);
        }
    }
 
    key = "ROTTYPE";
    if (metadata.exists(key) && !metadata.isUndefined(key)) {
        _rotType = rotTypeEnumFromStr(metadata.getAsString(key));
    }
 
    key = "HAS-SIMULATED-CONTENT";
    if (metadata.exists(key) && !metadata.isUndefined(key)) {
        _hasSimulatedContent = metadata.getAsBool(key);
    }
}

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

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

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< VisitInfo >::dynamicCast ( std::shared_ptr< Persistable > const & ptr )

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;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If 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 634 of file VisitInfo.cc.

                                                                       {
    return singleClassEquals(*this, other);
}

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

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

{ return _boresightAzAlt; }

getBoresightHourAngle()

lsst::geom::Angle lsst::afw::image::VisitInfo::getBoresightHourAngle

(

)

const

Definition at line 614 of file VisitInfo.cc.

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

                                                    {
    double _parallactic_y, _parallactic_x, result;
    _parallactic_y = sin(getBoresightHourAngle().asRadians());
    _parallactic_x =
            cos((getBoresightRaDec()[1]).asRadians()) * tan(getObservatory().getLatitude().asRadians()) -
            sin((getBoresightRaDec()[1]).asRadians()) * cos(getBoresightHourAngle().asRadians());
    result = atan2(_parallactic_y, _parallactic_x);
    return result * lsst::geom::radians;
}

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

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

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

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

{ return _date; }

getEra()

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

inline

get earth rotation angle at middle of exposure

Definition at line 156 of file VisitInfo.h.

{ return _era; }

getExposureTime()

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

inline

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

Definition at line 144 of file VisitInfo.h.

{ return _exposureTime; }

getFocusZ()

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

inline

Definition at line 200 of file VisitInfo.h.

{ return _focusZ; }

getHasSimulatedContent()

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

inline

Definition at line 206 of file VisitInfo.h.

{ return _hasSimulatedContent; }

getId()

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

inline

Definition at line 197 of file VisitInfo.h.

{ return _id; }

getInstrumentLabel()

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

inline

Definition at line 195 of file VisitInfo.h.

{ return _instrumentLabel; }

getLocalEra()

lsst::geom::Angle lsst::afw::image::VisitInfo::getLocalEra

(

)

const

Definition at line 612 of file VisitInfo.cc.

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

getObject()

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

inline

Definition at line 205 of file VisitInfo.h.

{ return _object; }

getObservationReason()

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

inline

Definition at line 204 of file VisitInfo.h.

{ return _observationReason; }

getObservationType()

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

inline

Definition at line 202 of file VisitInfo.h.

{ return _observationType; }

getObservatory()

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

inline

get observatory longitude, latitude and elevation

Definition at line 182 of file VisitInfo.h.

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

{ return getVisitInfoPersistenceName(); }

getPythonModule()

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

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::afw::image::FilterLabel, lsst::afw::cameraGeom::Detector, lsst::afw::cameraGeom::DetectorCollection, lsst::afw::cameraGeom::TransformMap, lsst::afw::detection::Footprint, lsst::afw::detection::GaussianPsf, lsst::afw::geom::SkyWcs, lsst::afw::geom::SpanSet, lsst::afw::geom::Transform< FromEndpoint, ToEndpoint >, lsst::afw::geom::Transform< afw::geom::Point2Endpoint, afw::geom::GenericEndpoint >, lsst::afw::image::ApCorrMap, lsst::afw::image::CoaddInputs, lsst::afw::image::TransmissionCurve, lsst::afw::math::ChebyshevBoundedField, lsst::afw::math::Function< double >, lsst::afw::math::Function< Kernel::Pixel >, lsst::afw::math::Function< Pixel >, lsst::afw::math::Function< ReturnT >, lsst::afw::math::Kernel, lsst::afw::math::PixelAreaBoundedField, lsst::afw::math::ProductBoundedField, lsst::afw::math::TransformBoundedField, lsst::afw::math::LanczosWarpingKernel, lsst::afw::math::BilinearWarpingKernel, lsst::afw::math::NearestWarpingKernel, lsst::afw::math::WarpingControl, lsst::afw::typehandling::StorableHelper< Base >, lsst::meas::algorithms::CoaddBoundedField, lsst::meas::algorithms::CoaddPsf, lsst::meas::algorithms::KernelPsf, lsst::meas::algorithms::WarpedPsf, lsst::meas::extensions::psfex::PsfexPsf, and lsst::meas::modelfit::Mixture.

Definition at line 36 of file Persistable.cc.

{ return std::string(); }

getRotType()

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

inline

get rotation type of boresightRotAngle

Definition at line 179 of file VisitInfo.h.

{ return _rotType; }

getScienceProgram()

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

inline

Definition at line 203 of file VisitInfo.h.

{ return _scienceProgram; }

getUt1()

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

inline

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

Definition at line 153 of file VisitInfo.h.

{ return _ut1; }

getWeather()

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

inline

get basic weather information

Definition at line 185 of file VisitInfo.h.

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

                                               {
    // Completely arbitrary seed
    return cpputils::hashCombine(17, _exposureTime, _darkTime, _date, _ut1, _era, _boresightRaDec,
                              _boresightAzAlt, _boresightAirmass, _boresightRotAngle, _rotType, _observatory,
                              _weather, _instrumentLabel, _id, _focusZ, _observationType, _scienceProgram,
                              _observationReason, _object, _hasSimulatedContent);
}

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

{ return true; }

operator!=()

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

inline

Definition at line 138 of file VisitInfo.h.

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

                                                       {
    return _eqOrNan(_exposureTime, other.getExposureTime()) && _eqOrNan(_darkTime, other.getDarkTime()) &&
           _date == other.getDate() && _eqOrNan(_ut1, other.getUt1()) && _eqOrNan(_era, other.getEra()) &&
           _eqOrNonFinite(_boresightRaDec, other.getBoresightRaDec()) &&
           _eqOrNonFinite(_boresightAzAlt, other.getBoresightAzAlt()) &&
           _eqOrNan(_boresightAirmass, other.getBoresightAirmass()) &&
           _eqOrNan(_boresightRotAngle, other.getBoresightRotAngle()) && _rotType == other.getRotType() &&
           _observatory == other.getObservatory() && _weather == other.getWeather() &&
           _instrumentLabel == other.getInstrumentLabel() && _id == other.getId() &&
           _eqOrNan(_focusZ, other.getFocusZ()) && _observationType == other.getObservationType() &&
           _scienceProgram == other.getScienceProgram() &&
           _observationReason == other.getObservationReason() && _object == other.getObject() &&
           _hasSimulatedContent == other.getHasSimulatedContent();
}

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]

fitsfile

FITS 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]	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.

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

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

T	The class expected of the two objects to be compared.

Parameters

lhs,rhs

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

                                                                     {
        auto typedRhs = dynamic_cast<T const*>(&rhs);
        if (typedRhs != nullptr) {
            return lhs == *typedRhs;
        } else {
            return false;
        }
    }

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

                                    {
    std::stringstream buffer;
    buffer << "VisitInfo(";
    buffer << "exposureTime=" << getExposureTime() << ", ";
    buffer << "darkTime=" << getDarkTime() << ", ";
    buffer << "date=" << (getDate().isValid() ? getDate().toString(daf::base::DateTime::TAI) : "<invalid>")
           << ", ";
    buffer << "UT1=" << getUt1() << ", ";
    buffer << "ERA=" << getEra() << ", ";
    buffer << "boresightRaDec=" << getBoresightRaDec() << ", ";
    buffer << "boresightAzAlt=" << getBoresightAzAlt() << ", ";
    buffer << "boresightAirmass=" << getBoresightAirmass() << ", ";
    buffer << "boresightRotAngle=" << getBoresightRotAngle() << ", ";
    buffer << "rotType=" << static_cast<int>(getRotType()) << ", ";
    buffer << "observatory=" << getObservatory() << ", ";
    buffer << "weather=" << getWeather() << ", ";
    buffer << "instrumentLabel='" << getInstrumentLabel() << "', ";
    buffer << "id=" << getId() << ", ";
    buffer << "focusZ=" << getFocusZ() << ", ";
    buffer << "observationType='" << getObservationType() << "', ";
    buffer << "scienceProgram='" << getScienceProgram() << "', ";
    buffer << "observationReason='" << getObservationReason() << "', ";
    buffer << "object='" << getObject() << "', ";
    buffer << "hasSimulatedContent=" << std::boolalpha << getHasSimulatedContent();
    buffer << ")";
    return buffer.str();
}

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

                                                       {
    VisitInfoSchema const& keys = VisitInfoSchema::get();
    table::BaseCatalog cat = handle.makeCatalog(keys.schema);
    std::shared_ptr<table::BaseRecord> record = cat.addNew();
    record->set(keys.exposureTime, getExposureTime());
    record->set(keys.darkTime, getDarkTime());
    record->set(keys.tai, getDate().nsecs(::DateTime::TAI));
    record->set(keys.ut1, getUt1());
    record->set(keys.era, getEra());
    record->set(keys.boresightRaDec, getBoresightRaDec());
    auto boresightAzAlt = getBoresightAzAlt();
    record->set(keys.boresightAzAlt_az, boresightAzAlt[0]);
    record->set(keys.boresightAzAlt_alt, boresightAzAlt[1]);
    record->set(keys.boresightAirmass, getBoresightAirmass());
    record->set(keys.boresightRotAngle, getBoresightRotAngle());
    record->set(keys.rotType, static_cast<int>(getRotType()));
    auto observatory = getObservatory();
    record->set(keys.latitude, observatory.getLatitude());
    record->set(keys.longitude, observatory.getLongitude());
    record->set(keys.elevation, observatory.getElevation());
    auto weather = getWeather();
    record->set(keys.airTemperature, weather.getAirTemperature());
    record->set(keys.airPressure, weather.getAirPressure());
    record->set(keys.humidity, weather.getHumidity());
    record->set(keys.instrumentLabel, getInstrumentLabel());
    record->set(keys.version, SERIALIZATION_VERSION);
    record->set(keys.idnum, getId());
    record->set(keys.focusZ, getFocusZ());
    record->set(keys.observationType, getObservationType());
    record->set(keys.scienceProgram, getScienceProgram());
    record->set(keys.observationReason, getObservationReason());
    record->set(keys.object, getObject());
    record->set(keys.hasSimulatedContent, getHasSimulatedContent());
    handle.saveCatalog(cat);
}

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]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

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

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

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

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

Friends And Related Symbol Documentation

operator<<()

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

related

Output operator for Storable.

Parameters

os	the desired output stream
storable	the object to print

Returns

a reference to os

Exceptions

UnsupportedOperationException

Thrown if storable does not have an implementation of Storable::toString.

Definition at line 174 of file Storable.h.

                                                                        {
    return os << storable.toString();
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/include/lsst/afw/image/VisitInfo.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/src/image/VisitInfo.cc