ossimBandAverageFilter.h

Go to the documentation of this file.

//*******************************************************************
// Copyright (C) 2000 ImageLinks Inc. 
//
// License:  MIT
//
// See LICENSE.txt file in the top level directory for more details.
//
// Author: Garrett Potts
//
//*************************************************************************
// $Id: ossimBandAverageFilter.h 15766 2009-10-20 12:37:09Z gpotts $
#ifndef ossimBandAverageFilter_HEADER
#define ossimBandAverageFilter_HEADER
#include <vector>
#include <ossim/imaging/ossimImageSourceFilter.h>

class OSSIMDLLEXPORT ossimBandAverageFilter : public ossimImageSourceFilter
{
public:
   ossimBandAverageFilter();
   ossimBandAverageFilter(ossimImageSource* input,
                          const std::vector<double>& weights);

   virtual ~ossimBandAverageFilter();

   virtual ossim_uint32 getNumberOfOutputBands()const;
   
   virtual ossimRefPtr<ossimImageData> getTile(const ossimIrect& rect,
                                               ossim_uint32 resLevel=0);

   virtual double getNullPixelValue(ossim_uint32 band=0)const;

   virtual double getMinPixelValue(ossim_uint32 band=0)const;
   
   virtual double getMaxPixelValue(ossim_uint32 band=0)const;

   double getWeight(ossim_uint32 band)const;

   void setWeight(ossim_uint32 band, double weight);

   virtual void initialize();

   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;

protected:
  ossimRefPtr<ossimImageData> theTile;
   std::vector<double>         theWeights;

   void checkWeights();
   
   template<class T> void averageInput(
      T dummyVariable, // used only for template type, value ignored
      ossimRefPtr<ossimImageData> inputDataObject);

// for Runtime Type Info (RTTI)
TYPE_DATA
};

#endif