-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathFftSharp.xml
230 lines (230 loc) · 11.1 KB
/
FftSharp.xml
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<?xml version="1.0"?>
<doc>
<assembly>
<name>FftSharp</name>
</assembly>
<members>
<member name="M:FftSharp.Filter.LowPass(System.Double[],System.Double,System.Double)">
<summary>
Silence frequencies above the given frequency
</summary>
</member>
<member name="M:FftSharp.Filter.HighPass(System.Double[],System.Double,System.Double)">
<summary>
Silence frequencies below the given frequency
</summary>
</member>
<member name="M:FftSharp.Filter.BandPass(System.Double[],System.Double,System.Double,System.Double)">
<summary>
Silence frequencies outside the given frequency range
</summary>
</member>
<member name="M:FftSharp.Filter.BandStop(System.Double[],System.Double,System.Double,System.Double)">
<summary>
Silence frequencies inside the given frequency range
</summary>
</member>
<member name="M:FftSharp.IWindow.Create(System.Int32,System.Boolean)">
<summary>
Generate this window as a new array with the given length.
Normalizing will scale the window so the sum of all points is 1.
</summary>
</member>
<member name="M:FftSharp.IWindow.Apply(System.Double[],System.Boolean)">
<summary>
Return a new array where this window was multiplied by the given signal.
Normalizing will scale the window so the sum of all points is 1 prior to multiplication.
</summary>
</member>
<member name="M:FftSharp.IWindow.ApplyInPlace(System.Double[],System.Boolean)">
<summary>
Modify the given signal by multiplying it by this window IN PLACE.
Normalizing will scale the window so the sum of all points is 1 prior to multiplication.
</summary>
</member>
<member name="P:FftSharp.IWindow.Name">
<summary>
Single word name for this window
</summary>
</member>
<member name="P:FftSharp.IWindow.Description">
<summary>
A brief description of what makes this window unique and what it is typically used for.
</summary>
</member>
<member name="M:FftSharp.Pad.IsPowerOfTwo(System.Int32)">
<summary>
Test if a number is an even power of 2
</summary>
</member>
<member name="M:FftSharp.Pad.ZeroPad(FftSharp.Complex[])">
<summary>
Return the input array (or a new zero-padded new one) ensuring length is a power of 2
</summary>
<param name="input">array of any length</param>
<returns>the input array or a zero-padded copy</returns>
</member>
<member name="M:FftSharp.Pad.ZeroPad(System.Double[])">
<summary>
Return the input array (or a new zero-padded new one) ensuring length is a power of 2
</summary>
<param name="input">array of any length</param>
<returns>the input array or a zero-padded copy</returns>
</member>
<member name="M:FftSharp.Pad.ZeroPad(FftSharp.Complex[],System.Int32)">
<summary>
Return the input array zero-padded to reach a final length
</summary>
<param name="input">array of any length</param>
<param name="finalLength">pad the array with zeros a the end to achieve this final length</param>
<returns>a zero-padded copy of the input array</returns>
</member>
<member name="M:FftSharp.Pad.ZeroPad(System.Double[],System.Int32)">
<summary>
Return the input array zero-padded to reach a final length
</summary>
<param name="input">array of any length</param>
<param name="finalLength">pad the array with zeros a the end to achieve this final length</param>
<returns>a zero-padded copy of the input array</returns>
</member>
<member name="M:FftSharp.Transform.FFT(FftSharp.Complex[])">
<summary>
Compute the discrete Fourier Transform (in-place) using the FFT algorithm.
</summary>
<param name="buffer">Data to transform in-place. Length must be a power of 2.</param>
</member>
<member name="M:FftSharp.Transform.FFT(System.Span{FftSharp.Complex})">
<summary>
Compute the discrete Fourier Transform (in-place) using the FFT algorithm.
</summary>
<param name="buffer">Data to transform in-place. Length must be a power of 2.</param>
</member>
<member name="M:FftSharp.Transform.FFT_WithoutChecks(System.Span{FftSharp.Complex})">
<summary>
High performance FFT function.
Complex input will be transformed in place.
Input array length must be a power of two. This length is NOT validated.
Running on an array with an invalid length may throw an invalid index exception.
</summary>
</member>
<member name="M:FftSharp.Transform.IFFT(FftSharp.Complex[])">
<summary>
Compute the inverse discrete Fourier Transform (in-place) using the FFT algorithm.
</summary>
<param name="buffer">Data to transform in-place. Length must be a power of 2.</param>
</member>
<member name="M:FftSharp.Transform.BitReverse(System.Int32,System.Int32)">
<summary>
Reverse the sequence of bits in an integer (01101 -> 10110)
</summary>
</member>
<member name="M:FftSharp.Transform.FFTfreq(System.Double,System.Int32,System.Boolean)">
<summary>
Calculate sample frequency for each point in a FFT
</summary>
<param name="sampleRate">Sample rate (Hz) of the original signal</param>
<param name="pointCount">Number of points to generate (typically the length of the FFT)</param>
<param name="oneSided">Whether or not frequencies are for a one-sided FFT (containing only real numbers)</param>
</member>
<member name="M:FftSharp.Transform.FFTfreq(System.Double,System.Double[],System.Boolean)">
<summary>
Calculate sample frequency for each point in a FFT
</summary>
<param name="sampleRate">Sample rate (Hz) of the original signal</param>
<param name="fft">FFT array for which frequencies should be generated</param>
<param name="oneSided">Whether or not frequencies are for a one-sided FFT (containing only real numbers)</param>
</member>
<member name="M:FftSharp.Transform.FFTfreqPeriod(System.Int32,System.Int32)">
<summary>
Return the distance between each FFT point in frequency units (Hz)
</summary>
</member>
<member name="M:FftSharp.Transform.IsPowerOfTwo(System.Int32)">
<summary>
Test if a number is an even power of 2
</summary>
</member>
<member name="M:FftSharp.Transform.MakeComplex(System.Double[])">
<summary>
Create an array of Complex data given the real component
</summary>
</member>
<member name="M:FftSharp.Transform.MakeComplex(System.Span{FftSharp.Complex},System.Span{System.Double})">
<summary>
Create an array of Complex data given the real component
</summary>
</member>
<member name="M:FftSharp.Transform.FFT(System.Double[])">
<summary>
Compute the 1D discrete Fourier Transform using the Fast Fourier Transform (FFT) algorithm
</summary>
<param name="input">real input (must be an array with length that is a power of 2)</param>
<returns>transformed input</returns>
</member>
<member name="M:FftSharp.Transform.RFFT(System.Double[])">
<summary>
Compute the 1D discrete Fourier Transform using the Fast Fourier Transform (FFT) algorithm
</summary>
<param name="input">real input (must be an array with length that is a power of 2)</param>
<returns>real component of transformed input</returns>
</member>
<member name="M:FftSharp.Transform.RFFT(System.Span{FftSharp.Complex},System.Span{System.Double})">
<summary>
Compute the 1D discrete Fourier Transform using the Fast Fourier Transform (FFT) algorithm
</summary>
<param name="destination">Memory location of the results (must be an equal to input length / 2 + 1)</param>
<param name="input">real input (must be an array with length that is a power of 2)</param>
<returns>real component of transformed input</returns>
</member>
<member name="M:FftSharp.Transform.Absolute(FftSharp.Complex[])">
<summary>
Return a Complex array as an array of its absolute values
</summary>
<param name="input"></param>
<returns></returns>
</member>
<member name="M:FftSharp.Transform.FFTmagnitude(System.Double[])">
<summary>
Calculte power spectrum density (PSD) original (RMS) units
</summary>
<param name="input">real input</param>
</member>
<member name="M:FftSharp.Transform.FFTmagnitude(System.Span{System.Double},System.Span{System.Double})">
<summary>
Calculte power spectrum density (PSD) original (RMS) units
</summary>
<param name="destination">Memory location of the results.</param>
<param name="input">real input</param>
</member>
<member name="M:FftSharp.Transform.FFTpower(System.Double[])">
<summary>
Calculte power spectrum density (PSD) in dB units
</summary>
<param name="input">real input</param>
</member>
<member name="M:FftSharp.Transform.FFTpower(System.Span{System.Double},System.Double[])">
<summary>
Calculte power spectrum density (PSD) in dB units
</summary>
<param name="destination">Memory location of the results.</param>
<param name="input">real input</param>
</member>
<member name="M:FftSharp.Window.Apply(System.Double[],System.Boolean)">
<summary>
Multiply the array by this window and return the result as a new array
</summary>
</member>
<member name="M:FftSharp.Window.ApplyInPlace(System.Double[],System.Boolean)">
<summary>
Multiply the array by this window, modifying it in place
</summary>
</member>
<member name="M:FftSharp.Window.GetWindows">
<summary>
Return an array containing all available windows.
Note that all windows returned will use the default constructor, but some
windows have customization options in their constructors if you create them individually.
</summary>
</member>
</members>
</doc>