Main Lemma Repository
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.

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  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 02/11/2014 03:33:08 PM
  11. * @author Trevor Irons (ti)
  12. * @email Trevor.Irons@lemmasoftware.org
  13. * @copyright Copyright (c) 2014, Trevor Irons
  14. */
  15. #ifndef FHTKEY201_INC
  16. #define FHTKEY201_INC
  17. #include "HankelTransform.h"
  18. namespace Lemma {
  19. /**
  20. \brief Impliments the fast Hankel transform as outlines by Key 2011
  21. \details This filter uses 51, 101, or 201 filter points and supports both lagged and related
  22. kernel arguments. This algorithm is a port of code carrying the following copyright and
  23. restriction:
  24. %------------------------------------------------------------------%
  25. % Copyright (c) 2012 by the Society of Exploration Geophysicists. %
  26. % For more information, go to http://software.seg.org/2012/0003 . %
  27. % You must read and accept usage terms at: %
  28. % http://software.seg.org/disclaimer.txt before use. %
  29. %------------------------------------------------------------------%
  30. */
  31. class FHTKey201 : public HankelTransform {
  32. friend std::ostream &operator<<(std::ostream &stream, const FHTKey201 &ob);
  33. struct ctor_key {};
  34. public:
  35. // ==================== LIFECYCLE =======================
  36. /** Default locked constructor, use NewSP */
  37. FHTKey201 ( const ctor_key& );
  38. /** DeSerializing locked constructor, use DeSerialize */
  39. FHTKey201 ( const YAML::Node& node, const ctor_key& );
  40. /** Default destructor */
  41. ~FHTKey201 ();
  42. /**
  43. * Factory method for generating objects.
  44. * @return std::shared_ptr< FHTKey201 >
  45. */
  46. static std::shared_ptr<FHTKey201> NewSP();
  47. /** YAML Serializing method
  48. */
  49. YAML::Node Serialize() const;
  50. /**
  51. * Constructs an object from a YAML::Node.
  52. */
  53. static std::shared_ptr< FHTKey201 > DeSerialize(const YAML::Node& node);
  54. // ==================== OPERATORS =======================
  55. // ==================== OPERATIONS =======================
  56. Complex Zgauss(const int &ikk, const EMMODE &imode,
  57. const int &itype, const Real &rho,
  58. const Real &wavef, KernelEM1DBase* Kernel);
  59. /// Computes related kernels, if applicable, otherwise this is
  60. /// just a dummy function.
  61. void ComputeRelated(const Real& rho, std::shared_ptr<KernelEM1DBase> Kernel);
  62. void ComputeRelated(const Real& rho, std::vector< std::shared_ptr<KernelEM1DBase> > KernelVec);
  63. void ComputeRelated(const Real& rho, std::shared_ptr<KernelEM1DManager> KernelManager);
  64. // ==================== ACCESS =======================
  65. // ==================== INQUIRY =======================
  66. /** Returns the name of the underlying class, similiar to Python's type */
  67. virtual std::string GetName() const;
  68. protected:
  69. // ==================== LIFECYCLE =======================
  70. private:
  71. // ==================== DATA MEMBERS =========================
  72. // Shared Filter Weights
  73. static const Eigen::Matrix<Real, 201, 3> WT201;
  74. /// Holds answer, dimensions are NumConv, and NumberRelated.
  75. Eigen::Matrix<Complex, Eigen::Dynamic, Eigen::Dynamic> Zans;
  76. /** ASCII string representation of the class name */
  77. static constexpr auto CName = "FHTKey201";
  78. }; // ----- end of class FHTKey201 -----
  79. } // ----- end of Lemma name -----
  80. #endif // ----- #ifndef FHTKEY201_INC -----