CAEN MCA  0.99.10
SDK for Hexagon
Macros
Data mask: Energy spectrum
API » Data masks

Information about the Energy Spectrum. Read only except DATAMASK_ENERGY_SPECTRUM_FILENAME and DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD. More...

+ Collaboration diagram for Data mask: Energy spectrum:

Macros

#define DATAMASK_ENERGY_SPECTRUM_ARRAY   UINT64_C(0x1)
 The spectrum. More...
 
#define DATAMASK_ENERGY_SPECTRUM_RTIME   UINT64_C(0x2)
 Real time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_LTIME   UINT64_C(0x4)
 Live time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_DTIME   UINT64_C(0x8)
 Dead time. More...
 
#define DATAMASK_ENERGY_SPECTRUM_OVERFLOW   UINT64_C(0x10)
 Number of overflows. More...
 
#define DATAMASK_ENERGY_SPECTRUM_UNDERFLOW   UINT64_C(0x20)
 Number of underflows. More...
 
#define DATAMASK_ENERGY_SPECTRUM_NENTRIES   UINT64_C(0x40)
 Total number of entries in the spectrum. More...
 
#define DATAMASK_ENERGY_SPECTRUM_NROIS   UINT64_C(0x80)
 Number of supported ROIs. More...
 
#define DATAMASK_ENERGY_SPECTRUM_FILENAME   UINT64_C(0x100)
 Remote file where the spectrum is saved periodically and at acquisition stop. More...
 
#define DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD   UINT64_C(0x200)
 Period of the auto save of the spectra to file in milliseconds. Set to 0 to disable the autosave. More...
 
#define DATAMASK_ENERGY_SPECTRUM_STABILIZER_ENABLE   UINT64_C(0x400)
 Status of the gain stabilizer. Set to 0 to disable the gain stabilizer. More...
 
#define DATAMASK_ENERGY_SPECTRUM_SAMPLE_ID   UINT64_C(0x800)
 Identification of the sample from which the spectrum is obtained. More...
 
#define DATAMASK_ENERGY_SPECTRUM_START_DATETIME   UINT64_C(0x1000)
 Datetime of last data acquisition start. More...
 
#define DATAMASK_ENERGY_SPECTRUM_STOP_DATETIME   UINT64_C(0x2000)
 Datetime of last data acquisition stop. More...
 

Detailed Description

Information about the Energy Spectrum. Read only except DATAMASK_ENERGY_SPECTRUM_FILENAME and DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD.

See also
CAEN_MCA_DATA_ENERGYSPECTRUM

Macro Definition Documentation

◆ DATAMASK_ENERGY_SPECTRUM_ARRAY

#define DATAMASK_ENERGY_SPECTRUM_ARRAY   UINT64_C(0x1)

The spectrum.

Note
Required argument: uint32_t*
Maximum size: ENERGYSPECTRUM_MAXLEN
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 542 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_RTIME

#define DATAMASK_ENERGY_SPECTRUM_RTIME   UINT64_C(0x2)

Real time.

Note
Required argument: uint64_t
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 543 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_LTIME

#define DATAMASK_ENERGY_SPECTRUM_LTIME   UINT64_C(0x4)

Live time.

Note
Required argument: uint64_t
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 544 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_DTIME

#define DATAMASK_ENERGY_SPECTRUM_DTIME   UINT64_C(0x8)

Dead time.

Note
Required argument: uint64_t
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 545 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_OVERFLOW

#define DATAMASK_ENERGY_SPECTRUM_OVERFLOW   UINT64_C(0x10)

Number of overflows.

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

Definition at line 546 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_UNDERFLOW

#define DATAMASK_ENERGY_SPECTRUM_UNDERFLOW   UINT64_C(0x20)

Number of underflows.

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

Definition at line 547 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_NENTRIES

#define DATAMASK_ENERGY_SPECTRUM_NENTRIES   UINT64_C(0x40)

Total number of entries in the spectrum.

Note
Required argument: uint64_t
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 548 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_NROIS

#define DATAMASK_ENERGY_SPECTRUM_NROIS   UINT64_C(0x80)

Number of supported ROIs.

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

Definition at line 549 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_FILENAME

#define DATAMASK_ENERGY_SPECTRUM_FILENAME   UINT64_C(0x100)

Remote file where the spectrum is saved periodically and at acquisition stop.

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

Definition at line 550 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD

#define DATAMASK_ENERGY_SPECTRUM_AUTOSAVE_PERIOD   UINT64_C(0x200)

Period of the auto save of the spectra to file in milliseconds. Set to 0 to disable the autosave.

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

Definition at line 551 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_STABILIZER_ENABLE

#define DATAMASK_ENERGY_SPECTRUM_STABILIZER_ENABLE   UINT64_C(0x400)

Status of the gain stabilizer. Set to 0 to disable the gain stabilizer.

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

Definition at line 552 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_SAMPLE_ID

#define DATAMASK_ENERGY_SPECTRUM_SAMPLE_ID   UINT64_C(0x800)

Identification of the sample from which the spectrum is obtained.

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

Definition at line 553 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_START_DATETIME

#define DATAMASK_ENERGY_SPECTRUM_START_DATETIME   UINT64_C(0x1000)

Datetime of last data acquisition start.

Note
Required argument: char*
Maximum size: DATETIME_MAXLEN
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 554 of file CAENMCATypes.h.

◆ DATAMASK_ENERGY_SPECTRUM_STOP_DATETIME

#define DATAMASK_ENERGY_SPECTRUM_STOP_DATETIME   UINT64_C(0x2000)

Datetime of last data acquisition stop.

Note
Required argument: char*
Maximum size: DATETIME_MAXLEN
Access type: read only
Examples:
examples_spectrum.c.

Definition at line 555 of file CAENMCATypes.h.