AHP® XC Correlators API
AHP XC Correlators
Functions
Features of the correlator

Functions

DLL_EXPORT int32_t ahp_xc_get_properties (void)
 Probe for a correlator and take its properties. More...
 
DLL_EXPORT char * ahp_xc_get_header (void)
 Obtain the correlator header. More...
 
DLL_EXPORT uint32_t ahp_xc_get_bps (void)
 Obtain the correlator bits per sample. More...
 
DLL_EXPORT uint32_t ahp_xc_get_nlines (void)
 Obtain the correlator number of lines. More...
 
DLL_EXPORT uint32_t ahp_xc_get_nbaselines (void)
 Obtain the correlator total baselines. More...
 
DLL_EXPORT int32_t ahp_xc_get_crosscorrelation_index (int32_t *lines, int32_t order)
 Return the cross-correlation index of the baseprism correlating the lines array. More...
 
DLL_EXPORT int32_t ahp_xc_get_line_index (int32_t idx, int32_t order)
 Return the cross-correlation index of the baseprism correlating the lines array. More...
 
DLL_EXPORT uint32_t ahp_xc_get_nbaseprisms (int32_t order)
 Obtain the correlator total baseprisms for arbitrary degree of coherence orders. More...
 
DLL_EXPORT uint32_t ahp_xc_get_delaysize (void)
 Obtain the correlator maximum delay value. More...
 
DLL_EXPORT uint32_t ahp_xc_get_autocorrelator_lagsize (void)
 Obtain the correlator lag buffer size for autocorrelations. More...
 
DLL_EXPORT uint32_t ahp_xc_get_crosscorrelator_lagsize (void)
 Obtain the correlator lag buffer size for crosscorrelations. More...
 
DLL_EXPORT double ahp_xc_get_frequency (void)
 Obtain the correlator maximum readout frequency. More...
 
DLL_EXPORT double ahp_xc_get_sampletime (void)
 Obtain the sampling time. More...
 
DLL_EXPORT double ahp_xc_get_packettime (void)
 Obtain the serial packet transmission time. More...
 
DLL_EXPORT uint32_t ahp_xc_get_packetsize (void)
 Obtain the serial packet size. More...
 
DLL_EXPORT void ahp_xc_enable_intensity_crosscorrelator (int32_t enable)
 Enable the intensity cross-correlation feature. More...
 
DLL_EXPORT int32_t ahp_xc_intensity_crosscorrelator_enabled ()
 Return non-zero if intensity crosscorrelation was enabled. More...
 
DLL_EXPORT void ahp_xc_enable_crosscorrelator (int32_t enable)
 Enable the cross-correlation capability of the device. More...
 
DLL_EXPORT int32_t ahp_xc_has_crosscorrelator (void)
 Returns the cross-correlation capability of the device. More...
 
DLL_EXPORT int32_t ahp_xc_has_psu (void)
 Returns if the device offers internal PSU line. More...
 
DLL_EXPORT int32_t ahp_xc_has_leds (void)
 Returns if the device has led lines to drive. More...
 
DLL_EXPORT int32_t ahp_xc_has_cumulative_only ()
 Returns if the device has cumulative correlators only. More...
 

Detailed Description

Function Documentation

◆ ahp_xc_enable_crosscorrelator()

DLL_EXPORT void ahp_xc_enable_crosscorrelator ( int32_t  enable)
Parameters
enableset to non-zero to enable the crosscorrelator

◆ ahp_xc_enable_intensity_crosscorrelator()

DLL_EXPORT void ahp_xc_enable_intensity_crosscorrelator ( int32_t  enable)
Parameters
enableset to non-zero to enable the intensity crosscorrelator

◆ ahp_xc_get_autocorrelator_lagsize()

DLL_EXPORT uint32_t ahp_xc_get_autocorrelator_lagsize ( void  )
Returns
Returns the lag size

◆ ahp_xc_get_bps()

DLL_EXPORT uint32_t ahp_xc_get_bps ( void  )
Returns
Returns the bits per sample value

◆ ahp_xc_get_crosscorrelation_index()

DLL_EXPORT int32_t ahp_xc_get_crosscorrelation_index ( int32_t *  lines,
int32_t  order 
)
Parameters
linesThe line indexes array
orderThe crosscorrelation order and size of the lines array
Returns
Returns the corresponding cross-correlation index

◆ ahp_xc_get_crosscorrelator_lagsize()

DLL_EXPORT uint32_t ahp_xc_get_crosscorrelator_lagsize ( void  )
Returns
Returns the lag size

◆ ahp_xc_get_delaysize()

DLL_EXPORT uint32_t ahp_xc_get_delaysize ( void  )
Returns
Returns the delay size

◆ ahp_xc_get_frequency()

DLL_EXPORT double ahp_xc_get_frequency ( void  )
Returns
Returns the maximum readout frequency

◆ ahp_xc_get_header()

DLL_EXPORT char* ahp_xc_get_header ( void  )
Returns
Returns a string representing the correlator ID

◆ ahp_xc_get_line_index()

DLL_EXPORT int32_t ahp_xc_get_line_index ( int32_t  idx,
int32_t  order 
)
Parameters
idxThe crosscorrelation indexes
orderThe crosscorrelation order
Returns
Returns the line index

◆ ahp_xc_get_nbaselines()

DLL_EXPORT uint32_t ahp_xc_get_nbaselines ( void  )
Returns
Returns the baselines quantity

◆ ahp_xc_get_nbaseprisms()

DLL_EXPORT uint32_t ahp_xc_get_nbaseprisms ( int32_t  order)
Parameters
orderThe degree of coherence order
Returns
Returns the baselines quantity

◆ ahp_xc_get_nlines()

DLL_EXPORT uint32_t ahp_xc_get_nlines ( void  )
Returns
Returns the number of lines

◆ ahp_xc_get_packetsize()

DLL_EXPORT uint32_t ahp_xc_get_packetsize ( void  )
Returns
Returns the packet size in bytes

◆ ahp_xc_get_packettime()

DLL_EXPORT double ahp_xc_get_packettime ( void  )
Returns
Returns the packet transmission time in seconds

◆ ahp_xc_get_properties()

DLL_EXPORT int32_t ahp_xc_get_properties ( void  )
Returns
Returns non-zero on failure

◆ ahp_xc_get_sampletime()

DLL_EXPORT double ahp_xc_get_sampletime ( void  )
Returns
Returns the sampling time in seconds

◆ ahp_xc_has_crosscorrelator()

DLL_EXPORT int32_t ahp_xc_has_crosscorrelator ( void  )
Returns
Returns non-zero if the device is a crosscorrelator

◆ ahp_xc_has_cumulative_only()

DLL_EXPORT int32_t ahp_xc_has_cumulative_only ( )
Returns
Returns non-zero if the device is a cumulative correlator only

◆ ahp_xc_has_leds()

DLL_EXPORT int32_t ahp_xc_has_leds ( void  )
Returns
Returns non-zero if leds are available

◆ ahp_xc_has_psu()

DLL_EXPORT int32_t ahp_xc_has_psu ( void  )
Returns
Returns non-zero if PSU is available

◆ ahp_xc_intensity_crosscorrelator_enabled()

DLL_EXPORT int32_t ahp_xc_intensity_crosscorrelator_enabled ( )
Returns
Returns non-zero if intensity crosscorrelation was enabled