VisitInfo.h

Go to the documentation of this file.

// -*- LSST-C++ -*- // fixed format comment for emacs
/*
 * LSST Data Management System
 * Copyright 2016 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_AFW_IMAGE_VISITINFO_H_INCLUDED
#define LSST_AFW_IMAGE_VISITINFO_H_INCLUDED
 
#include <cmath>
#include <limits>
 
#include "lsst/base.h"
#include "lsst/daf/base.h"
#include "lsst/afw/coord/Observatory.h"
#include "lsst/afw/coord/Weather.h"
#include "lsst/geom/Point.h"
#include "lsst/geom/SpherePoint.h"
#include "lsst/afw/table/misc.h"  // for RecordId
#include "lsst/afw/table/io/Persistable.h"
#include "lsst/afw/typehandling/Storable.h"
 
namespace lsst {
namespace afw {
namespace image {
 
enum class RotType {
    UNKNOWN,  
    SKY,      
    HORIZON,  
    MOUNT     
};
 
class VisitInfo : public table::io::PersistableFacade<VisitInfo>, public typehandling::Storable {
public:
    // TODO: remove exposureId on DM-32138
    explicit 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)
            : _exposureId(exposureId),
              _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) {}
 
    explicit 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 { return !(*this == other); };
 
    std::size_t hash_value() const noexcept override;
 
    // TODO: remove on DM-32138
    [[deprecated(
            "Replaced by VisitInfo::getId() for full focal plane identifiers and by "
            "ExposureInfo::getId() for detector-level identifiers. Will be removed after v25.")]] table::
            RecordId
            getExposureId() const {
        return _exposureId;
    }
 
    double getExposureTime() const { return _exposureTime; }
 
    double getDarkTime() const { return _darkTime; }
 
    daf::base::DateTime getDate() const { return _date; }
 
    double getUt1() const { return _ut1; }
 
    lsst::geom::Angle getEra() const { return _era; }
 
    lsst::geom::SpherePoint getBoresightRaDec() const { return _boresightRaDec; }
 
    lsst::geom::SpherePoint getBoresightAzAlt() const { return _boresightAzAlt; }
 
    double getBoresightAirmass() const { return _boresightAirmass; }
 
    lsst::geom::Angle getBoresightRotAngle() const { return _boresightRotAngle; }
 
    RotType getRotType() const { return _rotType; }
 
    coord::Observatory getObservatory() const { return _observatory; }
 
    coord::Weather getWeather() const { return _weather; }
 
    bool isPersistable() const noexcept override { return true; }
 
    // get the local sidereal time on the meridian (equivalent, but not equal, to Local Mean Sidereal Time)
    lsst::geom::Angle getLocalEra() const;
 
    // get hour angle at the boresight
    lsst::geom::Angle getBoresightHourAngle() const;
 
    std::string getInstrumentLabel() const { return _instrumentLabel; }
 
    table::RecordId getId() const { return _id; }
 
    // get defocal distance (mm)
    double getFocusZ() const { return _focusZ; }
 
    std::string getObservationType() const { return _observationType; }
    std::string getScienceProgram() const { return _scienceProgram; }
    std::string getObservationReason() const { return _observationReason; }
    std::string getObject() const { return _object; }
    bool getHasSimulatedContent() const { return _hasSimulatedContent; }
 
    lsst::geom::Angle getBoresightParAngle() const;
 
    std::shared_ptr<typehandling::Storable> cloneStorable() const override;
 
    std::string toString() const override;
 
    bool equals(typehandling::Storable const &other) const noexcept override;
 
protected:
    std::string getPersistenceName() const override;
 
    void write(OutputArchiveHandle &handle) const override;
 
private:
    table::RecordId _exposureId;  // TODO: remove on DM-32138
    double _exposureTime;
    double _darkTime;
    daf::base::DateTime _date;
    double _ut1;
    lsst::geom::Angle _era;
    lsst::geom::SpherePoint _boresightRaDec;
    lsst::geom::SpherePoint _boresightAzAlt;
    double _boresightAirmass;
    lsst::geom::Angle _boresightRotAngle;
    RotType _rotType;
    coord::Observatory _observatory;
    coord::Weather _weather;
    std::string _instrumentLabel;
    table::RecordId _id;
    double _focusZ;
    std::string _observationType;
    std::string _scienceProgram;
    std::string _observationReason;
    std::string _object;
    bool _hasSimulatedContent;
};
 
std::ostream &operator<<(std::ostream &os, VisitInfo const &visitInfo);
 
namespace detail {
 
void setVisitInfoMetadata(daf::base::PropertyList &metadata, VisitInfo const &visitInfo);
 
int stripVisitInfoKeywords(daf::base::PropertySet &metadata);
 
}  // namespace detail
}  // namespace image
}  // namespace afw
}  // namespace lsst
 
namespace std {
template <>
struct hash<lsst::afw::image::VisitInfo> {
    using argument_type = lsst::afw::image::VisitInfo;
    using result_type = size_t;
    size_t operator()(argument_type const &obj) const noexcept { return obj.hash_value(); }
};
}  // namespace std
 
#endif  // !LSST_AFW_IMAGE_VISITINFO_H_INCLUDED