1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
use ;
use crate;
/// Perform a quasi-discrete Hankel transform of the function `f` (sampled at points
/// `r`) and return the transformed function and its sample points in `k`-space.
///
/// If you require the transform on a frequency axis (as opposed to the `k`-axis), the
/// frequency axis `v` can be calculated using `v = k / (2 * pi)`.
///
/// # Warning
/// This method is a convenience wrapper for [`HankelTransform::qdht`], but incurs a
/// significant overhead in calculating the [`HankelTransform`] object. If you
/// are performing multiple transforms on the same grid, it will be much quicker to
/// construct a single [`HankelTransform`] object and call
/// [`HankelTransform::qdht`] multiple times.
///
/// # Arguments
/// * `r` - The radial coordinates at which the function is sampled.
/// * `f` - The value of the function to be transformed.
/// * `order` - The order of the Hankel Transform to perform. Defaults to 0.
/// * `axis` - Axis over which to compute the Hankel transform.
///
/// # Returns
/// A tuple containing the `k` coordinates of the transformed function and its values.
/// Perform an inverse quasi-discrete Hankel transform of the function `f` (sampled at points
/// `k`) and return the transformed function and its sample points in radial space.
///
/// If you have the transform on a frequency axis (as opposed to a `k`-axis), the
/// `k`-axis can be calculated using `k = 2 * pi * f`.
///
/// # Warning
/// This method is a convenience wrapper for [`HankelTransform::iqdht`], but incurs a
/// significant overhead in calculating the [`HankelTransform`] object. If you
/// are performing multiple transforms on the same grid, it will be much quicker to
/// construct a single [`HankelTransform`] object and call
/// [`HankelTransform::iqdht`] multiple times.
///
/// # Arguments
/// * `k` - The `k` coordinates at which the function is sampled.
/// * `f` - The value of the function to be transformed.
/// * `order` - The order of the Hankel Transform to perform. Defaults to 0.
/// * `axis` - Axis over which to compute the Hankel transform.
///
/// # Returns
/// A tuple containing the radial coordinates of the transformed function and its values.
/// Perform a spherical quasi-discrete Hankel transform of the function `f` (sampled at points
/// `r`) and return the transformed function and its sample points in `k`-space.
///
/// # Warning
/// This method is a convenience wrapper for [`HankelTransform::qdht`], but incurs a
/// significant overhead in calculating the [`HankelTransform`] object. If you
/// are performing multiple transforms on the same grid, it will be much quicker to
/// construct a single [`HankelTransform`] object using [`HankelTransform::new_spherical`] or
/// [`HankelTransform::new_spherical_from_r_grid`] and call
/// [`HankelTransform::qdht`] multiple times.
///
/// # Arguments
/// * `r` - The radial coordinates at which the function is sampled.
/// * `f` - The value of the function to be transformed.
/// * `order` - The order of the spherical Hankel Transform to perform.
/// * `axis` - Axis over which to compute the Hankel transform.
///
/// # Returns
/// A tuple containing the `k` coordinates of the transformed function and its values.
///
/// # See Also
/// The [online `hankrs` book](https://etfrogers.github.io/hankrs/spherical_known_transforms.html)
/// gives details of and demonstrates verified transform pairs for the spherical QDHT.
/// Perform an inverse spherical quasi-discrete Hankel transform of the function `f` (sampled at points
/// `k`) and return the transformed function and its sample points in radial space.
///
/// # Warning
/// This method is a convenience wrapper for [`HankelTransform::iqdht`], but incurs a
/// significant overhead in calculating the [`HankelTransform`] object. If you
/// are performing multiple transforms on the same grid, it will be much quicker to
/// construct a single [`HankelTransform`] object using [`HankelTransform::new_spherical`] or
/// [`HankelTransform::new_spherical_from_k_grid`] and call
/// [`HankelTransform::iqdht`] multiple times.
///
/// # Arguments
/// * `k` - The `k` coordinates at which the function is sampled.
/// * `f` - The value of the function to be transformed.
/// * `order` - The order of the spherical Hankel Transform to perform.
/// * `axis` - Axis over which to compute the Hankel transform.
///
/// # Returns
/// A tuple containing the radial coordinates of the transformed function and its values.
///
/// # See Also
/// The [online `hankrs` book](https://etfrogers.github.io/hankrs/spherical_known_transforms.html)
/// gives details of and demonstrates verified transform pairs for the spherical QDHT.