adi_fft.h File Reference

FFT library implementation headers. More...

#include <stdint.h>
#include <stdbool.h>
#include "adi_fft_windowing.h"

Include dependency graph for adi_fft.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	adi_fft_init_params
struct	adi_fft_processing
struct	adi_fft_measurements

Macros
#define	ADI_FFT_MAX_SAMPLES   2048

Typedefs
typedef float(*	adi_fft_data_to_volt_conv) (int32_t, uint8_t)
typedef int32_t(*	adi_fft_code_to_straight_bin_conv) (uint32_t, uint8_t)

Enumerations
enum	adi_fft_windowing_type {   BLACKMAN_HARRIS_7TERM ,   RECTANGULAR }

Functions
int	adi_fft_init (struct adi_fft_init_params *param, struct adi_fft_processing *fft_proc, struct adi_fft_measurements *fft_meas)
	Initialize the FFT structure. More...
int	adi_fft_update_params (struct adi_fft_init_params *param, struct adi_fft_processing *fft_proc)
	Update the FFT parameters. More...
int	adi_fft_perform (struct adi_fft_processing *fft_proc, struct adi_fft_measurements *fft_meas)
	Perform the FFT. More...

Detailed Description

FFT library implementation headers.

Copyright (c) 2023 Analog Devices, Inc. All rights reserved.

This software is proprietary to Analog Devices, Inc. and its licensors. By using this software you agree to the terms of the associated Analog Devices Software License Agreement.

Macro Definition Documentation

ADI_FFT_MAX_SAMPLES

#define ADI_FFT_MAX_SAMPLES   2048

Typedef Documentation

adi_fft_code_to_straight_bin_conv

typedef int32_t(* adi_fft_code_to_straight_bin_conv) (uint32_t, uint8_t)

adi_fft_data_to_volt_conv

typedef float(* adi_fft_data_to_volt_conv) (int32_t, uint8_t)

Enumeration Type Documentation

adi_fft_windowing_type

enum adi_fft_windowing_type

Enumerator
BLACKMAN_HARRIS_7TERM
RECTANGULAR

Function Documentation

adi_fft_init()

int adi_fft_init	(	struct adi_fft_init_params *	param,
		struct adi_fft_processing *	fft_proc,
		struct adi_fft_measurements *	fft_meas
	)

Initialize the FFT structure.

Parameters

param[in]	- FFT init parameters
fft_proc[in,out]	- FFT processing parameters
fft_meas[in,out]	- FFT measurements parameters

Returns

0 in case of success, negative error code otherwise

adi_fft_perform()

int adi_fft_perform	(	struct adi_fft_processing *	fft_proc,
		struct adi_fft_measurements *	fft_meas
	)

Perform the FFT.

Parameters

fft_proc[in,out]	- FFT processing parameters
fft_meas[in,out]	- FFT measurements parameters

Returns

0 in case of success, negative error code otherwise

adi_fft_update_params()

int adi_fft_update_params	(	struct adi_fft_init_params *	param,
		struct adi_fft_processing *	fft_proc
	)

Update the FFT parameters.

Parameters

param[in]	- FFT init parameters
fft_proc[in,out]	- FFT entry parameters

Returns

none