Fire-I.Net SDK Manual
Total Page:16
File Type:pdf, Size:1020Kb
Unibrain Fire-i.net SDK manual Programmer’s Manual & Reference Table of Contents TABLE OF CONTENTS ................................................. 2 IsCurrent property .............................................. 39 INTRODUCTION ........................................................ 4 Identifier property .............................................. 39 TECHNICAL DETAILS .................................................. 5 Fixed property .................................................... 40 ARCHITECTURE .............................................................. 5 UserDefined property ......................................... 40 PERFORMANCE ............................................................. 5 RawModeOverride property ............................... 41 INSTALLATION ............................................................... 6 Width property ................................................... 41 DESIGN ....................................................................... 6 Height property .................................................. 42 USAGE ...................................................................... 7 ToString method ................................................. 42 SCENARIO I – SIMPLE VIDEO VIEWER ................................. 7 Save method ....................................................... 42 SCENARIO II – CONTROLLING CAMERA FEATURES ............... 14 FIREIFIXEDSTREAMFORMAT ........................................... 44 SCENARIO III – MANIPULATING CAPTURED FRAMES ............ 17 ResolutionString property................................... 44 SCENARIO IV – WORKING WITH A ROI (A.K.A. FORMAT 7) . 19 FrameRateString property .................................. 44 REFERENCE ............................................................. 22 FrameRate property ........................................... 44 FIREIPREVIEWCONTROL ................................................ 22 PacketSize property ............................................ 45 FIREIGUID................................................................. 22 PacketsPerFrame property ................................. 45 [] property .......................................................... 22 ToString method ................................................. 46 ToString method................................................. 22 IsFrameRateSupported method ......................... 46 InitFromString method ....................................... 23 FIREIUSERDEFINEDSTREAMFORMAT ............................... 48 FIREIMANAGER ........................................................... 24 Left property ....................................................... 48 GetConnectedCamerasCount method ................ 24 Right property .................................................... 48 SelectCamera method ........................................ 24 Top property ....................................................... 48 GetCameraFromIndex method ........................... 25 Bottom property ................................................. 49 GetCameraFromGUID method ........................... 26 Width property ................................................... 49 FIREIREGISTER ............................................................ 27 Height property .................................................. 49 GetBit method .................................................... 27 MaxWidth property ............................................ 50 SetBit method ..................................................... 27 MaxHeight property ........................................... 50 GetField method ................................................. 28 HorizontalPositionUnit property......................... 50 SetField method ................................................. 28 VerticalPositionUnit property ............................. 51 GetFieldLen method ........................................... 29 WidthUnit property ............................................ 51 SetFieldLen method ............................................ 29 HeightUnit property ........................................... 51 SwapEndianess method ..................................... 29 MaxPacketSize property ..................................... 52 FIREITRIGGER ............................................................. 30 PacketSizeUnit property ..................................... 52 AbsControl property ........................................... 30 PacketSize property ............................................ 52 Enabled property ................................................ 30 F7Offset property ............................................... 53 Polarity property ................................................ 31 ToString method ................................................. 53 Source property .................................................. 31 SetROI method ................................................... 54 Value property ................................................... 32 FIREIFEATURE ............................................................. 55 Mode property ................................................... 32 Name property ................................................... 55 IsSupported property ......................................... 32 IsSupported property .......................................... 55 HasAbsolute property ........................................ 33 HasAbsolute property ......................................... 56 CanRead property .............................................. 33 HasOnePush property ......................................... 56 HasOnOff property ............................................. 33 CanRead property ............................................... 56 HasPolarity property .......................................... 34 HasOnOff property ............................................. 57 CanReadRaw property ....................................... 34 HasAuto property ............................................... 57 Parameter property ........................................... 34 HasManual property .......................................... 58 IsSourceSupported method ................................ 35 MinValue property ............................................. 58 IsModeSupported method ................................. 35 MaxValue property ............................................. 58 Reload method ................................................... 36 Absolute property ............................................... 59 PullSoftwareTrigger method .............................. 36 Enabled property ................................................ 59 Save method ...................................................... 36 AutoMode property ............................................ 59 FIREISTREAMFORMAT .................................................. 37 Value property .................................................... 60 PixelFormatString property ................................ 37 HasSoftAbsolute property .................................. 60 PixelFormat property ......................................... 37 SoftAbsolute property ........................................ 61 Resolution property ............................................ 38 ValueString property .......................................... 61 IsUserDefined property ...................................... 39 MinValueString property .................................... 61 2 MaxValueString property ................................... 62 Focus property .................................................... 78 Unit property ...................................................... 62 Zoom property .................................................... 78 AbsoluteValue property ..................................... 63 Brightness property ............................................ 78 MinAbsoluteValue property ............................... 63 Sharpness property ............................................. 79 MaxAbsoluteValue property .............................. 64 Gamma property ................................................ 79 Reload method ................................................... 64 RawConversion property .................................... 79 OnePush method ................................................ 64 Icon property ...................................................... 80 FIREIFRAME ............................................................... 66 ReadRegister method ......................................... 80 GetPixel method ................................................. 66 WriteRegister method ........................................ 81 SetPixel method ................................................. 66 ReadCommand method ...................................... 81 GetRGB method ................................................. 67 WriteCommand method ..................................... 82 SetRGB method .................................................. 67 ReadBlock method .............................................. 82 SaveToFile method ............................................. 67 WriteBlock method ............................................. 82 FlipHorizontally method ..................................... 68 GetMemoryPresetsCount method ...................... 83 FlipVertically method ......................................... 68 ToString method ................................................. 83 Negative method................................................ 68 GetFeature