From b212ab9ea21a093ba8fa9895e723bc76b84cf284 Mon Sep 17 00:00:00 2001 From: Chris Robinson Date: Sat, 14 Sep 2019 18:37:00 -0700 Subject: Add a note about clearing complex_hilbert's imaginary input --- common/alcomplex.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'common') diff --git a/common/alcomplex.h b/common/alcomplex.h index f224cce2..12b86436 100644 --- a/common/alcomplex.h +++ b/common/alcomplex.h @@ -17,7 +17,8 @@ void complex_fft(const al::span> buffer, const double sign) * Calculate the complex helical sequence (discrete-time analytical signal) of * the given input using the discrete Hilbert transform (In-place algorithm). * Fills the buffer with the discrete-time analytical signal stored in the - * buffer. The buffer is an array of complex numbers and MUST BE power of two. + * buffer. The buffer is an array of complex numbers and MUST BE power of two, + * and the imaginary components should be cleared to 0. */ void complex_hilbert(const al::span> buffer); -- cgit v1.2.3