enum_settings.h File Reference

All settings options and software constants. More...

Go to the source code of this file.

Enumerations
enum	sti_mode_t {   sti_I = 0 , sti_S1 = 1 , sti_S2 = 2 , sti_S2_enable_I = 3 ,   sti_STimer = 4 , sti_ASL = 5 }
enum	bti_mode_t {   bti_I = 0 , bti_S1 = 1 , bti_S2 = 2 , bti_S1S2 = 3 ,   bti_BTimer = 4 , bti_S1chopper = 5 , bti_S2chopper = 6 , bti_S1S2chopper = 7 }
enum	sslope_t { sslope_pos = 0 , sslope_neg = 1 , sslope_both = 2 }
enum	bslope_t { bslope_neg = 0 , bslope_pos = 1 , bslope_both = 2 }
enum	trigger_mode_t { xck = 0 , exttrig = 1 , dat = 2 }
enum	sensor_type_t {   sensor_type_pda = 0 , sensor_type_ir = 1 , sensor_type_fft = 2 , sensor_type_cmos = 3 ,   sensor_type_hsvis = 4 , sensor_type_hsir = 5 }
enum	camera_system_t { camera_system_3001 = 0 , camera_system_3010 = 1 , camera_system_3030 = 2 }
enum	fft_mode_t { full_binning = 0 , partial_binning = 1 , area_mode = 2 }
enum	tor_out_t {   tor_xck = 0 , tor_rego = 1 , tor_von = 2 , tor_dma_act = 3 ,   tor_asls = 4 , tor_stimer = 5 , tor_btimer = 6 , tor_isr_act = 7 ,   tor_s1 = 8 , tor_s2 = 9 , tor_block_on_synced = 10 , tor_measureon = 11 ,   tor_sdat = 12 , tor_bdat = 13 , tor_sec_mshut = 14 , tor_bec_mshut = 15 ,   tor_ifc = 16 , tor_do_cc_i = 17 , tor_exposure_window = 18 , tor_to_cnt_out = 19 ,   tor_secon = 20 , tor_i = 21 , tor_S1S2readDelay = 22 , tor_block_on = 23 ,   tor_unused_24 = 24 , tor_unused_25 = 25 , tor_unused_26 = 26 , tor_unused_27 = 27 ,   tor_unused_28 = 28 , tor_enffr = 29 , tor_enffw = 30 , tor_enffwrprot = 31 }
enum	adc_mode_t { normal = 0 , ramp = 1 , custom_pattern = 2 }
enum	channel_select_t { channel_select_A = 0 , channel_select_B = 1 , channel_select_A_B = 2 }
enum	monitor_t { monitor_xck = 0 , monitor_win = 1 , monitor_adc_clk = 2 , monitor_Vin = 3 }
enum	manipulate_data_mode_t { manipulate_data_mode_none = 0 , manipulate_data_mode_preset_linearization_polynom = 1 , manipulate_data_mode_custom_factor = 2 }
enum	DAC8568_location_t { DAC8568_camera = 0 , DAC8568_pcie = 1 }
enum	settings_level_t { settings_level_guided = 0 , settings_level_free = 1 }
enum	file_specifications_t { file_path_size = 256 , file_timestamp_size = 64 , file_filename_full_size = 256 }
enum	timer_resolution_t { timer_resolution_1us = 0 , timer_resolution_100us = 1 , timer_resolution_1ms = 2 , timer_resolution_100ns = 3 }

Detailed Description

All settings options and software constants.

Author

Florian Hahn

Date

23.10.2023

Copyright

Copyright Entwicklungsbuero Stresing. This software is release under the LPGL-3.0.

Enumeration Type Documentation

adc_mode_t

enum adc_mode_t

ADC mode shows the options for camera_settings::adc_mode.

Enumerator
normal	0	Normal operation, default.
ramp	1	Every 8 channels are performing a ramp signal.
custom_pattern	2	With custom pattern all 8 ADC channels deliver a specific constant value given by camera_settings::adc_custom_pattern.

bslope_t

enum bslope_t

This enum shows all options for the setting camera_settings::bslope.

Enumerator
bslope_neg	0	Use only negative slopes of the trigger input to start a block.
bslope_pos	1	Use only positive slopes of the trigger input to start a block.
bslope_both	2	Use both slopes of the trigger input to start a block.

bti_mode_t

enum bti_mode_t

Block trigger input mode shows the options for camera_settings::bti_mode

Enumerator
bti_I	0	External trigger on input I of PCIe board
bti_S1	1	External trigger on input S1 of PCIe board
bti_S2	2	External trigger on input S2 of PCIe board
bti_S1S2	3	External trigger when inputs S1 and S2 are high
bti_BTimer	4	Trigger with internal timer. Select the time between two blocks of readouts with btimer.
bti_S1chopper	5	S1 chopper
bti_S2chopper	6	S2 chopper
bti_S1S2chopper	7	S1&S2 chopper

camera_system_t

enum camera_system_t

Camera system shows the options for camera_settings::camera_system

Enumerator
camera_system_3001	0	3001 These camera versions are a 3001 system: 205.X 208.X 210.X 211.X 215.X 218.X These sensors are a 3001 system: S3901/S3904 S3902/S3903 S8380/S8381 G11608 G11620 G9203-256DA G9204-512DA S12600/S12601 S7030/S7031 S10420-01 S16010
camera_system_3010	1	3010. These camera versions are a 3010 system: 206.X 216.X 230.X These sensors are a 3010 system: S9037/S9038 S11071 S12198
camera_system_3030	2	3030. These camera versions are a 3030 system: 209.X 212.X These sensors are a 3030 system: S14290 G10786

channel_select_t

enum channel_select_t

This enum shows all options for the setting camera_settings::channel_select.

Enumerator
channel_select_A	0
channel_select_B	1
channel_select_A_B	2

DAC8568_location_t

enum DAC8568_location_t

This enum is describing the possible locations of the IC DAC8568 used in DAC8568_sendData().

Enumerator
DAC8568_camera	0	High speed camera system 3030, PCB 2189-7.
DAC8568_pcie	1	PCIe add on board EWS, PCB 2226-3.

fft_mode_t

enum fft_mode_t

Shows the options for camera_settings::fft_mode.

Enumerator
full_binning	0	Full binning is the FFT operation mode for summing up all vertical lines for one readout. The sensor is treated as a single line sensor in this mode. This is the default operation mode.
partial_binning	1	Partial binning is the FFT operation mode for summing up a specific count of lines per readout to get the sum of specific regions of the sensor. The number of regions is determined by the setting camera_settings::number_of_regions. The size of each region is determined by the setting camera_settings::region_size. In this mode the meaning of scans and blocks changes. One "scan" is now one region of the sensor. So measurement_settings::nos should equal camera_settings::number_of_regions and camera_settings::sti_mode should be set to sti_mode_t::sti_ASL. One "block" is one complete readout of all regions. The time between two block triggers is the exposure time of the sensor for one complete image. measurement_settings::nob and camera_settings::bti_mode can be chosen freely.
area_mode	2	Area mode is the FFT operation mode for reading out each vertical line separately. In this mode the meaning of scans and blocks changes. One "scan" is now one line of the sensor. So measurement_settings::nos should equal camera_settings::fft_lines and camera_settings::sti_mode should be set to sti_mode_t::sti_ASL. One "block" is one complete readout of all lines. The time between two block triggers is the exposure time of the sensor for one complete image. measurement_settings::nob and camera_settings::bti_mode can be chosen freely.

file_specifications_t

enum file_specifications_t

Enumerator
file_path_size	256
file_timestamp_size	64
file_filename_full_size	256

manipulate_data_mode_t

enum manipulate_data_mode_t

This enum shows all options for the setting camera_settings::manipulate_data_mode.

Enumerator
manipulate_data_mode_none	0	Don't manipulate the data. This is the defaut. Keep the data as raw as it is.
manipulate_data_mode_preset_linearization_polynom	1	Manipulate the data with a preset polynom. This option is here for future use only and not for production use yet.
manipulate_data_mode_custom_factor	2	Use the constant custom factor given by camera_settings::manipulate_data_custom_factor to manipulate the data.

monitor_t

enum monitor_t

This enum shows all options for the setting camera_settings::monitor.

Enumerator
monitor_xck	0	XCK is high during the readout of the camera.
monitor_win	1	Exp win stands for exposure window and is high, when the sensor is ready to be exposed to light.
monitor_adc_clk	2	The option ADC CLK sets the output to the ADC clock.
monitor_Vin	3	Vin is high when the voltage input is sampled.

sensor_type_t

enum sensor_type_t

Sensor type shows the options for camera_settings::sensor_type.

Enumerator
sensor_type_pda	0	PDA - Photodiode Array. These sensors are a PDA: S3901/S3904 S3902/S3903 S8380/S8381
sensor_type_ir	1	IR - Infrared These sensors are a IR: G11608 G11620 G9203-256DA G9204-512DA
sensor_type_fft	2	FFT - Full frame transfer. These sensors are a FFT: S12600/S12601 S7030/S7031 S10420-01 S16010
sensor_type_cmos	3	CMOS sensor. These sensors are a CMOS: S12198
sensor_type_hsvis	4	HSVIS - High speed sensor for visible light. These sensors are a HSVIS: S14290
sensor_type_hsir	5	HSIR - High speed sensor for infrared light. These sensors are a HSIR: G10786

settings_level_t

enum settings_level_t

Enumerator
settings_level_guided	0
settings_level_free	1

sslope_t

enum sslope_t

This enum shows all options for the setting camera_settings::sslope.

Enumerator
sslope_pos	0	Use only positive slopes of the trigger input to start a scan.
sslope_neg	1	Use only negative slopes of the trigger input to start a scan.
sslope_both	2	Use both slopes of the trigger intput to start a scan.

sti_mode_t

enum sti_mode_t

Scan trigger input mode shows the options for camera_settings::sti_mode

Enumerator
sti_I	0	External trigger on input I of PCIe board
sti_S1	1	External trigger on input S1 of PCIe board
sti_S2	2	External trigger on input S2 of PCIe board
sti_S2_enable_I	3	External trigger by I but only when enabled by S2.
sti_STimer	4	Trigger with internal timer. Select the time between two readouts with stime.
sti_ASL	5	Automatic internal instant trigger at the end of the last readout.

timer_resolution_t

enum timer_resolution_t

The enum timer_resolution_t shows all options of the setting camera_settings::timer_resolution_mode.

Enumerator
timer_resolution_1us	0	default option Min: 4 us Step : 1 us Max: 268,435,455 us = 268,435.455 s = 4.47 min
timer_resolution_100us	1	Min: 400 us Step: 100 us Max: 26,843,545,500 us = 26,843.5455 s = 447.39 min = 7.46 h
timer_resolution_1ms	2	Min: 4 ms Step: 1 ms Max: 268,435,455 ms = 268,435.455 s = 4473.9 min = 74.6 h
timer_resolution_100ns	3	Min: 400 ns Step : 100 ns Max: 26,843,545,500 ns = 26.8435455 s

tor_out_t

enum tor_out_t

TOR out shows the options for camera_settings::tor.

Enumerator
tor_xck	0	XCK starts the readout of the camera and is high during the readout.
tor_rego	1	The signal REGO is controlled by the bit TRIG_OUT of the register CTRLA. It can be controlled with the functions OutTrigLow(), OutTrigHigh() and OutTrigPulse(). The main purpose of this signal is for creating a hardware signal controlled by software, which can be measured by a oscilloscope or used by other electronics.
tor_von	2	DEPRECATED: VON is the signal for the vertical clocks of the FFT sensor. This signal is only used when camera_settings::is_fft_legacy is on.
tor_dma_act	3	DMA active is high during the direct memory access of the PCIe card.
tor_asls	4	ASLS stands for Auto Scan Line Start and shows when a new readout is started when camera_settings::sti_mode is set to sti_mode_t::sti_ASL.
tor_stimer	5	stimer is the internal trigger for the start of a readout when camera_settings::sti_mode is set to sti_mode_t::sti_STimer. The repetition rate is determined by camera_settings::stime.
tor_btimer	6	btimer is the internal trigger for the start of a block when camera_settings::bti_mode is set to bti_mode_t::bti_BTimer. The repetition rate is determined by camera_settings::btime.
tor_isr_act	7	ISR_ACT is high when the interrupt service routine is active. The ISR copies the data from the DMA buffer to the user buffer, when camera_settings::use_software_polling is not activated.
tor_s1	8	Shows the state of the input S1 of the PCIe board.
tor_s2	9	Shows the state of the input S2 of the PCIe board.
tor_block_on_synced	10	BLOCK_ON_SYNCED is high during a block readout sequence. The rising edge is synced to the next scan trigger after the rising edge of BLOCK_ON. The signal is resetted by BLOCK_EN = 0.
tor_measureon	11	measureon is high during the whole measurement.
tor_sdat	12	SDAT is high during the time delay between the scan trigger and the start of a scan. This time depends on camera_settings::sdat_in_10ns.
tor_bdat	13	BDAT is high during the time delay between the block trigger and the start of a block. This time depends on camera_settings::bdat_in_10ns.
tor_sec_mshut	14	sec_mshut is high during the scan exposure window when the option camera_settings::sec_in_10ns is used or can be manually set to high by OpenShutter().
tor_bec_mshut	15	bec_mshut is high during the block exposure window when the option camera_settings::bec_in_10ns is used or can be manually set to high by OpenShutter().
tor_ifc	16	IFC is the electronic exposure control signal used by some sensors and is sent to the camera. When camera_settings::sec_in_10ns is used IFC = SEC, otherwise it is always 1.
tor_do_cc_i	17	DO_CC_I is a fiber link synchronisation signal.
tor_exposure_window	18	Exposure window shows when it is possible to expose the camera to light. Since the PCIe card doesn't know exactly when the sensor is ready to be exposed this is only an estimated signal. If possible use monitor_t::monitor_win of camera_settings::monitor.
tor_to_cnt_out	19	tor_to_cnt_out shows the signal which is controlled by the setting camera_settings::tocnt. Depending on this setting, only specific XCK high periods are shown on the PCIe card output.
tor_secon	20	SECON is high during the scan exposure window when the option camera_settings::sec_in_10ns is used.
tor_i	21	Shows the state of the input I of the PCIe board.
tor_S1S2readDelay	22	Shows the delay between the trigger and the moment, when the states of S1 and S2 are read. This delay is controlled by the settting camera_settings::s1s2_read_delay_in_10ns.
tor_block_on	23	BLOCK_ON is high during a block readout sequence. The rising edge is synced to the next block trigger after the rising edge of BLOCK_EN. The signal is resetted by BLOCK_EN = 0.
tor_unused_24	24	Unused.
tor_unused_25	25	Unused.
tor_unused_26	26	Unused.
tor_unused_27	27	Unused.
tor_unused_28	28	Unused.
tor_enffr	29	Status of enable FIFO read.
tor_enffw	30	Status of enable FIFO write.
tor_enffwrprot	31

trigger_mode_t

enum trigger_mode_t

Trigger mode shows the options for camera_settings::trigger_mode_integrator.

Enumerator
xck	0	Trigger the integrator with the start signal XCK of the PCIe board. The integrator starts simultaneously with the sensor.
exttrig	1	Trigger the integrator with the input Ext. Trig. of the camera control. The integrator can be started separately from the sensor
dat	2	Trigger the integrator with the input Ext. Trig but with an additional delay.