Technical information

ManualsBrandsAllied Vision Technologies ManualsDigital CameraAVT GigEGoldeye

Camera and Driver Features

V3.0.0

15 January 2015

Allied Vision Technologies GmbH

Taschenweg 2a

D-07646 Stadtroda / Germany

Allied Vision GigE Cameras

Summary of content (95 pages)

PAGE 1
Allied Vision GigE Cameras Camera and Driver Features V3.0.
PAGE 2
Legal notice Trademarks Unless stated otherwise, all trademarks appearing in this document of Allied Vision Technologies are brands protected by law. Warranty The information provided by Allied Vision Technologies is supplied without any guarantees or warranty whatsoever, be it specific or implicit. Also, excluded are all implicit warranties concerning the negotiability, the suitability for specific applications or the non-breaking of laws and patents.
PAGE 3
Contents Contacting Allied Vision .................................................................................. 9 Introduction ...........................................................................................................10 Document history...........................................................................................................11 Conventions used in this manual .......................................................................................
PAGE 4
DeviceStatus ........................................................................................................ 36 DeviceTemperature [Float] R ...................................................................................... 36 DeviceTemperatureSelector [Enum] R/W ....................................................................... 36 EventControl ........................................................................................................ 36 EventData ..............................
PAGE 5
SensorWidth [Integer] R/C.......................................................................................... 53 Info .......................................................................................................................... 53 GevDeviceMACAddress [Integer] R................................................................................ 53 DeviceFirmwareVersion [String] R/C ............................................................................. 53 DeviceID [String] R/C .........
PAGE 6
TriggerSource [Enum] R/W.......................................................................................... 62 AnalogControl ...................................................................................................... 63 SensorGain [Enum] R/W ............................................................................................. 63 BufferHandlingControl ...................................................................................... 63 StreamAnnounceBufferMinimum [Integer] R ...
PAGE 7
DigitalIOControl................................................................................................... 68 LineIn .................................................................................................................... 68 LineOut................................................................................................................... 68 Strobe ....................................................................................................................
PAGE 8
SensorType [Enum] R/C.............................................................................................. 81 SensorWidth [Integer] R/C.......................................................................................... 81 Width [Integer] R/W.................................................................................................. 81 WidthMax [Integer] R ................................................................................................ 81 Info ...........................
PAGE 9
Contacting Allied Vision Contacting Allied Vision Info •  Technical information: http://www.alliedvision.com • Support: support@alliedvision.com Allied Vision Technologies GmbH (Headquarters) Taschenweg 2a 07646 Stadtroda, Germany Tel: +49 36428-677-0 Fax: +49 36428-677-28 e-mail: info@alliedvision.com Allied Vision Technologies Canada Inc. 101-3750 North Fraser Way Burnaby, BC, V5J 5E9, Canada Tel: +1 604-875-8855 Fax: +1 604-875-8856 e-mail: info@alliedvision.com Allied Vision Technologies Inc.
PAGE 10
Introduction Introduction The document describes the standard and advanced camera controls for Allied Vision GigE cameras as seen from the Vimba Viewer.
PAGE 11
Introduction Document history Version Date Remarks V1.0.0 2013-Jul-04 NEW MANUAL - RELEASE status V1.0.1 2013-Sep-06 • • • • • Added the EF lens controls on page 20 Added ReverseX control on page 52 Updated DefectMaskPixelEnable feature Updated controls in the Statistics feature Updated controls in the DeviceStatus feature V2.0.
PAGE 12
Introduction Version Date Remarks continued from last page V2.0.2 2014-Oct-08 (cont.) (cont.) V3.0.0 2015-Jan-15 • Added background color to AVT GigE IR & scientific camera and driver features chapter to distinguish it from AVT GigE camera and driver features chapter.
PAGE 13
Introduction Version Date Remarks continued from last page V3.0.0 2015-Jan-15 (cont.) (cont.) – Moved StreamInformation before TransportLayerControl – Removed GVCPHBInterval as it is replaced by GevHeartbeatInterval in Vimba 1.3 – Removed GevHeartbeatTimeout because it is replaced by DeviceLinkHeartbeatTimeout in camera firmware V2.04.
PAGE 14
Introduction Symbols Note This symbol highlights important information.  www  This symbol highlights URLs for further information. The URL itself is shown in blue. Example: http://www.alliedvisiontec.
PAGE 15
GigE camera and driver features GigE camera and driver features This chapter lists standard and advanced camera controls, as seen from the Vimba Viewer, for the following camera families: – Bigeye G – Mako G – Manta – Prosilica GB – Prosilica GC – Prosilica GE – Prosilica GS – Prosilica GT – Prosilica GX Acquisition This group of controls relates to image acquisition. AcquisitionAbort [Command] Software command to stop camera from receiving frame triggers and abort the current acquisition.
PAGE 16
GigE camera and driver features AcquisitionFrameRateLimit [Float] R Range: [Camera dependent] Unit: Frames per second The maximum frame rate possible for the current exposure duration and image format. AcquisitionMode [Enum] R/W Determines the behavior of the camera when acquisition start is triggered. [Default] After an acquisition start event, the camera will continuously receive frame trigger events. See TriggerSelector and TriggerSource for more information.
PAGE 17
GigE camera and driver features RecorderPreEventCount [Integer] R/W Range:[0–65535] Default: 0 Unit: Frames Valid when AcquisitionMode = Recorder. The number of frames returned before the AcquisitionRecord trigger event, with AcquisitionFrameCount minus RecorderPreEventCount frames being returned after the AcquisitionRecord trigger event. Note  At least one image must be captured after the AcquisitionRecord trigger event, i.e., you cannot set RecorderPreEventCount = 1, and AcquisitionFrameCount = 1.
PAGE 18
GigE camera and driver features TriggerDelayAbs [Float] R/W Range:[0 – Camera dependent] Default: 0 Unit: μs Start-of-image can be delayed to begin some time after a trigger event is received by the camera. This feature is valid only when TriggerSource is set to external trigger (i.e. Line1, Line2). This control is a common trigger to sync with a strobe lighting source, which will inherently have some fixed setup time. TriggerMode [Enum] R/W Enables or disables trigger set in TriggerSelector.
PAGE 19
GigE camera and driver features Note An acquisition stream must be started in order to trigger/receive individual frames. For Freerun and FixedRate the first frame is synchronized to AcquisitionStart trigger.
PAGE 20
GigE camera and driver features 0 1 [Default] The CCD sensor may be too hot. Acquired image data may have higher noise than expected or contain erroneous pixels at long exposure times The CCD sensor temperature is in the desired temperature range. Acquired image data are OK ColorTransformationControl This section describes features related to color transformations in the Allied Vision GigE color cameras. The following controls are only valid when using oncamera interpolated PixelFormats .
PAGE 21
GigE camera and driver features Gain12 Gain20 Gain21 Gain22 Blue contribution to the green pixel (multiplicative factor) Red contribution to the blue pixel (multiplicative factor) Green contribution to the blue pixel (multiplicative factor) Blue contribution to the blue pixel (multiplicative factor) DSPSubregion The automatic exposure, gain, white balance, and iris features can be configured to respond only to a subregion within the image scene.
PAGE 22
GigE camera and driver features DefectMask Some larger format sensors may contain defective columns. Class 1 and Class 0 sensors are available with no defective columns. www  See the modular concept document, or contact your Allied Vision sales representative for more information: http://www.alliedvisiontec.com/us/support/downloads/ product-literature/avt-modular-concept.
PAGE 23
GigE camera and driver features ExposureAutoControl ExposureAutoAdjustTol [Integer] R/W Range: [0–50] Default: 5 Unit: Percent Tolerance in variation from ExposureAutoTarget in which the auto exposure algorithm will not respond. It can be used to limit exposure setting changes to only larger variations in scene lighting.
PAGE 24
GigE camera and driver features ExposureMode [Enum] R/W [Default] Camera exposure time is set by ExposureTimeAbs TriggerWidth Camera exposure time is controlled by external trigger pulse on Line1 or Line2. In order for this feature to work, TriggerSelector = FrameStart and TriggerSource must be set to Line1 or Line2 PieceWiseLinearHDR Image dynamic range is increased in difficult lighting situations by clamping down bright pixels with light levels beyond ThresholdPWL limits.
PAGE 25
GigE camera and driver features ExposureTimePWL1 [Float] R/W Range: [Camera dependent] Unit: μs Valid only when ExposureMode = PieceWiseLinearHDR. Exposure time after ThresholdPWL1 is reached.
PAGE 26
GigE camera and driver features ThresholdPWL2 [Integer] R/W Range: [0–63] Default: 63 Valid only when ExposureMode = PieceWiseLinearHDR. The second and lowest threshold level in PieceWiseLinearHDR. 0 = no light capacity, 63 = full pixel light capacity. Note Setting ThresholdPWL2 above ThresholdPWL1 disables the second threshold of PieceWiseLinearHDR mode.  Shutter [Enum] R/W Activate or deactivate the mechanical shutter of Bigeye G-629B Cool cameras.
PAGE 27
GigE camera and driver features Gain [Float] R/W Range: [Camera dependent] Default: 0 Unit: 1 dB  V out G dB = 20 log  -----------  V in  The gain setting applied to the sensor. For best image quality, the gain setting should be set to zero. However, in low-light situations, it may be necessary to increase the gain setting. GainAuto [Enum] R/W Auto algorithms use information from the camera’s current image and apply the following settings to the next image.
PAGE 28
GigE camera and driver features GainAutoMax [Float] R/W Range: [0 – Camera dependent] Unit: dB The upper bound to the gain setting in auto gain mode. GainAutoMin [Float] R/W Range: [0 – Camera dependent] Default: 0 Unit: dB The lower bound to the gain setting in auto gain mode. GainAutoOutliers [Integer] R/W Range: [1–1000] Default: 0 Unit: 0.01%, i.e. 1000 = 10% The total pixels from top of the distribution that are ignored by the auto gain algorithm.
PAGE 29
GigE camera and driver features Hue [Float] R/W Range: Camera dependent Default: 0.00 Unit: Degrees Alters color of image without altering white balance. Takes float input, although rounds to integer. Only valid when using on-camera interpolated PixelFormats . IODMode [Enum] R/W Set camera to continuous or Image on Demand (IOD) mode. Continuous • The camera requires no external exposure signal • The camera generates a constant exposure time independently.
PAGE 30
GigE camera and driver features neous GainAuto = Continuous, or ExposureAuto = Continuous, to IrisMode = Video/DCIris/PIrisAuto results in undefined, “race to target” behavior. Note  The camera must be acquiring images in order for the auto algorithm to update. IrisAutoTarget [Integer] R/W Range: [0–100] Default: 50 Unit: Percent Controls the general lightness or darkness of the auto iris feature; specifically the target mean histogram level of the image—0 being black, 100 being white.
PAGE 31
GigE camera and driver features IrisVideoLevelMin [Integer] R/W Unit: 10 mV [Manta: 13.2 mV] Video-type lenses only. Limits the minimum driving voltage for opening the lens iris. A higher minimum value slows the adjustment time but prevents excessive overshoot. Range: [0–150] Default: Camera dependent LensDCIris DC-Iris lenses only. LensDCDriveStrength [Integer] R/W Range: [0–50] Default: 10 Lens drive voltage. Altering this changes the speed at which a DC-Iris lens operates.
PAGE 32
GigE camera and driver features LensDriveCommand [Enum] R/W Setting to any non-Stop value will execute the function for LensDriveDuration and then return to Stop. Stop IrisTimedOpen IrisTimedClose FocusTimedNear FocusTimedFar ZoomTimedIn ZoomTimedOut No action Open lens iris Close lens iris Shorten working distance Lengthen working distance Zoom in Zoom out LensDriveDuration [Integer] R/W Range: [0–5000] Default: 0 Unit: ms Duration of timed lens commands.
PAGE 33
GigE camera and driver features LUTBitDepthIn [Integer] R/C Display name: LUTBitLengthIn Bit depth of the input value of the LUT block. LUTBitDepthOut [Integer] R/C Display name: LUTBitLengthOut Bit depth of the output value of the LUT block. LUTSizeBytes [Integer] R/C Display name: LUTSize Memory size of the active LUT. LUTLoadAll / LUTLoad [Command] Loads LUT from flash memory into volatile memory of the camera.
PAGE 34
GigE camera and driver features NirMode [Enum] R/W Select 3 different NIR modes. The modes differ in quantum efficiency, frame rates, and anti-blooming characteristics Off On_HighQuality On_Fast [Default] NirMode set off. Acquire and readout image at same time. NIR sensitivity: No increased sensitivity in NIR range Anti-blooming characteristics: As specified by sensor manufacturer Usage: Best suited if you need very long exposure time Cannot acquire and readout image at same time.
PAGE 35
GigE camera and driver features Whitebalance BalanceRatioAbs [Float] R/W Range: [Camera dependent] Adjusts the gain of the channel selected in the BalanceRatioSelector. BalanceRatioAbs = 1.00 means no gain is applied. Note  The green channel gain is always 1.00, as this is the luminance/reference channel. To increase/decrease green, decrease/increase red and blue accordingly.
PAGE 36
GigE camera and driver features BalanceWhiteAutoRate [Integer] R/W Range: [1–100] Default: 100 Unit: Percent Rate of white balance adjustments, from 1 (slowest) to 100 (fastest). It is used to slow the rate of color balance change so that only longer period fluctuations affect color. DeviceStatus DeviceTemperature [Float] R Unit: Degree Celsius Resolution: 0.031 Camera internal temperature.
PAGE 37
GigE camera and driver features EventPtpSyncLost [Integer] R/C EventPtpSyncLocked [Integer] R/C EventLine1RisingEdge [Integer] R/C EventLine1FallingEdge[Integer] R/C EventLine2RisingEdge [Integer] R/C EventLine2FallingEdge [Integer] R/C EventLine3RisingEdge [Integer] R/C EventLine3FallingEdge[Integer] R/C EventLine4RisingEdge [Integer] R/C EventLine4FallingEdge [Integer] R/C EventFrameTriggerReady [Integer] R/C EventOverflow [Integer] R/C EventError [Integer] R/C Note  40005 40006 40010 40011 40012 4001
PAGE 38
GigE camera and driver features Bit 3 EventFrameTrigger Bit 19 EventFrameTriggerReady This is an alternative to setting each event individually using the EventNotification and EventSelector method. GigE BandwidthControlMode [Enum] R/W Selects the desired mode of bandwidth control. StreamBytesPerSecond [Default] See the StreamBytesPerSecond feature for more information SCPD Stream channel packet delay expressed in timestamp counter units.
PAGE 39
GigE camera and driver features Configuration GevIPConfigurationMode [Enum] R/W Display name: IP Configuration Mode Possible values: LLA, DHCP, Persistent Current IP configuration mode. Current GevCurrentDefaultGateway [Integer] R Display name: Current Default Gateway IP address of the default Gateway of the device. GevCurrentIPAddress [Integer] R Display name: Current IP Address Current IP address of the device.
PAGE 40
GigE camera and driver features GevHeartbeatTimeout [Integer] R/W Display name: Heartbeat Interval Range:[500–10000] Default: 3000 Unit: ms For Vimba v1.3 or higher only The driver sends heartbeat packets to the camera. If a heartbeat packet is not received within GevHeartbeatTimeout, the camera assumes the host has closed its controlling application or is dead, and closes its stream and control channel.
PAGE 41
GigE camera and driver features Ptp Precision Time Protocol (PTP) manages clock synchronization of multiple devices across an Ethernet network, with ±1 μs tolerance. Once the clocks of the devices are synchronized, a synchronous software trigger can be sent to Allied Vision cameras via the PtpAcquisitionGateTime control. On Allied Vision GigE cameras, the device clock is represented by the camera GevTimeStampValue feature.
PAGE 42
GigE camera and driver features PtpStatus [Enum] R State of the PTP operation. Disabled Initializing Listening Master Passive Uncalibrated Slave Note  [Default] Device PtpMode is set to Off PTP is being initialized. If one camera / PTP device is being initialized, all devices statuses are set to initialized. This state appears very briefly Device is listening for other PTP enabled devices. The purpose of this state is to determine which device will act as master Device acting as master clock.
PAGE 43
GigE camera and driver features StreamBytesPerSecond [Integer] R/W Range: [1,000,000 – 124,000,000 (248,000,000 for GX in LAG mode)] Unit: Bytes/s Moderates the data rate of the camera. This is particularly useful for slowing the camera down so that it can operate over slower links such as Fast Ethernet (100speed), or wireless networks. It is also an important control for multi-camera situations.
PAGE 44
GigE camera and driver features StreamHoldCapacity [Integer] R Unit: Frames The maximum number of images (for the current size and format), which can be stored on the camera when StreamHold is enabled. Used in AcquisitionMode = Recorder, or StreamHoldEnable = On. This value is different for each camera depending on the camera internal memory size and the ImageSize. StreamHoldEnable [Enum] R/W Control on-camera image storage; this control is like a “pause” button for the image stream.
PAGE 45
GigE camera and driver features IO The control and readout of all camera inputs and outputs. The number of inputs and outputs is camera model dependent. StatusLED StatusLedLevels [Integer] R/W Range: [0–4294967296] Default: 0 Status led levels in GPO mode. Note StatusLedPolarity can invert these values.  StatusLedPolarity [Enum] R/W Possible values: Normal, Invert Polarity applied to the status led specified by StatusLedSelector.
PAGE 46
GigE camera and driver features Strobe Definition Strobe is an internal signal generator for on-camera clocking functions. Valid when any of the SyncOutSource is set to Strobe1. Strobe allows the added functionality of duration and delay, useful when trying to sync a camera exposure to an external strobe. StrobeDelay [Integer] R/W Range: [0 – Camera dependent] Default: 0 Delay from strobe trigger to strobe output.
PAGE 47
GigE camera and driver features SyncIn Signal source of the strobe timing unit. See SyncOutSource for descriptions. SyncInGlitchFilter [Integer] R/W Range: [0–50000] Default: 0 Unit: ns Ignores glitches on the SyncIn input line with pulse duration less than set value. Note  Setting SyncInGlitchFilter value increases latency of FrameTrigger by same amount. SyncInLevels [Integer] R A 4-bit register where each bit corresponds to a specific SyncIn input.
PAGE 48
GigE camera and driver features SyncOutSource [Enum] R/W Signal source of the sync-out line specified by SyncOutSelector. General purpose output GPO AcquisitionTriggerReady Active once the camera has been recognized by the host PC and is ready to start acquisition FrameTriggerReady Active when the camera is in a state that will accept the next frame trigger Exposing Active for the duration of sensor exposure FrameReadout Active during frame readout, i.e.
PAGE 49
GigE camera and driver features OffsetY [Integer] R/W Range: [0 – Camera dependent] Default: 0 Unit: Pixels Starting row of the readout region (relative to the first row of the sensor) in pixels. PixelFormat [Enum] R/W There are various pixel data formats that GigE cameras can output. Not all cameras have every mode (see the Technical Manuals for details): Mono8 Bit depth: 8. One pixel every byte. Monochrome. For color cameras with oncamera interpolation, luminance (Y) channel returned.
PAGE 50
GigE camera and driver features RGBA8Packed Bit depth: 8. One pixel every four bytes. On-camera interpolated color. Alpha channel (A) is fully opaque, 0xFF BGRA8Packed Bit depth: 8. One pixel every four bytes. On-camera interpolated color. Alpha channel (A) is fully opaque, 0xFF RGB12Packed Bit depth: 12. One pixel every six bytes—R, G, B channels LSB-aligned. On-camera interpolated color. YUV411Packed Bit depth: 8. 4 pixel every 6 byte. On-camera interpolated color. Data in YUV411 format.
PAGE 51
GigE camera and driver features BinningHorizontalMode [Enum] R/W Determines whether the result of binned pixels is averaged or summed up. Changing BinningHorizontalMode also changes BinningVerticalMode. [Default] Binning is accomplished by summing the charge / gray value of adjacent pixels on sensor Average Binning is accomplished by averaging the charge / gray value of adjacent pixels on sensor.
PAGE 52
GigE camera and driver features Note •  • Writing an invalid number for DecimationHorizontal will round up to next valid mode. For example, 5 rounds up to 8. DecimationHorizontal and BinningHorizontal are mutually exclusive. Setting DecimationHorizontal > 1 forces BinningHorizontal to 1. DecimationVertical [Integer] R/W Range: [1–8] Default: 1 Decimation (also known as sub-sampling) is the process of skipping neighboring pixels (with the same color) while being read out from the CCD chip.
PAGE 53
GigE camera and driver features SensorWidth [Integer] R/C The total number of pixel columns on the sensor. Info GevDeviceMACAddress [Integer] R Display name: Device MAC address 48-bit MAC address of the GVCP interface of the selected remote device. DeviceFirmwareVersion [String] R/C Firmware version of this Allied Vision GigE camera. DeviceID [String] R/C Serial number of the camera. DeviceUserID [String] R/W Used for multiple-camera situations for providing meaningful labels to individual cameras.
PAGE 54
GigE camera and driver features SavedUserSets Allied Vision GigE cameras are capable of storing a number of user-specified configurations within the camera's non-volatile memory. These saved configurations can be used to define the power-up settings of the camera or to quickly switch between a number of predefined settings. Note LUT features cannot be saved.  To save the content of a LUT, use Controls/LUTControl/LUTSave or LUTSaveAll.
PAGE 55
GigE camera and driver features Note  Note  Most GigE switches support a maximum PacketSize of 1500 in multicast mode. When using clients with Linux, you have to configure the IP subsystem to process Multicast IP traffic. MulticastEnable [Boolean] R/W Display name: Multicast Enable Possible values: True, False Default: False Enables multicast mode. In multicast mode all computers on the same subnet as the camera can receive image data from the camera MulticastIPAddress.
PAGE 56
GigE camera and driver features GVSPMaxLookBack [Integer] R/W Display name: GVSP Max Look Back Range: [1–1024] Default: 30 Size of the look back window, in packets, when determining if a stream packet is missing. When a stream packet arrives out of order, the driver skips back GVSPMaxLookBack packets to see if the packets previous to this point have all arrived. If not, a resend is issued.
PAGE 57
GigE camera and driver features Statistics Note  The packet counts in these statistics cover the image transport. Packets used for camera control or event data are not counted. All counters are reset at AcquisitionStart. StatFrameRate [Float] R Display name: Stat Frame Rate Rate at which the device is acquiring frames, derived from the frame timestamps. StatFrameDelivered [Integer] R Display name: Stat Frames Delivered Number of error-free frames captured since the start of imaging.
PAGE 58
GigE camera and driver features StatPacketMissed [Integer] R Display name: Stat Packets Missed Number of packets missed since the start of imaging. Note  If everything is configured correctly, this number should remain zero, or at least very low compared to StatPacketReceived. StatPacketReceived [Integer] R Display name: Stat Packets Received Number of error-free packets received by the driver since the start of imaging, this number should grow steadily during continuous acquisition.
PAGE 59
GigE IR & scientific camera and driver features GigE IR & scientific camera and driver features Goldeye G and Goldeye G Cool are short-wave infrared GigE cameras that provides comprehensive and advanced set of features for infrared imaging requirements. This chapter describes the standard and advanced camera controls, as seen from the Vimba Viewer, for Goldeye G and Goldeye G Cool cameras using the GenICam standard feature naming convention.
PAGE 60
GigE IR & scientific camera and driver features AcquisitionMode [Enum] R/W Determines the behavior of the camera when acquisition start is triggered. [Default] After an acquisition start event, the camera will continuously receive frame trigger events. See TriggerSelector and TriggerSource for more information SingleFrame The camera will only deliver a single frame trigger event.
PAGE 61
GigE IR & scientific camera and driver features ExposureMode [Enum] R/W Timed [Default] The camera exposure time is set by ExposureTime Control for exposure duration. ExposureTime [Float] R/W Range: [Camera dependent] The sensor integration time. Unit: μs RecorderPreEventCount [Integer] R/W Range:[0 – 65535] Default: 0 Unit: Frames Valid when AcquisitionMode = Recorder.
PAGE 62
GigE IR & scientific camera and driver features Note  If TriggerMode = Off and TriggerSelector = FrameStart, images triggered in FixedRate at AcquisitionFrameRateAbs. TriggerOverlap [Enum] R/W Permitted window of trigger activation, relative to previous frame. Does not work with Software triggering. Only external.
PAGE 63
GigE IR & scientific camera and driver features AnalogControl SensorGain [Enum] R/W Sets the FPA gain level. LowGain [Default] Sets FPA gain level to low HighGain Sets FPA gain level to high BufferHandlingControl StreamAnnounceBufferMinimum [Integer] R For Vimba V1.3 or higher only Display name: Stream Announce Buffer Minimum Minimal number of buffers to announce to enable selected acquisition mode. StreamAnnouncedBufferCount [Integer] R For Vimba V1.
PAGE 64
GigE IR & scientific camera and driver features NonImagePayloadSize [Integer] R Unit: Bytes Maximum size of chunk data, not including the image chunk, in the image block payload. If ChunkModeActive = False, NonImagePayloadSize = 0. DeviceControl BandwidthControlMode [Enum] R/W Selects the desired mode of bandwidth control. Bandwidth allocation can be controlled by DeviceLinkThroughputLimit or by SCPD0 register.
PAGE 65
GigE IR & scientific camera and driver features DeviceLinkHeartbeatTimeout [Float] R/W Granularity: 1000 Default: 3000000 Unit: μs Controls the current heartbeat timeout of the link selected by DeviceLinkSelector. DeviceLinkSelector [Integer] R/W Selects which link of the device to control. DeviceLinkThroughputLimit [Integer] R/W Range: [1,000,000 – 124,000,000] Unit: Bytes/s Moderates the data rate of the camera.
PAGE 66
GigE IR & scientific camera and driver features DeviceRelativeHumidity [Float] R Relative humidity, in percent, measured at the location selected in DeviceRelativeHumiditySelector. DeviceRelativeHumiditySelector [Enum] R/W Possible value: Sensorboard Selects the location for measuring relative humidity. DeviceSFNCVersionMajor [Integer] R/C Major part of the SFNC version number (part before the decimal). DeviceSFNCVersionMinor [Integer] R/C Minor part of the SFNC version number (part after the decimal).
PAGE 67
GigE IR & scientific camera and driver features DeviceUserID [String] R/W Used for multiple-camera situations for providing meaningful labels to individual cameras. DeviceVendorName [String] R/C Manufacturer’s name: Allied Vision Technologies. SensorCoolingPower [Float] R Cooling power consumption in mW. SensorTemperatureControlMode [Enum] R/W Defines the control mode for the thermoelectric cooler (TEC) of the sensor.
PAGE 68
GigE IR & scientific camera and driver features SensorTemperatureSetpointValue [Float] R/W The setpoint temperature, in °C, corresponding to the setpoint selected in SensorTemperatureSetpointSelector. TimestampLatch [Command] Captures timestamp and stores in TimestampLatchValue. TimestampLatchValue [Integer] R Unit: Camera clock ticks Value of timestamp, when latched by TimestampLatch. TimestampReset [Command] Resets the camera’s timestamp to 0.
PAGE 69
GigE IR & scientific camera and driver features Note LineOutPolarity can invert the LineOutLevels.  LineOutPolarity [Enum] R/W Possible values: Normal, Invert Default: Normal Polarity applied to the LineOut specified by LineOutSelector. LineOutSelector [Enum] R/W Possible values: LineOut1, LineOut2, LineOut3 Default: LineOut1 Selects the LineOut to control with LineOutSource, LineOutPolarity. LineOutSource [Enum] R/W Signal source of the LineOut line specified by LineOutSelector.
PAGE 70
GigE IR & scientific camera and driver features Strobe Definition Strobe is an internal signal generator for on-camera clocking functions. Valid when any of the LineOutSource is set to Strobe1. Strobe allows the added functionality of duration and delay, which is useful when trying to sync a camera exposure to an external strobe. StrobeDelay [Integer] R/W Range: [0 – Camera dependent] Default: 0 Delay from strobe trigger to strobe output.
PAGE 71
GigE IR & scientific camera and driver features EventControl EventData The following table lists all the events supported by the camera: EventAcquisitionEndFrameID EventAcquisitionEndTimestamp EventAcquisitionRecordTriggerFrameID EventAcquisitionRecordTriggerTimestamp EventAcquisitionStartFrameID EventAcquisitionStartTimestamp EventErrorFrameID EventErrorTimestamp EventExposureEndFrameID EventExposureEndTimestamp EventFrameTriggerFrameID EventFrameTriggerTimestamp EventFrameTriggerReadyFrameID EventFrameT
PAGE 72
GigE IR & scientific camera and driver features EventSelector [Enum] R/W Selects a specific event to be enabled or disabled using EventNotification. Possible values are listed as following: AcquisitionStart [Default] FrameTrigger AcquisitionRecordTrigger Line1FallingEdge Line2FallingEdge AcquisitionEnd ExposureEnd Line1RisingEdge Line2RisingEdge FrameTriggerReady EventsEnable1 [Integer] R/W Default: 0. Bit field of all events.
PAGE 73
GigE IR & scientific camera and driver features FileAttributeBuffer [Integer] R/(W) Contains the attribute that will be used for newly created files when FileOperationSelector = WriteAttribute. Bit 0–1 Bit 2–31 These two bits are used to encode the privilege level for a file. It defines who owns a file: • 0 = [Default] User owns the file.
PAGE 74
GigE IR & scientific camera and driver features Reads “FileAccessLength” bytes from the device storage, at the file relative offset set in FileAccessOffset into FileAccessBuffer Write Writes “FileAccessLength” bytes taken from the FileAccessBuffer into the device storage at the file relative offset defined by FileAccessOffset Delete Deletes the file selected by FileSelector in the device.
PAGE 75
GigE IR & scientific camera and driver features FileTypeBuffer [Integer] R/(W) Possible values: – 0x1000 = Non-uniformity correction data – 0x2000 = Defect pixel correction data Contains the type that will be used for newly created files when FileOperationSelector = WriteType. GigE Configuration GevIPConfigurationMode [Enum] R/W Display name: IP Configuration Mode Possible values: LLA, DHCP, Persistent Current IP configuration mode.
PAGE 76
GigE IR & scientific camera and driver features GevHeartbeatInterval [Integer] R/W Display name: Heartbeat Interval Range:[200–1450] Default: 1450 Unit: ms For Vimba V1.3 or higher only The driver sends heartbeat packets to the camera every GevHeartbeatInterval milliseconds. If the camera fails to respond to the heartbeat request, a retry is sent “GVCPCmdTimeout” ms later. After “GVCPCmdRetries” retries with no response, a camera unplugged event is returned by the driver.
PAGE 77
GigE IR & scientific camera and driver features ImageCorrectionControl DefectPixelCorrection DPCDatasetActivate [Command] Activates the dataset that is currently indexed by DPCDatasetSelector. DPCDatasetActive [Integer] R Range: [0 – Camera dependent] The index of the active data set, starting at 0. The maximum possible value of DPCDatasetActive depends on the number of valid data sets in the camera.
PAGE 78
GigE IR & scientific camera and driver features NUCDatasetActiveDescription [String] R Gives a short descriptive label to the data set that is currently indexed by NUCDatasetActive. For example: Gain 0, 15.000°C, 1000μs.
PAGE 79
GigE IR & scientific camera and driver features NUCDatasetAuto [Enum] R/W Controls automatic selection of the NUCDatasetActive. [Default] The automatic mode is off Auto-NUC occurs until target is achieved, then NUCDatasetAuto returns to Off Continuous The non-uniformity correction will continue according to the scene illumination Off Once NUCDatasetDescription [String] R Description of the data set indexed by NUCDatasetSelector.
PAGE 80
GigE IR & scientific camera and driver features NUCDatasetTemperature [Float] R Sensor temperature, in °C, at acquisition of the data set indexed by NUCDatasetSelector. The data set should be selected so that the actual sensor temperature is close to the reference temperature. Note  The number of distinct reference values is limited by available correction data, depending on the camera variant. NUCMode [Enum] R/W Controls the operating mode of the non-uniformity correction.
PAGE 81
GigE IR & scientific camera and driver features PixelFormat [Enum] R/W There are various pixel data formats that Allied Vision GigE IR and scientific cameras can output. Not all cameras have every mode (see the Technical Manuals for details): Mono8 Bit depth: 8. One pixel every byte. Monochrome. For color cameras with on-camera interpolation, luminance (Y) channel returned. Mono12 Bit depth: 12. One pixel every two bytes, LSB aligned. Monochrome.
PAGE 82
GigE IR & scientific camera and driver features Info GevDeviceMACAddress [Integer] R Display name: Device MAC address 48-bit MAC address of the GVCP interface of the selected remote device. DevicePartNumber [String] R/C Manufacturer’s part number. FirmwareVerBuild [Integer] R/C Build information. FirmwareVerMajor [Integer] R/C Major part of the firmware version number (part before the decimal). FirmwareVerMinor [Integer] R/C Minor part of firmware version number (part after the decimal).
PAGE 83
GigE IR & scientific camera and driver features MulticastEnable [Boolean] R/W Display name: Multicast Enable Possible values: True, False Default: False Enables multicast mode. In multicast mode all computers on the same subnet as the camera can receive image data from the camera MulticastIPAddress. MulticastIPAddress [Integer] R/W Display name: Multicast IP Address Sets the multicast IP address.
PAGE 84
GigE IR & scientific camera and driver features GVSPMaxRequests [Integer] R/W Display name: GVSP Max Requests Range: [1–512] Default: 3 The maximum number of resend requests that the host will attempt before marking a packet dropped. GVSPMaxWaitSize [Integer] R/W Display name: GVSP Max Wait Size Range: [8–1024] Default: 100 Maximum number of received GVSP packets following a resend request to wait before requesting again.
PAGE 85
GigE IR & scientific camera and driver features StatFrameDelivered [Integer] R Display name: Stat Frames Delivered Number of error-free frames captured since the start of imaging. StatFrameDropped [Integer] R Display name: Stat Frames Dropped Number of incomplete frames received by the host due to missing packets (not including shoved frames).
PAGE 86
GigE IR & scientific camera and driver features StatPacketReceived [Integer] R Display name: Stat Packets Received Number of error-free packets received by the driver since the start of imaging, this number should grow steadily during continuous acquisition. StatPacketRequested [Integer] R Display name: Stat Packets Requested Number of missing packets that were requested to be resent from the device.
PAGE 87
GigE IR & scientific camera and driver features Note  Currently as per the GigE Vision specification, LLA cannot be disabled. GevCurrentIPConfigurationPersistentIP [Boolean] R/W Possible values: True, False Default: False Controls whether the Persistent IP configuration scheme is activated on the given logical link. GevInterfaceSelector [Integer] R/W Selects which logical link to control. GevMACAddress [Integer] R MAC address of the link specified by GevInterfaceSelector.
PAGE 88
GigE IR & scientific camera and driver features StreamHoldEnable [Enum] R/W Control on-camera image storage; this control is like a “pause” button for the image stream. On Images remain stored on the camera, and are not transmitted to the host Off [Default] The image stream resumes, and any stored images are sent to the host UserSetControl UserSetDefaultSelector [Enum] R/W Possible values: Default, UserSet1, UserSet2, UserSet3, UserSet4 Selects the user set to be loaded on power-up or reset.
PAGE 89
Index (GigE camera and driver features) Index (GigE camera and driver features) A AcqStartTriggerMode ................................ 16 Acquiring ..................................... 45, 46, 48 Acquisition ............................................. 15 AcquisitionAbort ..................................... 15 AcquisitionEnd ........................................ 18 AcquisitionFrameCount ................... 15, 16, 17 AcquisitionFrameRateAbs ................ 15, 18, 19 AcquisitionFrameRateLimit .....
PAGE 90
Index (GigE camera and driver features) ExposureTimePWL1 ............................. 24, 25 ExposureTimePWL2 ............................. 24, 25 ExposureValue ........................................ 24 F FirmwareVerBuild .................................... 53 FirmwareVerMajor .................................... 53 FirmwareVerMinor .................................... 53 FitRange ................................................ 23 fixed setup time ....................................... 18 FixedRate .
PAGE 91
Index (GigE camera and driver features) Line1 ..................................................... 19 Line2 ..................................................... 19 LineIn1 ............................................. 46, 48 LineIn2 ............................................. 46, 48 LineIn3 ............................................. 46, 48 LineIn4 ............................................. 46, 48 LUTAddress ............................................. 32 LUTBitDepthIn ...........................
PAGE 92
Index (GigE camera and driver features) StrobeDurationMode ................................ 46 StrobeSource .......................................... 46 SubstrateVoltage ..................................... 34 SyncIn ................................................... 47 SyncInGlitchFilter .................................... 47 SyncInLevels ........................................... 47 SyncInSelector ........................................ 47 SyncOut .................................................
PAGE 93
Index (GigE IR & scientific camera and driver features) Index (GigE IR & scientific camera and driver features) A Acquiring .......................................... 69, 70 AcquisitionAbort ..................................... 59 AcquisitionEnd ........................................ 62 AcquisitionFrameCount ................... 59, 60, 61 AcquisitionFrameRate .......................... 59, 62 AcquisitionFrameRateAbs .......................... 62 AcquisitionFrameRateLimit ........................
PAGE 94
Index (GigE IR & scientific camera and driver features) FileOperationStatus ................................. 74 FileSelector ....................................... 73, 74 FileSize .................................................. 74 FileStatus ............................................... 74 FileType ................................................. 74 FileTypeBuffer ......................................... 74 FirmwareVerBuild .................................... 82 FirmwareVerMajor .................
PAGE 95
Index (GigE IR & scientific camera and driver features) O OffsetX ................................................... 80 OffsetY ................................................... 80 P PayloadSize ............................................ 87 Persistent ............................................... 76 PixelFormat ............................................ 81 R Recorder ................................. 59, 60, 65, 87 RecorderPreEventCount ........................ 60, 61 S SCPD ......................