StatsFilterHit.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
 
#ifndef STATISTICAL_FILTER_HIT_INCLUDE
#define STATISTICAL_FILTER_HIT_INCLUDE
 
namespace gnsstk
{
   //---------------------------------------------------------------------------------
   // TD NB pffrac is never used.
   // NB WindowFilter does not find outliers
   //---------------------------------------------------------------------------------
 
   template <class T> class FilterHit
   {
   public:
      typedef enum EventType
      {
         BOD = 0, 
         outlier, 
         slip,    
         other    
      } event;
 
      FilterHit()
         : index(-1), type(BOD), npts(0), ngood(0), score(0), step(T(0)),
           sigma(T(0)), dx(T(0)), haveStats(false)
      {
      }
 
      // member data
      event type;           
 
      unsigned int
         index;             
      unsigned int
         npts;              
      unsigned int ngood;   
      unsigned int
         score;             
 
      T step;               
      T sigma;              
      T dx;                 
 
      bool haveStats;       
      // see getStats() - meanings depend on filter
      T min, max, med, mad; 
 
      std::string msg;      
 
      bool isBOD() { return (type == BOD); }
 
      bool isOutlier() { return (type == outlier); }
 
      bool isSlip() { return (type == slip); }
 
      std::string analMsg() const { return msg; }
 
      std::string asString(const int osp = 3) const
      {
         std::stringstream oss;
         switch (type)
         {
            case BOD:
               oss << "BOD";
               break;
            case outlier:
               oss << "OUT";
               break;
            case slip:
               oss << "SLIP";
               break;
            default:
            case other:
               oss << "other";
               break;
         }
         oss << std::fixed << std::setprecision(osp);
 
         // ind npts step dx sig score - be sure this order matches
         // asStringRead()
         oss << " " << index << " " << npts << " " << dx;
         if (type == slip)
         {
            oss << " " << step << " " << sigma << " " << score;
         }
         else
         {
            oss << " ?"
                << " ?"
                << " ?";
         }
 
         return oss.str();
      }
 
      std::string asStringRead(const int osp = 3) const
      {
         std::stringstream oss;
         switch (type)
         {
            case BOD:
               oss << "BOD";
               break;
            case outlier:
               oss << "OUT";
               break;
            case slip:
               oss << "SLIP";
               break;
            default:
            case other:
               oss << "other";
               break;
         }
         oss << " ind=" << index << " npts=" << npts << " ngood=" << ngood
             << std::fixed << std::setprecision(osp) << " x_gap=" << dx;
         if (type == slip)
         {
            oss << " step=" << step << " sig=" << sigma << " score=" << score
                << (score < 100 ? " SMALL" : "");
         }
 
         return oss.str();
      }
 
      std::string asStatsString(const int osp = 3) const
      {
         std::stringstream oss;
         oss << asString(osp) << std::fixed << std::setprecision(osp);
         if (!haveStats)
         {
            oss << "; NoSt";
         }
         else
         {
            oss << " min=" << min << " max=" << max << " med=" << med
                << " mad=" << mad;
         }
         return oss.str();
      }
 
   }; // end class FilterHit
 
   //---------------------------------------------------------------------------------
   //---------------------------------------------------------------------------------
} // namespace gnsstk
#endif // #define STATISTICAL_FILTER_HIT_INCLUDE