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/Coord.h"
#include "lsst/afw/coord/Weather.h"
#include "lsst/afw/geom/Point.h"
#include "lsst/afw/table/misc.h"  // for RecordId
#include "lsst/afw/table/io/Persistable.h"

namespace lsst { namespace afw { namespace image {

enum class RotType {
    UNKNOWN,    
    SKY,        
    HORIZON,    
    MOUNT       
};

class VisitInfo : public table::io::PersistableFacade<VisitInfo>, public table::io::Persistable {
public:

    explicit VisitInfo(
        table::RecordId exposureId,
        double exposureTime,
        double darkTime,
        daf::base::DateTime const & date,
        double ut1,
        geom::Angle const & era,
        coord::IcrsCoord const & boresightRaDec,
        coord::Coord const & boresightAzAlt,
        double boresightAirmass,
        geom::Angle const & boresightRotAngle,
        RotType const & rotType,
        coord::Observatory const & observatory,
        coord::Weather const & weather
    ) :
        _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)
    {};

    explicit VisitInfo(daf::base::PropertySet const & metadata);

    ~VisitInfo() {};

    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); };

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

    geom::Angle getEra() const { return _era; }

    coord::IcrsCoord getBoresightRaDec() const { return _boresightRaDec; }

    coord::Coord getBoresightAzAlt() const { return _boresightAzAlt; }

    double getBoresightAirmass() const { return _boresightAirmass; }

    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 { return true; }

    // get the local sidereal time on the meridian (equivalent, but not equal, to Local Mean Sidereal Time)
    geom::Angle getLocalEra() const;

    // get hour angle at the boresight
    geom::Angle getBoresightHourAngle() const;

protected:

    virtual std::string getPersistenceName() const;

    virtual void write(OutputArchiveHandle & handle) const;

private:
    table::RecordId _exposureId;
    double _exposureTime;
    double _darkTime;
    daf::base::DateTime _date;
    double _ut1;
    geom::Angle _era;
    coord::IcrsCoord _boresightRaDec;
    coord::Coord _boresightAzAlt;
    double _boresightAirmass;
    geom::Angle _boresightRotAngle;
    RotType _rotType;
    coord::Observatory _observatory;
    coord::Weather _weather;
};

namespace detail {

void setVisitInfoMetadata(daf::base::PropertyList &metadata, VisitInfo const &visitInfo);

int stripVisitInfoKeywords(daf::base::PropertySet & metadata);

} // lsst::afw::image::detail

}}} // lsst::afw::image

#endif // !LSST_AFW_IMAGE_VISITINFO_H_INCLUDED