CEObserver.h

Go to the documentation of this file.

/***************************************************************************
 *  CEObserver.h: CppEphem                                                 *
 * ----------------------------------------------------------------------- *
 *  Copyright © 2016-2019 JCardenzana                                      *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
 
#ifndef CEObserver_h
#define CEObserver_h
 
#include "CEAngle.h"
#include "CEDate.h"
#include "CENamespace.h"
 
class CEObserver {
public:
    CEObserver(void) ;
    CEObserver(const double& longitude, 
               const double& latitude, 
               const double& elevation,
               const CEAngleType& angle_type = CEAngleType::DEGREES) ;
    CEObserver(const CEObserver& other) ;
    virtual ~CEObserver(void) ;
    
    CEObserver& operator=(const CEObserver& other);
 
    /****************************************************
     * Methods for accessing the underlying observer info
     ****************************************************/
    double              Longitude_Rad() const;
    double              Longitude_Deg() const;
    double              Latitude_Rad() const;
    double              Latitude_Deg() const;
    double              Elevation_m() const;
    double              Pressure_hPa() const;
    double              Temperature_C() const;
    double              Temperature_K() const;
    double              Temperature_F() const;
    double              RelativeHumidity() const;
    double              Wavelength_um() const;
    void                SetUTCOffset(const double& utc_offset);
    double              UTCOffset() const;
    std::vector<double> Time(const CEDate& date);
    std::vector<double> Time_UTC(const CEDate& date);
    
    /****************************************************
     * Methods for setting the underlying observer info
     ****************************************************/
    void SetElevation(const double& elevation=0.0);
    void SetLongitude(const double& longitude, 
                      const CEAngleType&  angle_type=CEAngleType::RADIANS);
    void SetLatitude(const double& latitude, 
                     const CEAngleType&  angle_type=CEAngleType::RADIANS);
    void SetGeoCoordinates(const double& longitude,
                           const double& latitude,
                           const CEAngleType&  angle_type=CEAngleType::RADIANS);
    void SetPressure_hPa(const double& pressure=CppEphem::EstimatePressure_hPa(CppEphem::SeaLevelTemp_C()));
    void SetRelativeHumidity(const double& humidity=0.0);
    void SetTemperature_C(const double& temp_C=CppEphem::SeaLevelTemp_C());
    void SetTemperature_K(const double& temp_K=CppEphem::SeaLevelTemp_K());
    void SetTemperature_F(const double& temp_F=CppEphem::SeaLevelTemp_F());
    void SetWavelength_um(const double& new_wavelength_um);
    
    /****************************************************
     * Methods for getting observer position and velocity
     * vectors relative to CIRS and ICRS coordinates
     ****************************************************/
    std::vector<double> PositionGeo(void) const;
    std::vector<double> PositionCIRS(const CEDate& date) const;
    std::vector<double> PositionICRS(const CEDate& date) const;
    std::vector<double> VelocityCIRS(const CEDate& date) const;
    std::vector<double> VelocityICRS(const CEDate& date) const;
 
    // Print information about the observer
    std::string print(void) const;
 
private:
 
    void copy_members(const CEObserver& other);
    void init_members(void);
    void free_members(void);
 
    // Update teh Position and velocity vectors
    void UpdatePosVel(const CEDate& date) const;
 
    // Variables which define the observers location on Earth
    double longitude_;              
    double latitude_;               
    double elevation_m_;            
 
    // Variables defining the observers atmospheric conditions
    double pressure_hPa_;           
    double temperature_celsius_;    
    double relative_humidity_;      
    double wavelength_um_;          
    
    // Cached position/velocity vectors
    mutable double              cache_date_; 
    mutable std::vector<double> pos_cirs_;   
    mutable std::vector<double> pos_icrs_;   
    mutable std::vector<double> vel_cirs_;   
    mutable std::vector<double> vel_icrs_;   
 
    // Variables defining the time of the observer
    double  utc_offset_;            
};
 
 
/**********************************************************************/
inline
double CEObserver::Longitude_Rad() const
{
    return longitude_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Longitude_Deg() const
{
    return longitude_ * DR2D ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Latitude_Rad() const
{
    return latitude_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Latitude_Deg() const
{
    return latitude_ * DR2D ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Elevation_m() const
{
    return elevation_m_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Pressure_hPa() const
{
    return pressure_hPa_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Temperature_C() const
{
    return temperature_celsius_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Temperature_K() const
{
    return CppEphem::Temp_C2K(temperature_celsius_);
}
 
 
/**********************************************************************/
inline
double CEObserver::Temperature_F() const
{
    return CppEphem::Temp_C2F(temperature_celsius_);
}
 
 
/**********************************************************************/
inline
double CEObserver::RelativeHumidity() const
{
    return relative_humidity_ ;
}
 
 
/**********************************************************************/
inline
double CEObserver::Wavelength_um() const
{
    return wavelength_um_ ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetUTCOffset(const double& utc_offset) 
{
    utc_offset_ = utc_offset ;
}
 
 
/**********************************************************************/
inline
double CEObserver::UTCOffset() const
{
    return utc_offset_ ;
}
 
 
/**********************************************************************/
inline
std::vector<double> CEObserver::Time(const CEDate& date)
{
    double utc = date.MJD();
    utc -= std::floor(utc);
    utc += utc_offset_/24.0;            // Do this here for precision reasons
    utc *= CppEphem::sec_per_day();
    return CETime::TimeDbl2Vect( CETime::TimeSec2Time(utc) ) ;
}
 
 
/**********************************************************************/
inline
std::vector<double> CEObserver::Time_UTC(const CEDate& date) 
{
    return CETime::TimeDbl2Vect(date.GetTime_UTC()) ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetElevation(const double& elevation)
{
    elevation_m_ = elevation ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetLongitude(const double& longitude, 
                              const CEAngleType&  angle_type)
{
    longitude_ = longitude * ((angle_type==CEAngleType::RADIANS) ? 1 : DD2R) ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetLatitude(const double& latitude, 
                             const CEAngleType&  angle_type)
{
    latitude_ = latitude * ((angle_type==CEAngleType::RADIANS) ? 1 : DD2R) ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetGeoCoordinates(const double& longitude,
                                   const double& latitude,
                                   const CEAngleType&  angle_type)
{
    SetLongitude(longitude, angle_type);
    SetLatitude(latitude, angle_type);
}
 
 
/**********************************************************************/
inline
void CEObserver::SetPressure_hPa(const double& pressure)
{
    pressure_hPa_ = pressure ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetRelativeHumidity(const double& humidity)
{
    relative_humidity_ = humidity ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetTemperature_C(const double& temp_C)
{
    temperature_celsius_ = temp_C ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetTemperature_K(const double& temp_K)
{
    temperature_celsius_ = CppEphem::Temp_K2C(temp_K) ;
}
 
 
/**********************************************************************/
inline
void CEObserver::SetTemperature_F(const double& temp_F)
{
    temperature_celsius_ = CppEphem::Temp_F2C(temp_F);
}
 
 
/**********************************************************************/
inline
void CEObserver::SetWavelength_um(const double& new_wavelength_um)
{
    wavelength_um_ = new_wavelength_um ;
}
 
#endif /* CEObserver_h */