SplineFill.h

Go to the documentation of this file.

#if !defined(SplineFill_h)
#define SplineFill_h
/**                                                                       
 * @file                                                                  
 * $Revision: 3878 $
 * $Date: 2012-01-18 10:23:13 -0700 (Wed, 18 Jan 2012) $
 * $Id: SplineFill.h 3878 2012-01-18 17:23:13Z slambright@GS.DOI.NET $
 * 
 *   Unless noted otherwise, the portions of Isis written by the USGS are 
 *   public domain. See individual third-party library and package descriptions 
 *   for intellectual property information, user agreements, and related  
 *   information.                                                         
 *                                                                        
 *   Although Isis has been used by the USGS, no warranty, expressed or   
 *   implied, is made by the USGS as to the accuracy and functioning of such 
 *   software and related material nor shall the fact of distribution     
 *   constitute any such warranty, and no responsibility is assumed by the
 *   USGS in connection therewith.                                        
 *                                                                        
 *   For additional information, launch                                   
 *   $ISISROOT/doc//documents/Disclaimers/Disclaimers.html                
 *   in a browser or see the Privacy & Disclaimers page on the Isis website,
 *   http://isis.astrogeology.usgs.gov, and the USGS privacy and disclaimers on
 *   http://www.usgs.gov/privacy.html.                                    
 */                                                                       

#include <string>
#include <vector>

#include "iString.h"
#include "Module.h"
#include "NumericalApproximation.h"
#include "SpecialPixel.h"
#include "iException.h"

namespace Isis {

  /**
   * @brief Compute a low pass filter from a Module class content
   * 
   * @ingroup Utility
   * 
   * @author 2007-10-09 Kris Becker
   *
   * @internal
   *   @history 2008-11-05 Jeannie Walldren Replaced references to 
   *                           DataInterp class with NumericalApproximation.
   */
  class SplineFill : public Module {

    public: 
      //  Constructors and Destructor
      SplineFill() : Module("SplineFill"), _filled(0) { }

      SplineFill(const Module &c) : 
                     Module("SplineFill", c), _filled(0) {
        fill(c.ref());
        _history.add(formHistory());
      }

      SplineFill(const HiVector &v) : 
                     Module("SplineFill"), _filled(0) {
        fill(v);
        _history.add(formHistory());
      }
      SplineFill(const HiVector &v, const HiHistory &h) : 
                     Module("SplineFill", h), _filled(0) {
        fill(v);
        _history.add(formHistory());
      }

      /** Destructor */
      virtual ~SplineFill() { }

      void Process(const HiVector &v) {
        fill(v);
        _history.clear();
        _history.add(formHistory());
      }

      inline int Filled() const { return (_filled); }

    private:
      int   _filled;         //!< Number values replaced

      std::string formHistory() {
        iString cfilled(_filled);
        return (std::string("SplineFill(Cubic,Filled[" + cfilled + "])"));
      }

      void fill(const HiVector &v) {
        NumericalApproximation spline(NumericalApproximation::CubicNatural);
        for (int i = 0 ; i < v.dim() ; i++) {
          if (!IsSpecial(v[i])) {
            spline.AddData(i, v[i]); 
          }
        }

        //  Compute the spline and fill missing data
        HiVector vout(v.dim());
        _filled = 0;
        for (int j = 0 ; j < v.dim() ; j++) {
          if (IsSpecial(v[j])) {
            vout[j] = spline.Evaluate(j,NumericalApproximation::NearestEndpoint); 
            _filled++;
          }
          else {
            vout[j] = v[j];
          }
        }

        _data = vout;
        return;
      }
  };

}     // namespace Isis
#endif