GainOffsetProxyRaster.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_GAINOFFSETPROXYRASTER_H
#define __TERRALIB_RASTER_INTERNAL_GAINOFFSETPROXYRASTER_H
 
// TerraLib
#include "Raster.h"
#include "Config.h"
 
#include <memory>
#include <vector>
 
namespace te
{
  namespace rst
  {
    class GainOffsetProxyBand;
   
    /*!
      \class GainOffsetProxyRaster
 
      \brief A proxy class to dynamically apply gains/offsets to/from each input raster band.
      
      \note OutputValue = ( InputValue * gain ) + offset
      
      \ingroup rst
    */
    class TERASTEREXPORT GainOffsetProxyRaster: public Raster
    {
      public:
 
        /*!
          \brief Default Constructor.
          \param inputRaster Input raster (this instance must be always valid).
          \param gains A vector of gains for each input band..
          \param offsets A vector of offsets for each input band..
          \param noDataValues External values to be interpreted as No-data values.
        */
        GainOffsetProxyRaster( te::rst::Raster& inputRaster,
          const std::vector< double >& gains, const std::vector< double >& offsets,
          const std::vector< double >& noDataValues );
 
        /*! \brief Destructor. */
        ~GainOffsetProxyRaster();
 
        // mandatory overloads of pure virtual methods
        void open(const std::map<std::string, std::string>& rinfo, te::common::AccessPolicy p = te::common::RAccess);
        std::map<std::string, std::string> getInfo() const;
        std::size_t getNumberOfBands() const;
        int getBandDataType(std::size_t i) const;
        const Band* getBand(std::size_t i) const;
        Band* getBand(std::size_t i);
        const Band& operator[](std::size_t i) const;
        Band& operator[](std::size_t i);
        bool createMultiResolution( const unsigned int levels, 
          const InterpolationMethod interpMethod );
        bool removeMultiResolution(); 
        unsigned int getMultiResLevelsCount() const;        
        Raster* getMultiResLevel( const unsigned int level ) const;
 
        // overloads
 
      protected:
        
        te::rst::Raster const * m_inputRasterPtr; //!< Input raster pointer.
        std::vector< std::shared_ptr< GainOffsetProxyBand > > m_bands; //!< Pointers the this instance bands.
        std::vector< double > m_noDataValues; //!< External values to be interpreted as No-data values..
        
        /*!
          \brief This instance info.
        */
        std::map<std::string, std::string> m_rasterInfo;
        
        void updateRasterInfo();
        
      private:
        
        GainOffsetProxyRaster();
        GainOffsetProxyRaster(const GainOffsetProxyRaster& rhs);
        AbstractData* clone() const;
    };
  } // end namespace rst
}   // end namespace te
 
#endif //__TERRALIB_RASTER_INTERNAL_GAINOFFSETPROXYRASTER_H