TestFourierTransformation.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_TEST_TESTMATH_TEST_FOURIER_TRANSFORMATION_H
#define META_OCEAN_TEST_TESTMATH_TEST_FOURIER_TRANSFORMATION_H
 
#include "ocean/test/testmath/TestMath.h"
 
#include "ocean/test/TestSelector.h"
 
namespace Ocean
{
 
namespace Test
{
 
namespace TestMath
{
 
/**
 * This class implements test for the Fourier transformation class.
 * @ingroup testmath
 */
class OCEAN_TEST_MATH_EXPORT TestFourierTransformation
{
    public:
 
        /**
         * This functions tests all 3D line functions.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @param selector The test selector
         * @return True, if succeeded
         */
        static bool test(const double testDuration, const TestSelector& selector);
 
        /**
         * Tests the forward and backward (inverse) Fourier transformation.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type to be tested, 'float' or 'double'
         * @tparam tSourceIsComplex True, if the source signal is complex; False, if the source is composed of real elements only
         */
        template <typename T, bool tSourceIsComplex>
        static bool testFourierTransform(const double testDuration);
 
        /**
         * Tests the element-wise multiplication of two complex spectrums.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type to be tested, 'float' or 'double'
         */
        template <typename T>
        static bool testElementwiseMultiplication2(const double testDuration);
 
        /**
         * Tests the element-wise multiplication of two spectrums in CCS-packed format.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type to be tested, 'float' or 'double'
         */
        template <typename T>
        static bool testElementwiseMultiplicationCCS(const double testDuration);
 
        /**
         * Tests the element-wise division of two complex spectrums.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type to be tested, 'float' or 'double'
         */
        template <typename T>
        static bool testElementwiseDivision2(const double testDuration);
 
        /**
         * Tests the in-place shift of the four quadrants of a spectrum.
         * @param testDuration Number of seconds for each test, with range (0, infinity)
         * @return True, if succeeded
         * @tparam T The data type to be tested
         */
        template <typename T>
        static bool testShiftHalfDimension2(const double testDuration);
 
    protected:
 
        /**
         * Returns the offsets of the real part and of the imaginary part of every complex value of a CCS-packed spectrum.
         * The offsets are determined from the CCS layout documented in FourierTransformation.h, independently of the implementation under test.
         * @param width The width of the spectrum in elements, with range [1, infinity)
         * @param height The height of the spectrum in elements, with range [1, infinity)
         * @param paddingElements The number of padding elements at the end of each spectrum row, with range [0, infinity)
         * @return The offset of the real part and the offset of the imaginary part of each complex value, the second offset is `Index32(-1)` for the values without an imaginary part
         */
        static IndexPairs32 ccsSpectrumValues(const unsigned int width, const unsigned int height, const unsigned int paddingElements);
};
 
}
 
}
 
}
 
#endif // META_OCEAN_TEST_TESTMATH_TEST_FOURIER_TRANSFORMATION_H