CAEN MCA  0.99.10
SDK for Hexagon
Data mask: Lists

Information about the list mode. Some data is read only. More...

+ Collaboration diagram for Data mask: Lists:

Modules

 Data mask: Lists (type of data)
 Bits provided by DATAMASK_LIST_FILE_DATAMASK.
 
 Data mask: Lists (event flags)
 Bits provided by DATAMASK_LIST_DATA_FLAGS_DATAMASK. Copied from CAENDPPLayerTypes.h.
 

Macros

#define DATAMASK_LIST_ENABLE   UINT64_C(0x1)
 List enabled. Boolean. More...
 
#define DATAMASK_LIST_SAVEMODE   UINT64_C(0x2)
 Current List mode. More...
 
#define DATAMASK_LIST_FILENAME   UINT64_C(0x4)
 In case of ASCII-Binary mode: remote file name used. More...
 
#define DATAMASK_LIST_FILE_DATAMASK   UINT64_C(0x8)
 Data to save. More...
 
#define DATAMASK_LIST_GETFAKEEVTS   UINT64_C(0x10)
 Get also fake events. Boolean. More...
 
#define DATAMASK_LIST_MAXNEVTS   UINT64_C(0x20)
 In case of memory mode: max number of events to get in case of memory mode. Must be < LISTS_DATA_MAXLEN. More...
 
#define DATAMASK_LIST_NEVTS   UINT64_C(0x40)
 Number of events in the data. More...
 
#define DATAMASK_LIST_DATA_TIMETAG   UINT64_C(0x80)
 Timetags of the events in picoseconds since acquisition start. More...
 
#define DATAMASK_LIST_DATA_ENERGY   UINT64_C(0x100)
 Energies of the events in bins. More...
 
#define DATAMASK_LIST_DATA_FLAGS_DATAMASK   UINT64_C(0x200)
 Flags of the events. More...
 
#define DATAMASK_LIST_GETSATEVTS   UINT64_C(0x400)
 Get also saturated events. Boolean. More...
 
#define DATAMASK_LIST_GETSKIMEVTS   UINT64_C(0x800)
 Get also energy skim events (whose energy is outside the spectrum [LLD,ULD] interval). Boolean. More...
 

Detailed Description

Information about the list mode. Some data is read only.

See also
CAEN_MCA_DATA_LIST_MODE

Macro Definition Documentation

◆ DATAMASK_LIST_ENABLE

#define DATAMASK_LIST_ENABLE   UINT64_C(0x1)

List enabled. Boolean.

Note
Required argument: uint32_t
Access type: read/write
Examples:
examples_lists.c.

Definition at line 613 of file CAENMCATypes.h.

◆ DATAMASK_LIST_SAVEMODE

#define DATAMASK_LIST_SAVEMODE   UINT64_C(0x2)

Current List mode.

Note
Required argument: int32_t
Access type: read/write
See also
CAEN_MCA_ListSaveMode_t
Examples:
examples_lists.c.

Definition at line 614 of file CAENMCATypes.h.

◆ DATAMASK_LIST_FILENAME

#define DATAMASK_LIST_FILENAME   UINT64_C(0x4)

In case of ASCII-Binary mode: remote file name used.

Note
Required argument: char*
Maximum size: LISTS_FULLPATH_MAXLEN
Access type: read/write
Examples:
examples_lists.c.

Definition at line 615 of file CAENMCATypes.h.

◆ DATAMASK_LIST_FILE_DATAMASK

#define DATAMASK_LIST_FILE_DATAMASK   UINT64_C(0x8)

Data to save.

Note
Required argument: uint32_t
Access type: read/write
See also
Data mask: Lists (type of data)
Examples:
examples_lists.c.

Definition at line 616 of file CAENMCATypes.h.

◆ DATAMASK_LIST_GETFAKEEVTS

#define DATAMASK_LIST_GETFAKEEVTS   UINT64_C(0x10)

Get also fake events. Boolean.

Note
Required argument: uint32_t
Access type: read/write
Examples:
examples_lists.c.

Definition at line 617 of file CAENMCATypes.h.

◆ DATAMASK_LIST_MAXNEVTS

#define DATAMASK_LIST_MAXNEVTS   UINT64_C(0x20)

In case of memory mode: max number of events to get in case of memory mode. Must be < LISTS_DATA_MAXLEN.

Note
Required argument: uint32_t
Access type: read/write
Examples:
examples_lists.c.

Definition at line 618 of file CAENMCATypes.h.

◆ DATAMASK_LIST_NEVTS

#define DATAMASK_LIST_NEVTS   UINT64_C(0x40)

Number of events in the data.

Note
Required argument: uint32_t
Access type: read only
Examples:
examples_lists.c.

Definition at line 619 of file CAENMCATypes.h.

◆ DATAMASK_LIST_DATA_TIMETAG

#define DATAMASK_LIST_DATA_TIMETAG   UINT64_C(0x80)

Timetags of the events in picoseconds since acquisition start.

Note
Required argument: uint64_t*
Maximum size: LISTS_DATA_MAXLEN
Access type: read only
Warning
Should be used only when save mode is CAEN_MCA_SAVEMODE_MEMORY, as the internal buffer is reset when this data is read.
Examples:
examples_lists.c.

Definition at line 620 of file CAENMCATypes.h.

◆ DATAMASK_LIST_DATA_ENERGY

#define DATAMASK_LIST_DATA_ENERGY   UINT64_C(0x100)

Energies of the events in bins.

Note
Required argument: uint16_t*
Maximum size: LISTS_DATA_MAXLEN
Access type: read only
Warning
Should be used only when save mode is CAEN_MCA_SAVEMODE_MEMORY, as the internal buffer is reset when this data is read.
Examples:
examples_lists.c.

Definition at line 621 of file CAENMCATypes.h.

◆ DATAMASK_LIST_DATA_FLAGS_DATAMASK

#define DATAMASK_LIST_DATA_FLAGS_DATAMASK   UINT64_C(0x200)

Flags of the events.

Note
Required argument: uint32_t*
Maximum size: LISTS_DATA_MAXLEN
Access type: read only
Warning
Should be used only when save mode is CAEN_MCA_SAVEMODE_MEMORY, as the internal buffer is reset when this data is read.
See also
Data mask: Lists (event flags)
Examples:
examples_lists.c.

Definition at line 622 of file CAENMCATypes.h.

◆ DATAMASK_LIST_GETSATEVTS

#define DATAMASK_LIST_GETSATEVTS   UINT64_C(0x400)

Get also saturated events. Boolean.

Note
Required argument: uint32_t
Access type: read/write
Examples:
examples_lists.c.

Definition at line 623 of file CAENMCATypes.h.

◆ DATAMASK_LIST_GETSKIMEVTS

#define DATAMASK_LIST_GETSKIMEVTS   UINT64_C(0x800)

Get also energy skim events (whose energy is outside the spectrum [LLD,ULD] interval). Boolean.

Note
Required argument: uint32_t
Access type: read/write
Examples:
examples_lists.c.

Definition at line 624 of file CAENMCATypes.h.