spatmod/imagesample.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGESAMPLE_H
#define  INC_SPATMOD_IMAGESAMPLE_H

#ifndef  INC_SPATMOD_DATATYPE_H
#include <spatmod/datatype.h>
#endif

namespace SPATMOD {
namespace IMAGE {

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

class SAMPLE {

   public:

      enum TYPE {
         TYPE_Invalid =          0,
         TYPE_Unknown =          1,
         TYPE_Index =            2,    
         TYPE_Gray =             3,
         TYPE_Red =              4,
         TYPE_Green =            5,
         TYPE_Blue =             6,
         TYPE_Opacity =          7,
         TYPE_Cyan =             8,
         TYPE_Magenta =          9,
         TYPE_Yellow =           10,
         TYPE_Black =            11,
         TYPE_Hue =              12,
         TYPE_Saturation =       13,
         TYPE_ComplexMagnitude = 14,   
         TYPE_ComplexPhase =     15,   
         TYPE_ComplexReal =      16,   
         TYPE_ComplexImaginary = 17,   
         TYPE_Validity =         18,   
         };

      SAMPLE ();

      SAMPLE (
         const SAMPLE& rhs
         );

      SAMPLE (
         TYPE SampleType,              
         DATATYPE DataType,            
         const void* pValue = 0        
         );

      ~SAMPLE ();

      SAMPLE& operator= (
         const SAMPLE& rhs
         );

      int CompareValues (
         const SAMPLE& rhs             
         ) const;

      void Exchange (
         SAMPLE& other                 
         );

      DATATYPE GetDataType (
         ) const { return (m_DataType); }

      UINT32 GetNumBytes (
         ) const { return (m_DataType & DATATYPE_MASK_Size); }

      UINT16 GetPrecision (
         ) const { return (m_Precision); }

      TYPE GetType (
         ) const { return (m_SampleType); }

      double GetValueDouble (
         ) const;

      INT32 GetValueINT32 (
         ) const;

      const void* GetValuePtr (
         ) const { return (m_pValue); }

      void SetDataType (
         DATATYPE DataType
         );

      void SetPrecision (
         int precision
         );

      void SetType (
         TYPE SampleType
         ) { m_SampleType = SampleType; }

      void SetValue (
         double value                     
         );

      void SetValueFromPtr (
         const void *pValue               
         );

      void SetValueMaximum (
         );

      void SetValueMinimum (
         );

      void SetValueNAN (
         );

      void SetValueZero (
         );

      bool IsEqual (
         const SAMPLE& rhs
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      void *m_pValue;
      TYPE m_SampleType;
      DATATYPE m_DataType;
      UINT16 m_Precision;

      #endif // GENERATING_DOXYGEN_OUTPUT
   };

inline bool operator== (
   const SAMPLE& lhs,
   const SAMPLE& rhs
   ) { return (lhs.IsEqual(rhs)); }

inline bool operator!= (
   const SAMPLE& lhs,
   const SAMPLE& rhs
   ) { return (!lhs.IsEqual(rhs)); }

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

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

#endif    // INC_SPATMOD_IMAGESAMPLE_H

---