- * | Key | Description | Units
- * |
|---|
| signaltype | Signal type: 0=Real, 1=Complex |
- * |
| nfft | FFT size |
- * |
| datasize | Data size |
- * |
| fbin | Frequency bin size | Hz
- * |
| fdata | Data rate | S/s
- * |
| fsample | Sample rate | S/s
- * |
| fshift | Shift frequency | Hz
- * |
| fsnr | Full-scale-to-noise ratio (a.k.a. "SNRFS") | dB
- * |
| snr | Signal-to-noise ratio | dB
- * |
| sinad | Signal-to-noise-and-distortion ratio | dB
- * |
| sfdr | Spurious-free dynamic range | dB
- * |
| abn | Average bin noise | dBFS
- * |
| nsd | Noise spectral density | dBFS/Hz
- * |
| carrierindex | Order index of the Carrier tone |
- * |
| maxspurindex | Order index of the MaxSpur tone |
- * |
| ab_width | Analysis band width | Hz
- * |
| ab_i1 | Analysis band first index |
- * |
| ab_i2 | Analysis band last index |
- * |
| {PREFIX}_nbins | Number of bins associated with PREFIX |
- * |
| {PREFIX}_rss | Root-sum-square associated with PREFIX |
- * |
| {TONEKEY}:orderindex | Tone order index |
- * |
| {TONEKEY}:freq | Tone frequency | Hz
- * |
| {TONEKEY}:ffinal | Tone final frequency | Hz
- * |
| {TONEKEY}:fwavg | Tone weighted-average frequency | Hz
- * |
| {TONEKEY}:i1 | Tone first index |
- * |
| {TONEKEY}:i2 | Tone last index |
- * |
| {TONEKEY}:nbins | Tone number of bins |
- * |
| {TONEKEY}:inband | 0: tone is in-band; 1: tone is out-of-band |
- * |
| {TONEKEY}:mag | Tone magnitude |
- * |
| {TONEKEY}:mag_dbfs | Tone magnitude relative to full-scale | dBFS
- * |
| {TONEKEY}:mag_dbc | Tone magnitude relative to carrier | dBc
- * |
| {TONEKEY}:phase | Tone phase | rad
- * |
| {TONEKEY}:phase_c | Tone phase relative to carrier | rad
+ * |
| Key | Description | Units |
|---|
|
+ * signaltype | Signal type: 0=Real, 1=Complex |
+ * |
| nfft | FFT size | |
| datasize |
+ * Data size | |
| fbin |
+ * Frequency bin size | Hz |
| fdata |
+ * Data rate | S/s |
| fsample |
+ * Sample rate | S/s |
| fshift |
+ * Shift frequency | Hz |
| fsnr |
+ * Full-scale-to-noise ratio (a.k.a. "SNRFS") | dB |
| snr |
+ * Signal-to-noise ratio | dB |
| sinad |
+ * Signal-to-noise-and-distortion ratio | dB |
| sfdr |
+ * Spurious-free dynamic range | dB |
| abn |
+ * Average bin noise | dBFS |
| nsd |
+ * Noise spectral density | dBFS/Hz |
|
+ * carrierindex | Order index of the Carrier tone |
+ * |
| maxspurindex | Order index of the MaxSpur tone |
+ * |
| ab_width | Analysis band width | Hz |
|
+ * ab_i1 | Analysis band first index |
+ * |
| ab_i2 | Analysis band last index | |
|
+ * {PREFIX}_nbins | Number of bins associated with PREFIX |
+ * |
| {PREFIX}_rss | Root-sum-square associated with PREFIX
+ * | |
| {TONEKEY}:orderindex | Tone order index | |
|
+ * {TONEKEY}:freq | Tone frequency |
+ * Hz |
| {TONEKEY}:ffinal | Tone final frequency | Hz |
|
+ * {TONEKEY}:fwavg | Tone weighted-average frequency |
+ * Hz |
| {TONEKEY}:i1 | Tone first index | |
|
+ * {TONEKEY}:i2 | Tone last index |
+ * |
| {TONEKEY}:nbins | Tone number of bins | |
|
+ * {TONEKEY}:inband | 0: tone is in-band; 1: tone is out-of-band |
+ * |
| {TONEKEY}:mag | Tone magnitude | |
|
+ * {TONEKEY}:mag_dbfs | Tone magnitude relative to full-scale |
+ * dBFS |
| {TONEKEY}:mag_dbc | Tone magnitude relative to carrier
+ * | dBc |
| {TONEKEY}:phase | Tone phase | rad |
|
+ * {TONEKEY}:phase_c | Tone phase relative to carrier |
+ * rad
* |
*/
__api int gn_fft_analysis(
- char** rkeys, ///< [out] Result keys array pointer
- size_t rkeys_size, ///< [in] Result keys array size
- double* rvalues, ///< [out] Result values array pointer
- size_t rvalues_size, ///< [in] Result values array size
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- const double* in, ///< [in] Interleaved Re/Im input array pointer
- size_t in_size, ///< [in] Input array size
- size_t nfft, ///< [in] FFT size
- GnFreqAxisType axis_type ///< [in] Frequency axis type
- );
+ char **rkeys, ///< [out] Result keys array pointer
+ size_t rkeys_size, ///< [in] Result keys array size
+ double *rvalues, ///< [out] Result values array pointer
+ size_t rvalues_size, ///< [in] Result values array size
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ const double *in, ///< [in] Interleaved Re/Im input array pointer
+ size_t in_size, ///< [in] Input array size
+ size_t nfft, ///< [in] FFT size
+ GnFreqAxisType axis_type ///< [in] Frequency axis type
+);
/**
* @brief gn_fft_analysis_select returns select Fourier analysis results
* @return 0 on success, non-zero otherwise
*/
__api int gn_fft_analysis_select(
- double* rvalues, ///< [out] Result values array pointer
- size_t rvalues_size, ///< [in] Result values array size
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- const char** rkeys, ///< [in] Result keys array pointer
- size_t rkeys_size, ///< [in] Result keys array size
- const double* in, ///< [in] Interleaved Re/Im input array pointer
- size_t in_size, ///< [in] Input array size
- size_t nfft, ///< [in] FFT size
- GnFreqAxisType axis_type ///< [in] Frequency axis type
- );
+ double *rvalues, ///< [out] Result values array pointer
+ size_t rvalues_size, ///< [in] Result values array size
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ const char **rkeys, ///< [in] Result keys array pointer
+ size_t rkeys_size, ///< [in] Result keys array size
+ const double *in, ///< [in] Interleaved Re/Im input array pointer
+ size_t in_size, ///< [in] Input array size
+ size_t nfft, ///< [in] FFT size
+ GnFreqAxisType axis_type ///< [in] Frequency axis type
+);
/**
* @brief gn_fft_analysis_single returns a single Fourier analysis result
* @return 0 on success, non-zero otherwise
*/
__api int gn_fft_analysis_single(
- double* rvalue, ///< [out] Result value
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- const char* rkey, ///< [in] Result key
- const double* in, ///< [in] Interleaved Re/Im input array pointer
- size_t in_size, ///< [in] Input array size
- size_t nfft, ///< [in] FFT size
- GnFreqAxisType axis_type ///< [in] Frequency axis type
- );
+ double *rvalue, ///< [out] Result value
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ const char *rkey, ///< [in] Result key
+ const double *in, ///< [in] Interleaved Re/Im input array pointer
+ size_t in_size, ///< [in] Input array size
+ size_t nfft, ///< [in] FFT size
+ GnFreqAxisType axis_type ///< [in] Frequency axis type
+);
/**
* \defgroup FourierAnalysisConfiguration Configuration
@@ -722,263 +708,245 @@ __api int gn_fft_analysis_single(
* @brief gn_fa_analysis_band
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_analysis_band(
- const char* obj_key, ///< [in] Object key
- double center, ///< [in] Analysis band center
- double width ///< [in] Analysis band width
- );
+__api int gn_fa_analysis_band(const char *obj_key, ///< [in] Object key
+ double center, ///< [in] Analysis band center
+ double width ///< [in] Analysis band width
+);
/**
* @brief gn_fa_analysis_band_e
* @return 0 on success, non-zero otherwise
*/
__api int gn_fa_analysis_band_e(
- const char* obj_key, ///< [in] Object key
- const char* center, ///< [in] Analysis band center expression
- const char* width ///< [in] Analysis band width expression
- );
+ const char *obj_key, ///< [in] Object key
+ const char *center, ///< [in] Analysis band center expression
+ const char *width ///< [in] Analysis band width expression
+);
/**
* @brief gn_fa_clk
* @return 0 on success, non-zero otherwise
*/
__api int gn_fa_clk(
- const char* obj_key, ///< [in] Object key
- const int* clk, ///< [in] Pointer to array of clock divisors
- size_t clk_size, ///< [in] Size of array of clock divisors
- bool as_noise ///< [in] If true, CLK components will be treated as noise
- );
+ const char *obj_key, ///< [in] Object key
+ const int *clk, ///< [in] Pointer to array of clock divisors
+ size_t clk_size, ///< [in] Size of array of clock divisors
+ bool as_noise ///< [in] If true, CLK components will be treated as noise
+);
/**
* @brief gn_fa_conv_offset
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_conv_offset(
- const char* obj_key, ///< [in] Object key
- bool enable ///< [in] If true, enable converter offset
- );
+__api int
+gn_fa_conv_offset(const char *obj_key, ///< [in] Object key
+ bool enable ///< [in] If true, enable converter offset
+);
/**
* @brief gn_fa_create
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_create(
- const char* obj_key ///< [in] Object key
- );
+__api int gn_fa_create(const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_fa_dc
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_dc(
- const char* obj_key, ///< [in] Object key
- bool as_dist ///< [in] If true, treat DC as distortion
- );
+__api int gn_fa_dc(const char *obj_key, ///< [in] Object key
+ bool as_dist ///< [in] If true, treat DC as distortion
+);
/**
* @brief gn_fa_fdata
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fdata(
- const char* obj_key, ///< [in] Object key
- double f ///< [in] fdata
- );
+__api int gn_fa_fdata(const char *obj_key, ///< [in] Object key
+ double f ///< [in] fdata
+);
/**
* @brief gn_fa_fdata_e
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fdata_e(
- const char* obj_key, ///< [in] Object key
- const char* f ///< [in] fdata expression
- );
+__api int gn_fa_fdata_e(const char *obj_key, ///< [in] Object key
+ const char *f ///< [in] fdata expression
+);
/**
* @brief gn_fa_fixed_tone
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fixed_tone(
- const char* obj_key, ///< [in] Object key
- const char* comp_key, ///< [in] Component key
- GnFACompTag tag, ///< [in] Tag
- double freq, ///< [in] Frequency
- int ssb ///< [in] Number of single-side bins
- );
+__api int gn_fa_fixed_tone(const char *obj_key, ///< [in] Object key
+ const char *comp_key, ///< [in] Component key
+ GnFACompTag tag, ///< [in] Tag
+ double freq, ///< [in] Frequency
+ int ssb ///< [in] Number of single-side bins
+);
/**
* @brief gn_fa_fixed_tone_e
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fixed_tone_e(
- const char* obj_key, ///< [in] Object key
- const char* comp_key, ///< [in] Component key
- GnFACompTag tag, ///< [in] Tag
- const char* freq, ///< [in] Frequency expression
- int ssb ///< [in] Number of single-side bins
- );
+__api int gn_fa_fixed_tone_e(const char *obj_key, ///< [in] Object key
+ const char *comp_key, ///< [in] Component key
+ GnFACompTag tag, ///< [in] Tag
+ const char *freq, ///< [in] Frequency expression
+ int ssb ///< [in] Number of single-side bins
+);
/**
* @brief gn_fa_fsample
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fsample(
- const char* obj_key, ///< [in] Object key
- double f ///< [in] fsample
- );
+__api int gn_fa_fsample(const char *obj_key, ///< [in] Object key
+ double f ///< [in] fsample
+);
/**
* @brief gn_fa_fsample_e
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fsample_e(
- const char* obj_key, ///< [in] Object key
- const char* f ///< [in] fsample expression
- );
+__api int gn_fa_fsample_e(const char *obj_key, ///< [in] Object key
+ const char *f ///< [in] fsample expression
+);
/**
* @brief gn_fa_fshift
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fshift(
- const char* obj_key, ///< [in] Object key
- double f ///< [in] fshift
- );
+__api int gn_fa_fshift(const char *obj_key, ///< [in] Object key
+ double f ///< [in] fshift
+);
/**
* @brief gn_fa_fshift_e
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fshift_e(
- const char* obj_key, ///< [in] Object key
- const char* f ///< [in] fshift expression
- );
+__api int gn_fa_fshift_e(const char *obj_key, ///< [in] Object key
+ const char *f ///< [in] fshift expression
+);
/**
* @brief gn_fa_fund_images
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_fund_images(
- const char* obj_key, ///< [in] Object key
- bool enable ///< [in] If true, enable fundamental images
- );
+__api int
+gn_fa_fund_images(const char *obj_key, ///< [in] Object key
+ bool enable ///< [in] If true, enable fundamental images
+);
/**
* @brief gn_fa_hd
* @return 0 on success, non-zero otherwise
*/
__api int gn_fa_hd(
- const char* obj_key, ///< [in] Object key
- int n ///< [in] Order of harmonic distortion, i.e., the maximum harmonic
- );
+ const char *obj_key, ///< [in] Object key
+ int n ///< [in] Order of harmonic distortion, i.e., the maximum harmonic
+);
/**
* @brief gn_fa_ilv
* @return 0 on success, non-zero otherwise
*/
__api int gn_fa_ilv(
- const char* obj_key, ///< [in] Object key
- const int* ilv, ///< [in] Pointer to array of interleaving factors
- size_t ilv_size, ///< [in] Size of array of interleaving factors
- bool as_noise ///< [in] If true, ILV components will be treated as noise
- );
+ const char *obj_key, ///< [in] Object key
+ const int *ilv, ///< [in] Pointer to array of interleaving factors
+ size_t ilv_size, ///< [in] Size of array of interleaving factors
+ bool as_noise ///< [in] If true, ILV components will be treated as noise
+);
/**
* @brief gn_fa_imd
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_imd(
- const char* obj_key, ///< [in] Object key
- int n ///< [in] Order of intermodulation distortion
- );
+__api int gn_fa_imd(const char *obj_key, ///< [in] Object key
+ int n ///< [in] Order of intermodulation distortion
+);
/**
* @brief gn_fa_load
* @return 0 on success, non-zero otherwise
* @details If obj_key is empty, the object key is derived from filename.
*/
-__api int gn_fa_load(
- char* buf, ///< [out] Pointer to character array
- size_t size, ///< [in] Size of character array
- const char* filename, ///< [in] Filename
- const char* obj_key ///< [in] Object key
- );
+__api int gn_fa_load(char *buf, ///< [out] Pointer to character array
+ size_t size, ///< [in] Size of character array
+ const char *filename, ///< [in] Filename
+ const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_fa_max_tone
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_max_tone(
- const char* obj_key, ///< [in] Object key
- const char* comp_key, ///< [in] Component key
- GnFACompTag tag, ///< [in] Tag
- int ssb ///< [in] Number of single-side bins
- );
+__api int gn_fa_max_tone(const char *obj_key, ///< [in] Object key
+ const char *comp_key, ///< [in] Component key
+ GnFACompTag tag, ///< [in] Tag
+ int ssb ///< [in] Number of single-side bins
+);
/**
* @brief gn_fa_preview
* @return 0 on success, non-zero otherwise
*/
__api int gn_fa_preview(
- char* buf, ///< [out] Pointer to character array
- size_t size, ///< [in] Size of character array
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- bool cplx ///< [in] If true, preview will include complex components
- );
+ char *buf, ///< [out] Pointer to character array
+ size_t size, ///< [in] Size of character array
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ bool cplx ///< [in] If true, preview will include complex components
+);
/**
* @brief gn_fa_quad_errors
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_quad_errors(
- const char* obj_key, ///< [in] Object key
- bool enable ///< [in] If true, enable quadrature errors
- );
+__api int
+gn_fa_quad_errors(const char *obj_key, ///< [in] Object key
+ bool enable ///< [in] If true, enable quadrature errors
+);
/**
* @brief gn_fa_remove_comp
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_remove_comp(
- const char* obj_key, ///< [in] Object key
- const char* comp_key ///< [in] Component key
- );
+__api int gn_fa_remove_comp(const char *obj_key, ///< [in] Object key
+ const char *comp_key ///< [in] Component key
+);
/**
* @brief gn_fa_reset
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_reset(
- const char* obj_key ///< [in] Object key
- );
+__api int gn_fa_reset(const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_fa_ssb
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_ssb(
- const char* obj_key, ///< [in] Object key
- GnFASsb group, ///< [in] SSB group
- int ssb ///< [in] Number of single-side bins
- );
+__api int gn_fa_ssb(const char *obj_key, ///< [in] Object key
+ GnFASsb group, ///< [in] SSB group
+ int ssb ///< [in] Number of single-side bins
+);
/**
* @brief gn_fa_var
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_var(
- const char* obj_key, ///< [in] Object key
- const char* name, ///< [in] Variable name
- double value ///< [in] Variable value
- );
+__api int gn_fa_var(const char *obj_key, ///< [in] Object key
+ const char *name, ///< [in] Variable name
+ double value ///< [in] Variable value
+);
/**
* @brief gn_fa_wo
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_wo(
- const char* obj_key, ///< [in] Object key
- int n ///< [in] Number of worst others
- );
+__api int gn_fa_wo(const char *obj_key, ///< [in] Object key
+ int n ///< [in] Number of worst others
+);
/** @} FourierAnalysisConfiguration */
@@ -991,27 +959,27 @@ __api int gn_fa_wo(
* @brief gn_fa_result
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_result(
- double* result, ///< [out] Result associated with rkey
- const char** rkeys, ///< [in] Result keys array pointer
- size_t rkeys_size, ///< [in] Result keys array size
- const double* rvalues, ///< [in] Result values array pointer
- size_t rvalues_size, ///< [in] Result values array size
- const char* rkey ///< [in] Key of desired result
+__api int
+gn_fa_result(double *result, ///< [out] Result associated with rkey
+ const char **rkeys, ///< [in] Result keys array pointer
+ size_t rkeys_size, ///< [in] Result keys array size
+ const double *rvalues, ///< [in] Result values array pointer
+ size_t rvalues_size, ///< [in] Result values array size
+ const char *rkey ///< [in] Key of desired result
);
/**
* @brief gn_fa_result_string
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fa_result_string(
- char* result, ///< [out] Result string associated with rkey
- size_t result_size, ///< [in] Size of result string
- const char** rkeys, ///< [in] Result keys array pointer
- size_t rkeys_size, ///< [in] Result keys array size
- const double* rvalues, ///< [in] Result values array pointer
- size_t rvalues_size, ///< [in] Result values array size
- const char* rkey ///< [in] Key of desired result
+__api int
+gn_fa_result_string(char *result, ///< [out] Result string associated with rkey
+ size_t result_size, ///< [in] Size of result string
+ const char **rkeys, ///< [in] Result keys array pointer
+ size_t rkeys_size, ///< [in] Result keys array size
+ const double *rvalues, ///< [in] Result values array pointer
+ size_t rvalues_size, ///< [in] Result values array size
+ const char *rkey ///< [in] Key of desired result
);
/** @} FourierAnalysisResults */
@@ -1024,66 +992,70 @@ __api int gn_fa_result_string(
/**
* @brief gn_fa_load_key_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
-__api int gn_fa_load_key_size(
- size_t* size, ///< [out] Number of characters in key
- const char* filename, ///< [in] Filename
- const char* obj_key ///< [in] Object key
- );
+__api int
+gn_fa_load_key_size(size_t *size, ///< [out] Number of characters in key
+ const char *filename, ///< [in] Filename
+ const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_fa_preview_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
__api int gn_fa_preview_size(
- size_t* size, ///< [out] Number of characters in compenent list string
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- bool cplx ///< [in] If true, list will include complex components
- );
+ size_t *size, ///< [out] Number of characters in compenent list string
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ bool cplx ///< [in] If true, list will include complex components
+);
/**
* @brief gn_fa_result_string_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
__api int gn_fa_result_string_size(
- size_t* size, ///< [out] Number of characters result string
- const char** rkeys, ///< [in] Result keys array pointer
- size_t rkeys_size, ///< [in] Result keys array size
- const double* rvalues, ///< [in] Result values array pointer
- size_t rvalues_size, ///< [in] Result values array size
- const char* rkey ///< [in] Key of desired result
- );
+ size_t *size, ///< [out] Number of characters result string
+ const char **rkeys, ///< [in] Result keys array pointer
+ size_t rkeys_size, ///< [in] Result keys array size
+ const double *rvalues, ///< [in] Result values array pointer
+ size_t rvalues_size, ///< [in] Result values array size
+ const char *rkey ///< [in] Key of desired result
+);
/**
* @brief gn_fft_analysis_results_key_sizes
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the key sizes. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the key sizes. See \ref
+ * gn_set_string_termination.
*/
__api int gn_fft_analysis_results_key_sizes(
- size_t* key_sizes, ///< [out] Key size array pointer
- size_t key_sizes_size, ///< [in] Key size array size
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- size_t in_size, ///< [in] Input array size
- size_t nfft ///< [in] FFT size
- );
+ size_t *key_sizes, ///< [out] Key size array pointer
+ size_t key_sizes_size, ///< [in] Key size array size
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ size_t in_size, ///< [in] Input array size
+ size_t nfft ///< [in] FFT size
+);
/**
* @brief gn_fft_analysis_results_size
* @return 0 on success, non-zero otherwise
*/
__api int gn_fft_analysis_results_size(
- size_t* size, ///< [out] Number of key-value result pairs
- const char* cfg_id, ///< [in] Configuration identifier (filename or object key)
- size_t in_size, ///< [in] Input array size
- size_t nfft ///< [in] FFT size
- );
+ size_t *size, ///< [out] Number of key-value result pairs
+ const char *
+ cfg_id, ///< [in] Configuration identifier (filename or object key)
+ size_t in_size, ///< [in] Input array size
+ size_t nfft ///< [in] FFT size
+);
/** @} FourierAnalysisHelpers */
@@ -1103,142 +1075,140 @@ extern "C" {
* @{
*/
- /**
+/**
* @brief gn_fft
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fft(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const double* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const double* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window ///< [in] Window
- );
+__api int gn_fft(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const double *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window ///< [in] Window
+);
/**
* @brief gn_fft16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fft16(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int16_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int16_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format ///< [in] Code format
- );
+__api int
+gn_fft16(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int16_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int16_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_fft32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fft32(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int32_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int32_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format ///< [in] Code format
- );
+__api int
+gn_fft32(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int32_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int32_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_fft64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fft64(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int64_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int64_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format ///< [in] Code format
- );
+__api int
+gn_fft64(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int64_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int64_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_rfft
* @return 0 on success, non-zero otherwise
* @details This function will be implemented in the future.
*/
-__api int gn_rfft(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnRfftScale scale ///< [in] Scaling mode
- );
+__api int gn_rfft(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnRfftScale scale ///< [in] Scaling mode
+);
/**
* @brief gn_rfft16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_rfft16(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int16_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format, ///< [in] Code format
- GnRfftScale scale ///< [in] Scaling mode
- );
+__api int
+gn_rfft16(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int16_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format, ///< [in] Code format
+ GnRfftScale scale ///< [in] Scaling mode
+);
/**
* @brief gn_rfft32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_rfft32(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int32_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format, ///< [in] Code format
- GnRfftScale scale ///< [in] Scaling mode
- );
+__api int
+gn_rfft32(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int32_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format, ///< [in] Code format
+ GnRfftScale scale ///< [in] Scaling mode
+);
/**
* @brief gn_rfft64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_rfft64(
- double* out, ///< [out] Interleaved Re/Im output array pointer
- size_t out_size, ///< [in] Output array size
- const int64_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- size_t navg, ///< [in] FFT averaging number
- size_t nfft, ///< [in] FFT size
- GnWindow window, ///< [in] Window
- GnCodeFormat format, ///< [in] Code format
- GnRfftScale scale ///< [in] Scaling mode
- );
+__api int
+gn_rfft64(double *out, ///< [out] Interleaved Re/Im output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int64_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft, ///< [in] FFT size
+ GnWindow window, ///< [in] Window
+ GnCodeFormat format, ///< [in] Code format
+ GnRfftScale scale ///< [in] Scaling mode
+);
/**
* \defgroup FourierTransformHelpers Helpers
@@ -1249,24 +1219,22 @@ __api int gn_rfft64(
* @brief gn_fft_size
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fft_size(
- size_t* out_size, ///< [out] Output array size
- size_t i_size, ///< [in] In-phase input array size
- size_t q_size, ///< [in] Quadrature input array size
- size_t navg, ///< [in] FFT averaging number
- size_t nfft ///< [in] FFT size
- );
+__api int gn_fft_size(size_t *out_size, ///< [out] Output array size
+ size_t i_size, ///< [in] In-phase input array size
+ size_t q_size, ///< [in] Quadrature input array size
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft ///< [in] FFT size
+);
/**
* @brief gn_rfft_size
* @return 0 on success, non-zero otherwise
*/
-__api int gn_rfft_size(
- size_t* out_size, ///< [out] Output array size
- size_t in_size, ///< [in] Input array size
- size_t navg, ///< [in] FFT averaging number
- size_t nfft ///< [in] FFT size
- );
+__api int gn_rfft_size(size_t *out_size, ///< [out] Output array size
+ size_t in_size, ///< [in] Input array size
+ size_t navg, ///< [in] FFT averaging number
+ size_t nfft ///< [in] FFT size
+);
/** @} FourierTransformHelpers */
@@ -1290,58 +1258,54 @@ extern "C" {
* @brief gn_alias
* @return 0 on success, non-zero otherwise
*/
-__api int gn_alias(
- double* out, ///< [out] Output pointer
- double fs, ///< [in] Sample rate (S/s)
- double freq, ///< [in] Frequency (Hz)
- GnFreqAxisType axis_type ///< [in] Frequency axis type
- );
+__api int gn_alias(double *out, ///< [out] Output pointer
+ double fs, ///< [in] Sample rate (S/s)
+ double freq, ///< [in] Frequency (Hz)
+ GnFreqAxisType axis_type ///< [in] Frequency axis type
+);
/**
* @brief gn_coherent
* @return 0 on success, non-zero otherwise
*/
-__api int gn_coherent(
- double* out, ///< [out] Output pointer
- size_t nfft, ///< [in] FFT size
- double fs, ///< [in] Sample rate (S/s)
- double freq ///< [in] Desired frequency (Hz)
- );
+__api int gn_coherent(double *out, ///< [out] Output pointer
+ size_t nfft, ///< [in] FFT size
+ double fs, ///< [in] Sample rate (S/s)
+ double freq ///< [in] Desired frequency (Hz)
+);
/**
* @brief gn_fftshift
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fftshift(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size ///< [in] Input array size
- );
+__api int gn_fftshift(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size ///< [in] Input array size
+);
/**
* @brief gn_freq_axis
* @return 0 on success, non-zero otherwise
*/
-__api int gn_freq_axis(
- double* out, ///< [out] Array pointer
- size_t size, ///< [in] Array size
- size_t nfft, ///< [in] FFT size
- GnFreqAxisType axis_type, ///< [in] Frequency axis type
- double fs, ///< [in] Sample rate (S/s)
- GnFreqAxisFormat axis_format ///< [in] Frequency axis format
- );
+__api int
+gn_freq_axis(double *out, ///< [out] Array pointer
+ size_t size, ///< [in] Array size
+ size_t nfft, ///< [in] FFT size
+ GnFreqAxisType axis_type, ///< [in] Frequency axis type
+ double fs, ///< [in] Sample rate (S/s)
+ GnFreqAxisFormat axis_format ///< [in] Frequency axis format
+);
/**
* @brief gn_ifftshift
* @return 0 on success, non-zero otherwise
*/
-__api int gn_ifftshift(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size ///< [in] Input array size
- );
+__api int gn_ifftshift(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size ///< [in] Input array size
+);
/**
* \defgroup FourierUtilityHelpers Helpers
@@ -1352,11 +1316,11 @@ __api int gn_ifftshift(
* @brief gn_freq_axis_size
* @return 0 on success, non-zero otherwise
*/
-__api int gn_freq_axis_size(
- size_t* size, ///< [out] Output array size
- size_t nfft, ///< [in] FFT size
- GnFreqAxisType axis_type ///< [in] Frequency axis type
- );
+__api int
+gn_freq_axis_size(size_t *size, ///< [out] Output array size
+ size_t nfft, ///< [in] FFT size
+ GnFreqAxisType axis_type ///< [in] Frequency axis type
+);
/** @} FourierUtilityHelpers */
@@ -1387,67 +1351,63 @@ __api int gn_mgr_clear();
* @return 0 on success, non-zero otherwise
*/
__api int gn_mgr_compare(
- bool* result, ///< [out] true if the objects are equal, false otherwise
- const char* obj_key1, ///< [in] Object key 1
- const char* obj_key2 ///< [in] Object key 2
- );
+ bool *result, ///< [out] true if the objects are equal, false otherwise
+ const char *obj_key1, ///< [in] Object key 1
+ const char *obj_key2 ///< [in] Object key 2
+);
/**
* @brief gn_mgr_contains
* @return Always returns 0
*/
__api int gn_mgr_contains(
- bool* result, ///< [out] true if Manager contains key, false otherwise
- const char* obj_key ///< [in] Object key
- );
+ bool *result, ///< [out] true if Manager contains key, false otherwise
+ const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_mgr_remove
* @return Always returns 0
*/
-__api int gn_mgr_remove(
- const char* obj_key ///< [in] Object key
- );
+__api int gn_mgr_remove(const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_mgr_save
* @return 0 on success, non-zero otherwise
* @details If filename is empty, the filename is derived from obj_key.
*/
-__api int gn_mgr_save(
- char* buf, ///< [out] Pointer to character array
- size_t size, ///< [in] Size of character array
- const char* obj_key, ///< [in] Object key
- const char* filename ///< [in] Filename
- );
+__api int gn_mgr_save(char *buf, ///< [out] Pointer to character array
+ size_t size, ///< [in] Size of character array
+ const char *obj_key, ///< [in] Object key
+ const char *filename ///< [in] Filename
+);
/**
* @brief gn_mgr_size
* @return Always returns 0
*/
-__api int gn_mgr_size(
- size_t* size ///< [out] Number of objects owned by the manager
- );
+__api int
+gn_mgr_size(size_t *size ///< [out] Number of objects owned by the manager
+);
/**
* @brief gn_mgr_to_string
* @return 0 on success, non-zero otherwise
*/
-__api int gn_mgr_to_string(
- char* buf, ///< [out] Pointer to character array
- size_t size, ///< [in] Size of character array
- const char* obj_key ///< [in] Object key
- );
+__api int gn_mgr_to_string(char *buf, ///< [out] Pointer to character array
+ size_t size, ///< [in] Size of character array
+ const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_mgr_type
* @return 0 on success, non-zero otherwise
*/
-__api int gn_mgr_type(
- char* buf, ///< [out] Pointer to character array
- size_t size, ///< [in] Size of character array
- const char* obj_key ///< [in] Object key
- );
+__api int gn_mgr_type(char *buf, ///< [out] Pointer to character array
+ size_t size, ///< [in] Size of character array
+ const char *obj_key ///< [in] Object key
+);
/**
* \defgroup ManagerHelpers Helpers
@@ -1457,36 +1417,36 @@ __api int gn_mgr_type(
/**
* @brief gn_mgr_save_filename_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
__api int gn_mgr_save_filename_size(
- size_t* size, ///< [out] Number of characters in filename
- const char* obj_key, ///< [in] Object key
- const char* filename ///< [in] Filename
- );
+ size_t *size, ///< [out] Number of characters in filename
+ const char *obj_key, ///< [in] Object key
+ const char *filename ///< [in] Filename
+);
/**
* @brief gn_mgr_to_string_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
__api int gn_mgr_to_string_size(
- size_t* size, ///< [out] Number of characters in the string
- const char* obj_key ///< [in] Object key
- );
+ size_t *size, ///< [out] Number of characters in the string
+ const char *obj_key ///< [in] Object key
+);
/**
* @brief gn_mgr_type_size
* @return 0 on success, non-zero otherwise
- * @details The library string termination setting determines whether or not a null terminator
- * is included in the size. See \ref gn_set_string_termination.
+ * @details The library string termination setting determines whether or not a
+ * null terminator is included in the size. See \ref gn_set_string_termination.
*/
__api int gn_mgr_type_size(
- size_t* size, ///< [out] Number of characters in object type string
- const char* obj_key ///< [in] Object key
- );
+ size_t *size, ///< [out] Number of characters in object type string
+ const char *obj_key ///< [in] Object key
+);
/** @} ManagerHelpers */
@@ -1510,215 +1470,204 @@ extern "C" {
* @brief gn_downsample
* @return 0 on success, non-zero otherwise
*/
-__api int gn_downsample(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int ratio, ///< [in] Downsample ratio
- bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
- );
+__api int
+gn_downsample(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int ratio, ///< [in] Downsample ratio
+ bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
+);
/**
* @brief gn_downsample16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_downsample16(
- int16_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int16_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int ratio, ///< [in] Downsample ratio
- bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
- );
+__api int
+gn_downsample16(int16_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int16_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int ratio, ///< [in] Downsample ratio
+ bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
+);
/**
* @brief gn_downsample32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_downsample32(
- int32_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int32_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int ratio, ///< [in] Downsample ratio
- bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
- );
+__api int
+gn_downsample32(int32_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int32_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int ratio, ///< [in] Downsample ratio
+ bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
+);
/**
* @brief gn_downsample64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_downsample64(
- int64_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int64_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int ratio, ///< [in] Downsample ratio
- bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
- );
+__api int
+gn_downsample64(int64_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int64_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int ratio, ///< [in] Downsample ratio
+ bool interleaved ///< [in] If true, 'in' is interleaved I/Q data
+);
/**
* @brief gn_fshift
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fshift(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const double* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- double fs, ///< [in] Sample rate
- double fshift ///< [in] Shift frequency
- );
+__api int gn_fshift(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const double *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ double fs, ///< [in] Sample rate
+ double fshift ///< [in] Shift frequency
+);
/**
* @brief gn_fshift16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fshift16(
- int16_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int16_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int16_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Code width
- double fs, ///< [in] Sample rate
- double fshift, ///< [in] Shift frequency
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_fshift16(int16_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int16_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int16_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Code width
+ double fs, ///< [in] Sample rate
+ double fshift, ///< [in] Shift frequency
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_fshift32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fshift32(
- int32_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int32_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int32_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Code width
- double fs, ///< [in] Sample rate
- double fshift, ///< [in] Shift frequency
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_fshift32(int32_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int32_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int32_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Code width
+ double fs, ///< [in] Sample rate
+ double fshift, ///< [in] Shift frequency
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_fshift64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fshift64(
- int64_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int64_t* i, ///< [in] In-phase input array pointer
- size_t i_size, ///< [in] In-phase input array size
- const int64_t* q, ///< [in] Quadrature input array pointer
- size_t q_size, ///< [in] Quadrature input array size
- int n, ///< [in] Code width
- double fs, ///< [in] Sample rate
- double fshift, ///< [in] Shift frequency
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_fshift64(int64_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int64_t *i, ///< [in] In-phase input array pointer
+ size_t i_size, ///< [in] In-phase input array size
+ const int64_t *q, ///< [in] Quadrature input array pointer
+ size_t q_size, ///< [in] Quadrature input array size
+ int n, ///< [in] Code width
+ double fs, ///< [in] Sample rate
+ double fshift, ///< [in] Shift frequency
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_normalize16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_normalize16(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int16_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_normalize16(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int16_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_normalize32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_normalize32(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int32_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_normalize32(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int32_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_normalize64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_normalize64(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const int64_t* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- int n, ///< [in] Resolution
- GnCodeFormat format ///< [in] Code format
- );
+__api int gn_normalize64(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const int64_t *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ int n, ///< [in] Resolution
+ GnCodeFormat format ///< [in] Code format
+);
/**
* @brief gn_polyval
* @return 0 on success, non-zero otherwise
*/
-__api int gn_polyval(
- double* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- const double* c, ///< [in] Coefficient array pointer
- size_t c_size ///< [in] Coefficient array size
- );
+__api int gn_polyval(double *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ const double *c, ///< [in] Coefficient array pointer
+ size_t c_size ///< [in] Coefficient array size
+);
/**
* @brief gn_quantize16
* @return 0 on success, non-zero otherwise
*/
-__api int gn_quantize16(
- int16_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- double fsr, ///< [in] Full-scale range
- int n, ///< [in] Resolution
- double noise, ///< [in] Input referred RMS noise
- GnCodeFormat format ///< [in] Code format
+__api int gn_quantize16(int16_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ double fsr, ///< [in] Full-scale range
+ int n, ///< [in] Resolution
+ double noise, ///< [in] Input referred RMS noise
+ GnCodeFormat format ///< [in] Code format
);
/**
* @brief gn_quantize32
* @return 0 on success, non-zero otherwise
*/
-__api int gn_quantize32(
- int32_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- double fsr, ///< [in] Full-scale range
- int n, ///< [in] Resolution
- double noise, ///< [in] Input referred RMS noise
- GnCodeFormat format ///< [in] Code format
+__api int gn_quantize32(int32_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ double fsr, ///< [in] Full-scale range
+ int n, ///< [in] Resolution
+ double noise, ///< [in] Input referred RMS noise
+ GnCodeFormat format ///< [in] Code format
);
/**
* @brief gn_quantize64
* @return 0 on success, non-zero otherwise
*/
-__api int gn_quantize64(
- int64_t* out, ///< [out] Output array pointer
- size_t out_size, ///< [in] Output array size
- const double* in, ///< [in] Input array pointer
- size_t in_size, ///< [in] Input array size
- double fsr, ///< [in] Full-scale range
- int n, ///< [in] Resolution
- double noise, ///< [in] Input referred RMS noise
- GnCodeFormat format ///< [in] Code format
+__api int gn_quantize64(int64_t *out, ///< [out] Output array pointer
+ size_t out_size, ///< [in] Output array size
+ const double *in, ///< [in] Input array pointer
+ size_t in_size, ///< [in] Input array size
+ double fsr, ///< [in] Full-scale range
+ int n, ///< [in] Resolution
+ double noise, ///< [in] Input referred RMS noise
+ GnCodeFormat format ///< [in] Code format
);
/**
@@ -1731,21 +1680,20 @@ __api int gn_quantize64(
* @return 0 on success, non-zero otherwise
*/
__api int gn_downsample_size(
- size_t* out_size, ///< [out] Output array size
- size_t in_size, ///< [in] Input array size
- int ratio, ///< [in] Downsample ratio
- bool interleaved ///< [in] If bool, 'in' is interleaved I/Q data
- );
+ size_t *out_size, ///< [out] Output array size
+ size_t in_size, ///< [in] Input array size
+ int ratio, ///< [in] Downsample ratio
+ bool interleaved ///< [in] If bool, 'in' is interleaved I/Q data
+);
/**
* @brief gn_fshift_size
* @return 0 on success, non-zero otherwise
*/
-__api int gn_fshift_size(
- size_t* out_size, ///< [out] Output array size
- size_t i_size, ///< [in] In-phase input array size
- size_t q_size ///< [in] Quadrature input array size
- );
+__api int gn_fshift_size(size_t *out_size, ///< [out] Output array size
+ size_t i_size, ///< [in] In-phase input array size
+ size_t q_size ///< [in] Quadrature input array size
+);
/** @} SignalProcessingHelpers */
@@ -1769,59 +1717,56 @@ extern "C" {
* @brief gn_cos
* @return 0 on success, non-zero otherwise
*/
-__api int gn_cos(
- double* out, ///< [out] Array pointer
- size_t size, ///< [in] Array size
- double fs, ///< [in] Sample rate (S/s)
- double ampl, ///< [in] Amplitude
- double freq, ///< [in] Frequency (Hz)
- double phase, ///< [in] Phase (rad)
- double td, ///< [in] Time delay (s)
- double tj ///< [in] RMS Aperture jitter (s)
- );
+__api int gn_cos(double *out, ///< [out] Array pointer
+ size_t size, ///< [in] Array size
+ double fs, ///< [in] Sample rate (S/s)
+ double ampl, ///< [in] Amplitude
+ double freq, ///< [in] Frequency (Hz)
+ double phase, ///< [in] Phase (rad)
+ double td, ///< [in] Time delay (s)
+ double tj ///< [in] RMS Aperture jitter (s)
+);
/**
* @brief gn_gaussian
* @return 0 on success, non-zero otherwise
*/
-__api int gn_gaussian(
- double* out, ///< [out] Array pointer
- size_t size, ///< [in] Array size
- double mean, ///< [in] Mean
- double sd ///< [in] Standard deviation
- );
+__api int gn_gaussian(double *out, ///< [out] Array pointer
+ size_t size, ///< [in] Array size
+ double mean, ///< [in] Mean
+ double sd ///< [in] Standard deviation
+);
/**
* @brief gn_ramp
* @return 0 on success, non-zero otherwise
*/
-__api int gn_ramp(
- double* out, ///< [out] Array pointer
- size_t size, ///< [in] Array size
- double start, ///< [in] Start value
- double stop, ///< [in] Stop value
- double noise ///< [in] RMS noise
- );
+__api int gn_ramp(double *out, ///< [out] Array pointer
+ size_t size, ///< [in] Array size
+ double start, ///< [in] Start value
+ double stop, ///< [in] Stop value
+ double noise ///< [in] RMS noise
+);
/**
* @brief gn_sin
* @return 0 on success, non-zero otherwise
*/
-__api int gn_sin(
- double* out, ///< [out] Array pointer
- size_t size, ///< [in] Array size
- double fs, ///< [in] Sample rate (S/s)
- double ampl, ///< [in] Amplitude
- double freq, ///< [in] Frequency (Hz)
- double phase, ///< [in] Phase (rad)
- double td, ///< [in] Time delay (s)
- double tjrms ///< [in] RMS Aperture jitter (s)
- );
+__api int gn_sin(double *out, ///< [out] Array pointer
+ size_t size, ///< [in] Array size
+ double fs, ///< [in] Sample rate (S/s)
+ double ampl, ///< [in] Amplitude
+ double freq, ///< [in] Frequency (Hz)
+ double phase, ///< [in] Phase (rad)
+ double td, ///< [in] Time delay (s)
+ double tjrms ///< [in] RMS Aperture jitter (s)
+);
/**
* @brief gn_wf_analysis
* @return 0 on success, non-zero otherwise
- * @details The results contain the following key-value pairs (see general description of
+ * @details The results contain the following key-value pairs (see general
+ * description of
* \ref AnalysisRoutines "Analysis Routines").
*