GainOffsetProxyBand.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
 
    This file is part of the TerraLib - a Framework for building GIS enabled applications.
 
    TerraLib is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License,
    or (at your option) any later version.
 
    TerraLib is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */
 
#ifndef __TERRALIB_RASTER_INTERNAL_GAINOFFSETPROXYBAND_H
#define __TERRALIB_RASTER_INTERNAL_GAINOFFSETPROXYBAND_H
 
// TerraLib
#include "Band.h"
#include "Config.h"
#include "BlockUtils.h"
 
namespace te
{
  namespace rst
  {
    class GainOffsetProxyRaster;
    
    /*!
      \class GainOffsetProxyBand
      \brief GainOffsetProxyRaster raster band.
      \note OutputValue = ( InputValue * gain ) + offset
    */
    class TERASTEREXPORT GainOffsetProxyBand : public te::rst::Band
    {
      public:
 
        /*!
          \brief Default Constructor.
 
          \param raster Related raster.
          \param idx The band index.
        */
        GainOffsetProxyBand( te::rst::Raster& raster, 
          GainOffsetProxyRaster& proxyRaster, std::size_t idx,
          const double gain, const double offset, const double& noDataValue );
 
        ~GainOffsetProxyBand();
        
        // mandatory overloads of pure virtual methods
 
        inline te::rst::Raster* getRaster() const;
        void getValue(unsigned int c, unsigned int r, double& value) const;
        void setValue(unsigned int c, unsigned int r, const double value);
        void getIValue(unsigned int c, unsigned int r, double& value) const;
        void setIValue(unsigned int c, unsigned int r, const double value);
        void read(int x, int y, void* buffer) const;
        void* read(int x, int y);
        void write(int x, int y, void* buffer);
 
      protected :
        
        te::rst::Raster* m_externalRasterPtr; //!< The original external raster instance.
        te::rst::GainOffsetProxyRaster* m_proxyRasterPtr; //!< The proxy raster instance (parent raster).
        Band* m_externalBandPtr; //!< Pointers the external bands.
        double m_gain; //!< Gain to be applied to this band values.
        double m_offset; //!< Offset to applied to this band values.
        int m_blkPixelsNumber; //!< The blocks number of pixels;
        double m_externalBandNoDataValue; //!< External band no-data value.
        double m_newNoDataValue; //!< External value to be interpreted as No-data values.
        void* m_internalBufferPtr; //!< A pointer to the internal data block buffer.
 
        te::rst::GetBufferValueFPtr m_getBuff;   //!< A pointer to a function that helps to extract a double or complex value from a specific buffer data type (char, int16, int32, float, ...).
        te::rst::GetBufferValueFPtr m_getBuffI;  //!< A pointer to a function that helps to extract the imaginary part value from a specific buffer data type (cint16, cint32, cfloat, cdouble).
        te::rst::SetBufferValueFPtr m_setBuff;   //!< A pointer to a function that helps to insert a double or complex value into a specific buffer data type (char, int16, int32, float, ...).
        te::rst::SetBufferValueFPtr m_setBuffI;  //!< A pointer to a function that helps to insert the imaginary part value into a specific buffer data type (cint16, cint32, cfloat, cdouble).        
        
        // variables used by setValue
        mutable double m_setValue_auxValue;
        
        // variables used by setIValue
        mutable double m_setIValue_auxValue;
        
        // variables used by read
        mutable int m_read_blkIdx;
        mutable double m_read_value;
        
        // variables used by write
        mutable int m_write_blkIdx;
        mutable double m_write_value;        
        
      private:
 
        GainOffsetProxyBand( const GainOffsetProxyBand& other );        
    };
 
  } // end namespace rst
}     // end namespace te
 
#endif  // __TERRALIB_RASTER_INTERNAL_GAINOFFSETPROXYBAND_H