wavelets.h

Go to the documentation of this file.

#ifndef SOPT_WAVELETS_WAVELETS_H
#define SOPT_WAVELETS_WAVELETS_H
 
#include "sopt/config.h"
#include "sopt/types.h"
#include "sopt/wavelets/direct.h"
#include "sopt/wavelets/indirect.h"
#include "sopt/wavelets/wavelet_data.h"
 
#include <string> // for std::string
 
namespace sopt::wavelets {
 
// Advance declaration so we can define the subsequent friend function
class Wavelet;
 
Wavelet factory(const std::string& name = "DB1", t_uint nlevels = 1);
 
class Wavelet : public WaveletData {
  friend Wavelet factory(const std::string& name, t_uint nlevels);
 
 protected:
  Wavelet(WaveletData const &c, t_uint nlevels) : WaveletData(c), levels_(nlevels) {}
 
 public:
  virtual ~Wavelet() {}
 
// Temporary macros that checks constraints on input
#define SOPT_WAVELET_MACRO_MULTIPLE(NAME)                                                   \
  if (((NAME).rows() == 1 or (NAME).cols() == 1)) {                                             \
    if ((NAME).size() % (1 << levels()) != 0)                                                 \
      throw std::length_error("Size of " #NAME " must number a multiple of 2^levels or 1"); \
  } else if ((NAME).rows() != 1 and (NAME).rows() % (1 << levels()) != 0)                       \
    throw std::length_error("Rows of " #NAME " must number a multiple of 2^levels or 1");   \
  else if ((NAME).cols() % (1 << levels()) != 0)                                              \
    throw std::length_error("Columns of " #NAME " must number a multiple of 2^levels");
#define SOPT_WAVELET_MACRO_EQUAL_SIZE(A, B)                                                 \
  if ((A).rows() != (B).rows() or (A).cols() != (B).cols()) (A).derived().resize((B).rows(), (B).cols()); \
  if ((A).rows() != (B).rows() or (A).cols() != (B).cols())                                         \
  throw std::length_error("Incorrect size for output matrix(or could not resize)")
  template <typename T0>
  auto direct(Eigen::ArrayBase<T0> const &signal) const
      -> decltype(direct_transform(signal, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(signal);
    return direct_transform(signal, levels(), *this);
  }
  template <typename T0, typename T1>
  auto direct(Eigen::ArrayBase<T1> &coefficients, Eigen::ArrayBase<T0> const &signal) const
      -> decltype(direct_transform(coefficients, signal, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(signal);
    SOPT_WAVELET_MACRO_EQUAL_SIZE(coefficients, signal);
    return direct_transform(coefficients, signal, levels(), *this);
  }
  template <typename T0, typename T1>
  auto direct(Eigen::ArrayBase<T1> &&coefficients, Eigen::ArrayBase<T0> const &signal) const
      -> decltype(direct_transform(coefficients, signal, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(signal);
    SOPT_WAVELET_MACRO_EQUAL_SIZE(coefficients, signal);
    return direct_transform(coefficients, signal, levels(), *this);
  }
  template <typename T0>
  auto indirect(Eigen::ArrayBase<T0> const &coefficients) const
      -> decltype(indirect_transform(coefficients, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(coefficients);
    return indirect_transform(coefficients, levels(), *this);
  }
  template <typename T0, typename T1>
  auto indirect(Eigen::ArrayBase<T1> const &coefficients, Eigen::ArrayBase<T0> &signal) const
      -> decltype(indirect_transform(coefficients, signal, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(coefficients);
    SOPT_WAVELET_MACRO_EQUAL_SIZE(signal, coefficients);
    return indirect_transform(coefficients, signal, levels(), *this);
  }
  template <typename T0, typename T1>
  auto indirect(Eigen::ArrayBase<T1> const &coeffs, Eigen::ArrayBase<T0> &&signal) const
      -> decltype(indirect_transform(coeffs, signal, 1, *this)) {
    SOPT_WAVELET_MACRO_MULTIPLE(coeffs);
    SOPT_WAVELET_MACRO_EQUAL_SIZE(signal, coeffs);
    return indirect_transform(coeffs, signal, levels(), *this);
  }
#undef SOPT_WAVELET_MACRO_MULTIPLE
#undef SOPT_WAVELET_MACRO_EQUAL_SIZE
  t_uint levels() const { return levels_; }
  void levels(t_uint l) { levels_ = l; }
 
 protected:
  t_uint levels_;
};
} // namespace sopt::wavelets
#endif