Functions

API that allows unconventional modes of operation.

Functions

int xsp3_set_data_buffer (int path, int chan, u_int32_t *buffer, u_int32_t bufsiz)
 Set the location of the histogram buffer and buffer size in the xspress3 system.
int xsp3_set_data_module (int path, int chan, MOD_IMAGE *module, u_int32_t *buffer, u_int32_t bufsiz)
 Set the location of the data module, histogram buffer and buffer size in the xspress3 system.
MOD_IMAGE * xsp3_get_data_module (int path, int chan)
 Get a pointer to the data module in which the histogram data is stored for a particular channel.

Function Documentation

MOD_IMAGE* xsp3_get_data_module ( int  path,
int  chan 
)

Get a pointer to the data module in which the histogram data is stored for a particular channel.

Parameters:
path a handle to the top level of the xspress3 system returned from xsp3_config().
chan is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1)
Returns:
a pointer to the data module or NULL.
int xsp3_set_data_buffer ( int  path,
int  chan,
u_int32_t *  buffer,
u_int32_t  bufsiz 
)

Set the location of the histogram buffer and buffer size in the xspress3 system.

This is provided if the default shared memory buffers are not th be used, which will be difficult to implement. This buffer should be present before initialising the histogramming threads and remain in context until after the threads have been terminated.

Parameters:
path a handle to the top level of the xspress3 system returned from xsp3_config().
chan is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1)
buffer a longword pointer to the location of the buffer
bufsiz the size of the buffer
Returns:
XSP3_OK or a negative error code.
int xsp3_set_data_module ( int  path,
int  chan,
MOD_IMAGE *  module,
u_int32_t *  buffer,
u_int32_t  bufsiz 
)

Set the location of the data module, histogram buffer and buffer size in the xspress3 system.

This data module should be present before initialising the histogramming threads and remain in context until after the threads have been terminated.

Parameters:
path a handle to the top level of the xspress3 system returned from xsp3_config().
chan is the number of the channel in the xspress3 system, 0 to (xsp3_get_num_chan() - 1)
module a pointer to the data module
buffer a pointer to the data buffer within the data module
bufsiz the size of the buffer
Returns:
XSP3_OK or a negative error code.