AHP® XC Correlators API
AHP XC Correlators
|
Functions | |
DLL_EXPORT ahp_xc_packet * | ahp_xc_alloc_packet (void) |
Allocate and return a packet structure. More... | |
DLL_EXPORT ahp_xc_packet * | ahp_xc_copy_packet (ahp_xc_packet *packet) |
Allocate and return a copy of a packet structure. More... | |
DLL_EXPORT void | ahp_xc_free_packet (ahp_xc_packet *packet) |
Free a previously allocated packet structure. More... | |
DLL_EXPORT ahp_xc_sample * | ahp_xc_alloc_samples (uint64_t nlines, size_t size) |
Allocate and return a samples array. More... | |
DLL_EXPORT ahp_xc_sample * | ahp_xc_copy_samples (ahp_xc_sample *src, uint64_t nlines, size_t size) |
Allocate and return a copy of the passed samples array. More... | |
DLL_EXPORT void | ahp_xc_free_samples (uint64_t nlines, ahp_xc_sample *samples) |
Free a previously allocated samples array. More... | |
DLL_EXPORT int32_t | ahp_xc_get_packet (ahp_xc_packet *packet) |
Grab a data packet. More... | |
DLL_EXPORT void | ahp_xc_start_autocorrelation_scan (uint32_t index) |
Initiate an autocorrelation scan. More... | |
DLL_EXPORT void | ahp_xc_end_autocorrelation_scan (uint32_t index) |
End an autocorrelation scan. More... | |
DLL_EXPORT int32_t | ahp_xc_scan_autocorrelations (ahp_xc_scan_request *lines, uint32_t nlines, ahp_xc_sample **autocorrelations, int32_t *interrupt, double *percent) |
Scan all available delay channels and get autocorrelations of each input. More... | |
DLL_EXPORT void | ahp_xc_start_crosscorrelation_scan (uint32_t index) |
Initiate a crosscorrelation scan. More... | |
DLL_EXPORT void | ahp_xc_end_crosscorrelation_scan (uint32_t index) |
End a crosscorrelation scan. More... | |
DLL_EXPORT int32_t | ahp_xc_scan_crosscorrelations (ahp_xc_scan_request *lines, uint32_t nlines, ahp_xc_sample **crosscorrelations, int32_t *interrupt, double *percent) |
Scan all available delay channels and get crosscorrelations of each input with others. More... | |
DLL_EXPORT ahp_xc_packet* ahp_xc_alloc_packet | ( | void | ) |
DLL_EXPORT ahp_xc_sample* ahp_xc_alloc_samples | ( | uint64_t | nlines, |
size_t | size | ||
) |
nlines | The Number of samples to be allocated. |
len | The lag_size and correlations field size of each sample. |
DLL_EXPORT ahp_xc_packet* ahp_xc_copy_packet | ( | ahp_xc_packet * | packet | ) |
DLL_EXPORT ahp_xc_sample* ahp_xc_copy_samples | ( | ahp_xc_sample * | src, |
uint64_t | nlines, | ||
size_t | size | ||
) |
src | The source samples array. |
nlines | The Number of samples to be allocated. |
len | The lag_size and correlations field size of each sample. |
DLL_EXPORT void ahp_xc_end_autocorrelation_scan | ( | uint32_t | index | ) |
index | The line index. |
DLL_EXPORT void ahp_xc_end_crosscorrelation_scan | ( | uint32_t | index | ) |
index | The line index. |
DLL_EXPORT void ahp_xc_free_packet | ( | ahp_xc_packet * | packet | ) |
packet | pointer to the ahp_xc_packet structure to be freed |
DLL_EXPORT void ahp_xc_free_samples | ( | uint64_t | nlines, |
ahp_xc_sample * | samples | ||
) |
nlines | The Number of samples to be allocated. |
samples | the ahp_xc_sample array to be freed |
DLL_EXPORT int32_t ahp_xc_get_packet | ( | ahp_xc_packet * | packet | ) |
packet | The ahp_xc_packet structure to be filled. |
DLL_EXPORT int32_t ahp_xc_scan_autocorrelations | ( | ahp_xc_scan_request * | lines, |
uint32_t | nlines, | ||
ahp_xc_sample ** | autocorrelations, | ||
int32_t * | interrupt, | ||
double * | percent | ||
) |
lines | the input lines structure array. |
nlines | the element size of the input lines array. |
autocorrelations | An ahp_xc_sample array pointer, can be NULL. Will be allocated by reference and filled by this function. |
interrupt | This should point32_t to an int32_t variable, when setting to 1, on a separate thread, scanning will be interrupted. |
percent | Like interrupt a variable, passed by reference that will be updated with the percent of completion. |
DLL_EXPORT int32_t ahp_xc_scan_crosscorrelations | ( | ahp_xc_scan_request * | lines, |
uint32_t | nlines, | ||
ahp_xc_sample ** | crosscorrelations, | ||
int32_t * | interrupt, | ||
double * | percent | ||
) |
lines | the input lines structure array. |
nlines | the element size of the input lines array. |
crosscorrelations | An ahp_xc_sample array pointer, can be NULL. Will be allocated by reference and filled by this function. |
interrupt | This should point32_t to an int32_t variable, when setting to 1, on a separate thread, scanning will be interrupted. |
percent | Like interrupt a variable, passed by reference that will be updated with the percent of completion. |
DLL_EXPORT void ahp_xc_start_autocorrelation_scan | ( | uint32_t | index | ) |
index | The line index. |
DLL_EXPORT void ahp_xc_start_crosscorrelation_scan | ( | uint32_t | index | ) |
index | The line index. |