Allied Vision GigE Cameras Camera and Driver Attributes Bigeye G Firmware v3.1.44.6 Mako G Firmware v1.54 Manta Firmware v1.54 Prosilica Firmware v1.54 V1.3.
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.
Contents Contacting Allied Vision Technologies ................................................... 6 Introduction ............................................................................................................ 7 Important notes ............................................................................................................. 7 Document history ........................................................................................................... 8 Symbols used in this manual ....
DeviceStatus .......................................................................................................... 35 DeviceTemperatureMainboard – Float32 – R ................................................................... 35 DeviceTemperatureSensor – Float32 – R ........................................................................ 35 EventControl .......................................................................................................... 35 EventID.................................
Part........................................................................................................................ 49 Sensor .................................................................................................................... 49 UniqueID – Uint32 – R/C ............................................................................................ 49 IO..............................................................................................................................
Contacting Allied Vision Technologies Contacting Allied Vision Technologies 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.
Introduction Introduction The document describes the standard and advanced camera controls for AVT GigE cameras as seen from the AVT GigE SampleViewer. The document is intended for use with PvAPI SDK. AVT offers a number of GigE Vision camera families, which includes: – Bigeye G – Prosilica GB – Prosilica GS – Mako G – Prosilica GC – Prosilica GT – Manta – Prosilica GE – Prosilica GX This document can be applied to all of these families. www Follow this link to learn about GigE Vision cameras from AVT.
Introduction Document history Version V1.0.0 V1.0.1 V1.0.2 V1.0.3 V1.0.4 V1.0.5 V1.0.6 V1.0.7 V1.0.8 V1.0.9 V1.1.0 Date Remarks 2006-May-18 New Manual – Release Status – Firmware: 1.00.00 2006-Jun-12 Firmware: 1.14.00 – ExposureMode, WhitebalMode addition 2006-Aug-02 Firmware: 1.18.00 – PixelFormat YUV addition 2006-Sep-08 Firmware: 1.22.00 – StreamHold, SyncOutGPOLevels addition 2007-May-30 Firmware: 1.26.
Introduction continued from last page V1.1.0 [Continued] 2013-Jul-05 [Continued] • Updated the following controls: – PayloadSize – EdgeFilter – Gamma – Hue – IrisVideoLevelMax – IrisVideoLevelMin – Saturation – LUTControl – BandwidthCtrlMode – StreamHoldEnable V1.1.1 2013-Sep-06 • • • Added the EF lens controls Added control on page 48 Updated the DefectMaskPixelEnable, Eventcontrol, and DeviceStatus controls V1.1.
Introduction Symbols used in this manual Note This symbol highlights important information. www This symbol highlights URLs for further information. The URL itself is shown in blue. Example: http://www.alliedvision.
AVT GigE camera attributes AVT GigE camera attributes Acquisition Trigger AcqEnd AcqEndTriggerEvent – Enum – R/W If AcqEndTriggerMode = SyncIn1/2/3/4, determines which SyncIn electrical signal initiates trigger. EdgeRising EdgeFalling EdgeAny LevelHigh LevelLow [Default] Rising edge trigger Falling edge trigger Rising or falling edge Active high signal Active low signal AcqEndTriggerMode – Enum – R/W Determines if end of acquisition initiated by an external hardware trigger.
AVT GigE camera attributes AcqRecTriggerMode – Enum – R/W Determines if recorder mode trigger event is initiated by an external hardware trigger. SyncIn1 SyncIn2 SyncIn3 SyncIn4 Disabled [Default] Trigger at SyncIn1 to be associated with this control Trigger at SyncIn2 to be associated with this control Trigger at SyncIn3 to be associated with this control Trigger at SyncIn4 to be associated with this control No external trigger.
AVT GigE camera attributes FrameRate – Float32 – R/W Range: [Camera dependent] Units: Hz When FrameStartTriggerMode is set to FixedRate, this control specifies the frame rate. Depending on the exposure duration, the camera may not achieve the frame rate set here. Note • • • If ExposureMode = Manual: Ensure [1/ExposureValue*] > FrameRate to achieve target frame rate. If ExposureMode = External: Ensure [1/(external trigger pulse width)] > FrameRate to achieve target frame rate.
AVT GigE camera attributes FrameStartTriggerMode – Enum – R/W Determines how a frame is initiated. 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/AcqStart trigger.
AVT GigE camera attributes AcquisitionMode – Enum – R/W Determine how many frame triggers the camera receives after acquisition start event. Continuous [Default] The camera will continuously receive frame triggers SingleFrame The camera will only receive a single frame trigger event. Further frame triggers will be ignored until acquisition is stopped and restarted MultiFrame The camera will receive AcquisitionFrameCount number of frame triggers.
AVT GigE camera attributes SensorShutterMode – Enum – R/W Type of the shutter. Figure 1 illustrates different sensor shutter modes. Global Rolling GlobalReset [Default] All pixels reset and start exposure at same time. All pixels shifted to readout at same time. All pixels have same ExposureValue Each row is reset, exposed, and read out in succession from top to bottom of image. All pixels have same ExposureValue.
AVT GigE camera attributes ConfigFile AVT's 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.
AVT GigE camera attributes ColorTransformationMode – Enum – R/W Off Manual Temp6500K No color transformation Manually set ColorTransformationValue matrix coefficients Colors optimized for a surrounding color temperature 6500 K ColorTransformationValueBB – Float32 – R/W Range: [0.000 – 2.000] Default: 1.000 Blue multiplicative factor applied to blue input channel. ColorTransformationValueBG – Float32 – R/W Range: [0.000 – 2.000] Default: 1.000 Green multiplicative factor applied to blue input channel.
AVT GigE camera attributes DSPSubregionBottom – Uint32 – R/W Range: [0 – Sensor height] Default: Sensor height Defines the bottom edge of the DSP subregion. Units: Rows from top edge of full image. DSPSubregionLeft – Uint32 – R/W Range: [0 – Sensor width] Default: 0 Defines the left edge of the DSP subregion. Units: Columns from left edge of full image. DSPSubregionRight – Uint32 – R/W Range: [0 – Sensor width] Default: Sensor width Defines the right edge of the DSP subregion.
AVT GigE camera attributes DefectMaskColumnEnable – Enum – R/W Defect masking replaces defective columns with interpolated values based on neighboring columns. Defective columns are detected and recorded at the factory. Enabled Disabled www [Default] Enables masking of defective columns Disables masking of defective columns For more information on the Loaddefect application and column defect masking process, see: http://www.alliedvision.
AVT GigE camera attributes EFLensFStopMax – Float – R Default: Lens dependent Unit: F-Stop Maximum possible F-stop setting or the smallest possible aperture for the EF lens based on current zoom setting. EFLensFStopMin – Float – R Default: Lens dependent Unit: F-Stop Minimum possible F-stop setting or the largest possible aperture for the EF lens based on current zoom setting.
AVT GigE camera attributes EFLensStatus EFLensID – Integer – R Identification value of the attached EF lens. EFLensLastError – Enum – R Most recently detected error.
AVT GigE camera attributes Exposure Auto Auto algorithms use information from the camera’s current image and apply the following settings to the next image. Large changes in scene lighting may require several frames for the algorithm to stabilize. If using ExposureMode = Auto, and GainMode = Auto simultaneously, priority is given to changes in exposure until ExposureAutoMax is reached, at which point priority is given to changes in gain.
AVT GigE camera attributes ExposureAutoOutliers – Uint32 – R/W Range: [0 – 1000] Default: 0 Units: 0.01% i.e. 1000 = 10% With ExposureAutoTarget as the mean target brightness, ExposureAutoOutliers is the percentage of pixels on the upper bound of the image brightness distribution graph that are ignored by the ExposureAuto algorithm. This can be used limit the effect of small specular bright spots on the overall image brightness calculation.
AVT GigE camera attributes ExposureValue – Uint32 – R/W Range: [Camera dependent] Units: μs The sensor integration time. Values written to control are rounded to nearest multiple of ExposureTimeIncrement. Reading this control returns the used, rounded value. ExposureValue depends on ExposureMode as follows: • ExposureMode = Manual: ExposureValue is sensor integration time. • ExposureMode = Auto/AutoOnce/External: ExposureValue is ignored.
AVT GigE camera attributes ThresholdPWL1 – Integer – R/W Range: [0–63] Default: 63 Valid only when ExposureMode = PieceWiseLinearHDR. The first and highest threshold level in PieceWiseLinearHDR. 0 = no light capacity, 63 = full pixel light capacity. Note Leaving ThresholdPWL1 at 63 disables the first threshold of PieceWiseLinearHDR mode, effectively disabling HDR mode. ThresholdPWL2 – Integer – R/W Range: [0–63] Default: 63 Valid only when ExposureMode = PieceWiseLinearHDR.
AVT GigE camera attributes Gain Auto Auto algorithms use information from the camera’s current image and apply the following settings to the next image. Large changes in scene lighting may require 2-3 frames for the algorithm to stabilize. The camera must be acquiring images in order for the auto algorithm to update.
AVT GigE camera attributes GainMode – Enum – R/W Manual Auto [Default] The camera gain is fixed by GainValue parameter Valid when ExposureMode = Manual, Auto, or PieceWiseLinearHDR. The gain will vary continuously according to the scene illumination. The Auto function operates according to the Auto and DSP controls AutoOnce Valid when ExposureMode = Manual, Auto, or PieceWiseLinearHDR.
AVT GigE camera attributes IOD [Default] Enables IOD mode (image on demand mode). In this mode the camera needs an external trigger signal or a timer driven internal exposure signal SyncIn1/2/3/4/5 The camera is switched between IOD and Continuous mode, dependent on the level of SyncIn1/2/3/4/5 Note If Continuous mode is activated, no external exposure signal is allowed. Set e.g. FrameStartTriggerMode to an unused SyncIn. LensDrive Open loop DC 3 axis lens control.
AVT GigE camera attributes Iris Auto iris lens support. Supported auto-iris lens types (camera dependent): video, DC, and P-iris. GT series detects lens type on power up. DC settings will not apply if P-Iris lens connected. P-Iris settings will not apply if DC iris lens connected. The auto iris algorithm calculates IrisAutoTarget based on information of the current image, and applies this to the next image. Large changes in scene lighting may require 2-3 frames for the algorithm to stabilize.
AVT GigE camera attributes IrisVideoLevelMax – Uint32 – R/W Range: [0 – 150] Default: Camera dependent Units: 10 mV [Manta: 13.2 mV] Video-type lenses only. Limits the maximum driving voltage for closing the lens iris. IrisVideoLevelMin – Uint32 – R/W Range: [0 – 150] Default: Camera dependent Units: 10 mV [Manta: 13.2 mV] Video-type lenses only. Limits the minimum driving voltage for opening the lens iris. LensDCIris DC Iris lenses only.
AVT GigE camera attributes Saturation – Float32 – R/W Range: [0.000 – 2.000]. Alters color intensity. Applied post-bayer interpolation. Only available on color PixelFormats noted with on-camera interpolation. 0.000 Monochrome 1.000 [Default] Default saturation 2.000 Maximum possible saturation that can be applied LUTControl The use of one LUT allows any function (in the form Output = F(Input)) to be stored in the camera's memory and to be applied on the individual pixels of an image at runtime.
AVT GigE camera attributes Note To avoid confusion, especially with color cameras, we recommend the following steps: 1. Configure the LUT modes. 2. Enable the LUT. LUTSave/LUTSaveAll – Command Saves LUT from volatile memory into flash memory of the camera. Note With ConfigFile control (ConfigFileSave command) you can‘t save the contents of the LUT. LUTSelector – Enum – R/W Possible values: LUT1, LUT2, LUT3, LUT4, LUT5 Default: LUT1 Selects which LUT to control. These LUTs are camera specific.
AVT GigE camera attributes Offset OffsetValue – Integer – R/W Range: [0-255] Default: 0 Brightness (aka black level). Setting GainValue does not change the OffsetValue. SubstrateVoltage VsubValue – Uint32 – R/C Range: [Camera dependent] Units: mV Factory use only. CCD substrate voltage. Optimized at factory for each sensor. Whitebalance Unlike Hue or ColorTransformationControl, this is a pre-bayer interpolation gain adjustment. Applies to all color PixelFormats.
AVT GigE camera attributes WhitebalValueBlue – Uint32 – R/W Range: [Camera dependent] Units: percent Gain applied to all blue pixels on the CCD, pre-interpolation. 100% = no gain applied. Each camera model calibrated with a different factory default. Note There is no WhitebalValueGreen, as this is the luminance/ reference channel. To increase/decrease green, decrease/ increase red and blue accordingly. DeviceStatus DeviceTemperatureMainboard – Float32 – R Units: Degree Celsius Resolution: 0.
AVT GigE camera attributes EventSyncIn1Fall – Uint32 – R/C 40011 EventSyncIn2Rise – Uint32 – R/C 40012 EventSyncIn2Fall – Uint32 – R/C 40013 EventSyncIn3Rise – Uint32 – R/C 40014 EventSyncIn3Fall – Uint32 – R/C 40015 EventSyncIn4Rise – Uint32 – R/C 40016 EventSyncIn4Fall – Uint32 – R/C 40017 EventFrameTriggerReady – Uint32 – R/C 40018 EventOverflow – Uint32 – R/C 65534 Always on. Cannot be turned off with EventSelector or EventsEnable1. Event occurs if camera event buffer overflows, i.e.
AVT GigE camera attributes GigE BandwidthCtrlMode – Enum – R/W Select the desired mode of bandwidth control. StreamBytesPerSecond SCPD Both [Default] See the StreamBytesPerSecond control for more information Stream channel packet delay expressed in timestamp counter units. This mode may be used to limit the rate of data from the camera to the host. It works by inserting a delay between successive stream channel packets, e.g. the longer the delay, the slower the data rate.
AVT GigE camera attributes [Byte7]These 8 bits indicate the current aperture position of the EF lens in Dn. To convert Dn to FStop value, use formula: FStop = 2 (Dn – 8) /16. [Byte 8] These 8 bits indicate the current focal length of the EF lens in mm. [Bytes 9 – 12] Exposure value in μs. [Bytes 13 – 16] Gain value in dB. For GT1930L and GT1930LC cameras: Gain value in tenths of dB (i.e. 201 represents 20.1 dB) [Bytes 17 – 18] Sync in levels. A bit field. Bit 0 is sync-in 0, bit 1 is sync-in 1, etc.
AVT GigE camera attributes GvspLookbackWindow – Uint32 – R/W Units: packets Size of the look back window when determining if a stream packet is missing. When a stream packet arrives out of order, the driver skips back GvspLookbackWindow packets to see if the packets previous to this point have all arrived. If not, a resend is issued. A lower value allows the driver less time to assemble out-of-order packets; a larger value allows the driver more time.
AVT GigE camera attributes HeartbeatTimeout – Uint32 – R/W Range: [500 – 3,600,000] Default: 6000 Units: ms Timespan for which the camera waits for a heartbeat packet. If a heartbeat packet is not received within HeartbeatTimeout, the camera assumes the host has closed its controlling application or is dead, and closes its stream and control channel. This parameter may need to be increased if stepping through code in a debugger, as this prevents the driver from sending heartbeat packets.
AVT GigE camera attributes PayloadSize – Unit32 – R Units: Bytes Total size of payload in bytes. • If ChunkModeActive = TURE: PayloadSize = TotalBytesPerFrame + NonImagePayloadSize + 8 • If ChunkModeActive = FALSE: PayloadSize = TotalBytesPerFrame PTP Precision Time Protocol (PTP) manages clock synchronization of multiple devices across an Ethernet network, with ±1 μs tolerance.
AVT GigE camera attributes Master Auto This device’s TimeStampValue is the master clock. All other PTP enabled slave devices synchronize their clock to this camera This device uses the IEEE1588 best master clock algorithm to determine which device is master, and which are slaves. It may be assigned as either. There may be several state transitions prior to synchronization PtpStatus – Enum – R State of the PTP operation.
AVT GigE camera attributes To calculate the required minimum StreamBytesPerSecond setting for a camera in any image mode, use the following formula: StreamBytesPerSecond = Height x Width x FrameRate x Bytes per pixel 115,000,000 is the typical data maximum data rate for a GigE port. Beyond this setting, some network cards will drop packets.
AVT GigE camera attributes Timestamp TimeStampFrequency – Uint32 – R/C Units: Hz Camera clock frequency. Timebase for TimeStampValue. Note PvAPI users: images returned from the camera are marked with a timestamp: tPvFrame.TimestampLo/Hi. This can be useful for determining whether images are missing from a sequence due to missing trigger events. TimeStampReset – Command Reset the camera’s time stamp to 0. Not possible while PTP enabled (PtpMode = Master, or Auto).
AVT GigE camera attributes RegionY – Uint32 – R/W Range: [0 - Camera dependent] Units: rows The Y position of the top-left corner of the ROI. RegionY + Height must not exceed SensorHeight. Width – Uint32 – R/W Range: [1 - Camera dependent] Units: columns The horizontal size of the ROI rectangle. PixelFormat – Enum – R/W The various pixel data formats the camera can output. Not all cameras have every format. See camera user manual.
AVT GigE camera attributes ImageMode BinningHorizontalMode – Enum – R/W Determines whether the result of binned pixels is averaged or summed up. Changing BinningHorizontalMode also changes BinningVerticalMode. Sum Average [Default] Binning is accomplished by summing the charge / gray value of adjacent pixels on sensor Binning is accomplished by averaging the charge / gray value of adjacent pixels on sensor.
AVT GigE camera attributes Note • • BinningY and DecimationVertical are mutually exclusive. Setting BinningY > 1 forces DecimationVertical to 1. Color cameras only: Color information is lost while binning is active due to summing of adjacent different filtered pixels on the Bayer filter array. DecimationHorizontal – 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.
AVT GigE camera attributes Note Writing an invalid number for DecimationVertical will round up to next valid mode. For example, 5 rounds up to 8. www For more information on the decimation process, see: http://www.alliedvision.com/fileadmin/content/documents/ products/cameras/various/appnote/Decimation.pdf ReverseX – Boolean – R/W Possible values: True, False Default: False Flips the image sent by device horizontally. The region of interest (ROI) is applied after flipping.
AVT GigE camera attributes Firmware Read only. Firmware currently loaded on the camera. FirmwareVerBuild – Uint32 – R/C Build number. FirmwareVerMajor – Uint32 – R/C The major part of the Firmware version number (part before the decimal). FirmwareVerMinor – Uint32 – R/C The minor part of Firmware version number (part after the decimal). Part PartClass – Uint32 – R/C Camera part class (manufacturer dependent). PartNumber – Uint32 – R/C Camera part number. Manufacturer part number for the camera model.
AVT GigE camera attributes IO The control and readout of all camera inputs and outputs. The number of inputs and outputs is camera model dependent. StatusLed1 Indicates status of LED1. StatusLedInvert - Enum - R/W Possible values: On, Off Polarity applied to the status LED. Note On: yellow LED Off: green LED StatusLed1Mode - Enum - R/W Determines the behavior of the StatusLed1.
AVT GigE camera attributes Strobe 1 Strobe is an internal signal generator for on-camera clocking functions. Valid when any of the SyncOut modes are set to Strobe1. Strobe allows the added functionality of duration and delay, useful when trying to sync a camera exposure to an external strobe. Strobe1ControlledDuration – Enum – R/W Possible values: On, Off Default: Off When enabled, the Strobe1Duration control is valid.
AVT GigE camera attributes SyncIn1 SyncIn1GlitchFilter – Uint32 – R/W Range: [0 – 50000] Default: 0 Units: relative Ignores glitches on the SyncIn1 input line with pulse duration less than set value. Units are approximately accurate to nanoseconds. Exact units are camera model and input dependent. Note Setting this value increases latency of FrameTrigger by same amount. SyncIn2/3/4 Analogous to SyncIn1. SyncInLevels – Uint32 – R A bit field, each bit corresponding to a specific SyncIn input.
AVT GigE camera attributes SyncIn4 Strobe1 CCDTemperatureOK Note Active when there is an external trigger at SyncIn4 The output signal is controlled according to Strobe1 settings Only for cameras that support this feature: indicates if camera has reached the desired temperature value For detailed information see the camera waveform diagrams provided in the camera manuals. SyncOut2/3/4 Analogous to SyncOut1. SyncOutGpoLevels – Uint32 – R/W GPO output levels. A bit field.
AVT GigE camera attributes Note PvAPI programmers: this stat does not increment if no frames queued. Use tPvFrame. FrameCount for a counter of exactly which image the camera is returning. StatFramesDropped – Uint32 – R The number of frames returned to the PvAPI frame queue with one or more dropped packet within. Note PvAPI programmers: this stat does not increment if no frames queued. Use tPvFrame. FrameCount for a counter of exactly which image the camera is returning.
Index Index A AcqEnd ............................................. 11, 12 AcqEndTriggerEvent ................................. 11 AcqEndTriggerMode ............................ 11, 15 AcqRec ............................................. 11, 15 AcqRecTriggerEvent .................................. 11 AcqRecTriggerMode ............................. 11, 12 AcqStart .................................. 11, 12, 13, 14 AcqStartTriggerEvent ................................ 12 AcqStartTriggerMode ...................
Index EFLensFocusDecrease ............................... 21 EFLensFocusIncrease ................................ 21 EFLensFocusMax ...................................... 21 EFLensFocusMin ...................................... 21 EFLensFocusStepSize ................................ 21 EFLensFocusSwitch ................................... 21 EFLensFStopCurrent ................................. 21 EFLensFStopDecrease .......................... 20, 21 EFLensFStopIncrease ...........................
Index IO ......................................................... 50 IODMode ................................................ 28 IP ......................................................... 38 IP address camera ................................................ 38 host network interface ........................... 38 Iris ........................................................ 30 IrisAutoTarget ......................................... 30 IrisMode ...........................................
Index StatFramesCompleted .......................... 40, 53 StatFramesDropped ............................. 40, 54 StatPacketsErroneous ............................... 54 StatPacketsMissed ................................... 54 StatPacketsReceived ................................. 54 StatPacketsRequested ............................... 54 StatPacketsResent ................................... 54 Stats ..................................................... 53 StatusLed1 .......................................
For technical support, please contact support@alliedvision.com. For comments or suggestions regarding this document, please contact info@alliedvision.com. Disclaimer Due to continual product development, technical specifications may be subject to change without notice. All trademarks are acknowledged as property of their respective owners. We are convinced that this information is correct. We acknowledge that it may not be comprehensive.
