Lemma is an Electromagnetics API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. /* This file is part of Lemma, a geophysical modelling and inversion API.
  2. * More information is available at http://lemmasoftware.org
  3. */
  4. /* This Source Code Form is subject to the terms of the Mozilla Public
  5. * License, v. 2.0. If a copy of the MPL was not distributed with this
  6. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  7. */
  8. /**
  9. * @file
  10. * @date 05/02/2018 09:46:38 PM
  11. * @author Trevor Irons (ti)
  12. * @email Trevor.Irons@utah.edu
  13. * @copyright Copyright (c) 2018, University of Utah
  14. * @copyright Copyright (c) 2018, Trevor Irons & Lemma Software, LLC
  15. */
  16. #ifndef FHT_INC
  17. #define FHT_INC
  18. #pragma once
  19. #include "HankelTransform.h"
  20. #include "CubicSplineInterpolator.h"
  21. namespace Lemma {
  22. /**
  23. \ingroup FDEM1D
  24. \brief Impliments lagged and related fast Hankel transform through
  25. digital filtering.
  26. \details A general Fast Hankel Transform routine which uses the digital
  27. filter apporach. Both lagged and related kernels are supported in
  28. order to minimize kernel function calls.
  29. This approach performs a complete sweep of the
  30. coefficients , for a variant that uses a longer filter which may
  31. be truncated, see FHTAnderson801.
  32. @see FHTAnderson801
  33. @see GQChave
  34. @see QWEKey
  35. */
  36. template < HANKELTRANSFORMTYPE Type >
  37. class FHT : public HankelTransform {
  38. friend std::ostream &operator<<(std::ostream &stream, const FHT<Type> &ob) {
  39. stream << ob.Serialize(); // << "\n";
  40. return stream;
  41. }
  42. public:
  43. // ==================== LIFECYCLE =======================
  44. /**
  45. * Default protected constructor, use NewSP methods to construct
  46. * @see FHT::NewSP
  47. */
  48. explicit FHT (const ctor_key& key ) : HankelTransform( key ) {
  49. }
  50. /**
  51. * Protected DeDerializing constructor, use factory DeSerialize method.
  52. * @see FHT::DeSerialize
  53. */
  54. FHT (const YAML::Node& node, const ctor_key& key) : HankelTransform(node, key) {
  55. }
  56. /** Default protected destructor, use smart pointers (std::shared_ptr) */
  57. ~FHT () {
  58. }
  59. /**
  60. * Factory method for generating concrete class.
  61. * @return a std::shared_ptr of type FHT
  62. */
  63. static std::shared_ptr< FHT > NewSP() {
  64. return std::make_shared< FHT >( ctor_key() );
  65. }
  66. /**
  67. * Uses YAML to serialize this object.
  68. * @return a YAML::Node
  69. * @see FHT::DeSerialize
  70. */
  71. YAML::Node Serialize() const {
  72. YAML::Node node = HankelTransform::Serialize();
  73. node.SetTag( this->GetName() ); // + enum2String(Type) );
  74. //node.SetTag( enum2String(Type) );
  75. //node["var"] = 0;
  76. return node;
  77. }
  78. /**
  79. * Constructs an FHT object from a YAML::Node.
  80. * @see FHT::Serialize
  81. */
  82. static std::shared_ptr<FHT> DeSerialize(const YAML::Node& node);
  83. // ==================== OPERATORS =======================
  84. // ==================== OPERATIONS =======================
  85. Complex Zgauss(const int&, const Lemma::EMMODE&, const int&, const Real&,
  86. const Real&, Lemma::KernelEM1DBase* Kernel);
  87. /// Computes related kernels, if applicable, otherwise this is
  88. /// just a dummy function.
  89. void ComputeRelated(const Real& rho, std::shared_ptr<KernelEM1DBase> Kernel) {
  90. }
  91. void ComputeRelated(const Real& rho, std::vector< std::shared_ptr<KernelEM1DBase> > KernelVec) {
  92. }
  93. void ComputeRelated(const Real& rho, std::shared_ptr<KernelEM1DManager> KernelManager);
  94. void ComputeLaggedRelated(const Real& rho, const int& nlag, std::shared_ptr<KernelEM1DManager> KernelManager);
  95. // ==================== ACCESS =======================
  96. /**
  97. * @param[in] rho is the argument for lagged convolution evaluation from the
  98. * spline after calculation.
  99. */
  100. void SetLaggedArg(const Real& rho) {
  101. for (int i=0; i<Zans.cols(); ++ i) {
  102. Zans(0, i) = Complex( splineVecReal[i]->Interpolate(rho),
  103. splineVecImag[i]->Interpolate(rho) );
  104. }
  105. return ;
  106. }
  107. // ==================== INQUIRY =======================
  108. /**
  109. * @return filter asbscissa spacing
  110. */
  111. inline Real GetABSER();
  112. //{
  113. // return 0; //this->WT(0,0)/this->WT(1,0);
  114. //}
  115. /** Returns the name of the underlying class, similiar to Python's type */
  116. inline std::string GetName() const {
  117. return enum2String(Type); //this->CName;
  118. }
  119. protected:
  120. // ==================== LIFECYCLE =======================
  121. // ==================== DATA MEMBERS =========================
  122. private:
  123. // Filter Weights, these are specialized for each template type
  124. static const Eigen::Matrix<Real, Eigen::Dynamic, 3> WT;
  125. /// Spines for lagged convolutions (real part)
  126. std::vector <std::shared_ptr<CubicSplineInterpolator> > splineVecReal;
  127. /// Spines for lagged convolutions (imaginary part)
  128. std::vector < std::shared_ptr<CubicSplineInterpolator> > splineVecImag;
  129. /// Holds answer, dimensions are NumConv, and NumberRelated.
  130. Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic> Zans;
  131. /** ASCII string representation of the class name */
  132. //static constexpr auto CName = "FHT";
  133. }; // ----- end of class FHT ----
  134. // Forward declarations
  135. template<>
  136. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKEY201>::WT;
  137. template<>
  138. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKEY101>::WT;
  139. template<>
  140. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKEY51>::WT;
  141. template<>
  142. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKONG61>::WT;
  143. template<>
  144. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKONG121>::WT;
  145. template<>
  146. const Eigen::Matrix<Real, Eigen::Dynamic, 3> FHT<FHTKONG241>::WT;
  147. template < HANKELTRANSFORMTYPE Type >
  148. Complex FHT<Type>::Zgauss(const int& ii, const Lemma::EMMODE& mode, const int& jj, const Real& val,
  149. const Real& val2, Lemma::KernelEM1DBase* Kernel){
  150. // TODO, in 101 or 51 we never reach here!!
  151. //std::cout << "Zgauss " << std::endl;
  152. return this->Zans(0, Kernel->GetManagerIndex());
  153. }
  154. // Specialisations
  155. // Note that ANDERSON801, CHAVE, QWEKEY will throw errors as they are not consistent
  156. // part of this class
  157. template < HANKELTRANSFORMTYPE Type >
  158. Real FHT< Type >::GetABSER() {
  159. return WT(0,0)/WT(1,0);
  160. }
  161. /* specializations could provide slighly better performance by reducing divides */
  162. // template < >
  163. // Real FHT< FHTKEY201 >::GetABSER() {
  164. // return WT(0,0)/WT(1,0);
  165. // }
  166. //
  167. // template < >
  168. // Real FHT< FHTKEY101 >::GetABSER() {
  169. // return WT(0,0)/WT(1,0);
  170. // }
  171. //
  172. // template < >
  173. // Real FHT< FHTKEY51 >::GetABSER() {
  174. // return WT(0,0)/WT(1,0);
  175. // }
  176. //--------------------------------------------------------------------------------------
  177. // Class: FHT
  178. // Method: ComputeRelated
  179. //--------------------------------------------------------------------------------------
  180. template < HANKELTRANSFORMTYPE Type >
  181. void FHT<Type>::ComputeRelated ( const Real& rho, std::shared_ptr<KernelEM1DManager> KernelManager ) {
  182. int nrel = (int)(KernelManager->GetSTLVector().size());
  183. Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic > Zwork;
  184. Zans= Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic>::Zero(1, nrel);
  185. Zwork.resize(WT.rows(), nrel);
  186. VectorXr lambda = WT.col(0).array()/rho;
  187. int NumFun = 0;
  188. int idx = 0;
  189. // Get Kernel values
  190. for (int ir=0; ir<lambda.size(); ++ir) {
  191. // irelated loop
  192. ++NumFun;
  193. KernelManager->ComputeReflectionCoeffs(lambda(ir), idx, rho);
  194. for (int ir2=0; ir2<nrel; ++ir2) {
  195. // Zwork* needed due to sign convention of filter weights
  196. Zwork(ir, ir2) = std::conj(KernelManager->GetSTLVector()[ir2]->RelBesselArg(lambda(ir)));
  197. }
  198. }
  199. for (int ir2=0; ir2<nrel; ++ir2) {
  200. Zans(0, ir2) = Zwork.col(ir2).dot(WT.col(KernelManager->GetSTLVector()[ir2]->GetBesselOrder() + 1))/rho;
  201. }
  202. return ;
  203. } // ----- end of method FHT::ComputeRelated -----
  204. //--------------------------------------------------------------------------------------
  205. // Class: FHT
  206. // Method: ComputeLaggedRelated
  207. //--------------------------------------------------------------------------------------
  208. template < HANKELTRANSFORMTYPE Type >
  209. void FHT<Type>::ComputeLaggedRelated ( const Real& rho, const int& nlag, std::shared_ptr<KernelEM1DManager> KernelManager ) {
  210. int nrel = (int)(KernelManager->GetSTLVector().size());
  211. Eigen::Matrix< Complex, Eigen::Dynamic, Eigen::Dynamic > Zwork;
  212. Zans= Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic>::Zero(nlag, nrel);
  213. Zwork.resize(WT.rows()+nlag, nrel); // Zwork needs to be expanded to filter length + nlag
  214. // lambda needs to be expanded to include lagged results
  215. VectorXr lambda = (VectorXr(WT.rows()+nlag) << WT.col(0).array()/rho, VectorXr::Zero(nlag)).finished();
  216. for (int ilam =WT.rows(); ilam< nlag+WT.rows(); ++ilam) {
  217. lambda(ilam) = lambda(ilam-1)/GetABSER();
  218. }
  219. int NumFun = 0;
  220. int idx = 0;
  221. VectorXr Arg(nlag);
  222. Arg(nlag-1) = rho;
  223. for (int ilag=nlag-2; ilag>=0; --ilag) {
  224. Arg(ilag) = Arg(ilag+1) * GetABSER();
  225. }
  226. // Get Kernel values
  227. for (int ir=0; ir<lambda.size(); ++ir) {
  228. // irelated loop
  229. ++NumFun;
  230. KernelManager->ComputeReflectionCoeffs(lambda(ir), idx, rho);
  231. for (int ir2=0; ir2<nrel; ++ir2) {
  232. Zwork(ir, ir2) = std::conj(KernelManager->GetSTLVector()[ir2]->RelBesselArg(lambda(ir)));
  233. }
  234. }
  235. // Inner product and scale
  236. int ilagr = nlag-1; // Zwork is in opposite order from Arg
  237. for (int ilag=0; ilag<nlag; ++ilag) {
  238. for (int ir2=0; ir2<nrel; ++ir2) {
  239. Zans(ilagr, ir2) = Zwork.col(ir2).segment(ilag,WT.rows()).dot( WT.col(KernelManager->GetSTLVector()[ir2]->GetBesselOrder()+1) ) / Arg(ilagr);
  240. }
  241. ilagr -= 1;
  242. }
  243. // make sure vectors are empty
  244. splineVecReal.clear();
  245. splineVecImag.clear();
  246. // Now do cubic spline
  247. for (int ii=0; ii<Zans.cols(); ++ii) {
  248. auto SplineR = CubicSplineInterpolator::NewSP();
  249. SplineR->SetKnots( Arg, Zans.col(ii).real() );
  250. splineVecReal.push_back(SplineR);
  251. auto SplineI = CubicSplineInterpolator::NewSP();
  252. SplineI->SetKnots( Arg, Zans.col(ii).imag() );
  253. splineVecImag.push_back(SplineI);
  254. }
  255. return ;
  256. } // ----- end of method FHT::ComputeLaggedRelated -----
  257. } // ----- end of namespace Lemma ----
  258. #endif // ----- #ifndef FHT_INC -----
  259. /* vim: set tabstop=4 expandtab: */
  260. /* vim: set filetype=cpp: */