mi32/trend.h

Go to the documentation of this file.

#ifndef  INC_MI32_TREND_H
#define  INC_MI32_TREND_H

#ifndef  INC_MI32_POLYNOMIAL_H
#include <mi32/polynomial.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
namespace RVC {
   class OBJITEM;
   class RASTER;
   class NULLMASK;
   }
#endif


class TREND2D {
   public:

      #ifndef GENERATING_DOXYGEN_OUTPUT
      class GENERATOR;
      #endif

      class PARM {
         public:

            PARM (
               ) : m_Order(1), m_BorderCells(0), m_SampleCols(1), m_SampleRows(1), m_PreserveRange(false) { }

            void Set (
               int Order,              
               int BorderCells,        
               int SampleCols,         
               int SampleRows,         
               bool PreserveRange      
               ) { m_Order = Order; m_BorderCells = BorderCells; m_SampleCols = SampleCols; m_SampleRows = SampleRows; m_PreserveRange = PreserveRange; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            int m_Order;               // Polynomial order, usually 1 or 2
            int m_BorderCells;         // Number of border cells to use, 0 to use entire raster
            int m_SampleCols;          // Sample interval for columns (>= 1)
            int m_SampleRows;          // Sample interval for rows (>= 1)
            bool m_PreserveRange;      // Preserve original dynamic range when compute global scale and offset
            friend class TREND2D;
            friend class TREND2D::GENERATOR;
            #endif
         };

      TREND2D ();

      ~TREND2D ();

      double AddTrend (
         double x,
         double y,
         double value
         ) const;

      ERRVALUE Compute (
         const PARM& parm,                      
         RVC::RASTER& ObjRaster,                
         RVC::RASTER *pObjMask = 0              
         );

      ERRVALUE Compute (
         const PARM& parm,                      
         const RVC::OBJITEM& ObjItemRaster,     
         const RVC::OBJITEM *pObjItemMask = 0   
         );

      double GetGlobalOffset (
         ) const { return (m_GlobalOffset); }

      double GetGlobalScale (
         ) const { return (m_GlobalScale); }

      const PARM& GetParm (
         ) const { return (m_Parm); }

      double GetValue (
         double x,
         double y
         ) const { return (m_Polynomial.Evaluate(x,y)); }

      double SubtractTrend (
         double x,
         double y,
         double value
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      PARM m_Parm;
      POLYNOMIAL_2D m_Polynomial;
      double m_GlobalScale;
      double m_GlobalOffset;
      friend class TREND2D::GENERATOR;
      #endif
   };


#endif   // INC_MI32_TREND_H 

---