DF_Proj_Report.hpp

//    DFLib: A library of Bearings Only Target Localization algorithms
//    Copyright (C) 2009-2015  Thomas V. Russo
//
//    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/>.
//-------------------------------------------------------------------------

//-------------------------------------------------------------------------
// Filename       : $RCSfile$
//
// Purpose        : Implements the DFLib::Abstract::Report interface such that
//                  the "user" coordinate system is specified using a proj.4
//                  spatial reference system and the "XY" coordinate system
//                  is a mercator projection on the WGS84 ellipsoid.
//
// Special Notes  : Use of this class treats bearing lines to target 
//                  transmitter as loxodromes, not geodesics.  Technically,
//                  that is incorrect.  For practical VHF target localization,
//                  it is probably good enough.  To implement a Report class
//                  that implements completely correct geodesic calculations
//                  would be much harder, and I haven't done it yet.  One
//                  would require an X-Y coordinate system in which straight 
//                  lines are geodesics rather than loxodromes, and there is no
//                  conformal projection that does that.  
//
// Creator        : 
//
// Creation Date  : 
//
// Revision Information:
// ---------------------
//
// Revision Number: $Revision$
//
// Revision Date  : $Date$
//
// Current Owner  : $Author$
//-------------------------------------------------------------------------
#ifndef DF_PROJ_REPORT_HPP
#define DF_PROJ_REPORT_HPP
#ifdef _MSC_VER
#define _USE_MATH_DEFINES
#endif
#include "DFLib_port.h"
#include <cmath>

#include "DF_Abstract_Report.hpp"

namespace DFLib
{
  namespace Proj
  {
    class Point;

    /// \brief DF report in user-specified coordinates
    class CPL_DLL Report 
      : public DFLib::Abstract::Report
    {
    private:
      Point *receiverLocation;            
      double bearing,sigma;
    public:
      Report(const std::vector<double> &theLocationUser, 
                     const double &bearing,const double &std_dev,
                     const std::string &theName,const std::vector<std::string>&projArgs);


      Report(const Report & right);
      Report & operator=(const Report& rhs);

      virtual ~Report();
      virtual  const  std::vector<double> &getReceiverLocation();
      virtual Point getReceiverPoint() const;
      virtual  double getReportBearingRadians() const;
      virtual  double getBearing() const;
      virtual  double getBearingStandardDeviationRadians() const;
      virtual  double getSigma() const;
      virtual  void  setReceiverLocationUser(const std::vector<double> &theLocation);
      virtual  void  setReceiverLocationMercator(const std::vector<double> &theLocation);
      //! set bearing in degrees
      virtual  void  setBearing(double Bearing);
      //! set standard deviation in degrees
      virtual  void  setSigma(double Sigma);
      //! allow us to change the projection of the user coordinates
      virtual void setUserProj(const std::vector<std::string> &projArgs);
    };
  }

  inline double DFLib::Proj::Report::getReportBearingRadians() const
  {
    // bearing *must* be in 0<bearing<2*pi
    return bearing;
  }
  inline double DFLib::Proj::Report::getBearing() const
  {
    // always return bearing in range 0-360 degrees
    return (getReportBearingRadians()*180.0/M_PI);
  }

  inline double DFLib::Proj::Report::getBearingStandardDeviationRadians() const
  {
    return sigma;
  }
  inline double DFLib::Proj::Report::getSigma() const
  {
    return sigma*180/M_PI;
  }

  inline void DFLib::Proj::Report::setReceiverLocationUser(const std::vector<double> &theLocation)
  {
    receiverLocation->setUserCoords(theLocation);
  }

  inline void DFLib::Proj::Report::setReceiverLocationMercator(const std::vector<double> &theLocation)
  {
    receiverLocation->setXY(theLocation);
  }

  inline void DFLib::Proj::Report::setUserProj(const std::vector<std::string> &projArgs)
  {
    receiverLocation->setUserProj(projArgs);
  }

  inline const std::vector<double> & DFLib::Proj::Report::getReceiverLocation() 
  { 
    return receiverLocation->getXY();
  }

  inline void DFLib::Proj::Report::setBearing(double Bearing)
  {
    // bearing *must* be in 0<bearing<2*pi
    bearing=Bearing*M_PI/180.0;
    while (bearing < 0)
      bearing += 2*M_PI;
    while (bearing >= 2*M_PI)
      bearing -= 2*M_PI;

  }
  inline void DFLib::Proj::Report::setSigma(double Sigma)
  {
    sigma=Sigma*M_PI/180;
  }
}
#endif // DF_PROJ_REPORT_HPP