rvc/histogrm.h

Go to the documentation of this file.

#ifndef INC_RVC_HISTOGRM_H
#define INC_RVC_HISTOGRM_H

#ifndef INC_RVC_RASTER_H
   #include <rvc/raster.h>
#endif

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


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward Declarations
class REGION2D;
class STAT_UNIVARIATE;
namespace RVC {
   class CREDENTIALS;
   class FILEHANDLE;
   struct HISTINFO;
   }
#endif


namespace RVC {

class HISTOGRAM : public RVC::OBJECT {
   public:
   
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class FILTER_COMPONENT;
      #endif
      
      HISTOGRAM ();

      HISTOGRAM (
         const RVC::HISTOGRAM& rhs
         );

      virtual ~HISTOGRAM ();

      RVC::HISTOGRAM& operator= (
         const RVC::HISTOGRAM& rhs
         );

      ERRVALUE ComputeFromRegion (
         const RVC::RASTER& RastObj,
         const REGION2D& Region,
#ifdef RVC_CREDENTIALS_MANDATORY
         RVC::RASTER::COMPONENT Component,
         const CREDENTIALS* Credentials 
#else
         RVC::RASTER::COMPONENT Component = RVC::RASTER::COMPONENT_Default,
         const CREDENTIALS* Credentials = 0           
#endif
         );

      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;
         
      RVC::RASTER::COMPONENT GetComponent (
         ) const;

      UINT16 GetCountScale (
         ) const { return (m_CountScale); }

      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 RVC::RASTER& parent,
#ifdef RVC_CREDENTIALS_MANDATORY
         RVC::RASTER::COMPONENT Component,
         const CREDENTIALS* Credentials 
#else
         RVC::RASTER::COMPONENT Component = RVC::RASTER::COMPONENT_Default,
         const CREDENTIALS* Credentials = 0           
#endif
         );

      ERRVALUE Read (
         const RVC::RASTER& parent,
#ifdef RVC_CREDENTIALS_MANDATORY
         RVC::RASTER::COMPONENT Component,
         const CREDENTIALS* Credentials 
#else
         RVC::RASTER::COMPONENT Component = RVC::RASTER::COMPONENT_Default,
         const CREDENTIALS* Credentials = 0           
#endif
         );

      void SetBinRange (
         const DOUBLE_RANGE& range
         );

      void SetSampleIntervals (
         UINT16 LineInterval,
         UINT16 ColumnInterval
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      SIMPLE_ARRAY<UINT32> m_CellCount;      
      DOUBLE_RANGE m_BinRange;               
      double m_BinInterval;                  
      double m_Mean;                         
      double m_StdDev;                       
      double m_Sum;                          
      double m_SumOfSquares;                 
      double m_MeanFull;                     
      UINT32 m_CountLtMin;                   
      UINT32 m_CountGtMax;                   
      UINT32 m_CountNull;                    
      UINT16 m_LineSample;                   
      UINT16 m_ColumnSample;                 
      DOUBLE_RANGE m_CellRange;              
      LRECT2D m_HistExtents;                 
      RASTER::COMPONENT m_Component;
      UINT16 m_CountScale;                   // Scale for "count" values

      ERRVALUE ComputeDefaultHistogram (const RASTER& RastObj, const CREDENTIALS* Credentials);
      ERRVALUE ComputeHistogram (const OBJITEM& SrcObjItem, const CREDENTIALS* Credentials);
      void GetDftDescriptor (RVC::RASTER::COMPONENT Component, RVC::DESCRIPTOR& Descriptor) const;
      void GetInfo (HISTINFO& histinfo) const;
      static ERRVALUE GetInfo (FILEHANDLE* FileHandle, const OBJECT& obj, HISTINFO& histinfo);
      ERRVALUE SaveHistogram (const RASTER& RastObj, const DESCRIPTOR& Descriptor, const CREDENTIALS* Credentials);
      void SetInfo (const HISTINFO& histinfo, IMAGE::CELLTYPE CellType);
         
      // Implementation of RVC::OBJECT virtual methods
      virtual OBJTYPE v_GetDftObjectType () const;

      class COMPHIST;
      friend class COMPHIST;
      friend class FILTER_COMPONENT;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class HISTOGRAM::FILTER_COMPONENT : public OBJECT::FILTER {
   public:

      FILTER_COMPONENT (
         const RASTER& ParentRastObj,
         RASTER::COMPONENT Component
         );

      virtual ~FILTER_COMPONENT ();
         
   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      RASTER::COMPONENT m_Component;
      IMAGE::CELLTYPE m_CellType;
      FILEHANDLE* m_FileHandle;
      
      virtual bool Filter (const RVC::OBJECT& obj);
      #endif      // GENERATING_DOXYGEN_OUTPUT
   };

}     // End of RVC namespace

#endif   // INC_RVC_HISTOGRM_H

---