background image

IRON

  

CoaXPress 

User Manual 

 

 

 

Sky Blue Microsystems GmbH

Geisenhausenerstr. 18
81379 Munich, Germany

+49 89 780 2970, [email protected] 

www.skyblue.de

In Great Britain:

Zerif Technologies Ltd.

Winnington House, 2 Woodberry Grove

Finchley, London N12 0DR
+44 115 855 7883, [email protected]

www.zerif.co.uk

International Distributors

 

March 2021 

 Rev 1.4

 

Summary of Contents for IRON CoaXPress

Page 1: ...rstr 18 81379 Munich Germany 49 89 780 2970 info skyblue de www skyblue de In Great Britain Zerif Technologies Ltd Winnington House 2 Woodberry Grove Finchley London N12 0DR 44 115 855 7883 info zerif co uk www zerif co uk International Distributors March 2021 Rev 1 4 ...

Page 2: ...on Control 14 6 3 1 Acquisition Control XML parameters 14 6 3 2 Exposure Time 15 6 3 3 Auto Exposure Gain Algorithm 15 6 3 4 Combined Auto Exposure Auto Gain Mode 18 6 3 5 Brightness Level 18 6 3 6 Auto Exposure Gain ROI Definition 19 6 4 Analog Control 21 6 4 1 Analog and Digital Gain and Black Level 21 6 4 2 White Balance 22 6 5 LUT control 24 6 5 1 LUT Control XML Parameters 24 6 5 2 LUT pixel ...

Page 3: ... 972 72 2723500 Fax 972 72 2723511 www kayainstruments com Table of Contents 6 9 1 CoaXPress XML Parameters 33 6 10 Test Control 35 6 10 1 Test Control XML Parameters 35 6 10 2 Build In Test 36 6 11 Lens Control 37 6 11 1 Lens Control Parameters 37 6 11 2 P Iris Setup 39 6 11 3 Birger Setup 40 ...

Page 4: ...Figure 17 Pixel Correction Control category in GenICam Browser 25 Figure 18 Defect pixel correction position for Mono image 26 Figure 19 Defect pixel correction position for Color image 26 Figure 20 File Access Control parameter configuration in GenICam Browser 28 Figure 21 UserSet Control parameter configuration in GenICam Browser 31 Figure 22 CoaXPress category in GenICam Browser 33 Figure 23 Te...

Page 5: ...Figures Tables Table 12 White Balance parameters 23 Table 13 LUT Control parameters 24 Table 14 Pixel Correction Control parameters 25 Table 15 File Access Control parameters 29 Table 16 User Set Control parameters 31 Table 17 User Set Selector parameters 31 Table 18 CoaXPress parameters 34 Table 19 Test Control parameters 36 Table 20 Lens Control parameters 38 ...

Page 6: ...able 1 Revision History Ver Date Notes 1 0 06 2019 Initial release 1 1 07 2019 Balance White chapter update 1 2 09 2019 Minor content and tables editing 1 3 03 2020 Add more descriptive section for File Access Control Add new parameters for Exposure Auto algorithm Document restructure for better readability 1 4 03 2021 Update description of Lens Control chapter Add support for P Iris lens control ...

Page 7: ...ay drop or fall resulting in injury to persons or the camera Do not use the product if dropped or damaged Otherwise a fire or electric shock may occur Do not touch the product with metallic objects Otherwise a fire or electric shock may occur Do not place the product in dusty or humid environments nor where water may splash Otherwise a fire or electric shock may occur Do not wet the product or tou...

Page 8: ...under other abnormal and or unreasonable conditions Secondary damages caused by the use of this product or its unusable state business interruption or others Use of this product in any manner that contradicts this manual or malfunctions that may occur due to connection to other devices Damage to this product that is out of our control or failure due to modification Accidents and or third parties t...

Page 9: ... image streaming Using standard CoaXPress Frame Grabber connection and streaming can be achieved in few easy steps and requires little configurations The camera provides vast variety of image processing algorithms and configurations to adjust the stream output Camera control can be achieved using standard GenICam interface subordinate to the camera s descriptive schema xml file Configuration featu...

Page 10: ...hen PoCXP is enabled on Frame Grabbers 5 2 Micro BNC Connector To connect the Micro BNC cable first need to align the pin on the male end with the L shaped track on the female connector of the Coaxial cable Once aligned the connector should be pushed in place see figure no 1 Only mild pressure should be applied to achieve this operation otherwise it may cause unnecessary damage to the cable or the...

Page 11: ...timing for each indicator are described in the following tables LED state Indication Off Camera is not powered Solid orange Camera is booting Solid red Camera is powered but no active connection Fast flash alternate green orange Fast flash alternate green orange Connection detection in progress Solid green Camera is connected no data being transferred Fast flash green Camera is connected data is b...

Page 12: ...ks Value Gen i Cam name Gen i Cam Category DeviceControl Device Vendor Name Name of the manufacturer of the device DeviceVendorName String Device Model Name The model of the device DeviceModelName String Device Manufacturer Info Extended manufacturer information about the device DeviceManufacturerInfo String Device Version The version of the device DeviceVersion String Device Firmware Version The ...

Page 13: ...rface 6 1 2 Device Operation Timer Device Operation Timer indicates how much time has the camera been operational in its lifetime The time value units of the Timer are in minutes For example value of 1234 will indicate that camera has been operational powered up for total of 1234 minutes in its lifetime This parameter can be found under the Device Control section of camera s XML ...

Page 14: ...ML Parameters Parameter Description Gen i Cam name Type Possible values Remarks Value Gen i Cam name Gen i Cam Category ExtendedStreamFeatures ImageFormatControl Width Min Minimum width of the image WidthMin Integer In pixels See remark 1 Height Min Minimum height of the image HeightMin Integer In pixels See remark 1 Width Max Maximum width of the image WidthMax Integer In pixels See remark 1 Heig...

Page 15: ... pattern that is generated by the device as image source TestPattern Enumeration 0x101 Grey Vertical Ramp 1 0x102 Grey Vertical Ramp 2 0x103 Gradation Pattern Vertical invert Flip image vertically The ROI will stay as original image ReverseY Boolean 0 False 1 True Horizontal invert Flip image horizontally The ROI will stay as original image ReverseX Boolean 0 False 1 True Binning Selector Selects ...

Page 16: ...e Grabber is possible according to input camera PixelFormat resolution and HW capabilities 3 Reduces the vertical resolution height of the image A value of 1 indicates that no vertical binning is performed by the camera 4 Reduces the horizontal resolution width of the image A value of 1 indicates that no horizontal binning is performed by the camera 5 Reduces the horizontal resolution width of the...

Page 17: ...uisition of the device AcquisitionStart Command 1 Activate Acquisition Stop Stops the Acquisition of the device at the end of the current Frame AcquisitionStop Command 0 Activate Frame Rate Max Acquisition rate maximum value AcquisitionFrameRateMax Float In units of Hz Frame Rate Controls the acquisition rate at which the frames are captured AcquisitionFrameRate Float 1 In units of Hz Exposure Mod...

Page 18: ... to control the picture brightness by adjusting Exposure and Gain values in automatic mode in order to reach desired brightness level The algorithm calculates the average picture intensiveness inside the defined ROI and tries to adjust it to desired brightness level The brightness is adjusted by increasing decreasing exposure time and or analog gain level Three modes are available for automatic br...

Page 19: ...iption Gen i Cam name Type Possible values Remarks Value Gen i Cam name Gen i Cam Category AcquisitionControl Exposure Auto Sets the automatic exposure mode when ExposureMode is Timed ExposureAuto Enumeration 0x00 Off 0x01 Continuous 0x02 Once Desired Brightness Level Image total Brightness Level DesiredBrightnessLevel Float Range 1 to 2 bitness 2 Exposure Auto Min Time Sets the Auto Exposure mini...

Page 20: ...adjustment By default these values will be set to maximum and minimum possible values Figure 10 Auto Gain values 3 Choose one of Auto Gain modes Once or Continuous Under Once mode the algorithm will adjust the Analog Gain only once and then the feature will be set to OFF Respectively under Continuous mode the gain will be adjusted continuously Figure 11 Auto Gain mode selection The following table...

Page 21: ...hm starts to modify Gain Level and adjust exposure level accordingly This mode is operational only when both Auto Exposure and Auto Gain are set to Continues mode Steps to set Combined Auto Exposure and Auto Gain Mode 1 Define the parameters for Auto Exposure please see the section 6 3 3 1 for detailed instructions 2 Set Auto Exposure to Continuous mode 3 Define the parameters for Auto Gain please...

Page 22: ...r Range 0 to max pixel value Average Brightness Level Current average brightness level result from auto compensation AverageBrightnessLevel Integer Range 0 to max pixel value Peak Brightness Level Current peak brightness level result from auto compensation PeakBrightnessLevel Integer Range 0 to max pixel value Brightness Level Average Peak Balance Sets the effective ratio of Average Brightness Lev...

Page 23: ...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 AnalogControl AutoCompensationControl Auto Compensation ROI Width Width of the Auto Compensation calculation ROI AutoCompensationRoiWidth Integer Auto Compensation ROI Height Height of the Auto Compensation calculation ROI AutoCompen...

Page 24: ...gControl Gain Selector Selects which Gain is controlled by the various Gain features GainSelector Enumeration Selector 0 DigitalAll 1 DigitalRed 2 DigitalGreen 3 DigitalBlue Gain Controls the selected gain as an absolute physical value Gain GainSelector Float Max 7 99923 Analog Gain Level Controls the analog gaining level AnalogGainLevel Float Min 1 Max 252 Black Level Selector Selects which Black...

Page 25: ...el is the offset of said pixel and the Gain is the gain of the pixel Analog Black Level Controls the analog black level as an absolute physical value Represents the applied DC offset 6 4 2 White Balance Parameter Description Gen i Cam name Type Possible values Remarks Value Gen i Cam name Gen i Cam Category AnalogControl Balance White Auto Controls the mode for automatic white balancing between th...

Page 26: ... Red 1 Green 2 Blue Balance Ratio Ratio of the selected color compared to a reference color component selected using Balance White Calculation Mode Used to adjust colors for white balancing BalanceRatio BalanceRatioSelector Float Max 7 999 Table 12 White Balance parameters Automatic white balance adjustment compensate sensor output colors to true colors The algorithm works on the assumption that a...

Page 27: ...1 true LUT Index Control the index offset of the coefficient to access in the selected LUT LUTIndex LUTSelector Integer Max 4095 LUT Value Returns the Value at entry LUTIndex of the LUT selected by LUTSelector LUTValue LUTSelector LUTIndex Integer Max 4095 LUT Value All Accesses all the LUT coefficients in a single access without using individual LUTIndex LUTValueAll LUTSelector IRegister Table 13...

Page 28: ...ected DefectPixelSelectorMax Integer Defect Pixel Selector Total number of defect pixels to be corrected DefectPixelSelector Integer Selector Defect pixel X coordinate Configure defect pixel X coordinate DefectPixelX DefectPixelSelector Integer Min 1 Max SensorWidth Defect pixel Y coordinate Configure defect pixel Y coordinate DefectPixelY DefectPixelSelector Integer Min 1 Max SensorHeight Defect ...

Page 29: ...ls from both sides of pixel 𝑃 𝑥 𝑦 in the same row corresponding to the same Bayer color element Figure 19 Defect pixel correction position for Color image 6 6 3 Field Correction The Flat field and Dark field corrections are used to improve the quality of the image by removing the artefacts that are caused by fixed pattern noise and variations in the pixel to pixel sensitivity of the detector To ma...

Page 30: ...or by applying an external trigger 4 Initiate the selected calibration with Field Calibration Start command Execute Notes 1 The Flat field calibration should be performed after the Dark field calibration has already be performed for the selected camera settings 2 The PRNU and DSNU depends on exposure gain temperature and number of active fiber links In case the above conditions might change during...

Page 31: ...access mode in which a file is opened in the device FileOpenMode Enumeration 0 Read 1 Write 2 ReadWrite File Size Represents the size of the selected file in bytes FileSize Integer File Operation Selector Selects the target operation for the selected file in the device This Operation is executed when the FileOperationExecute feature is called FileOperationSelector Enumeration Selector 0 Open 1 Clo...

Page 32: ...FileOperationSelector to Write in order to select write operation 7 Fill FileAccessOffset FileAccessLength and FileAccessBuffer with offset position length and data for next transection 8 Perform write operation using FileOperationExecute command 9 Check the operation status in FileOperationStatus and count of transferred bytes in FileOperationResult 10 Proceed to next transaction by performing st...

Page 33: ... operation 6 7 4 User Memory UserMemory is a dedicated non volatile memory space reserved for user usage Up to 74MB can be filled with user specific data which can be read back at any time This memory space will not be erased or modified on camera power cycle Notice that the camera does not manage the user memory space nor is it responsible for any initial value Write operation remarks Writing to ...

Page 34: ...ible values Remarks Value Gen i Cam name Gen i Cam Category UserSetControl User Set Selector Selects the feature User Set to load save or configure UserSetSelector Enumeration Selector Load User Configuration Loads the User Set specified by UserSetSelector to the device and makes it active UserSetLoad UserSetSelector Command 1 Activate Save User Configuration Save the User Set specified by UserSet...

Page 35: ... numeration as UserSetX X in range of 1 8 NOTE Default user set contains factory settings and is not rewritable 4 Execute Save User Configuration command Load User Set 1 Select UserSetSelector to the desired UserSetX X in range of 1 8 2 Execute Load User Configuration command 3 Press Refresh located in the bottom of the project window 4 In order to determine the user set configuration with which s...

Page 36: ...teger Control Packet Data Size Bootstrap register ControlPacketDataSize ControlPacketDataSize Integer Stream Packet Data Size Bootstrap register StreamPacketDataSize StreamPacketDataSize Min 256 Max 8192 Connection Config Bootstrap register ConnectionConfig ConnectionConfig Enumeration 0x00010038 x1_CXP_3 1 Link 3 125 Gbps 0x00010048 x1_CXP_6 1 Link 6 25 Gbps Connection Config Default Bootstrap re...

Page 37: ...ger Connection Test Rx Packets Reports the current count for test packets received by the device on the connection selected by CxpConnectionSelector CxpConnectionTestRxPacketC ount Integer Connection Test Tx Packets Reports the current count for test packets sent to the device on the connection selected by CxpConnectionSelector CxpConnectionTestTxPacketC ount Integer Tap Geometry Vertical multi ta...

Page 38: ...ol XML Parameters Parameter Description Gen i Cam name Type Possible values Remarks Value Gen i Cam name Gen i Cam Category TestControl Sensor Register Address Sensor Register Address SensorRegAddress Integer Sensor Register Value Returns the value of sensor register at SensorRegAddress address SensorRegValue Integer Gen i Cam Category TestControl BIT BIT Reset All Reset all BITs BITResetAll Comma...

Page 39: ...dongle should be mounted to perform this test 3 SensorControl Test basic communication with the sensor by reading and comparing with a known default value 4 SensorLVDS Test stream interface with the sensor using a known pattern 5 Temperature Test the temperature of several components they must be in acceptable range 6 Voltages Test the analog voltages levels they must be in acceptable range 7 MACO...

Page 40: ...ens LensCommSource Enumeration 0 RS232_0 Lens Initiate Initiates lens controller LensInit Command 1 Activate Lens Reset Reset lens controller LensReset Command 1 Activate Lens Present Indicate if lens is present LensPresent Enumeration 0 No 1 Yes Lens Name Lens descriptive name LensName StringReg Lens Identification Lens type identification LensId StringReg Lens Serial Number Serial Number of the ...

Page 41: ...er value will increase the response speed LensIrisSpeed integer Please note that a value that is too low may result in skipped steps Iris Close Close iris in incremental steps LensIrisClose Command 1 Activate Iris Open Open iris in incremental steps LensIrisOpen Command 1 Activate Iris Minimum Position Lens minimum position for iris LensIrisPositionMin Float For P Iris please refer to the lens s m...

Page 42: ... turned off 2 Set LensSelector as P Iris to select P Iris control 3 Initialize the P Iris using LensInit command The P Iros will calibrate and move to initial position 4 After a successful initialization the LensIrisControl category will be available to control the iris motor LensIrisSpeed can be used to increase the iris response speed a value that is too low may result in skipped steps LensIrisP...

Page 43: ...t this process might take a few minutes to learn the specific steps of the lens 4 After a successful initialization the lens info LensFocusControl LensIrisControl and LensCommandControl categories will be available to control the different lens components 5 Recommended Use the UserSetSave UserSetSelector command to save this preset and remove the need to initiate the Birger in future sessions Figu...

Reviews: