Loading
 
Support Support Home » APIs » XiAPINET » XiAPINET Manual

xiApi.NET Manual

BINNING_SELECTOR class

Selects which binning engine is configured by BinningHorizontal, BinningVertical and BinningPattern parameters; to be used with PRM.BINNING_SELECTOR function parameter.

BINNING_SELECTOR.SENSOR : Sensor binning engine selected (if available).

BINNING_MODE class

Selects binning mode; to be used with PRM.BINNING_HORIZONTAL_MODE and PRM.BINNING_VERTICAL_MODE function parameters.

BINNING_MODE.SUM : The response from the combined pixels will be added, resulting in increased sensitivity.

BINNING_MODE.AVERAGE : The response from the combined pixels will be averaged, resulting in increased signal/noise ratio.

BINNING_PATTERN class

Selects binning pattern type; to be used with PRM.BINNING_PATTERN function parameter.

BINNING_PATTERN.MONO : Monochrome type binning - adjacent pixels are combined.

BINNING_PATTERN.BAYER : Bayer type binning - bayer pattern is preserved during pixel combining.

DECIMATION_SELECTOR class

Selects which decimation engine is configured by DecimationHorizontal, DecimationVertical and DecimationPattern parameters; to be used with PRM.DECIMATION_SELECTOR function parameter.

DECIMATION_SELECTOR.SENSOR : Sensor decimation engine selected (if available).

DECIMATION_PATTERN class

Selects decimation pattern type; to be used with PRM.DECIMATION_PATTERN function parameter.

DECIMATION_PATTERN.MONO : Monochrome type decimation - adjacent pixels are skipped.

DECIMATION_PATTERN.BAYER : Bayer type decimation - bayer pattern is preserved during pixel decimation.

DOWNSAMPLING_TYPE class

Downsampling type, switch between binning and skipping, to be used with the PRM.DOWNSAMPLING_TYPE function parameter.

DOWNSAMPLING_TYPE.BINNING : Binned type for higher sensitivity.

DOWNSAMPLING_TYPE.SKIPPING : Skipped type for higher frame rates.

TEST_PATTERN_GENERATOR_SELECTOR class

Selects which test pattern generator is configured by TestPattern; to be used with PRM.TEST_PATTERN_GENERATOR_SELECTOR function parameter.

TEST_PATTERN_GENERATOR_SELECTOR.SENSOR : Sensor test pattern engine selected.

TEST_PATTERN_GENERATOR_SELECTOR.FPGA : FPGA test pattern engine selected.

TEST_PATTERN class

Selects which test pattern type is to be used on the selected generator; to be used with PRM.TEST_PATTERN function parameter.

TEST_PATTERN.OFF : Testpattern turned off.

TEST_PATTERN.BLACK : Image is filled with darkest possible image.

TEST_PATTERN.WHITE : Image is filled with brightest possible image.

TEST_PATTERN.GREY_HORIZ_RAMP : Image is filled horizontally with an image that goes from the darkest possible value to the brightest.

TEST_PATTERN.GREY_VERT_RAMP : Image is filled vertically with an image that goes from the darkest possible value to the brightest.

TEST_PATTERN.GREY_HORIZ_RAMP_MOVING : Image is filled horizontally with an image that goes from the darkest possible value to the brightest and moves from left to right.

TEST_PATTERN.GREY_VERT_RAMP_MOVING : Image is filled vertically with an image that goes from the darkest possible value to the brightest and moves from left to right.

TEST_PATTERN.HORIZ_LINE_MOVING : A moving horizontal line is superimposed on the live image.

TEST_PATTERN.VERT_LINE_MOVING : A moving vertical line is superimposed on the live image.

TEST_PATTERN.COLOR_BAR : Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.

TEST_PATTERN.FRAME_COUNTER : A frame counter is superimposed on the live image.

TEST_PATTERN.DEVICE_SPEC_COUNTER : 128bit counter.

IMG_FORMAT class

Output image format definitions to be used with the PRM.IMG_FORMAT function parameter. Setting
this parameter will reset current region of interest.

IMG_FORMAT.MONO8 : Monochrome image with 8 bits per pixel.

IMG_FORMAT.MONO16 : Monochrome image with 16 bits per pixel.

IMG_FORMAT.RGB24 : RGB image data format image with 24 bits per pixel.

IMG_FORMAT.RGB32 : RGBA image data format image with 32 bits per pixel.

IMG_COLOR_FILTER_ARRAY class

IMG_COLOR_FILTER_ARRAY.NONE : B/W sensors.

IMG_COLOR_FILTER_ARRAY.BAYER_RGGB : Regular Bayer RGGB readout.

IMG_COLOR_FILTER_ARRAY.CMYG : AK Sony sensors.

IMG_COLOR_FILTER_ARRAY.RGR : 2R+G readout of RGGB sensor.

IMG_COLOR_FILTER_ARRAY.BAYER_BGGR : Bayer BGGR readout.

IMG_COLOR_FILTER_ARRAY.BAYER_GRBG : Bayer GRBG readout.

IMG_COLOR_FILTER_ARRAY.BAYER_GBRG : Bayer GBRG readout.

BUFF_POLICY class

Buffer policy settings(can be safe, data will be copied to user/app buffer or unsafe, user will get internally allocated buffer without data copy).

BUFF_POLICY.UNSAFE : User gets pointer to internally allocated circle buffer and data may be overwritten by device.

BUFF_POLICY.SAFE : Data from device will be copied to user allocated buffer or xiApi allocated memory.

TRG_SOURCE class

TRG_SOURCE.OFF : Camera works in free run mode.

TRG_SOURCE.EDGE_RISING : External trigger (rising edge).

TRG_SOURCE.EDGE_FALLING : External trigger (falling edge).

TRG_SOURCE.SOFTWARE : Software(manual) trigger.

TRG_SELECTOR class

Definitions containing information about trigger functionality.

TRG_SELECTOR.FRAME_START : Selects a trigger starting the capture of one frame.

TRG_SELECTOR.EXPOSURE_ACTIVE : Selects a trigger controlling the duration of one frame.

TRG_SELECTOR.FRAME_BURST_START : Selects a trigger starting the capture of the bursts of frames in an acquisition.

TRG_SELECTOR.FRAME_BURST_ACTIVE :Selects a trigger controlling the duration of the capture of the bursts of frames in an acquisition.

ACQ_TIMING_MODE class

ACQ_TIMING_MODE.FREE_RUN : Selects a trigger starting the capture of one frame.

ACQ_TIMING_MODE.FRAME_RATE : Selects a trigger controlling the duration of one frame.

GPI_MODE class

GPI port state options

GPI_MODE.OFF : Input off.

GPI_MODE.TRIGGER : Trigger input.

GPI_MODE.EXT_EVENT : External signal input.

GPO_MODE class

GPO port state options

GPO_MODE.OFF : Output off.

GPO_MODE.ON : Logical level.

GPO_MODE.FRAME_ACTIVE : High during exposure(integration) time + readout time + data transfer time.

GPO_MODE.FRAME_ACTIVE_NEG : Low during exposure(integration) time + readout time + data trasnfer time.

GPO_MODE.EXPOSURE_ACTIVE : High during exposure(integration) time.

GPO_MODE.EXPOSURE_ACTIVE_NEG : Low during exposure(integration) time.

GPO_MODE.FRAME_TRIGGER_READY : On when sensor is ready for next trigger edge.

GPO_MODE.FRAME_TRIGGER_READY_NEG : Off when sensor is ready for next trigger edge.

GPO_MODE.EXPOSURE_PULSE : Short On/Off pulse on start of each exposure.

GPO_MODE.EXPOSURE_PULSE_NEG : Short Off/On pulse on start of each exposure.

LED_MODE class

Camera LED state options.

LED_MODE.LED_HEARTBEAT : Blink if link is ok (led 1), heartbeat mode (led 2).

LED_MODE.LED_TRIGGER_ACTIVE : Blink led if trigger detected.

LED_MODE.LED_EXT_EVENT_ACTIVE : Blink led if external signal detected.

LED_MODE.LED_ACQUISITION : Blink led during data streaming.

LED_MODE.LED_EXPOSURE_ACTIVE : Blink led during sensor integration time.

LED_MODE.LED_FRAME_ACTIVE : Blink if device busy/not busy.

LED_MODE.LED_LINK : Blink led if link is ok.

LED_MODE.LED_OFF : Set led to zero.

LED_MODE.LED_ON : Set led to one.

COUNTER_SELECTOR class

Frames counter selector.

CNT_SEL_TRANSPORT_SKIPPED_FRAMES : Number of skipped frames on transport layer (e.g. when image gets lost while transmission). Occur when capacity of transport channel does not allow to transfer all data.

CNT_SEL_API_SKIPPED_FRAMES : Number of skipped frames on API layer. Occur when application does not process the images as quick as they are received from the camera.

CNT_SEL_TRANSPORT_TRANSFERRED_FRAMES : Number of successfully transferred frames on transport layer.

TS_RST_MODE class

Time stamp reset arming options.

TS_RST_MODE.TS_RST_ARM_ONCE : TimeStamp reset is armed once, after execution engine is disabled.

TS_RST_MODE.TS_RST_ARM_PERSIST : TimeStamp reset is armed permanently if source is selected.

TS_RST_SOURCE class

Possible timestamp reset sources.

TS_RST_SOURCE.TS_RST_OFF : No source selected, timestamp reset effectively disabled.

TS_RST_SOURCE.TS_RST_SRC_GPI_1 : TimeStamp reset source selected GPI1 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_2 : TimeStamp reset source selected GPI2 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_3 : TimeStamp reset source selected GPI3 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_4 : TimeStamp reset source selected GPI4 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_1_INV : TimeStamp reset source selected GPI1 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_2_INV : TimeStamp reset source selected GPI2 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_3_INV : TimeStamp reset source selected GPI3 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPI_4_INV : TimeStamp reset source selected GPI4 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_1 : TimeStamp reset source selected GPO1 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_2 : TimeStamp reset source selected GPO2 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_3 : TimeStamp reset source selected GPO3 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_4 : TimeStamp reset source selected GPO4 (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_1_INV : TimeStamp reset source selected GPO1 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_2_INV : TimeStamp reset source selected GPO2 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_3_INV : TimeStamp reset source selected GPO3 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_GPO_4_INV : TimeStamp reset source selected GPO4 inverted (after de-bounce).

TS_RST_SOURCE.TS_RST_SRC_TRIGGER : TimeStamp reset source selected TRIGGER (signal for sensor).

TS_RST_SOURCE.TS_RST_SRC_TRIGGER_INV : TimeStamp reset source selected TRIGGER inverted (signal for sensor).

TS_RST_SOURCE.TS_RST_SRC_SW : TimeStamp reset source selected software (has immediate effect and is self cleared).

TS_RST_SOURCE.TS_RST_SRC_EXPACTIVE : TimeStamp reset source selected exposure active.

TS_RST_SOURCE.TS_RST_SRC_EXPACTIVE_INV : TimeStamp reset source selected exposure active inverted.

TS_RST_SOURCE.TS_RST_SRC_FVAL : TimeStamp reset source selected frame valid signal from sensor.

TS_RST_SOURCE.TS_RST_SRC_FVAL_INV : TimeStamp reset source selected frame valid signal from sensor inverted.

LENS_MODE class

Possible values for Lens_Mode

LENS_MODE.ON : Lens control is initialized and enabled.

LENS_MODE.OFF : Lens control is disabled.

LENS_FEATURE_SELECTOR class

Possible values for Lens Feature Selector

LENS_FEATURE_SELECTOR.MOTORIZED_FOCUS_SWITCH : Status of lens motorized focus switch.

LENS_FEATURE_SELECTOR.MOTORIZED_FOCUS_BOUNDED : On read = 1 if motorized focus is on one of limits.

LENS_FEATURE_SELECTOR.MOTORIZED_FOCUS_CALIBRATION : On read = 1 if motorized focus is calibrated. Write 1 to start calibration.

LENS_FEATURE_SELECTOR.IMAGE_STABILIZATION_ENABLED : On read = 1 if image stabilization is enabled. Write 1 to enable image stabilization.

LENS_FEATURE_SELECTOR.IMAGE_STABILIZATION_SWITCH_STATUS : On read = 1 if image stabilization switch is in position On.

LENS_FEATURE_SELECTOR.IMAGE_ZOOM_SUPPORTED : On read = 1 if lens supports zoom = are not prime.

SENSOR_FEATURE_SELECTOR class

Time stamp reset arming options.

SENSOR_FEATURE_SELECTOR.SENSOR_FEATURE_ZEROROT_ENABLE : Zero ROT enable for ONSEMI PYTHON family

DEBUG_LEVEL class

Debug level enumerator.

DEBUG_LEVEL.TRACE : Information level.

DEBUG_LEVEL.WARNING : Warning level.

DEBUG_LEVEL.ERROR : Error level.

DEBUG_LEVEL.FATAL : Fatal error level.

OpenDevBy class

OpenDevice function paramameter enumerator, provides options to be used for selecting the appropriate camera to be opened.

OpenDevBy.Index : Open camera by its index.

OpenDevBy.SerialNumber : Open camera by its serial number.

OpenDevBy.SystemInstancePath : Open camera by its system instance path.

OpenDevBy.DeviceUserId : Open camera by its user ID string.

PRM class

Parameters available for set/get operations.

PRM.DEVICE_NAME : Get camera model name. Type string.

xiCam.GetParam(PRM.DEVICE_NAME, out string val);

PRM.DEVICE_TYPE : Returns device type (1394, USB2.0, CURRERA…..). Type string.

xiCam.GetParam(PRM.DEVICE_TYPE, out string val)

PRM.DEVICE_MODEL_ID : Returns device model id . Type integer.

xiCam.GetParam(PRM.DEVICE_MODEL_ID, out int val)

PRM.SENSOR_MODEL_ID : Returns device sensor model id . Type integer.

xiCam.GetParam(PRM.SENSOR_MODEL_ID, out int val)

PRM.DEBUG_LEVEL : Set the amount of debug prints to be reported from dll. Use DEBUG_LEVEL class to set parameter. Type int.

xiCam.SetParam(PRM.DEBUG_LEVEL, int val)
xiCam.GetParam(PRM.DEBUG_LEVEL, out int val)

PRM.DEVICE_INSTANCE_PATH : Return device system instance path. Type string.

xiCam.GetParam(PRM.DEVICE_INSTANCE_PATH, string val)

PRM.DEVICE_LOCATION_PATH : Return location of the device in the device tree. Type string.

xiCam.GetParam(PRM.DEVICE_LOCATION_PATH, string val)

PRM.DEVICE_USER_ID : Returns custom device ID string. Type string.

xiCam.GetParam(PRM.DEVICE_USER_ID, string val)
xiCam.SetParam(PRM.DEVICE_USER_ID, string val)

PRM.XI_DEVICE_MANIFEST : Return device capability description XML.

xiCam.GetParam(PRM.XI_DEVICE_MANIFEST, string val)

PRM.IMAGE_USER_DATA : Image user ID can be used for synchronization of parameters - marking at image

xiCam.SetParam(PRM.IMAGE_USER_DATA, int val)

PRM.DEVICE_ID : Returns device ID string. Type string.

xiCam.GetParam(PRM.DEVICE_ID, string val)

PRM.AUTO_BANDWIDTH_CALCULATION : Enable/disable automatic bus speed adjusting on device init. Type int.

xiCam.SetParam(PRM.AUTO_BANDWIDTH_CALCULATION, int val)
xiCam.GetParam(PRM.AUTO_BANDWIDTH_CALCULATION, out int val)

PRM.NEW_PROCESS_CHAIN_ENABLE : Enable/disable New processing engine for camera families MU, MQ, MD.
Type int.
Default 0

xiCam.SetParam(PRM.NEW_PROCESS_CHAIN_ENABLE, int val)
xiCam.GetParam(PRM.NEW_PROCESS_CHAIN_ENABLE, out int val)

PRM.DEVICE_SN : Returns device serial number in string.

xiCam.GetParam(PRM.DEVICE_SN, out string val)

PRM.DEVICE_SENS_SN : Returns sensor serial number. Type string.

xiCam.GetParam(PRM.DEVICE_SENS_SN, out string val)

PRM.EXPOSURE : Set/Get exposure time in microseconds. Type int.

xiCam.GetParam( PRM.EXPOSURE, out int val) or
xiCam.SetParam( PRM.EXPOSURE, int val)

PRM.EXPOSURE_MAX : Get longest possible exposure to be set on camera. Type int.

xiCam.GetParam( PRM.EXPOSURE_MAX, out int val)

PRM.EXPOSURE_MIN : Get shortest possible exposure to be set on camera. Type int.

xiCam.GetParam( PRM.EXPOSURE_MIN, out int val)

PRM.EXPOSURE_BURST_COUNT : Set/Get the number of times of exposure in one frame. Type int.

xiCam.GetParam( PRM.EXPOSURE_BURST_COUNT, out int val) or
xiCam.SetParam( PRM.EXPOSURE_BURST_COUNT, int val)

PRM.GAIN_SELECTOR : Select gain type to control with GAIN. Type int.

xiCam.SetParam( PRM.GAIN_SELECTOR, int val) or
xiCam.SetParam( PRM.GAIN, float val)

PRM.GAIN : Set/Get camera gain in dB. Type float.

xiCam.GetParam( PRM.GAIN, out float val) or
xiCam.SetParam( PRM.GAIN, float val)

PRM.GAIN_MAX : Get highest possible camera gain in dB. Type float.

xiCam.GetParam( PRM.GAIN_MAX, out float val)

PRM.GAIN_MIN : Get lowest possible camera gain in dB. Type float.

xiCam.GetParam( PRM.GAIN_MIN, out float val)

PRM.DOWNSAMPLING : Set/Get image resolution by binning or skipping. Type int.

xiCam.GetParam( PRM.DOWNSAMPLING, out int val) or
xiCam.SetParam( PRM.DOWNSAMPLING, int val)

PRM.DOWNSAMPLING_MAX : Get highest value for binning or skipping. Type int.

xiCam.GetParam( PRM.DOWNSAMPLING_MAX, out int val)

PRM.DOWNSAMPLING_MIN : Get lowest value for binning or skipping. Type int.

xiCam.GetParam( PRM.DOWNSAMPLING_MIN, out int val)

PRM.DOWNSAMPLING_TYPE : Change image downsampling type. Use class DOWNSAMPLING_TYPE to set value. Type int.

xiCam.GetParam(PRM.DOWNSAMPLING_TYPE, out int val)
xiCam.SetParam(PRM.DOWNSAMPLING_TYPE, int val)

PRM.BINNING_SELECTOR : Select Binning engine to configure. Use class BINNIG_SELECTOR to set value. Type int.

xiCam.GetParam(PRM.BINNING_SELECTOR , out int val)
xiCam.SetParam(PRM.BINNING_SELECTOR , in int val)

PRM.BINNING_HORIZONTAL_MODE : Selects the mode to use to combine horizontal pixel together. Use class BINNIG_MODE to set value. Type int.

xiCam.GetParam(PRM.BINNING_HORIZONTAL_MODE , out int val)
xiCam.SetParam(PRM.BINNING_HORIZONTAL_MODE , in int val)

PRM.BINNING_VERTICAL_MODE : Selects the mode to use to combine vertical pixel together. Use class BINNIG_MODE to set value. Type int.

xiCam.GetParam(PRM.BINNING_VERTICAL_MODE , out int val)
xiCam.SetParam(PRM.BINNING_VERTICAL_MODE , in int val)

PRM.BINNING_VERTICAL : Defines number of vertical photo-sensitive cells to combine. Type int.

xiCam.GetParam(PRM.BINNING_VERTICAL , out int val)
xiCam.SetParam(PRM.BINNING_VERTICAL , in int val)

PRM.BINNING_HORIZONTAL : Defines number of horizontal photo-sensitive cells to combine. Type int.

xiCam.GetParam(PRM.BINNING_HORIZONTAL , out int val)
xiCam.SetParam(PRM.BINNING_HORIZONTAL , in int val)

PRM.BINNING_HORIZONTAL_PATTERN : Defines binning horizontal pattern. Use class BINNIG_PATTERN to set value. Type int.

xiCam.GetParam(PRM.BINNING_HORIZONTAL_PATTERN , out int val)
xiCam.SetParam(PRM.BINNING_HORIZONTAL_PATTERN , in int val)

PRM.BINNING_VERTICAL_PATTERN : Defines binning vertical pattern. Use class BINNIG_PATTERN to set value. Type int.

xiCam.GetParam(PRM.BINNING_VERTICAL_PATTERN , out int val)
xiCam.SetParam(PRM.BINNING_VERTICAL_PATTERN , in int val)

PRM.DECIMATION_SELECTOR : Select Decimation engine to configure. Use class DECIMATION_SELECTOR to set value. Type int.

xiCam.GetParam(PRM.DECIMATION_SELECTOR , out int val)
xiCam.SetParam(PRM.DECIMATION_SELECTOR , in int val)

PRM.DECIMATION_VERTICAL : Reduces the vertical resolution of the image by the specified decimation factor. Type int.

xiCam.GetParam(PRM.DECIMATION_VERTICAL , out int val)
xiCam.SetParam(PRM.DECIMATION_VERTICAL , in int val)

PRM.DECIMATION_HORIZONTAL : Reduces the horizontal resolution of the image by the specified decimation factor. Type int.

xiCam.GetParam(PRM.DECIMATION_HORIZONTAL , out int val)
xiCam.SetParam(PRM.DECIMATION_HORIZONTAL , in int val)

PRM.DECIMATION_HORIZONTAL_PATTERN : Defines decimation horizontal pattern. Use class DECIMATION_PATTERN to set value. Type int.

xiCam.GetParam(PRM.DECIMATION_HORIZONTAL_PATTERN , out int val)
xiCam.SetParam(PRM.DECIMATION_HORIZONTAL_PATTERN , in int val)

PRM.DECIMATION_VERTICAL_PATTERN : Defines decimation vertical pattern. Use class DECIMATION_PATTERN to set value. Type int.

xiCam.GetParam(PRM.DECIMATION_VERTICAL_PATTERN , out int val)
xiCam.SetParam(PRM.DECIMATION_PATTERN , in int val)

PRM.TEST_PATTERN_GENERATOR_SELECTOR : Select test pattern generator to be used. Use class TEST_PATTERN_GENERATOR_SELECTOR to set value. Type int.

xiCam.GetParam(PRM.TEST_PATTERN_GENERATOR_SELECTOR , out int val)
xiCam.SetParam(PRM.TEST_PATTERN_GENERATOR_SELECTOR , in int val)

PRM.TEST_PATTERN : Select test pattern type to be used on the selected generator. Use class TEST_PATTERN to set value. Type int.

xiCam.GetParam(PRM.TEST_PATTERN , out int val)
xiCam.SetParam(PRM.TEST_PATTERN , in int val)

PRM.IMAGE_DATA_FORMAT : Set/Get output image data format. Use class IMG_FORMAT to set value. Type int.

xiCam.GetParam( PRM.IMAGE_DATA_FORMAT, out int val) or
xiCam.SetParam( PRM.IMAGE_DATA_FORMAT, int val)

PRM.IMAGE_DATA_FORMAT_RGB32_ALPHA : Set/Get the alpha channel of RGB32 output image format(see PRM.IMAGE_DATA_FORMAT). Type int.

xiCam.GetParam( PRM.IMAGE_DATA_FORMAT_RGB32_ALPHA, out int val) or
xiCam.SetParam( PRM.IMAGE_DATA_FORMAT_RGB32_ALPHA, int val)

PRM.IMAGE_PAYLOAD_SIZE : Buffer size in bytes sufficient for output image returned by GetImage. Type int. Read only.

xiCam.GetParam( PRM.IMAGE_PAYLOAD_SIZE, out int val)

PRM.TRANSPORT_PIXEL_FORMAT : Transport pixel format is format of data transported by link to transport layer.

PRM.SHUTTER_TYPE : Change sensor shutter type(CMOS sensor). Use class SHUTTER_TYPE to set value. Type int.

xiCam.GetParam(PRM.SHUTTER_TYPE, out int val)
xiCam.SetParam(PRM.SHUTTER_TYPE, out int val)

PRM.SENSOR_TAPS : Set/Get number of sensor taps. Supported only by MD camera family. Type int.

xiCam.GetParam( PRM.SENSOR_TAPS, out int val) or
xiCam.SetParam( PRM.SENSOR_TAPS, int val)

PRM.SENSOR_CLOCK_FREQ_HZ : Set/Get sensor clock frequency in Hz. Type int.

xiCam.GetParam( PRM.SENSOR_CLOCK_FREQ_HZ, out int val) or
xiCam.SetParam( PRM.SENSOR_CLOCK_FREQ_HZ, int val)

PRM.SENSOR_CLOCK_FREQ_INDEX: Sensor clock frequency. Selects frequency index for sensor. Type int.

xiCam.GetParam( PRM.SENSOR_CLOCK_FREQ_INDEX, out int val) or
xiCam.SetParam( PRM.SENSOR_CLOCK_FREQ_INDEX, int val)

PRM.SENSOR_OUTPUT_CHANNEL_COUNT: Number of output channels from sensor used for data transfer. Type int.

xiCam.GetParam( PRM.SENSOR_OUTPUT_CHANNEL_COUNT, out int val) or

PRM.SENSOR_DATA_BIT_DEPTH : Set/Get sensor output data bit depth. Type int.

xiCam.GetParam( PRM.SENSOR_DATA_BIT_DEPTH, out int val) or
xiCam.SetParam( PRM.SENSOR_DATA_BIT_DEPTH, int val)

PRM.OUTPUT_DATA_BIT_DEPTH : Set/Get device output data bit depth. Type int.

xiCam.GetParam( PRM.OUTPUT_DATA_BIT_DEPTH, out int val) or
xiCam.SetParam( PRM.OUTPUT_DATA_BIT_DEPTH, int val)

PRM.IMAGE_DATA_BIT_DEPTH : Set/Get bitdepth of data returned by function xiGetImage. Type int.

xiCam.GetParam( PRM.IMAGE_DATA_BIT_DEPTH, out int val) or
xiCam.SetParam( PRM.IMAGE_DATA_BIT_DEPTH, int val)

PRM.OUTPUT_DATA_PACKING : Set/Get Device output data packing (or grouping) enabled. Packing could be enabled if output_data_bit_depth > 8 and packing is available. Type int.

xiCam.GetParam( PRM.OUTPUT_DATA_PACKING, out int val) or
xiCam.SetParam( PRM.OUTPUT_DATA_PACKING, int val)

PRM.OUTPUT_DATA_PACKING : Device output data packing (or grouping) enabled. Type int.

xiCam.SetParam( PRM.OUTPUT_DATA_PACKING_TYPE, OUTPUT_DATA_PACKING_TYPE.XI_GROUPING)
xiCam.SetParam( PRM.OUTPUT_DATA_PACKING, int val)

PRM.IMAGE_IS_COLOR : Returns 1 for color cameras. By default -. Type Int.

xiCam.GetParam( PRM.IMAGE_IS_COLOR, out int val) 

PRM.COLOR_FILTER_ARRAY : Returns color filter array type of RAW data. By default -. Type Int.

xiCam.GetParam( PRM.COLOR_FILTER_ARRAY, out int val)

PRM.FRAMERATE : Get frames per second. Type float.

xiCam.GetParam( PRM.FRAMERATE, out float val)

PRM.FRAMERATE_MAX : Get highest possible framerate for current camera settings. Type float.

xiCam.GetParam( PRM.FRAMERATE_MAX, out float val)

PRM.FRAMERATE_MIN : Get lowest framerate for current camera settings. Type float.

xiCam.GetParam( PRM.FRAMERATE_MIN, out float val)

PRM.AVAILABLE_BANDWIDTH : Calculate and return available interface bandwidth(int Megabits). Type int.

xiCam.GetParam(PRM.AVAILABLE_BANDWIDTH, int val)

PRM.COUNTER_SELECTOR : Select frames counter. Type int.

xiCam.SetParam( PRM.COUNTER_SELECTOR, out int val)

PRM.COUNTER_VALUE : Get frames counter status. Type int.

xiCam.GetParam( PRM.COUNTER_VALUE, out int val)

PRM.AVAILABLE_BANDWIDTH_MAX : Get highest possible framerate for current camera settings. Type int.

xiCam.GetParam(PRM.AVAILABLE_BANDWIDTH_MAX, int val)

PRM.AVAILABLE_BANDWIDTH_MIN : Get lowest bandwidth for current camera settings. Type int.

xiCam.GetParam(PRM.AVAILABLE_BANDWIDTH_MIN, int val)

PRM.LIMIT_BANDWIDTH : Set/get bandwidth(datarate)(in Megabits)

xiCam.GetParam(PRM.LIMIT_BANDWIDTH, out int val)
xiCam.SetParam(PRM.LIMIT_BANDWIDTH, int val)

PRM.LIMIT_BANDWIDTH_MAX : Get highest possible bandwidth for current camera settings. Type int

xiCam.GetParam(PRM.LIMIT_BANDWIDTH_MAX, out int val)
xiCam.SetParam(PRM.LIMIT_BANDWIDTH_MAX, int val)

PRM.LIMIT_BANDWIDTH_MIN : Get lowest bandwidth for current camera settings. Type int.

xiCam.GetParam(PRM.LIMIT_BANDWIDTH_MIN, out int val)
xiCam.SetParam(PRM.LIMIT_BANDWIDTH_MIN, int val)

PRM.BUFFER_POLICY : Data move policy.

xiCam.GetParam( PRM.BUFFER_POLICY, out float val)
xiCam.SetParam( PRM.BUFFER_POLICY, int val)

PRM.OFFSET_X : Set/Get horizontal offset from the origin to the area of interest (in pixels). Type int. Must be even, otherwise exception is raised.

xiCam.GetParam( PRM.OFFSET_X, out int val) or
xiCam.SetParam( PRM.OFFSET_X, int val)

PRM.OFFSET_X_MAX : Get maximum horizontal offset from the origin to the area of interest (in pixels). Type int.

xiCam.GetParam( PRM.OFFSET_X_MAX, out int val) 

PRM.OFFSET_X_MIN : Get minimum horizontal offset from the origin to the area of interest (in pixels). Type int.

xiCam.GetParam( PRM.OFFSET_X_MIN, out int val) 

PRM.OFFSET_Y : Set/Get vertical offset from the origin to the area of interest (in pixels). Type int. Must be even, otherwise exception is raised.

xiCam.GetParam( PRM.OFFSET_Y, out int val) or
xiCam.SetParam( PRM.OFFSET_Y, int val)

PRM.OFFSET_Y_MAX : Get maximum vertical offset from the origin to the area of interest (in pixels). Type int.

xiCam.GetParam( PRM.OFFSET_Y_MAX, out int val) 

PRM.OFFSET_Y_MIN : Get minimal vertical offset from the origin to the area of interest (in pixels). Type int.

xiCam.GetParam( PRM.OFFSET_Y_MIN, out int val) 

PRM.WIDTH : Set/Get width of the image provided by the camera (in pixels). Type int. Must be divisible by 4, otherwise exception is raised.

xiCam.GetParam( PRM.WIDTH, out int val) or
xiCam.SetParam( PRM.WIDTH, int val)

PRM.WIDTH_MAX : Get maximal image width provided by the camera (in pixels). Type int.

xiCam.GetParam( PRM.WIDTH_MAX, out int val) 

PRM.WIDTH_MIN : Get minimal image width provided by the camera (in pixels). Type int.

xiCam.GetParam( PRM.WIDTH_MIN, out int val) 

PRM.HEIGHT : Set/Get height of the image provided by the camera (in pixels). Type int. Must be even, otherwise exception is raised.

xiCam.GetParam( PRM.HEIGHT, out int val) or
xiCam.SetParam( PRM.HEIGHT, int val)

PRM.HEIGHT_MAX : Get maximal image height provided by the camera (in pixels). Type int.

xiCam.GetParam( PRM.HEIGHT_MAX, out int val)

PRM.HEIGHT_MIN : Get minimal image height provided by the camera (in pixels). Type int.

xiCam.GetParam( PRM.HEIGHT_MIN, out int val)

PRM.REGION_SELECTOR : Selects Region in Multiple ROI which parameters are set by width, height, ... ,region mode. Type int.

 xiCam.GetParam(PRM.REGION_SELECTOR, out int val) or
      xiCam.SetParam(PRM.REGION_SELECTOR, int val)

PRM.REGION_SELECTOR_MAX : Get maximal region selector provided by the camera. Type int.

 xiCam.GetParam(PRM.REGION_SELECTOR_MAX, out int val) 

PRM.REGION_SELECTOR_MIN : Get minimall region selector provided by the camera. Type int.

 xiCam.GetParam(PRM.REGION_SELECTOR_MIN, out int val) 

PRM.REGION_MODE : Activates/deactivates Region selected by Region Selector. Type int. 0-inactive, 1-active. Type int.

 xiCam.GetParam(PRM.REGION_MODE, out int val) or
      xiCam.SetParam(PRM.REGION_MODE, int val)

PRM.REGION_MODE_MAX : Get maximal mode (is 1) active region. Type int.

 xiCam.GetParam(PRM.REGION_MODE_MAX, out int val) 

PRM.REGION_MODE_MIN : Get minimal mode (is 0) inactive region. Type int.

 xiCam.GetParam(PRM.REGION_MODE_MIN, out int val) 

PRM.HORIZONTAL_FLIP : Activates horizontal flip if available in camera. Currently available only some MQ cameras models. Type int.

 xiCam.GetParam(PRM.HORIZONTAL_FLIP, out int val) 

PRM.VERTICAL_FLIP : Activates vertical flip if available in camera. Currently available only some MQ cameras models. Type int.

 xiCam.GetParam(PRM.VERTICAL_FLIP, out int val) 

PRM.LUT_EN : Activates look up table. Currently available only for Currera-R and MQ cameras.

xiCam.GetParam( PRM.LUT_EN, out int val) or
xiCam.SetParam( PRM.LUT_EN, int val)

PRM.LUT_INDEX : Controls the index (offset) of the coefficient to access in the LUT. Type int.

xiCam.GetParam( PRM.LUT_INDEX, out int val) or
xiCam.SetParam( PRM.LUT_INDEX, int val)

PRM.LUT_INDEX_MAX : Get highest LUT index (offset) of the coefficient to access in the LUT. Type int.

xiCam.GetParam( PRM.LUT_INDEX_MAX, out int val)

PRM.LUT_INDEX_MIN : Get lowest LUT index (offset) of the coefficient to access in the LUT. Type int.

xiCam.GetParam( PRM.LUT_INDEX_MIN, out int val)

PRM.LUT_VALUE : Set/Get value at entry LUTIndex of the LUT. Type int.

xiCam.GetParam( PRM.LUT_VALUE, out int val) or
xiCam.SetParam( PRM.LUT_VALUE, int val)

PRM.LUT_VALUE_MAX : Get highest value to be set in LUT. Type int.

xiCam.GetParam( PRM.LUT_VALUE_MAX, out int val)

PRM.LUT_VALUE_MIN : Get lowest value to be set in LUT. Type int.

xiCam.GetParam( PRM.LUT_VALUE_MIN, out int val)

PRM.TRG_SOURCE : Set/Get source of trigger. Use TRG_SOURCE class to set parameter. Type int.

xiCam.GetParam( PRM.TRG_SOURCE, out int val) or
xiCam.SetParam( PRM.TRG_SOURCE, int val)

PRM.TRG_SOFTWARE : Set an internal software trigger. h3. PRM.TRG_SOURCE must be set to TRG_SOFTWARE. Type int.

xiCam.SetParam( PRM.TRG_SOFTWARE, int val)

PRM.TRG_DELAY : Specifies the delay in microseconds (us) to apply after the trigger reception before activating it. Type int.

xiCam.GetParam(PRM.TRG_DELAY, out int val)
xiCam.SetParam(PRM.TRG_DELAY, int val)

PRM.GPI_SELECTOR : Select camera GPI port. Type int.

xiCam.GetParam( PRM.GPI_SELECTOR, out int val) or
xiCam.SetParam( PRM.GPI_SELECTOR, int val)

PRM.GPI_SELECTOR_MAX : Get highest GPI port number on camera. Type int.

xiCam.GetParam( PRM.GPI_SELECTOR_MAX, out int val)

PRM.GPI_SELECTOR_MIN : Get lowest GPI port number on camera. Type int.

xiCam.GetParam( PRM.GPI_SELECTOR_MIN, out int val)

PRM.GPI_LEVEL : Get current GPI level. By default -. Type int.

xiCam.GetParam( PRM.GPI_LEVEL, out int val) or

PRM.GPI_MODE : Set/Get GPI functionality. Select port by using GPI_SELECTOR parameter.
Use GPI_MODE class to set mode. Type int.

xiCam.GetParam( PRM.GPI_MODE, out int val) or
xiCam.SetParam( PRM.GPI_MODE, int val)

PRM.GPO_SELECTOR : Select camera GPO port. Type int.

xiCam.GetParam( PRM.GPO_SELECTOR, out int val) or
xiCam.SetParam( PRM.GPO_SELECTOR, int val)

PRM.GPO_SELECTOR_MAX : Get highest GPO port number on camera. Type int.

xiCam.GetParam( PRM.GPO_SELECTOR_MAX, out int val)

PRM.GPO_SELECTOR_MIN : Get lowest GPI port number on camera. Type int.

xiCam.GetParam( PRM.GPO_SELECTOR_MIN, out int val)

PRM.GPO_MODE : Set/Get GPO functionality. Select port by using GPO_SELECTOR parameter.
Use GPO_MODE class to set mode. Type int.

xiCam.GetParam( PRM.GPO_MODE, out int val) or
xiCam.SetParam( PRM.GPO_MODE, int val)

PRM.LED_SELECTOR : Selects camera LED to be used. Currently supported only for Currera-R cameras. Type int.

xiCam.GetParam( PRM.LED_SELECTOR, out int val) or
xiCam.SetParam( PRM.LED_SELECTOR, int val)

PRM.LED_SELECTOR_MAX : Get highest LED number on camera. Type int.

xiCam.GetParam( PRM.LED_SELECTOR_MAX, out int val)

PRM.LED_SELECTOR_MIN : Get lowest LED number on camera. Type int.

xiCam.GetParam( PRM.LED_SELECTOR_MIN, out int val)

PRM.LED_MODE : Set/Get LED functionality. Select port by using LED_SELECTOR parameter.
Use LED_MODE class to set parameter. Type int.

xiCam.GetParam( PRM.LED_MODE, out int val) or
xiCam.SetParam( PRM.LED_MODE, int val)

PRM.TS_RST_MODE : Defines how time stamp reset engine will be armed.
Use TS_RST_MODE class to set parameter. Type int.

xiCam.GetParam(PRM.TS_RST_MODE, out int val) or
xiCam.SetParam(PRM.TS_RST_MODE, int val)

PRM.TS_RST_SOURCE : Defines which source will be used for timestamp reset. Writing this parameter will trigger settings of engine (arming)
Use TS_RST_SOURCE class to set parameter. Type int.

xiCam.GetParam( PRM.TS_RST_SOURCE, out int val) or
xiCam.SetParam( PRM.TS_RST_SOURCE, int val)

PRM.ACQ_FRAME_BURST_COUNT : Sets number of frames acquired by burst. This burst is used only if trigger is set to FrameBurstStart. Type int.

xiCam.GetParam(PRM.ACQ_FRAME_BURST_COUNT, out int val) or
xiCam.SetParam(PRM.ACQ_FRAME_BURST_COUNT, int val)

PRM.ACQ_BUFFER_SIZE : Acquisition buffer size in bytes.
By default 53248000. Type int.

xiCam.GetParam( PRM.ACQ_BUFFER_SIZE, out int val) or
xiCam.SetParam( PRM.ACQ_BUFFER_SIZE, int val)

PRM.ACQ_BUFFER_SIZE_UNIT : Acquisition buffer size unit in bytes.
By default 1. Type int.

xiCam.GetParam( PRM.ACQ_BUFFER_SIZE_UNIT, out int val) or
xiCam.SetParam( PRM.ACQ_BUFFER_SIZE_UNIT, int val)

PRM.ACQ_TRANSPORT_BUFFER_SIZE : Acquisition transport buffer size in bytes. By default 1048576. Type int.

xiCam.GetParam(PRM.ACQ_TRANSPORT_BUFFER_SIZE, out int val) or
xiCam.SetParam(PRM.ACQ_TRANSPORT_BUFFER_SIZE, int val)

PRM.ACQ_TRANSPORT_BUFFER_SIZE_MAX : Maximum of acquisition transport buffer size in bytes. Type int.

xiCam.GetParam(PRM.ACQ_TRANSPORT_BUFFER_SIZE_MIN, out int val)

PRM.ACQ_TRANSPORT_BUFFER_SIZE_MIN : Minimum of acquisition transport buffer size in bytes. Type int.

xiCam.GetParam(PRM.ACQ_TRANSPORT_BUFFER_SIZE_MIN, out int val)

PRM.ACQ_TRANSPORT_PACKET_SIZE : Acquisition transport packet size in bytes. Type int.

xiCam.GetParam(PRM.ACQ_TRANSPORT_PACKET_SIZE, out int val)

PRM.BUFFERS_QUEUE_SIZE : Queue of field/frame buffers.
By default 4. Type int.

xiCam.GetParam( PRM.BUFFERS_QUEUE_SIZE, out int val) or
xiCam.SetParam( PRM.BUFFERS_QUEUE_SIZE, int val)

PRM.BUFFERS_QUEUE_SIZE_MAX : Maximum of images count in queue. Type int.

xiCam.GetParam( PRM.BUFFERS_QUEUE_SIZE_MAX, out int val)

PRM.BUFFERS_QUEUE_SIZE_MIN : Minimum of images count in queue. Type int.

xiCam.GetParam( PRM.BUFFERS_QUEUE_SIZE_MIN, out int val)

ACQ_TRANSPORT_BUFFER_COMMIT : Number of buffers to commit to low level.
By default -. Type int.

xiCam.GetParam( PRM.ACQ_TRANSPORT_BUFFER_COMMIT, out int val) or
xiCam.SetParam( PRM.ACQ_TRANSPORT_BUFFER_COMMIT, int val)

ACQ_TRANSPORT_BUFFER_COMMIT_MAX : Maximum number of buffers to commit to low level. Type int.

xiCam.GetParam( PRM.ACQ_TRANSPORT_BUFFER_COMMIT_MAX, out int val)

ACQ_TRANSPORT_BUFFER_COMMIT_MIN : Minimum number of buffers to commit to low level. Type int.

xiCam.GetParam( PRM.ACQ_TRANSPORT_BUFFER_COMMIT_MIN, out int val)

PRM.RECENT_FRAME : GetImage returns most recent frame. By default 0. Type int.

xiCam.GetParam(PRM.RECENT_FRAME, out int val) or
xiCam.SetParam(PRM.RECENT_FRAME, int val)

PRM.TRANSPORT_DATA_TARGET: Sets the transport data target to CPU-RAM or GPU-RAM. Type int.

xiCam.SetParam(PRM.TRANSPORT_DATA_TARGET, int val)

PRM.DEVICE_RESET : Resets the camera to default state. By default 0. Type int.

xiCam.SetParam(PRM.DEVICE_RESET, int val)

PRM.CMS : Initialize/uninitialize CMS, perceptual inetent. By default CMS_MODE.DIS. Type int.

xiCam.GetParam(PRM.CMS, out int val) or
xiCam.SetParam(PRM.CMS, int val)

PRM.CMS_INTENT : Renderung intent. By default CMS_INTENTS.INTENT_PERCEPTUAL. Type int.

xiCam.GetParam(PRM.CMS_INTENT, out int val) or
xiCam.SetParam(PRM.CMS_INTENT, int val)

PRM.APPLY_CMS : Apply CMS profiles(input.icc and output.icm), perceptual inetent. By default 0. Type int.

xiCam.GetParam(PRM.APPLY_CMS, out int val) or
xiCam.SetParam(PRM.APPLY_CMS, int val)

PRM.INPUT_CMS_PROFILE : Apply input CMS profile. Type string.

xiCam.SetParam(PRM.INPUT_CMS_PROFILE, string val)

PRM.OUTPUT_CMS_PROFILE : Apply output CMS profile. Type string.

xiCam.SetParam(PRM.OUTPUT_CMS_PROFILE, string val)

PRM.WB_KR : White balance red coefficient. By default 1. Type float.

xiCam.GetParam( PRM.WB_KR, out float val) or
xiCam.SetParam( PRM.WB_KR, float val) 

PRM.WB_KG : White balance green coefficient. By default 1. Type float.

xiCam.GetParam( PRM.WB_KG, out float val) or
xiCam.SetParam( PRM.WB_KG, float val)  

PRM.WB_KB : White balance blue coefficient. By default 1. Type float.

xiCam.GetParam( PRM.WB_KB, out float val) or
xiCam.SetParam( PRM.WB_KB, float val)  

PRM.MANUAL_WB : Calculates White Balance. By default -. Type int.

xiCam.SetParam( PRM.MANUAL_WB, 0)  

PRM.AUTO_WB : Automatic white balance. By default 0. Type int.

xiCam.GetParam( PRM.AUTO_WB, out int val)  
xiCam.SetParam( PRM.AUTO_WB, int val)  

PRM.GAMMAY : Luminosity gamma. By default 1.0. Type float.

xiCam.GetParam( PRM.GAMMAY, out float val) or
xiCam.SetParam( PRM.GAMMAY, float val)  

PRM.GAMMAC : Chromaticity gamma. By default 0. Type float.

xiCam.GetParam( PRM.GAMMAC, out float val) or
xiCam.SetParam( PRM.GAMMAC, float val)  

PRM.SHARPNESS : Sharpness strenght. By default 0. Type float.

xiCam.GetParam( PRM.SHARPNESS, out float val) or
xiCam.SetParam( PRM.SHARPNESS, float val)  

PRM.CC_MATRIX_00 : Color Correction Matrix element [0][0]. By default 1.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_00, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_00, float val)  

PRM.CC_MATRIX_01 : Color Correction Matrix element [0][1]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_01, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_01, float val)  

PRM.CC_MATRIX_02 : Color Correction Matrix element [0][2]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_02, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_02, float val)  

PRM.CC_MATRIX_03 : Color Correction Matrix element [0][3]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_03, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_03, float val)  

PRM.CC_MATRIX_10 : Color Correction Matrix element [1][0]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_10, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_10, float val)  

PRM.CC_MATRIX_11 : Color Correction Matrix element [1][1]. By default 1.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_11, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_11, float val)  

PRM.CC_MATRIX_12 : Color Correction Matrix element [1][2]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_12, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_12, float val)  

PRM.CC_MATRIX_13 : Color Correction Matrix element [1][3]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_13, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_13, float val)  

PRM.CC_MATRIX_20 : Color Correction Matrix element [2][0]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_20, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_20, float val) 

PRM.CC_MATRIX_21 : Color Correction Matrix element [2][1]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_21, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_21, float val) 

PRM.CC_MATRIX_22 : Color Correction Matrix element [2][2]. By default 1.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_22, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_22, float val) 

PRM.CC_MATRIX_23 : Color Correction Matrix element [2][3]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_23, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_23, float val) 

PRM.CC_MATRIX_30 : Color Correction Matrix element [3][0]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_30, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_30, float val) 

PRM.CC_MATRIX_31 : Color Correction Matrix element [3][1]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_31, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_31, float val) 

PRM.CC_MATRIX_32 : Color Correction Matrix element [3][2]. By default 1.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_32, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_32, float val) 

PRM.CC_MATRIX_33 : Color Correction Matrix element [3][3]. By default 0.0. Type float.

xiCam.GetParam( PRM.CC_MATRIX_33, out float val) or
xiCam.SetParam( PRM.CC_MATRIX_33, float val) 

PRM.DEFAULT_CC_MATRIX : Set default Color Correction Matrix.

xiCam.SetParam( PRM.DEFAULT_CC_MATRIX, int val) 

PRM.AEAG : Start automatic exposure/gain. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.AEAG, int val) 
xiCam.GetParam( PRM.AEAG, out int val)

PRM.EXP_PRIORITY : Exposure priority (0.5 - exposure 50%, gain 50%). By default 0.8. Type float.

xiCam.SetParam( PRM.EXP_PRIORITY, float val)
xiCam.GetParam( PRM.EXP_PRIORITY, out float val)

PRM.AE_MAX_LIMIT : Maximum limit of exposure in AEAG procedure. By default 1000000(1s). Type integer.

xiCam.SetParam( PRM.AE_MAX_LIMIT, int val)
xiCam.GetParam( PRM.AE_MAX_LIMIT, out int val)

PRM.AG_MAX_LIMIT : Maximum limit of gain in AEAG procedure. By default defined by sensor. Type float.

xiCam.SetParam( PRM.AG_MAX_LIMIT, float val)
xiCam.GetParam( PRM.AG_MAX_LIMIT, out float val)

PRM.AEAG_LEVEL : Average intensity of output signal AEAG should achieve(in ). By default 40(). Type integer.

xiCam.SetParam( PRM.AEAG_LEVEL, int val);
xiCam.GetParam( PRM.AEAG_LEVEL, out int val);

PRM.AEAG_ROI_OFFSET_X : Automatic exposure/gain ROI offset X. Default 0. Type: integer.

xiCam.SetParam( PRM.AEAG_ROI_OFFSET_X, int val);
xiCam.GetParam( PRM.AEAG_ROI_OFFSET_X, out int val);

PRM.AEAG_ROI_OFFSET_Y : Automatic exposure/gain ROI offset Y. Default 0. Type: integer.

xiCam.SetParam( PRM.AEAG_ROI_OFFSET_Y, int val);
xiCam.GetParam( PRM.AEAG_ROI_OFFSET_Y, out int val);

PRM.AEAG_ROI_WIDTH : Automatic exposure/gain ROI width. Default Default depends on sensors resolution and downsampling. Type: integer.

xiCam.SetParam( PRM.AEAG_ROI_WIDTH, int val);
xiCam.GetParam( PRM.AEAG_ROI_WIDTH, out int val);

PRM.AEAG_ROI_HEIGHT : Automatic exposure/gain ROI height. Default depends on sensors resolution and downsampling. Type: integer.

xiCam.SetParam( PRM.AEAG_ROI_HEIGHT, int val);
xiCam.GetParam( PRM.AEAG_ROI_HEIGHT, out int val);

PRM.SENS_DEFECTS_CORR_LIST_SELECTOR: Selector for current sensor defects list used by Sensor Defect Correction. By default 0(Factory). Type enumerator.

xiCam.SetParam( PRM.SENS_DEFECTS_CORR_LIST_SELECTOR, int val);
xiCam.GetParam( PRM.SENS_DEFECTS_CORR_LIST_SELECTOR, out int val);

PRM.SENS_DEFECTS_CORR_LIST_CONTENT: Set/Get current sensor defects list used by Sensor Defect Correction(in specific text format). By default -(Factory). Type string.

xiCam.SetParam( PRM.SENS_DEFECTS_CORR_LIST_SELECTOR, string val);
xiCam.GetParam( PRM.SENS_DEFECTS_CORR_LIST_SELECTOR, out string val);

PRM.SENS_DEFECTS_CORR : Enable sensor defects correction of sensor defects. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.SENS_DEFECTS_CORR, int val);
xiCam.GetParam( PRM.SENS_DEFECTS_CORR, out int val);

PRM.FFC : Enable image flat field correction.
By default 0(disabled). Type integer.

xiCam.SetParam( PRM.FFC , int val);
xiCam.GetParam( PRM.FFC , out int val);

PRM.FFC_FLAT_FIELD_FILE_NAME: Set name of file of image flat field to be applied for FFC processor(in tiff format).
By default -. Type string.

xiCam.SetParam(PRM.FFC_FLAT_FIELD_FILE_NAME, out string val);

PRM.FFC_DARK_FIELD_FILE_NAME: Set name of file of image dark field to be applied for FFC processor(in tiff format).
By default -. Type string.

xiCam.SetParam(PRM.FFC_DARK_FIELD_FILE_NAME, out string val);

PRM.COLUMN_FPN_CORRECTION : Enable correction of column fpn. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.COLUMN_FPN_CORRECTION, int val);
xiCam.GetParam( PRM.COLUMN_FPN_CORRECTION, out int val);

PRM.ROW_FPN_CORRECTION : Enable correction of row fpn. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.ROW_FPN_CORRECTION, int val);
xiCam.GetParam( PRM.ROW_FPN_CORRECTION, out int val);

PRM.DEBOUNCE_EN : Enable/Disable debounce to selected GPI. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.DEBOUNCE_EN, int val);
xiCam.GetParam( PRM.DEBOUNCE_EN, out int val);

PRM.DEBOUNCE_T0 : Debounce time (x * 10us). Type integer.

xiCam.SetParam( PRM.DEBOUNCE_T0, int val);
xiCam.GetParam( PRM.DEBOUNCE_T0, out int val);

PRM.DEBOUNCE_T1 : Debounce time (x * 10us). Type integer.

xiCam.SetParam( PRM.DEBOUNCE_T1, int val);
xiCam.GetParam( PRM.DEBOUNCE_T1, out int val);

PRM.DEBOUNCE_POL : Debounce polarity (pol = 1 t0 - falling edge, t1 - rising edge). By default 0(disabled). Type integer.

xiCam.SetParam( PRM.DEBOUNCE_POL, int val);
xiCam.GetParam( PRM.DEBOUNCE_POL, out int val);

PRM.IS_COOLED : Returns 1 for cameras that support cooling. By default -. Type integer.

xiCam.GetParam( PRM.IS_COOLED, out int val);

PRM.COOLING : Set camera cooling. By default 0. Type integer.

xiCam.SetParam( PRM.COOLING, int val);
xiCam.GetParam( PRM.COOLING, out int val);

PRM.TARGET_TEMP : Set sensor target temperature for cooling. By default 20. Type float.

xiCam.SetParam( PRM.TARGET_TEMP, float val);
xiCam.GetParam( PRM.TARGET_TEMP, out float val);

PRM.TEMP_SELECTOR : Camera temperature selector. By default -. Type int.

xiCam.SetParam( PRM.TEMP_SELECTOR, int val);
xiCam.GetParam( PRM.TEMP_SELECTOR, out int val);

PRM.TEMP : Camera temperature(selected by TEMP_SELECTOR). By default -. Type float.

xiCam.SetParam( PRM.TEMP, float val);
xiCam.GetParam( PRM.TEMP, out float val);

PRM.CHIP_TEMP : Camera chip temperature. By default -. Type float.

xiCam.SetParam( PRM.CHIP_TEMP, float val);
xiCam.GetParam( PRM.CHIP_TEMP, out float val);

PRM.HOUS_TEMP : Camera housing temperature. By default -. Type float.

xiCam.SetParam( PRM.HOUS_TEMP, float val);
xiCam.GetParam( PRM.HOUS_TEMP, out float val);

PRM.HOUS_BACK_SIDE_TEMP : Camera housing temperature. By default -. Type float.

xiCam.SetParam( PRM.HOUS_BACK_SIDE_TEMP, float val);
xiCam.GetParam( PRM.HOUS_BACK_SIDE_TEMP, out float val);

SENSOR_BOARD_TEMP : Camera sensor board temperature. By default -. Type float.

xiCam.SetParam( PRM.SENSOR_BOARD_TEMP, float val);
xiCam.GetParam( PRM.SENSOR_BOARD_TEMP, out float val);

PRM.TEMP_CONTROL_MODE: Camera temperature control mode. By default -. Type int.

xiCam.SetParam( PRM.TEMP_CONTROL_MODE, int val);
xiCam.GetParam( PRM.TEMP_CONTROL_MODE, out int val);

PRM.TEMP_ELEMENT_SEL: Camera temperature element selector. By default -. Type int.

xiCam.SetParam( PRM.TEMP_ELEMENT_SEL, int val);
xiCam.GetParam( PRM.TEMP_ELEMENT_SEL, out int val);

PRM.TEMP_ELEMENT_VALUE: Camera element value (selected by TEMP_ELEMENT_SEL). By default -. Type float.

xiCam.SetParam( PRM.TEMP_ELEMENT_VALUE, float val);
xiCam.GetParam( PRM.TEMP_ELEMENT_VALUE, out float val);

PRM.HDR : Enable High Dynamic Range feature. By default 0(disabled). Type integer.

xiCam.SetParam( PRM.HDR, int val);
xiCam.GetParam( PRM.HDR, out int val);

PRM.HDR_KNEEPOINT_COUNT : The number of kneepoints in PWLR. Type integer.

xiCam.SetParam(PRM.HDR_KNEEPOINT_COUNT, int val);
xiCam.GetParam(PRM.HDR_KNEEPOINT_COUNT, out int val);

PRM.HDR_T1 : Exposure time of first slope(in microseconds). By default 40000us. Type integer.

xiCam.SetParam(PRM.HDR_T1, int val);
xiCam.GetParam(PRM.HDR_T1, out int val);

PRM.HDR_T2 : Exposure time of second slope(in microseconds). By default 20000us. Type integer.

xiCam.SetParam(PRM.HDR_T2, int val);
xiCam.GetParam(PRM.HDR_T2, out int val);

PRM.KNEEPOINT1 : First kneepoint (% of sensor saturation) By default 40%. Type integer.

xiCam.SetParam(PRM.KNEEPOINT1, int val);
xiCam.GetParam(PRM.KNEEPOINT1, out int val);

PRM.KNEEPOINT2 : Second kneepoint (% of sensor saturation) By default 40% Type integer.

xiCam.SetParam(PRM.KNEEPOINT2, int val);
xiCam.GetParam(PRM.KNEEPOINT2, out int val); 

PRM.API_VERSION : Return version of xiApi.NET. By default -. Type string.

xiCam.GetParam( PRM.API_VERSION, out string val);

PRM.DRV_VERSION : Returns the version of current device driver. By default -. Type string.

xiCam.GetParam( PRM.DRV_VERSION, out string val);

PRM.MCU1_VERSION : Returns the version of MCU1 firmware. By default -. Type string.

xiCam.GetParam(PRM.MCU1_VERSION, out string val)

PRM.MCU2_VERSION : Returns the version of MCU2 firmware. By default -. Type string.

xiCam.GetParam(PRM.MCU2_VERSION, out string val)

PRM.MCU3_VERSION : Returns the version of MCU3 firmware. By default -. Type string.

xiCam.GetParam(PRM.MCU3_VERSION, out string val)

PRM.FPGA1_VERSION : Returns the version of FPGA1 firmware. By default -. Type string.

xiCam.GetParam(PRM.FPGA1_VERSION, out string val)

PRM.XMLMAN_VERSION : Returns version of XML manifest. By default -. Type string.

xiCam.GetParam(PRM.XMLMAN_VERSION, out string val)

PRM.HW_REVISION : Returns the hardware revision number of the camera. By default -. Type integer.

xiCam.GetParam(PRM.HW_REVISION, out string val)

PRM.IS_DEVICE_EXIST : Returns 1 if camera is connected and works properly. Type string.

xiCam.GetParam(PRM.IS_DEVICE_EXIST, out int val)

PRM.ACQUISITION_STATUS_SELECTOR : Selects the internal acquisition signal to read using ACQUISITION_STATUS Type int.

xiCam.SetParam( PRM.ACQUISITION_STATUS_SELECTOR, int val)

PRM.ACQUISITION_STATUS :Returns acquisition status. Type string.

xiCam.GetParam(PRM.ACQUISITION_STATUS, out int val)

PRM.AVAILABLE_BANDWIDTH : Calculate and return available interface bandwidth(int Megabits). By default: Maximum of given interface. Type integer.

xiCam.GetParam( PRM.AVAILABLE_BANDWIDTH, out int val);

PRM.LIMIT_BANDWIDTH : Set/get camera data-rate (in Megabits) used for sending image data while acquisition. This parameter can be used to decrease data-rate when more cameras are connected to same interface to share same channel. By default: Maximum of given camera. Type integer.

xiCam.SetParam( PRM.LIMIT_BANDWIDTH, int data_rate_Mbps);
xiCam.GetParam( PRM.LIMIT_BANDWIDTH, out int data_rate_Mbps);

PRM.LIMIT_BANDWIDTH_MODE: Enabling this parameter - selects if
limiting defined using PRM.LIMIT_BANDWIDTH is applied. If not applied - device is running on last (typically full data speed).

PRM.SENSOR_MODE : Current sensor mode. Allows to select sensor mode by one integer. Setting of this parameter affects the image dimensions and downsampling.. Type integer.

xiCam.SetParam(PRM.SENSOR_MODE, int val);
xiCam.GetParam(PRM.SENSOR_MODE, out int val);

PRM.IMAGE_BLACK_LEVEL : Black level is level (in pixel counts) where average of pixels are changed when no light comes to the sensor.

PRM.API_CONTEXT_LIST : API Context contains text representation of current settings for offline image processing. It can be get while acquisition to store the context. Respectively it can be set while offline processing - to restore context.

PRM.READ_FILE_FFS: Read file from camera flash filesystem. By default -. Type string.

xiCam.GetParam(PRM.READ_FILE_FFS, out string val);

PRM.WRITE_FILE_FFS: Write file to camera flash filesystem. By default -. Type string.

xiCam.SetParam(PRM.WRITE_FILE_FFS, out string val);

PRM.FFS_FILE_NAME: Set name of file to be written/read from camera FFS. By default -. Type string.

xiCam.SetParam(PRM.FFS_FILE_NAME, out string val);

PRM.FFS_FILE_ID : File number(id) in camera FFS.
By default 0. Type integer.

xiCam.SetParam(PRM.FFS_FILE_ID, out int val);
xiCam.GetParam(PRM.FFS_FILE_ID, out int val);

PRM.FFS_FILE_SIZE : File size(file name can be set by PRM.FFS_FILE_NAME).

By default -. Type integer.
xiCam.GetParam(PRM.FFS_FILE_SIZE, out int val);

PRM.FREE_FFS_SIZE: Size of free camera FFS. By default -. Type integer.

xiCam.GetParam(PRM.FREE_FFS_SIZE, out int val);

PRM.USED_FFS_SIZE: Size of free camera FFS. By default -. Type integer.

xiCam.GetParam(PRM.USED_FFS_SIZE, out int val);

PRM.FFS_ACCESS_KEY: Setting of key enables file operations on some cameras.

xiCam.SetParam(PRM.FFS_ACCESS_KEY, int val);

PRM.LENS_MODE: Status of lens control interface. This shall be set to 1 before any Lens operations.

xiCam.SetParam(PRM.LENS_MODE, out int mode);

PRM.LENS_APERTURE_VALUE: Current lens aperture value in stops. Examples: 2.8, 4, 5.6, 8, 11

xiCam.SetParam(PRM.LENS_APERTURE_VALUE, float aperture);

PRM.LENS_FOCUS_MOVEMENT_VALUE: Lens current focus movement value to be used by LENS_FOCUS_MOVE in motor steps.

xiCam.SetParam(PRM.LENS_FOCUS_MOVEMENT_VALUE, int motor_steps_count);

PRM.LENS_FOCUS_MOVE: Moves lens focus motor by steps set in LENS_FOCUS_MOVEMENT_VALUE.

xiCam.SetParam(PRM.LENS_FOCUS_MOVE, int any);

PRM.LENS_FOCUS_DISTANCE: Lens focus distance in cm.

xiCam.GetParam(PRM.LENS_FOCUS_DISTANCE, out float distance_cm);

PRM.LENS_FOCAL_LENGTH: Lens focal distance in mm.

xiCam.GetParam(PRM.LENS_FOCAL_LENGTH, out float lendth_mm);

PRM.LENS_FEATURE_SELECTOR: Selects the current feature which is accessible by LENS_FEATURE.

xiCam.SetParam(PRM.LENS_FEATURE_SELECTOR, int selector_id);

PRM.LENS_FEATURE: Allows access to lens feature value currently selected by LENS_FEATURE_SELECTOR.

xiCam.SetParam(PRM.LENS_FEATURE, float value);

PRM.SENSOR_FEATURE_SELECTOR: Selects the current feature which is accessible by SENSOR_FEATURE_VALUE. Use SENSOR_FEATURE_SELECTOR class to set parameter. Type int.

xiCam.SetParam(PRM.SENSOR_FEATURE_SELECTOR, int select_id);
xiCam.GetParam(PRM.SENSOR_FEATURE_SELECTOR, out int select_id);

PRM.SENSOR_FEATURE_VALUE: Allows access to sensor feature value currently selected by SENSOR_FEATURE_SELECTOR. All ranges depends on selected feature.

xiCam.SetParam(PRM.SENSOR_FEATURE_VALUE, int val);
xiCam.GetParam(PRM.SENSOR_FEATURE_VALUE, out int val);

ImgParams class

Provides additional information about the acquired image.

int GetDataFormat()

Description : Returns data format of the last acquired image.

int GetWidth()

Description : Returns width of the last acquired image.

int GetHeight()

Description : Returns height of the last acquired image.

int GetFrameNum()

Description : Returns number of the last acquired image.

double GetTimestamp()

Description : Returns time stamp in seconds with microsecond precision.
Note: On most cameras the TimeStamp is represented in 32 bit microsecond number. The result resets automatically to zero after 2^32 micro-seconds (precisely 4294 seconds and 967296 micro seconds).

int GetDigitalInputLevel()

Description : Returns GPI input level.

int GetBlackLevel()

Description : Returns image black level (only for RAW and Mono formats).

void UpdateValues(int frm, int width, int height, int nframe, int tsSec, int tsUsec, int gpil, int bl)

Description : Update internal data of object.

xiCam class

Contains function definitions for the xiAPI.NET class.

void GetNumberDevices(out int devCount)

Description : Returns the number of all discovered devices.

Parameters :
out int devCount : The number of connected devices.

int GetNumberDevices()

Description : Returns the number of all discovered devices.

Return : The number of connected devices.

void OpenDevice(int DevID)

Description : This function initializes the device.

Parameters :
int DevID : Index of the device.

void OpenDevice(OpenDevBy Open_By, String Param)

Description : This function initializes the device.

Parameters :
OpenDevBy Open_By : Method to be used when selecting the device to be opened, use OpenDevBy enumerator for selection.
String Param : Input parameter for device selection, e.g. serial number or instance path.

void CloseDevice()

Description : This function uninitializes the specified device and releases allocated resources.

void StartAcquisition()

Description : This function starts the data acquisition on the device.

void StopAcquisition()

Description : Ends the work cycle of the camera, stops data acquisition and deallocates internal image buffers.

h3.void GetImage(out BitmapSource image, int timeout)

Description : This function acquires image and returns fills BitmapSource object.

Parameters :
out BitmapSource image : WPF BitmapSource to be filled.
int timeout : Time interval required to wait for the image (in milliseconds).

void GetImage( out WriteableBitmap image, int timeout)

Description : This function acquires image and returns fills WritableBitmap object. Supports UNSAFE buffer policy mode.

Parameters :
out WriteableBitmap image : WPF BitmapSource to be filled.
int timeout : Time interval required to wait for the image (in milliseconds).

void GetImage(WriteableBitmap image, int timeout)

Description : This function acquires image and returns fills WritableBitmap object. Supports SAFE buffer policy mode.

Parameters :
WriteableBitmap image : WPF BitmapSource to be filled.
int timeout : Time interval required to wait for the image (in milliseconds).

void GetImage(out Bitmap image, int timeout)

Description : This function acquires image and returns fills bitmap object. Supports UNSAFE buffer policy mode.

Parameters :
out Bitmap image : GDI+ bitmap to be filled
int timeout : Time interval required to wait for the image (in milliseconds)

void GetImage(Bitmap image, int timeout)

Description : This function acquires image and returns fills bitmap object. Supports SAFE buffer policy mode.

Parameters :
Bitmap image : GDI+ bitmap to be filled.
int timeout : Time interval required to wait for the image (in milliseconds)

void SetParam(string prm, int val)

Description : This function configures the device.

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.
int val : Integer value to be set.

7h3. void SetParam(string prm, float val)

Description : This function configures the device.

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.
float val : Float value to be set.

GetParam(string prm, out int val)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.
out int val : Integer value to be returned.

int GetParamInt(string prm)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.

Return : Integer value to be returned.

void GetParam(string prm, out float val)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.
out float val : Float value to be returned.

float GetParamFloat(string prm)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.

Return : Float value to be returned.

void GetParam(string prm, out string val)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.
out string val : String value to be returned.

string GetParamString(string prm)

Description : This function returns parameters information (current value, minimum, maximum, info).

Parameters :
string prm : Parameter name string. Use class PRM to set parameters.

Return : String value to be returned.

ImgParams GetLastImageParams()

Description : This function returns more detailed information about the last image in the ImgParams object.

Return : ImgParams object.

xiCamEnum class

Contains function definitions for fast camera enumeration and identification.

void ReEnumerate()

Description : Re-enumerate available cameras. Returns the number of currently available devices.

string GetSerialNumById(int devIndex)

Description : Retrieve serial number of device, in string format.

Parameters :
int devIndex : Index of device to be querried.

Return : String format of camera serial number to be returned.

string GetDevNameById(int devIndex)

Description : Retrieve model name of device, in string format.

Parameters :
int devIndex : Index of device to be querried.

Return : String format of camera model name to be returned.

string GetInstancePathById(int devIndex)

Description : Retrieve system instance path of device, in string format.

Parameters :
int devIndex : Index of device to be querried.

Return : String format of system instance path of device to be returned.

string GetDeviceTypeById(int devIndex)

Description : Retrieve type of device, in string format.

Parameters :
int devIndex : Index of device to be querried.

Return : String format of device type to be returned.

string GetDeviceUserIdById(int devIndex)

Description : Retrieve custom device ID, in string format.

Parameters :
int devIndex : Index of device to be querried.

Return : String format of custom device ID type to be returned.