Table of Contents Figures & Tables ..............................1 List of Figures ............................1 List of Tables ............................. 2 Revision History ..............................3 Introduction ..............................4 Safety Precautions ............................ 4 Disclaimer ..............................5 Overview ................................6 Feature Support by Version ........................6 Stream Metadata Information ..........................
Page 3
6.4.5 Brightness Level ..........................22 6.4.6 Auto Exposure & Gain ROI Definition ..................... 24 Analog Control ............................26 6.5.1 Analog and Digital Gain and Black Level ..................26 6.5.2 White Balance ..........................27 LUT control ............................. 29 6.6.1 LUT Control XML Parameters......................29 6.6.2 LUT pixel re-map algorithm ......................
Page 4
6.14.3 User Output block ........................... 54 6.14.4 Timer Trigger Signals ........................56 6.14.5 Counter Block ..........................60 6.15 Stream Metadata Information ........................ 64 Table of Contents...
2 Revision History Date Notes 06.2019 Initial release 07.2019 Balance White chapter update 09.2019 Minor content and tables editing 03.2020 - Added more descriptive section for File Access Control - Added new parameters for the Exposure Auto algorithm - Document restructure for better readability 03.2021 - Updated description of Lens Control chapter - Added support for P-Iris lens control...
3 Introduction 3.1 Safety Precautions With your Iron camera in hand, please take the time to read through the precautions listed below to avoid preventable and unnecessary injuries and damage to you, other personnel, or property. Read these safety instructions carefully before your first use of the product, as these precautions contain safety instructions that must be observed.
3.2 Disclaimer This product should only be used for image capturing and processing. KAYA Instruments assumes no responsibility for any damage that may ensue by using the camera for any purpose other than intended, as previously stated. Without detracting from what was previously written, please be advised that the company takes no responsibility for any damages caused by: ▪...
4 Overview This document describes the functionality and features of the Iron CoaXPress cameras. Iron CoaXPress cameras are high-speed, high-quality devices for image streaming. Using a standard CoaXPress Frame Grabber, connection and streaming can be achieved in a few easy steps and requires a few configurations. Our cameras provide a vast variety of image processing algorithms and configurations to adjust the stream output.
5 Hardware Reference 5.1 Power over CoaXPress Iron CoaXPress cameras support PoCXP (Power over CoaXPress), but must never be connected to an external power source whilst receiving power through PoCXP. Powering the camera with an external power source and over CoaXPress simultaneously may cause irreversible damage.
Do not force the cable out! In case of resistance check for the pin location with the track. Adjust as needed and only then pull the cable out. 5.3 Status LEDs The bi-color LEDs behave according to the definition in section 5.4 of the CoaXPress standard. Color-coded indications along with the exact timing for each indicator are described in the following tables: LED state Indication...
5.4 GPIO Connectivity Iron cameras have external inputs and outputs. Some of them are optically isolated while others operate at TTL/LVTTL levels. For pinout of GPIO connector and functional assignment please refer to specific camera datasheet. The following diagrams show GPIO electrical connections: 5.4.1 Opto-Isolated Inputs Opto-isolated inputs don’t share the same ground with the camera, and the voltage difference between the input and return pins must be positive between 3.3 and 24 volts.
5.4.4 Opto-Isolated Outputs There is no pull-up voltage on either contact of the optoisolated outputs. External pull-up voltage of up to 25 volts is required for operation. The voltage between Out and Return contacts must not exceed 25 volts and the current through the switch must not exceed 50 mA.
6 Configuration Interface 6.1 Device Control The Device Control contains manufacturer parameters describing the currently connected hardware device. The information includes the device vendor name, basic manufacturer information details, and the currently running firmware version. This information can be used to identify the specific hardware and notify in case a firmware update is needed to support the complete functionality set.
Device Fan Selects how to control the DeviceFanMode Enumeration Auto Mode fan activation state (Selector) Manual ForceOff Device Fan Device fan activation duty DeviceFanDutyCycle Integer Duty Cycle cycle. The duty cycle is the [DeviceFanMode] percentage of the pulse duration from the total period of the fan’s rotation cycle.
6.1.4 LED control Allows controlling the led activation behavior. The configuration applies to all camera LEDs. Two modes are available: 1. Automatic: The LEDs will indicate status according to CoaXPress standards (please see section 5.3). 2. Off: The camera’s LEDs will turn ON when power is applied to the camera. All the LEDs will turn OFF once the camera is detected.
6.2 Timestamp Timestamp mechanism for tagging frames and I/O events. The timestamp parameter reflects a global counter value, in nanoseconds. The counter value is represented by a 64bit unsigned integer which wraps around when the maximum value is reached and can be read from the “Timestamp” register. “TimestampReset” command force resets the timestamp counter to 0.
6.3 Image Format Control The Image Format Control is responsible for defining the output image dimensions and format type. The resolution of the image and output format will influence the maximum frame rate which can be achieved. Figure 9 – Image Format Control category in GenICam Browser Page no.
6.3.1 Image Format Control XML Parameters Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: ImageFormatControl Width Min Minimum width of the WidthMin Integer In pixels image See remark Height Min Minimum height of the HeightMin Integer In pixels image...
Page 21
Test Pattern Selects the type of test TestPattern Enumeration 0x000 Camera pattern that is may also 0x200 GrayHorizontalRamp generated by the contain 0x201 GrayVerticalRamp device as image source sensor specific 0x202 GrayDiagonalRamp test 0x203 GrayDiagonalIntervalRamp patterns 0x2FF UserTestPattern Vertical invert Flip image vertically. ReverseY Boolean False...
6.4 Acquisition Control The Acquisition stream control section describes settings and states for data generation (commands and stream). The acquisition can also be controlled trough executing the relevant commands from this category Figure 10 – Acquisition Control category in GenICam Browser 6.4.1 Acquisition Control XML parameters Parameter Description...
Remarks: 1. Controls the duration where the photosensitive cells are exposed to light. 6.4.2 Exposure Time Time in microseconds [µsec] in which sensor is exposed to light. This time is subject to the specified image frame rate: Minimum exposure depends on camera model, connection configuration and sensor characteristics 1,000,000 Maximum exposure ≅...
Page 24
Figure 12 – Auto exposure times 3. Choose one of the Auto Exposure modes: “Once” or “Continuous”. Under “Once” mode, the algorithm will adjust the Exposure only once and then the feature will be set to OFF. Respectively under “Continuous” mode, the exposure will be adjusted continuously. Figure 13 –...
Page 25
6.4.3.2 Auto Gain Mode When operating in this mode, the camera tries to reach the desired brightness level of the picture by adjusting Analog Gain Level. Steps to set Auto Gain Mode: 1. Define Desired Brightness Level Figure 14 – Brightness Level 2.
Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: AnalogControl Auto Gain Auto Gain Selector GainAuto Enumeration 0x00 0x01 Continuous 0x02 Once Auto Gain Min Auto Gain Min Value GainAutoMin Float See remark (1) Auto Gain Max Auto Gain Max Value GainAutoMax Float See remark (1)
Page 27
Figure 17 – Brightness level selection The average value is calculated by the following formulas: avg_val = ExposureAutoRatio[red]* avg_val[red]+ ExposureAutoRatio[green]* avg_val[green]+ ExposureAutoRatio[blue]* avg_val[blue] max_val= ExposureAutoRatio[red]* max_val[red]+ ExposureAutoRatio[green]* max_val[green]+ ExposureAutoRatio[blue]*max_val[blue] roi_avg= BrightnessLevelAveragePeakBalance*avg_val+ (1-BrightnessLevelAveragePeakBalance)*max_val The algorithm strives to make roi_avg value as close as possible to the specified “DesiredBrightnessLevel” by changing Exposure and Analog Gain.
Selects which Exposure 0x02 Blue Auto compensation ratio to control Auto Exposure Controls ratio of the ExposureAutoRatio Float Range: 0 to Ratio selected color component to a reference color component Table 10 – Brightness level control 6.4.6 Auto Exposure & Gain ROI Definition ROI definition refers to Region of Interest which will be used for brightness calculations.
Page 29
Auto Exposure ROI parameters are described in the following table: Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: AutoCompensationControl Auto Width of the AutoCompensationRoiWidth Integer Compensation Auto Compensation ROI Width calculation ROI Auto Height of the AutoCompensationRoiHeight Integer Compensation Auto Compensation...
6.5 Analog Control Analog control parameters describes how to influence the analog sensor features and digital modifiers, such as gain, black level, white balance and voltages, to manipulate image output. Figure 20 – Analog Control category in GenICam Browser 6.5.1 Analog and Digital Gain and Black Level Parameter Description Gen<i>Cam name...
Analog Black Controls the analog black AnalogBlackLevel Float See remark (1) Level level as an absolute physical value. Represents the applied DC offset Analog Selects an analog voltage AnalogVoltageSelector Enumeration See remark (2) Voltage (Selector) Selector Analog Device analog voltage AnalogVoltageValue Float In units of Volt...
Page 32
Balance White Height of the area for BalanceWhiteAreaHeight Integer Max: Image In units of Area Height BalanceWhite calculation, Height pixels inside the output image Balance White Horizontal offset from the BalanceWhiteAreaOffsetX Integer In units of Area Offset X origin to the area of pixels BalanceWhite interest Balance White...
6.6 LUT control The LUT control can be used to re-map the camera linear output in a different manner. Mostly to compensate for the non-linear scene emission. LUT configuration typical applications include enhancing gamma or image contrast, brightness changes, gray value spreading, setting individual gradation curves, etc. Figure 21 –...
6.7 Gamma Control Gamma correction is typically used to compensate for the non-linearity of the display system: it can be used to change the dynamic range of the image in such a way that more shades become visible while not losing the depth of the image.
Gamma Linear Controls the fast gamma GammaLinearContrast Float Max: Available only in Contrast correction contrast for the Min: 20.0 “FastExtended” linear part of the formula. Inc: 0.001 mode Gamma Linear Controls the fast gamma GammaLinearBrightness Float Max: -1.0 Available only in Brightness correction brightness for Min:...
6.7.3 BT.709 standard gamma curve algorithm The following image shows the normalized REC.709 gamma curve and its transition from linear to non-linear (power function) parts: Figure 23 – REC. 709 gamma curve The linear part ranges from 0 to <0.018 and is computed by the following formula: = 4.5*V The maximum value in this range is: (4.5* V...
6.8 Pixel Correction Control The pixel correction control allows compensating any sensor dead pixel by averaging adjacent pixels. The Dark and Flat field correction algorithm helps to solve issues with fixed pattern noise, which usually originates from the sensor. Figure 24 – Pixel Correction Control category in GenICam Browser 6.8.1 Pixel Correction Control XML Parameters Parameter Description...
6.8.2 Defect Pixel Correction The defected pixel correction will correct up to 32 pixels in the sensor and up to 2 adjacent pixels in a row. The pixel correction coordinates represent pixels of the sensor’s visible ROI, therefore identifying the correct X and Y coordinate should be done using a default, full resolution image.
Page 39
Where P(x,y) is the pixel at offset X in horizontal and Y in vertical. Pdark (x,y) is the offset of the pixel at offset X in horizontal and Y in vertical that was measured during the calibration stage. Gain(x,y) is the gain of the pixel at offset X in horizontal and Y in vertical that was measured during the calibration stage.
6.9 File Access Control File Access Control contains parameters related to accessing files stored on the device, including file selection, operation mode (reading and writing) as well as data transfer limitations, and information regarding file sizes. Figure 27 – File Access Control parameter configuration in GenICam Browser 6.9.1 File Access Control XML Parameters Parameter Description...
File Operation Represents the file FileOperationStatus Enumeration 0 Success Status operation execution status Failure File Operation Represents the file FileOperationResult Integer Result operation result. For Read or Write operations, the number of successfully read/written bytes is returned Table 17 – File Access Control parameters 6.9.2 How to Use File Access Control The purpose of the file access control interface is to perform large data transfers with the camera.
6.9.3 Firmware Update “FirmwareUpdate” is used to upload new firmware to the camera: only a dedicated firmware update file should be loaded using this method. The file upload process should not be interrupted and must be completed for a successful camera firmware update. After the upload of a new firmware file is finished the camera should be power cycled.
6.10 User Set Control Eight user sets are available for saving different camera parameter configurations. In addition, a “Default” UserSet is available so it will be possible to revert to default factory settings. Figure 28 – UserSet Control parameter configuration in GenICam Browser 6.10.1 User Set Control XML Parameters The User Set Control parameters are summarized in Tables 14 and 15: Parameter...
6.10.2 UserSet operation sequence The following steps describe the sequence of saving and loading user set camera parameter configurations: Save User Set: 1. Set the desired camera parameters. 2. Open the “User Set Control” category 3. Select the desired “UserSetSelector” enumeration as “UserSetX” (X in range of 1-8). Note: “Default”...
6.11 CoaXPress Category The CoaXPress category deals with CoaXPress protocol-specific configuration parameters. Figure 29 – CoaXPress category in GenICam Browser 6.11.1 CoaXPress XML Parameters Parameter Description Gen<i>Cam Type Possible values Remarks name Value Gen<i>Cam name Gen<i>Cam Category: CoaXPress Device Link ID Bootstrap register DeviceLinkID Integer DeviceLinkID...
Page 46
Connection Reports the current CxpConnectionTestErrorCount Integer Test Error connection error count for Count test packets received by the device on the connection selected by CxpConnectionSelector Connection Reports the current count CxpConnectionTestRxPacketCount Integer Test Rx for test packets received Packets by the device on the connection selected by CxpConnectionSelector Connection...
6.12 Test Control The test Control category contains parameters for camera testing and analysis purposes only. These configurations are not required for the standard operation of the camera. Configuration of these parameters might result in unexpected camera behavior if the wrong value is input. Figure 30 –...
BIT Status BIT current status BITStatus Enumeration 0 Unknown Pass Fail 0xFF Unsupported BIT Error BIT last error report BITErrorReport String Report description Table 21 – Test Control parameters 6.12.2 Build-In-Test The Build-In-Test (BIT) implements an option to check individual camera’s interfaces to insure correct behavior in the allowed range.
6.13 Lens Control The Lens control allows control over the Focus and Iris and provides general information about the mounted lens. The Lens Controller currently support Birger and P-Iris adaptors; Please note that a camera must be ordered with the P-Iris option and P-Iris cable assembly in order for the P-Iris lens to operate.
Page 50
Gen<i>Cam Category: LensIrisControl Iris Close Full Move iris to the fully LensIrisCloseFull Command 1 - Activate stopped down limit Iris Open Full Move iris to completely LensIrisOpenFull Command 1 - Activate open Iris Move Step Define iris move step LensIrisStep Integer Iris Speed Defines the aperture speed...
Figure 31 – Iron CoaXPress with P-Iris Iron CoaXPress cameras have integrated Gen<i>Cam parameters for controlling P-Iris lenses. 1. Mount the P-Iris lens and connect it to the GPIO while the camera is turned off. 2. Set “LensSelector” as “P-Iris” to select P-Iris control.
6.13.3 Birger Setup Iron CoaXPress cameras have integrated Gen<i>Cam parameters for controlling Birger lens adapters. Figure 33 – Iron CoaXPress with Birger 6. Mount the Birger adapter with a lens, and connect it to the GPIO while the camera is turned off.
6.14 I/O Controller A variety of triggers, auxiliary signals, timers, GPIO’s etc., can be used to initiate events, and transmit and receive data with configurable duration and activation modes. 6.14.1 Camera Stream Trigger Triggers are issued through the camera CoaXPress channels or GPIO. A sequence of synchronous or asynchronous signals can be configured to be issued, and can be useful in configuring an event-controlled image acquisition: trigger origins can be selected from a number of sources.
Page 54
must have its 0x08 Timer0Active TriggerMode set to 0x09 Timer1Start 0x0A Timer1End 0x0B Timer1Active 0x0F LinkTrigger0 0x1E UserOutput0 0x1F UserOutput1 0x20 UserOutput2 0x21 UserOutput3 Trigger Delay Specifies the delay TriggerDelay Integer in microseconds(us) [TriggerSelector] to apply after the trigger reception before activating it Trigger Filter Filter for trigger,...
Page 55
6.14.1.2 Trigger activation mode The trigger activation mode configures the capture criteria of the signal state. The default value is Rising Edge, which will trigger a frame on signal rising edge event. The different modes' functionality is as follows: 1. Any Edge: The frames will be acquired both on rising and falling edges of the trigger source.
6.14.2 Auxiliary GPIO Block A large array of GPIO is available for configuring trigger sources from external signal generators, such as TTL and OptoCoupled. The auxiliary GPIO signals can be used to initiate stream events from a variety of sources, such as CoaXPress triggers and other GPIOs.
Page 57
6.14.2.1 Auxiliary GPIO XML Parameters Parameter Description Gen<i>Cam Type Possible values Remarks name Value Gen<i>Cam name Gen<i>Cam Category: DigitalIOControl Line Selector Selects the LineSelector Enumeration Line0 GPIO output physical pin of the (Selector) depends on Line1 external camera camera model Line2 connectors.
0x08 OpenDrain Line Status All Returns the LineStatusAll Integer current status of [LineSelector] all available Line signals at time of polling in a single bitfield. Table 24 – GPIO parameters 6.14.3 User Output block Software trigger source which can be controlled by the user to generate onboard events. Several User Outputs have been reserved for trigger sources, their status can be changed in two ways: 1.
Page 59
Figure 38 – Line and User Output control parameter configurations in GenICam Browser Page no. 55 | Configuration Interface...
6.14.4 Timer Trigger Signals Configure an internal timer for timed trigger generation. Incorporate selection of signal edge capture mode, timer signal delay and duration and inverter for timer signal. None ( Off ) Exposure Trigger over CoaXPress ( LinkTrigger0 ) User Outputs Timer output Timer control...
Page 61
6.14.4.1 Timer activation mode The trigger activation mode configures the capture criteria of the signal state. The default value is Rising Edge, which will issue a trigger on a signal rising edge event. The different modes' functionality is as follows: 1.
Page 62
6.14.4.3 Timer Trigger XML Parameters Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: CounterAndTimerControl Timer Selects which TimerSelector Enumeration 0x00 Timer0 Selector Timer to configure. (Selector) 0x01 Timer1 Timer Delay Sets the duration in TimerDelay Float microseconds(μs) [TimerSelector]...
Page 63
0x27 Counter1Active Timer Trigger Generates an TimerTriggerSoftware Command Software internal trigger. [TimerSelector] TimerTriggerSource must be set to “Off”. Timer Reset Does a software TimerReset Command reset of the [TimerSelector] selected timer and starts it. The timer starts immediately after the reset unless a timer trigger is active.
6.14.5 Counter Block Configure a counter of events or signals. It can be used to count and monitor internal events (e.g FrameStart, Timer1End), I/O external events (e.g Input Line rising edge) and even clock ticks. It can be reset, read or written at any time.
Page 65
6.14.5.1 Counter XML Parameters Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: CounterAndTimerControl Counter Selects which CounterSelector Enumeration 0x00 Counter0 Selector Counter to (Selector) 0x01 Counter1 configure. Counter Select the events CounterEventSource Enumeration 0x00 Event Source that will be the [CounterSelector] 0x02...
6.15 Stream Metadata Information Runtime metadata information can be attached to each transmitted frame. When enabled, the metadata will be available at the beginning of each frame and substitute existing stream data. The information will be relevant for the specific frame and will be updated in the next frame. In an 8bit data image, the metadata will occupy contiguous bytes.
Page 69
Chunk data control GenICam interface: Parameter Description Gen<i>Cam name Type Possible values Remarks Value Gen<i>Cam name Gen<i>Cam Category: ChunkDataControl Chunk Mode Activates the inclusion ChunkModeActive Boolean Active of Chunk data in the payload of the image Chunk Selector Selects which Chunk to ChunkSelector Enumeration “Timestamp”'...
Need help?
Do you have a question about the IRON CoaXPress and is the answer not in the manual?
Questions and answers