wave_field.hpp

/* wave_field.hpp */
/* $Id: wave_field.hpp 21254 2011-11-18 11:15:39Z urij $ */
#ifndef __wave_field_hpp
#define __wave_field_hpp

#ifdef GE_BUILD
#include <trace.hpp>
#else
#include <s2proc/trace.hpp>
#endif

class WaveField 
{
public:
  
  /*
   * Basic types. 
   */
  
  typedef std::vector<Trace> TracesStorageT;             
  typedef TracesStorageT::iterator iterator;             
  typedef TracesStorageT::const_iterator const_iterator; 
  /*
   * Operators.  
   */
  
  WaveField operator+(const WaveField &wf) const;
  
  WaveField operator-(const WaveField &wf) const;
  
  /*
   * Constructors. 
   */
  
  WaveField();
  
  WaveField(const Trace::Header& hdr, 
        size_t size,              
        size_t length,            
        Trace::AmplT value        );
  
  template <typename Iterator>
  WaveField(Iterator first, Iterator last)
  {m_data.insert(m_data.begin(), first, last);}
  
  WaveField(const WaveField& that);
  
  virtual ~WaveField();
  
  /*
   * Accesors. 
   */
  
  const_iterator  begin() const;
  
  const_iterator  end() const;     
  
  const Trace&    at(size_t n) const;
  const Trace&    operator[](size_t n) const {return at(n);}
  
  size_t          size() const;                 
  
  bool            empty() const;
  
  size_t          length() const;
  
  Trace::TimeT    timestep() const;
  
  Trace::TimeT    duration() const;
  
  /*
   *  Modificators. 
   */
  
  iterator        begin();
  
  iterator        end();
  
  Trace&          at(size_t n);
  Trace&          operator[](size_t n)       {return at(n);}
  
  iterator         erase(iterator first, iterator last);
  
  void             clear();
  
  void             insert(iterator pos, size_t n, const Trace& tr=Trace());
  
  void             push_back(const Trace& t);
  
  void             resize(size_t n, const Trace& tr = Trace());
  
  WaveField&       fill(const Trace::AmplT &ampl);
  
  void             shift(Trace::TimeT s);

  void             shift(const std::vector<Trace::TimeT>& shifts);
  
  
  /*
   *  Working with windows. 
   */
  
  WaveField&       set_window(size_t trace,           
                  size_t traces,          
                  Trace::TimeT start,     
                  Trace::TimeT duration   );
  
  const WaveField& set_window(size_t trace,           
                  size_t traces,          
                  Trace::TimeT start,     
                  Trace::TimeT duration   ) const;
  
  Trace::TimeT     get_window_timestart() const;
  
  Trace::TimeT     get_window_duration() const;
  
  void             remove_window() const;
  
  bool             is_windowed() const;
    
  /*
   *  Correct data check. 
   */
  
  bool hasNAN(); 
  
  bool hasInf();
  
  bool hasNANInf();
    
protected:  
  
  TracesStorageT m_data;
  
  struct Window
  {
    size_t left;   
    size_t right;  
  };

  mutable std::vector<Window> m_win_stack;

private:
  
  const WaveField& set_window_impl(size_t trace, size_t traces, Trace::TimeT start, Trace::TimeT duration) const;
};


#endif /* wave_field.hpp */