ZeroBufferSmooth.h

Go to the documentation of this file.

#ifndef ZeroBufferSmooth_h
#define ZeroBufferSmooth_h
 
/* SPDX-License-Identifier: CC0-1.0 */
                                                                    
#include <cmath>
#include <string>
#include <vector>
#include <iostream>
#include <sstream>
 
 
#include "IString.h"
#include "HiCalTypes.h"
#include "HiCalUtil.h"
#include "HiCalConf.h"
#include "Module.h"
#include "SplineFill.h"
#include "LowPassFilter.h"
#include "Statistics.h"
#include "SpecialPixel.h"
#include "IException.h"
 
namespace Isis {
 
  class ZeroBufferSmooth : public Module {
 
    public:
      //  Constructors and Destructor
      ZeroBufferSmooth() : Module("ZeroBufferSmooth") { }
      ZeroBufferSmooth(HiCalData &cal, const HiCalConf &conf) :
                  Module("ZeroBufferSmooth") {
        init(cal, conf);
      }
 
      virtual ~ZeroBufferSmooth() { }
 
      const Statistics &Stats() const { return (_stats); }
 
    private:
      HiVector   _buffer;
      Statistics _stats;
 
      void init(HiCalData &cal, const HiCalConf &conf) {
        DbProfile prof = conf.getMatrixProfile();
        _history.clear();
        _history.add("Profile["+ prof.Name()+"]");
 
        int samp0 = toInt(ConfKey(prof,"ZeroBufferSmoothFirstSample",QString("0")));
        int sampN = toInt(ConfKey(prof,"ZeroBufferSmoothLastSample",QString("11")));
        _buffer = averageSamples(cal.getBuffer(), samp0, sampN);
        _history.add("AveCols(Buffer["+ToString(samp0)+","+ToString(sampN)+"])");
 
        //  Smooth/filter the averages
        LowPassFilter bufter(_buffer, _history,
                          toInt(ConfKey(prof,"ZeroBufferSmoothFilterWidth",QString("201"))),
                          toInt(ConfKey(prof,"ZeroBufferSmoothFilterIterations",QString("2"))));
        //  If need be, fill the data with a cubic spline
        SplineFill spline(bufter);
        _data = spline.ref();
        _history = spline.History();
 
        //  Compute statistics and record to history
        _stats.Reset();
        for ( int i = 0 ; i < _data.dim() ; i++ ) {
          // Spline guarantees _data is non-null!
          if ( !IsSpecial(_buffer[i]) ) {
            _stats.AddData(_data[i] - _buffer[i]);
          }
        }
        _history.add("Statistics(Average["+ToString(_stats.Average())+
                     "],StdDev["+ToString(_stats.StandardDeviation())+"])");
        return;
      }
 
      virtual void printOn(std::ostream &o) const {
        o << "#  History = " << _history << std::endl;
        //  Write out the header
        o << std::setw(_fmtWidth)   << "RawBuffer"
          << std::setw(_fmtWidth+1) << "Filtered\n";
 
        for (int i = 0 ; i < _data.dim() ; i++) {
          o << formatDbl(_buffer[i]) << " "
            << formatDbl(_data[i]) << std::endl;
        }
        return;
      }
 
  };
 
}     // namespace Isis
#endif