// Wavelet Analysis Tool
// universal data container for wavelet transforms
//
//$Id: WaveletUDT.hh,v 0.2 2001/06/06 19:37:00 sazonov Exp $
//$Id: WaveletUDT.hh,v 0.2 2001/08/10 11:00:00 klimenko Exp $

#ifndef WAVELET_UDT_HH
#define WAVELET_UDT_HH


#include "TimeSeries.hh"
#include "WaveDWT.hh"

namespace datacondAPI
{
//: UDT Representation of Wavelet
template<class DataType_t>
class WaveletUDT : public TimeSeries<DataType_t>
{
    
   public:
    
      // constructors
    
      //: Default constructor
      WaveletUDT();
    
      //: Construct WaveletUDT for specific wavelet type 
      //+ default constructor
      explicit WaveletUDT(const datacondAPIwat::Wavelet &w);

      //: Construct from Sequence
      //!param: value - data to initialize the WaveletUDT object
      explicit WaveletUDT(const Sequence<DataType_t>& value,
			  const datacondAPIwat::Wavelet &w);
    
      //: Construct from TimeSeries
      //!param: value - data to initialize the WaveletUDT object
      explicit WaveletUDT(const TimeSeries<DataType_t>& value,
			  const datacondAPIwat::Wavelet &w);
    
      //: Copy constructor
      //!param: value - object to copy from 
      explicit WaveletUDT(const WaveletUDT<DataType_t>& value);

      //: destructor
      virtual ~WaveletUDT();
    
      // UDT required members
    
      //: Duplicate *this on heap
      //!return: WaveletUDT* - duplicate of *this, allocated on heap
      virtual WaveletUDT* Clone() const;

      //: Convert *this to an ILWD
      //!param: Chain - CallChain *this is part of
      //!param: Target - intended destination of ILWD
      //!return: ILwd::LdasElement* - ILWD allocated on heap or null pointer
      virtual ILwd::LdasElement*
      ConvertToIlwd( const CallChain& Chain,
		     datacondAPI::udt::target_t 
		     Target = datacondAPI::udt::TARGET_GENERIC) const;

      // accessors

      //: Get maximum possible level of decompostion
      int getMaxLevel();

      //: Extract wavelet coefficients from specified layer
      //!param: n - layer number
      size_t getLayer(Sequence<DataType_t> &, int n);

      //: replace wavelet data for specified layer with data from Sequence
      //!param: n - layer number
      void putLayer(const Sequence<DataType_t> &, int n);

      // mutators

      //: initialize wavelet parameters from Wavelet object
      void setWavelet(const datacondAPIwat::Wavelet &w);

      //: Perform n steps of forward wavelet transform
      //!param: n - number of steps (-1 means full decomposition)
      void Forward(int n = -1);

      //: Perform n steps of inverse wavelet transform
      //!param: n - number of steps (-1 means full reconstruction)
      void Inverse(int n = -1);
      
// data members

      //: parameters of wavelet transform
      datacondAPIwat::WaveDWT<DataType_t>* pWavelet;

  }; // class WaveletUDT<DataType_t>

}; // namespace datacondAPI

#endif // WAVELET_UDT_HH