spatmod/imagestage.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGESTAGE_H
#define  INC_SPATMOD_IMAGESTAGE_H

#ifndef  INC_SPATMOD_IMAGEBASE_H
#include <spatmod/imagebase.h>
#endif

#ifndef  INC_SPATMOD_METADATACONTENT_H
#include <spatmod/metadatacontent.h>
#endif

#ifndef  INC_SPATMOD_METADATAFORMAT_H
#include <spatmod/metadataformat.h>
#endif

#ifndef INC_MI32_DELEGATE_H
#include <mi32/delegate.h>
#endif

class STAT_UNIVARIATE;
class STAT_MULTIVAR;

namespace SPATMOD {
namespace IMAGE {

class SECTION;
class SECTION_ITERATOR;
class BUFFER;

//=====================================================================================================================

class STAGE : public BASE {
   public:

      enum BESTZOOM {
         BESTZOOM_Closest,          
         BESTZOOM_ClosestTo1,       
         BESTZOOM_Below75Pct,       
         };

      // Default constructor.
      STAGE ();

      // Destructor.
      virtual ~STAGE ();

      ERRVALUE ComputeMultivariateStats (
         STAT_MULTIVAR& Stats                   
         );

      ERRVALUE ComputePixelRange (
         RANGETYPE RangeType = RANGETYPE_Exact  
         );

      ERRVALUE ComputePixelRange (
         const SECTION& section,                
         PIXEL& PixelValueMin,                  
         PIXEL& PixelValueMax,                  
         RANGETYPE accuracy = RANGETYPE_Maximal 
         ) { return (v_ComputePixelRange(section,PixelValueMin,PixelValueMax,accuracy)); }

      ERRVALUE ComputeSampleStats (
         STATSVALIDITY StatsValidity            
         );

      double GetBestZoom (
         double ZoomDesired,                    
         BESTZOOM bestzoom                      
         ) const;

      ERRVALUE GetBoundingRegion (
         REGION2D& region                       
         ) const { return (v_GetBoundingRegion(region)); }

      void GetMetadata (
         MISTRING& result,                      
         METADATACONTENT content,               
         METADATAFORMAT format                  
         ) const;

      const STAT_UNIVARIATE* GetSampleStats (
         UINT16 index                           
         ) const;

      STATSVALIDITY GetSampleStatsValidity (
         ) const { return (m_SampleStatsValidity); }

      ERRVALUE Initialize ();

      ERRVALUE Pull (
         const SECTION& section,          
         BUFFER& buffer                   
         );

      ERRVALUE PullBegin (
         const SECTION_ITERATOR& iterator
         );

      ERRVALUE PullEnd (
         );

      ERRVALUE PullSubSection (
         const SECTION& SubSection,
         BUFFER& buffer
         );

      ERRVALUE ZoomCoordinates (
         DPOINT2D *PtsImage,                    
         UINT32 NumPoints,                      
         double TgtZoom,                        
         double SrcZoom = 1                     
         ) const;

      ERRVALUE ZoomRectangle (
         DRECT2D& RectImage,                    
         double TgtZoom,                        
         double SrcZoom = 1                     
         ) const;

   protected:

      void GetMetadataThisOnly (
         MISTRING& result,                      
         METADATACONTENT content,               
         METADATAFORMAT format                  
         ) const;

      ERRVALUE SetSampleStats (
         const STAT_UNIVARIATE *SampleStatsArray,
         STATSVALIDITY StatsValidity
         );

      void SetSampleStatsValidity (
         STATSVALIDITY StatsValidity
         );

      virtual ERRVALUE v_ComputePixelRange (
         const SECTION& section,                
         PIXEL& PixelValueMin,                  
         PIXEL& PixelValueMax,                  
         RANGETYPE accuracy                     
         );

      virtual ERRVALUE v_GetBoundingRegion (
         REGION2D& region                       
         ) const;

      virtual bool v_QueryCapability (
         CAPABILITY capability
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      STATSVALIDITY m_SampleStatsValidity;
      STAT_UNIVARIATE *m_SampleStatsArray;

      // BASE overrides.
      virtual const char* v_GetTypeName () const;

      // Unimplemented
      STAGE (const STAGE&);
      STAGE& operator= (const STAGE&);
      #endif // GENERATING_DOXYGEN_OUTPUT

      // STAGE Overridables

      virtual ERRVALUE v_ComputeSampleStats (
         STAT_UNIVARIATE *SampleStatsArray,     
         STATSVALIDITY StatsValidity            
         );

      virtual void v_GetMetadata (
         MISTRING& result,                      
         METADATACONTENT content,               
         METADATAFORMAT format                  
         ) const = 0;

      virtual void v_GetMetadataThisOnly (
         MISTRING& result,                      
         METADATACONTENT content,               
         METADATAFORMAT format                  
         ) const;

      virtual ERRVALUE v_Initialize (
         ) = 0;

      virtual ERRVALUE v_PullBegin (
         const SECTION_ITERATOR& iterator    
         ) = 0;

      virtual ERRVALUE v_PullEnd (
         ) = 0;

      virtual ERRVALUE v_PullSubSection (
         const SECTION& SubSection,          
         BUFFER& buffer                      
         ) = 0;

   };

//=====================================================================================================================

}  // End namespace IMAGE
}  // End namespace SPATMOD

#endif   // INC_SPATMOD_IMAGESTAGE_H

---