Download VIRCAM SDK - FLIR Systems

FLIR Systems
Advanced Thermal Solutions
DD003U-H
Vircam SDK manual
Contents
1. Introduction ......................................................................................................................................................................................7
2. Before Starting .................................................................................................................................................................................7
3. Minimum configuration ....................................................................................................................................................................7
4. What is Vircam SDK .........................................................................................................................................................................7
5. System architecture .........................................................................................................................................................................8
6. Getting started with Vircam using C++ ...........................................................................................................................................9
7. Initialization functions ................................................................................................................................................................... 10
7.1.
Init.............................................................................................................................................................................................. 10
7.2.
IsIni ............................................................................................................................................................................................ 10
7.3.
ReInit ......................................................................................................................................................................................... 10
7.4.
IsServerRunning ........................................................................................................................................................................ 10
7.5.
GetVersion ................................................................................................................................................................................. 11
8. Debug functions ............................................................................................................................................................................. 12
8.1.
SetDebug................................................................................................................................................................................... 12
8.2.
GetDebug .................................................................................................................................................................................. 12
8.3.
SetActiveSpy ............................................................................................................................................................................. 12
8.4.
Command .................................................................................................................................................................................. 12
8.5.
SetLogFile ................................................................................................................................................................................. 12
9. Error Management functions......................................................................................................................................................... 13
9.1.
GetLastError .............................................................................................................................................................................. 13
10. Image acquisition functions .......................................................................................................................................................... 14
10.1. IsGrabberCap ............................................................................................................................................................................ 14
10.2. GetImage ................................................................................................................................................................................... 14
10.3. GetCurrentTimeCounter............................................................................................................................................................. 14
10.4. IsModuloImp .............................................................................................................................................................................. 14
10.5. GetNumberImagePacket............................................................................................................................................................ 14
10.6. StopAcqui .................................................................................................................................................................................. 15
10.7. Image information structure description...................................................................................................................................... 15
10.8. How to use shared memory ....................................................................................................................................................... 16
10.8.1.
Initialisation example ...................................................................................................................................................... 16
10.8.2.
Memory free example...................................................................................................................................................... 16
11. Frame rate functions ...................................................................................................................................................................... 17
11.1. SetFrequency ............................................................................................................................................................................ 17
11.2. GetFrequency ............................................................................................................................................................................ 17
11.3. GetMaxFrequency ..................................................................................................................................................................... 17
11.4. IsItWorksFloatFrequency ........................................................................................................................................................... 17
12. Integration time functions ............................................................................................................................................................. 18
12.1. GetIT ......................................................................................................................................................................................... 18
12.2. SetIntegration ............................................................................................................................................................................ 18
12.3. IsMultiTI ..................................................................................................................................................................................... 18
12.4. GetCurrentIT .............................................................................................................................................................................. 18
12.5. SetCurrentIT .............................................................................................................................................................................. 19
12.6. GetMultiNbrChannel .................................................................................................................................................................. 19
12.7. GetMaxMultiTIChannel .............................................................................................................................................................. 19
12.8. SetMultiTi ................................................................................................................................................................................... 19
12.9. GetCurrentMultiTiVideo.............................................................................................................................................................. 19
12.10. SetCurrentMultiTiVideo .............................................................................................................................................................. 19
12.11. IsSpi .......................................................................................................................................................................................... 19
12.12. SetOrionMode............................................................................................................................................................................ 20
12.13. GetOrionMode ........................................................................................................................................................................... 20
13. Windowing functions ..................................................................................................................................................................... 21
13.1. GetCurrentWindow .................................................................................................................................................................... 21
13.2. SetWindow................................................................................................................................................................................. 21
13.3. GetWindow ................................................................................................................................................................................ 21
13.4. GetRectFull ................................................................................................................................................................................ 22
13.5. GetRectQuarter ......................................................................................................................................................................... 22
13.6. GetRectHalf ............................................................................................................................................................................... 22
13.7. GetRectRandom ........................................................................................................................................................................ 22
13.8. GetRandomInfoWindow ............................................................................................................................................................. 23
13.9. IsEnableHalf .............................................................................................................................................................................. 23
13.10. IsEnableQuarter ......................................................................................................................................................................... 23
13.11. IsEnableRandom ....................................................................................................................................................................... 23
13.12. GetCurrentIndex ........................................................................................................................................................................ 23
DD003U-H Vircam SDK manual.doc
Page 2/81