Configuration¶

After a TimeTagger4 device has been initialized (see Initialization), it must be configured before it can acquire data.

To configure a TimeTagger4 device:

Get a default set of configuration parameters using timetagger4_get_default_configuration().
Change parameters of timetagger4_configuration according to your specific requirements.
Configure the TimeTagger4 device using timetagger4_configure().

The following example shows a basic configuration of an already initialized TimeTagger4 device using the default configuration parameters. A complete coding example can be found on github.com/cronologic-de/xtdc_babel or in Section Code Example.

// get a default set of configuration parameters
timetagger4_configuration config;
status = timetagger4_get_default_configuration(device, &config);
if (status != TIMETAGGER4_OK) { /* handle error */ }

// configure the device
status = timetagger4_configure(device, &config);
if (status != TIMETAGGER4_OK) { /* handle error */ }

timetagger4_configure¶

int timetagger4_configure(timetagger4_device *device, timetagger4_configuration *config)¶

Configures a TimeTagger4 device.

Parameters:

device – Pointer to a TimeTagger4 device.
config – Pointer to a timetagger4_configuration struct used for the configuration.

Returns:

Status code: TIMETAGGER4_OK, TIMETAGGER4_INVALID_DEVICE, TIMETAGGER4_HARDWARE_FAILURE, or TIMETAGGER4_INVALID_CONFIG_PARAMETERS.

timetagger4_get_default_configuration¶

int timetagger4_get_default_configuration(timetagger4_device *device, timetagger4_configuration *config)¶

Obtain a default set of configuration parameters.

Parameters:

device – Pointer to a TimeTagger4 device.
config – Pointer to a timetagger4_configuration struct that will be filled.

Returns:

Status code: TIMETAGGER4_OK, TIMETAGGER4_INVALID_DEVICE, or TIMETAGGER4_CRONO_INVALID_ARGUMENTS.

timetagger4_get_current_configuration¶

int timetagger4_get_current_configuration(timetagger4_device *device, timetagger4_configuration *config)¶

Obtain the current set of configuration parameters of an already configured TimeTagger4 device.

Parameters:

device – Pointer to a configured TimeTagger4 device.
config – Pointer to a timetagger4_configuration struct that will be filled.

Returns:

Status code: TIMETAGGER4_OK, or TIMETAGGER4_INVALID_DEVICE.

timetagger4_configuration¶

struct timetagger4_configuration¶

This struct is used to configure a TimeTagger4 device using timetagger4_configure().

int size¶: The number of bytes this struct occupies.

int version¶: Version number of this struct. It is increased when the definition of the struct changes.

int tdc_mode¶

Operational mode of the TDC.

Must be one of the following:

TIMETAGGER4_TDC_MODE_GROUPED¶

Operate in grouped mode.

Classical Common-Start operation. See also Grouping and Events.

TIMETAGGER4_TDC_MODE_CONTINUOUS¶

Operate in continuous mode. Only available for Gen 2.

timetagger4_trigger¶

struct timetagger4_trigger¶

Configure if rising or falling or both edges create a trigger event for timetagger4_tiger_block.

crono_bool_t falling¶: Falling edges will trigger an event.

crono_bool_t rising¶: Rising edges will trigger an event.

timetagger4_tiger_block¶

struct timetagger4_tiger_block¶

This struct configures the Timing Generators [see also Timing Generators (TiGer)].

crono_bool_t enable¶: Activates the TiGer.

Note

To use a TiGer, make sure to also set enable_lemo_output to true.

crono_bool_t negate¶

Inverts the output polarity.

Default is false.

crono_bool_t retrigger¶

Enables re-triggering.

If re-triggering is enabled, the following applies: After an event triggered the TiGer output, another event that is detected before the stop value is reached will extend the TiGer output for a time stop minus start.

crono_bool_t extend¶: Not applicable for the TimeTagger4.

crono_bool_t enable_lemo_output¶

Enables the LEMO output.

Drive the TiGer signal to the corresponding LEMO connector as an output.

Pulses created by the TiGer are visible at the corresponding input and can be used to get their exact timing.

Attention

The output is DC coupled. Make sure to not connect any devices to the corresponding input, as this may damage the device or the TimeTagger4.

uint_32_t start¶

Configure the duration when the TiGer output is enabled relative to the trigger.

timetagger4_channel¶

struct timetagger4_channel¶

crono_bool_t enabled¶: Enable the TDC channel.

crono_bool_t rising¶

Not applicable for the TimeTagger4.

Rising and/or falling edges are configured using timetagger4_trigger.

uint32_t start¶

Start value for the grouping functionality.

In multiples of timetagger4_param_info.binsize.

See also stop and Grouping and Events.

uint32_t stop¶

Stop value for the grouping functionality.

In multiples of timetagger4_param_info.binsize.

Only hits between start and stop are read out.

For Gen 1, the range is 0 ≤ start ≤ stop ≤ 2³¹.

For Gen 2, the range is 0 ≤ start ≤ stop ≤ 2³².

timetagger4_delay_config¶

struct timetagger4_delay_config¶

Only available for TimeTagger4 Gen 2.

uint32_t delay¶

Delay the corresponding input channel.

In units of timetagger4_static_info.delay_bin_size.

The range is 0 \(\le\) delay \(\le\) 1023.