rvc/hyperhistogram.h

Go to the documentation of this file.

#ifndef INC_RVC_HYPERHISTOGRAM_H
#define INC_RVC_HYPERHISTOGRAM_H

#ifndef  INC_RVC_OBJECT_H
   #include <rvc/object.h>
#endif

#ifndef  INC_MI32_RANGE_H
   #include <mi32/range.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward Declarations
class STAT_UNIVARIATE;
namespace RVC {
   struct HYPERHISTBANDINFO;
   class HYPERSPECTRAL;
   }
#endif


namespace RVC {

class HYPERHISTOGRAM : public RVC::OBJECT {
   public:
   
      HYPERHISTOGRAM ();

      HYPERHISTOGRAM (
         const RVC::HYPERHISTOGRAM& rhs
         );

      virtual ~HYPERHISTOGRAM ();

      HYPERHISTOGRAM& operator= (
         const HYPERHISTOGRAM& rhs
         );

      int GetBinIndexFromValue (
         double CellValue
         ) const;

      double GetBinInterval (
         ) const;

      double GetBinMaxValue (
         ) const;

      double GetBinMinValue (
         ) const;

      const DOUBLE_RANGE& GetBinRange (
         ) const { return (m_BinRange); }

      UINT32 GetCellCount (
         double CellValue
         ) const;

      const SIMPLE_ARRAY<UINT32>& GetCellCounts (
         ) const;

      double GetCellMaxValue (
         ) const { return (m_CellRange.GetMaximum()); }

      double GetCellMinValue (
         ) const { return (m_CellRange.GetMinimum()); }

      void GetCellRange (
         DOUBLE_RANGE& CellRange
         ) const { CellRange = m_CellRange; }

      UINT16 GetColumnSampleInterval (
         ) const;
         
      INT32 GetBand (
         ) const;

      UINT32 GetGreaterThanCount (
         ) const;
         
      UINT32 GetLessThanCount (
         ) const;
         
      UINT16 GetLineSampleInterval (
         ) const;
         
      double GetMean (
         ) const;

      UINT32 GetNullCellCount (
         ) const;

      ERRVALUE GetStatistics (
         STAT_UNIVARIATE& stats           
         ) const;
         
      double GetStdDev (
         ) const;

      ERRVALUE Make (
         const HYPERSPECTRAL& parent,
         INT32 BandNum,
#ifdef RVC_CREDENTIALS_MANDATORY
         const CREDENTIALS* Credentials 
#else
         const CREDENTIALS* Credentials = 0           
#endif
         );

      ERRVALUE Read (
         const HYPERSPECTRAL& parent,
         INT32 BandNum,
#ifdef RVC_CREDENTIALS_MANDATORY
         const CREDENTIALS* Credentials 
#else
         const CREDENTIALS* Credentials = 0           
#endif
         );

      void SetBinRange (
         const DOUBLE_RANGE& range
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      SIMPLE_ARRAY<UINT32> m_CellCount;      // Array of cell counts
      DOUBLE_RANGE m_BinRange;               // Overall bin range
      double m_BinInterval;                  // Bin interval
      double m_Mean;                         // Mean value within selected bin range
      double m_MeanFull;                     
      double m_StdDev;                       // Standard Deviation within selected bin range
      double m_Sum;                          
      double m_Sum2;                         
      UINT32 m_CountLtMin;                   // Number of cells with values less minimum bin
      UINT32 m_CountGtMax;                   // Number of cells with values greater maximum bin
      UINT32 m_CountNull;                    // Number of NULL cells in the raster
      DOUBLE_RANGE m_CellRange;              // Overall cell range
      INT32 m_BandNum;

      void SetInfo (const HYPERHISTBANDINFO& histinfo);
         
      // Implementation of RVC::OBJECT virtual methods
      virtual OBJTYPE v_GetDftObjectType () const;

      #endif // GENERATING_DOXYGEN_OUTPUT

   };

}     // End of RVC namespace

#endif   // INC_RVC_HYPERHISTOGRAM_H

---