SIDXCConstants.h File Reference

File containing SIDX constants for reference. More...

#include <stdint.h>

Go to the source code of this file.

Enumerations
enum	SIDXStatus {   SIDX_STATUS_SUCCESS = 0, SIDX_STATUS_PARAMETER_INVALID = 1, SIDX_STATUS_RESOURCES_INSUFFICIENT = 2, SIDX_STATUS_DEVICE_ERROR = 3,   SIDX_STATUS_DEVICE_NOT_FOUND = 4, SIDX_STATUS_CONFIGURATION_ERROR = 5, SIDX_STATUS_INTERNAL_ERROR = 6, SIDX_STATUS_OPERATION_INVALID = 7,   SIDX_STATUS_OVERRUN = 8 }
	SIDX function return values. More...
enum	SIDXDriverType {   SIDX_DRIVER_TYPE_ANDOR_TECHNOLOGY = 0, SIDX_DRIVER_TYPE_HAMAMATSU = 4, SIDX_DRIVER_TYPE_PHOTOMETRICS = 6, SIDX_DRIVER_TYPE_COOKE_PCO_PIXELFLY = 9,   SIDX_DRIVER_TYPE_JENOPTIK = 10, SIDX_DRIVER_TYPE_AVT = 11, SIDX_DRIVER_TYPE_APPLIED_SCIENTIFIC_INSTRUMENTATION = 12, SIDX_DRIVER_TYPE_LUDL_ELECTRONIC_PRODUCTS = 13,   SIDX_DRIVER_TYPE_PRIOR_SCIENTIFIC = 14, SIDX_DRIVER_TYPE_PRINCETON_INSTRUMENTS_PVCAM = 17, SIDX_DRIVER_TYPE_ANDOR_TECHNOLOGY_SDK3 = 18 }
	A value of this type represents a camera driver. More...
enum	SIDXSettingType {   SIDX_SETTING_TYPE_BOOLEAN = 0, SIDX_SETTING_TYPE_INTEGER = 1, SIDX_SETTING_TYPE_LIST = 2, SIDX_SETTING_TYPE_NONE = 3,   SIDX_SETTING_TYPE_REAL = 4, SIDX_SETTING_TYPE_SEQUENCE = 5, SIDX_SETTING_TYPE_STRING = 6 }
	A value of this type represents a setting type. More...
enum	SIDXShutterMode {   SIDX_SHUTTER_MODE_OPEN_DURING_EXPOSURE = 0, SIDX_SHUTTER_MODE_OPEN_DURING_SEQUENCE = 1, SIDX_SHUTTER_MODE_OPEN_DURING_ENABLE = 2, SIDX_SHUTTER_MODE_OPEN = 3,   SIDX_SHUTTER_MODE_CLOSE = 4, SIDX_SHUTTER_MODE_COUNT = 5 }
	A value of this type represents a shutter control mode. More...
enum	SIDXTriggerInMode {   SIDX_TRIGGER_IN_MODE_ALWAYS = 0, SIDX_TRIGGER_IN_MODE_EXPOSURE_START = 1, SIDX_TRIGGER_IN_MODE_EXPOSURE_DURATION = 2, SIDX_TRIGGER_IN_MODE_SEQUENCE_START = 3,   SIDX_TRIGGER_IN_MODE_EXPOSURE_DELIMIT = 4, SIDX_TRIGGER_IN_MODE_COUNT }
	A value of this type represents the trigger input control mode for acquisition. More...
enum	SIDXSignalActiveMode {   SIDX_SIGNAL_ACTIVE_MODE_EDGE_RISING = 0, SIDX_SIGNAL_ACTIVE_MODE_EDGE_FALLING = 1, SIDX_SIGNAL_ACTIVE_MODE_EDGE_ANY = 2, SIDX_SIGNAL_ACTIVE_MODE_LEVEL_HIGH = 3,   SIDX_SIGNAL_ACTIVE_MODE_LEVEL_LOW = 4, SIDX_SIGNAL_ACTIVE_MODE_COUNT = 5 }
	A value of this type represents the trigger signal mode for acquisition. More...
enum	SIDXCoolingControl { SIDX_COOLING_CONTROL_NONE = 0, SIDX_COOLING_CONTROL_GET_ONLY = 1, SIDX_COOLING_CONTROL_GET_SET = 2 }
	A value of this type represents a temperature control capability. More...
enum	SIDXPortType {   SIDX_PORT_TYPE_ANALOG_IN = 0, SIDX_PORT_TYPE_ANALOG_OUT = 1, SIDX_PORT_TYPE_BIT_IN = 2, SIDX_PORT_TYPE_BIT_OUT = 3,   SIDX_PORT_TYPE_DIGITAL_IN = 4, SIDX_PORT_TYPE_DIGITAL_OUT = 5, SIDX_PORT_TYPE_COUNT = 6 }
	A value of this type represents a device port. More...
enum	SIDXImageType { SIDX_IMAGE_TYPE_GRAYSCALE16 = 0, SIDX_IMAGE_TYPE_RGB24 = 1, SIDX_IMAGE_TYPE_RGB48 = 2 }
	A value of this type represents either a source image type or a target image type. More...

Detailed Description

File containing SIDX constants for reference.

Enumeration Type Documentation

enum SIDXCoolingControl

A value of this type represents a temperature control capability.

Enumerator
SIDX_COOLING_CONTROL_NONE	The camera does not provide any temperature information, and does not provide any temperature control.
SIDX_COOLING_CONTROL_GET_ONLY	The camera provides the sensor temperature, but does not provide control of the sensor temperature.
SIDX_COOLING_CONTROL_GET_SET	The camera provides the sensor temperature, and also provides control of the sensor temperature.

enum SIDXDriverType

A value of this type represents a camera driver.

Enumerator
SIDX_DRIVER_TYPE_ANDOR_TECHNOLOGY	Andor Technology CCD.
SIDX_DRIVER_TYPE_HAMAMATSU	Hamamatsu DCAM.
SIDX_DRIVER_TYPE_PHOTOMETRICS	Photometrics.
SIDX_DRIVER_TYPE_COOKE_PCO_PIXELFLY	PCO pixelfly.
SIDX_DRIVER_TYPE_JENOPTIK	Jenoptik.
SIDX_DRIVER_TYPE_AVT	Allied Vision Technologies.
SIDX_DRIVER_TYPE_APPLIED_SCIENTIFIC_INSTRUMENTATION	Applied Scientific Instrumentation.
SIDX_DRIVER_TYPE_LUDL_ELECTRONIC_PRODUCTS	Ludl.
SIDX_DRIVER_TYPE_PRIOR_SCIENTIFIC	Prior Scientific.
SIDX_DRIVER_TYPE_PRINCETON_INSTRUMENTS_PVCAM	Princeton Instruments PVCAM.
SIDX_DRIVER_TYPE_ANDOR_TECHNOLOGY_SDK3	Andor Technology sCMOS.

enum SIDXImageType

A value of this type represents either a source image type or a target image type.

Enumerator
SIDX_IMAGE_TYPE_GRAYSCALE16	16 bit grayscale image type.
SIDX_IMAGE_TYPE_RGB24	RGB color image with 8 bit per color.
SIDX_IMAGE_TYPE_RGB48	RBG color image with 16 bit per color.

enum SIDXPortType

A value of this type represents a device port.

Enumerator
SIDX_PORT_TYPE_ANALOG_IN	Analog input.
SIDX_PORT_TYPE_ANALOG_OUT	Analog output.
SIDX_PORT_TYPE_BIT_IN	Bit input.
SIDX_PORT_TYPE_BIT_OUT	Bit output.
SIDX_PORT_TYPE_DIGITAL_IN	Digital input.
SIDX_PORT_TYPE_DIGITAL_OUT	Digital output.
SIDX_PORT_TYPE_COUNT	The total number of possible device ports.

enum SIDXSettingType

A value of this type represents a setting type.

Enumerator
SIDX_SETTING_TYPE_BOOLEAN	The setting is one of the values true or false.
SIDX_SETTING_TYPE_INTEGER	The setting value is selected from a range of integer values. The range is identified by a minimum value and a maximum value.
SIDX_SETTING_TYPE_LIST	The setting value is selected from a small set (list) of values. The list is specified by a count of possible values. The value item range is 0 (zero) to one less than the count of possible values.
SIDX_SETTING_TYPE_NONE	No setting available.
SIDX_SETTING_TYPE_REAL	The setting value is selected from a range of real (floating point) values. The range is identified by a minimum value and a maximum value.
SIDX_SETTING_TYPE_SEQUENCE	The setting is an array of integer values.
SIDX_SETTING_TYPE_STRING	The setting is a text string.

enum SIDXShutterMode

A value of this type represents a shutter control mode.

Enumerator
SIDX_SHUTTER_MODE_OPEN_DURING_EXPOSURE	The shutter is open during each individual exposure. The shutter closes between exposures.
SIDX_SHUTTER_MODE_OPEN_DURING_SEQUENCE	The shutter is open during an exposure sequence. The shutter closes when no sequence is being acquired. If the sequence is triggered, the shutter opens only when the trigger occurs.
SIDX_SHUTTER_MODE_OPEN_DURING_ENABLE	The shutter is open while image acquisition is enabled. The shutter remains open during the acquisition sequence. If the sequence is triggered, the shutter opens as soon as acquisition is enabled, so the shutter may be open before the trigger occurs. The shutter closes when image acquisition is not enabled.
SIDX_SHUTTER_MODE_OPEN	The shutter is always open.
SIDX_SHUTTER_MODE_CLOSE	The shutter is always closed.
SIDX_SHUTTER_MODE_COUNT	The total number of possible shutter modes.

enum SIDXSignalActiveMode

A value of this type represents the trigger signal mode for acquisition.

Enumerator
SIDX_SIGNAL_ACTIVE_MODE_EDGE_RISING	Trigger signal rising edge starts the trigger.
SIDX_SIGNAL_ACTIVE_MODE_EDGE_FALLING	Trigger signal falling edge starts the trigger.
SIDX_SIGNAL_ACTIVE_MODE_EDGE_ANY	Trigger signal transition starts the trigger.
SIDX_SIGNAL_ACTIVE_MODE_LEVEL_HIGH	Trigger signal high starts the trigger.
SIDX_SIGNAL_ACTIVE_MODE_LEVEL_LOW	Trigger signal low starts the trigger.
SIDX_SIGNAL_ACTIVE_MODE_COUNT	The total number of possible trigger signal modes.

enum SIDXStatus

SIDX function return values.

Enumerator
SIDX_STATUS_SUCCESS	No errors.
SIDX_STATUS_PARAMETER_INVALID	The parameter is not valid.
SIDX_STATUS_RESOURCES_INSUFFICIENT	The memory resource is insufficient.
SIDX_STATUS_DEVICE_ERROR	An error has been detected in the hardware.
SIDX_STATUS_DEVICE_NOT_FOUND	A hardware device is not found.
SIDX_STATUS_CONFIGURATION_ERROR	Unanticipated error. Please report.
SIDX_STATUS_INTERNAL_ERROR	Unanticipated error. Please report.
SIDX_STATUS_OPERATION_INVALID	The operation is not valid in the current conditions.
SIDX_STATUS_OVERRUN	The current hardware configuration is not supported.

enum SIDXTriggerInMode

A value of this type represents the trigger input control mode for acquisition.

Enumerator
SIDX_TRIGGER_IN_MODE_ALWAYS	The trigger is always asserted. An acquisition will start immediately.
SIDX_TRIGGER_IN_MODE_EXPOSURE_START	The trigger input starts a single exposure. The exposure duration is set by the exposure interval.
SIDX_TRIGGER_IN_MODE_EXPOSURE_DURATION	The trigger input gates a single exposure. The exposure duration is set by the trigger, the camera exposes the image as long as the the trigger is asserted. The camera terminates the exposure when the trigger is deasserted. This is also called 'bulb' mode.
SIDX_TRIGGER_IN_MODE_SEQUENCE_START	The trigger input starts an acquisition sequence. The trigger input is asserted only once for the entire sequence.
SIDX_TRIGGER_IN_MODE_EXPOSURE_DELIMIT	The trigger input delimits exposures, ending one exposure and starting another.
SIDX_TRIGGER_IN_MODE_COUNT	The total number of possible trigger input modes.