Home

User`s Manual OLE Automation - FLIR Customer Support Center

1. 7559011 Rev a318 ENGLISH February 20 2009 IX 4 63 4 64 4 65 4 66 4 67 4 68 4 69 4 70 4 71 4 72 4 73 4 74 4 75 4 76 4 77 4 78 4 79 4 80 4 81 4 82 4 83 RestoreAnalysis Method erer 65 RestoreObjParameters Method SaveAreaAsCsv Method 65 Savelmage Method 66 SaveSession Method 67 SetCameraSource Method 67 SetFrameRate 67 Setlnverted Method 68 SetPalette Method 68 SetPlayRate Method SetScaling Method we 69 StepBackward Metteg 69 StepForward Method viken ne HR 70 SubtrGetResultlmage tnnt 70 SubtrSaveOutput Method entere id rtr E SubtrSetOptions Method SubtrSetOutput Method SubtrSetOutputDir Method SubtrSetReference Method 72 SubtrSetScale Method ME 73 SubtrSetSource Method 73 ESE E IAEA EA eroe Leto d IEAA ENIAN TEYE 75 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 General Submitting question Downloads Publ No T559011 Rev a318 ENGLISH EN February 20 2009 Customer help For customer help visit http flircusthelp com app home To submit a question to the customer help team you must be a registered user It only takes a few minutes to register online If you only want to search the knowledge b
2. 4 30 FocusStop Method Use the FocusStop method to stop the camera focus Syntax object FocusStop Publ 7559011 Rev a318 ENGLISH EN February 20 2009 53 4 Methods object The ThermaCAM Re For example Session1 searcher object GetFormulaBylndex Method 4 31 Syntax Result object GetFormulaByIndex ndex Name Label Expression Precision Object Index Description The ThermaCAM Re searcher object in Index for formula sought For example Session1 1 2 7 N Where is the total number of formulas in the session Name Label Expression Precision out formula name out Formula label out Formula expression short out Formula precision Result 4 32 Syntax Boolean TRUE if the request was successful GetFormulaByName Method Result object GetFormulaByName ndex Name Label Expression Precision Object Name Label Expression Description The ThermaCAM Re searcher object in Formula name for formu la sought out Formula label out Formula expression For example Session1 Precision short out Formula precision Result 54 Boolean TRUE if the request was successful Publ No T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods 4 33 GetFrameRate Method Despite its name this method gets the image rate of the current connect
3. object Double starting time NOTE This value is only valid if start condition is set to 2 Time 26 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties 3 60 RecStopCond Property Set or get condition for stop recording Recording may stop on five different events User selects the start stop button on the recording toolbar After XX images a Predefined time User pushes the function key F5 External trig event Syntax index object RecStopCond object RecStopCond index Description The ThermaCAM Researcher For example Session1 object Short Stop condition 0 Tool button Key trig 1 Time 2 After N images 3 External trig delay 3 61 RecStopDelay Property Set or get delay time for stop recording Syntax delay object RecStopDelay object RecStopDelay delay LOL ThermaCAM Researcher For example Session1 object Double Delay time NOTE This value is only valid if stop condition is set to 4 External trig 3 62 RecStopDuration Property Set or get recording time duration Syntax time object RecStopDuration object RecStopDuration time Publ 7559011 Rev a318 ENGLISH EN February 20 2009 27 3 Properties few e Object The ThermaCAM Researcher For example Session1 object Time Double Recording time NOTE This value is only valid if stop condition is set t
4. Description object The ThermaCAM Researcher For example Session1 object Temperature Temperature unit 0 Celsius unit short integer 1 Fahrenheit 2 Kelvin NOTE No event is fired by this change 3 79 Totallmages Property Get the number of selected images for playing Syntax images object Totallmages object Totallmages images few om em Object The ThermaCAM Researcher For example Session1 object Images Selected number of images 34 Publ T559011 Rev a318 ENGLISH EN February 20 2009 3 Properties 3 80 UselmageObjParams Property Set or get the state that tells if current object parameters shall be kept when a new image is loaded or if they shall be taken from the new image Syntax object UselmageObjParams usage usage object UselmageObjParams Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Take the object parameters from the new image when it is loaded FALSE Keep the current object parameters when a new image is loaded 3 81 UselmageScale Property Set or getthe state that tells if current scale shall be kept when a new image is loaded or if it shall be taken from the new image Syntax object UselmageScale usage usage object UselmageScale Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Take the scale from the new image when itis loaded FALSE Kee
5. object The ThermaCAM Re For example Session1 searcher object anaFuncname Generic name string of an ARO1 area or line analysis function number Number of classes to be used NOTE You can t expect the temperatures to be correct until ThermaCAM Researcher has updated itself completely to the new conditions 4 15 AnalysisHisto Threshold Method The AnalysisHistoThreshold method lets you retrieve and change the threshold temperature of the specified area and line measurement functions of an IR image Note that this method only applies to areas and lines Syntax object AnalysisHistoThreshold funcName temperature temperature object AnalysisHistoThreshold funcName Description object The ThermaCAM For example Session1 Researcher object funcName The name of the ar1 for example function to be affect ed Publ No T559011 Rev a318 ENGLISH February 20 2009 47 4 Methods m pee The current presentation unit is used temperature Double The tempera ture at which the his togram threshold shall be set NOTE You can t expect the temperatures to be correct until ThermaCAM Researcher has updated itself completely to the new conditions 4 16 AnalysisResults Method Use the AnalysisResults method to retrieve some or all analysis single results as strings Syntax resultString object AnalysisResults anaFuncSelString object De
6. 2009 49 4 Methods lineFuncname Number 4 19 You can use the AnalysisTemperatureByName method to retrieve one temperature Description Generic name string of a line analysis function The minimum number of elements required for the array value for an analysis function Syntax flag sTempState object strGenericName dblTemperature Description The ThermaCAM Researcher object Name of the analysis function plus the type of temperature re quested separated with a dot The temperature for the specified analysis function If TempState is Invalid the temper ature can t be deter mined Analysis TemperatureByName Method object AnalysisTemperatureByName strGenericName dblTemperature For example Session1 For example sp1 temp ar2 avg The current presentation unit is used TempState The state of the tem perature will be re turned here 0 OK 1 Warning the temperature is unreliable 2 Underflow too low temperature 3 Overflow too high temperature 4 Invalid the temperature could not be calculated 50 Indicates if the speci fied name exists or not Boolean Publ T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods NOTE Only single temperature values can be retrieved No emissivity position or other information is available through this method NOTE You can only retrieve temperature values not s
7. 24 Disconnect Method Use the Disconnect method to disconnect the application from the camera Syntax object Disconnect LONNNNL ee _ Object The ThermaCAM Re For example Session1 searcher object 4 25 ExternalCorrection Method Use the ExternalCorrection method to calibrate the pixel to pixel differences in the camera with the present image as reference Syntax ExternalCorrection em Description we Object The ThermaCAM Re For example I MN searcher object 4 26 FastBackward Method You can use the FastBackward method to continuously replay the selected disk im age s backward fast Syntax object FastBackward 52 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods object The ThermaCAM Re For example Session1 searcher object 4 27 FastForward Method You can use the FastForward method to continuously replay the selected disk im age s forward fast object FastForward Deen object The ThermaCAM Re For example Session1 searcher object 4 28 FocusFar Method Use the FocusFar method to start the camera focus towards infinity Syntax object FocusFar EE object The ThermaCAM Re For example Session1 searcher object 4 29 FocusNear Method Use the FocusNear method to start the camera focus towards near focus Syntax object FocusNear object The ThermaCAM Re For example Session1 searcher object
8. 3 16 CameraRangeMin Property mmmmneerenrerrerersvsenvovennenrasennenranessvsenvasensenravensentns 11 3 17 CameraSerialNo Property 11 3 18 CameraSpan Property 12 3 19 Property 12 3 20 CanHaveBarCodes Property 12 3 21 e Cassetto Property ert HR Tt hrec deiecta a e iat 13 3 22 COMPO Property reet etre eh et etre 13 3 23 Connected Property 13 3 24 Cooler Property eee 14 3 25 CurrentlROutput Property 14 3 26 DefaultHistogramClasses Property 15 3 27 Device Property 15 3 28 DistanceUnit Property ener peter EEN 15 3 29 Emissivity Property eene m eee eet dE eee cenas 16 3 30 EstimatedTransmission Property retreat tetendit idea 16 3 31 ExtOpticsTemperature Property 16 3 32 ExtOpticsTransmission Property 17 3 33 Filter Property 17 3 34 Filtering Property EA 3 35 Freeze Property i eerte eie Rte e EG Dee e ec nay 18 3 36 gt ImageDate Property snc feces nene eiie eei tae eec tese ik 18 3 37 ImageFilenarie Property tnter np Bicis nt eie dene 18 3 38 ImageMaxTemperature Property 19 3 39 ImageMinTemperature Property 19 3 40 ImagePath Property 20 3 41 Imag
9. 4 Object Signal 5 10 Reserved NOTE This property states the desired output of ThermaCAM Researcher The program will choose an output that corresponds as closely to this setting as possible SEE ALSO For more information about current output see section a 3 25 CurrentiROutput Property on page 14 3 53 Ratio Property Gets the current image aspect ratio Syntax doubleRatio object Ratio Description object The ThermaCAM Researcher For example Session1 object doubleRatio The current aspect ratio in The image width divided by its height double precision 3 54 RecAutoNameBase Property Set or get user defined prefix for image names when recording For each new image recorded Researcher will add an incremented sequence number Syntax prefix object RecAutoNameBase object RecAutoNameBase prefix 24 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties ew om I RN Object The ThermaCAM Researcher For example Session1 object prefix String Image prefix For example Mylmage 3 55 ReclmgPres Property Gets or sets the Enable Image Presentation option during image recording Syntax bool object ReclmgPres object ReclmgPres boo em The ThermaCAM Researcher For example Session1 object Boolean 3 56 RecOneFileRec Property Set or get whether recorded images should be stored in separate files o
10. AnalysisDefinePolygonArea Method 44 AnalysisDefineSpotmeter Method 44 AnalysisDeleteFunc Method 45 AnalysisFuncNames Method 45 AnalysisHistoArray Method 46 AnalysisHistoClasses Method 47 AnalysisHistoThreshold Method 47 76 methods continued AnalysisResults Method 48 AnalysisTemperatureArrayLen Method 49 AnalysisTemperatureArray Method 49 AnalysisTemperatureByName Method 50 AutoAdjust Method 51 AutoRewind Method 51 Connect Method 51 CopySessionAndlmage Method 52 Disconnect Method 52 ExternalCorrection Method 52 FastBackward Method 52 FastForward Method 53 FocusFar Method 53 FocusNear Method 53 FocusStop Method 53 GetFormulaByIndex Method 54 GetFormulaByName Method 54 GetFrameRate Method 55 GetNamedValue Method 55 GetNoFormulas Method 55 GetNumPlaybTextCmts Method 56 GetNumRecTextCmts Method 56 GetPalettelnfo Method 56 GetPlaybTextCmtByName Method 57 GetPlaybTextCmt Method 57 GetPlayRate Method 58 GetRecTextCmtByName Method 58 GetRecTextCmt Method 58 GetScaling Method 59 GotoFirstImage Method 59 GotoLastlmage Method 60 ImageDimensions Method 60 InternalCorrection Method 60 KeyTrigF5 Method 61 Loadimage Method 61 NewSession Method 61 OpenSession Method 61 PlayBackward Method 62 PlayForward Method 62 PlayStop Method 62 RecordOnelmage Method 63 Refresh Method 63 RemoveAllAnalysis Method 63 RemovePlaybTextCmtByName Method 64 RemovePlaybTextCmt Method 64 RemoveRecTe
11. GetPlaybTextCmt n ndex strLabel strValue Description Object The ThermaCAM Re For example Session1 searcher object The text comment wanted 0 1 2 strLabel String The retrieved name strValue String The retrieved value Result Boolean TRUE Successful outcome 4 40 GetPlaybTextCmtByName Method Retrieves text comments during image playback Syntax Result object GetPlaybTextCmtByName strLabel strValue Description Object The ThermaCAM Re For example Session1 searcher object strLabel String The comment to retrieve strValue String The retrieved value Result Boolean TRUE Successful outcome Publ No T559011 Rev a318 ENGLISH February 20 2009 57 4 Methods 4 41 GetPlayRate Method Get the image playback display rate A fast forward backward display rate is achieved by just showing every N th image A slow forward backward display is achieved by an X fold delay of the image presentation Syntax nRate object GetPlayRate bDelay Description The ThermaCAM Re For example Session1 searcher object Boolean TRUE if the image presentation is delayed in stead of speeded up Short integer The N or X value 4 42 GetRecTextCmt Method Retrieves text comments during image recording Syntax Result object GetRecTextCmt nindex strLabel strValue Description Object The ThermaCAM Re For example Session1 searcher o
12. com cn Web www flir com CHINA FLIR Systems Shanghai Representative Office Room 6311 West Building Jin Jiang Hotel 59 Maoming Road South Shanghai 200020 PRC Phone 86 21 5466 0286 Fax 86 21 5466 0289 E mail shanghai flir com cn Web www flir com CHINA FLIR Systems Guangzhou Representative Office 1105 Main Tower Guang Dong International Hotel 339 Huanshi Dong Road Guangzhou 510098 86 20 8333 7492 86 20 8331 0976 E mail guangzhou flir com cn Web www flir com FRANCE FLIR Systems 10 rue Guynemer 92130 Issy les Moulineaux Cedex FRANCE Phone 33 0 1 41 33 97 97 Fax 33 0 1 47 36 18 32 E mail info flir fr Web www flir com GERMANY FLIR Systems Berner Strasse 81 D 60437 Frankfurt am Main GERMANY Phone 49 0 69 95 00 900 Fax 49 0 69 95 00 9040 E mail info flir de Web www flir com GREAT BRITAIN FLIR Systems 2 Kings Hill Avenue Kings Hill West Malling Kent ME19 4AQ UNITED KINGDOM Phone 44 0 1732 220 011 Fax 44 0 1732 843 707 E mail sales flir uk com Web www flir com HONG KONG FLIR Systems Room 1613 15 Tower 2 Grand Central Plaza 138 Shatin Rural Committee Rd Shatin N T HONG KONG Phone 852 27 92 89 55 Fax 852 27 92 89 52 E mail flir flir com hk Web www flir com ITALY FLIR Systems Via L Manara 2 20051 Limbiate MI ITALY Phone 39 02 99 45 10 01 Fax 39 02 99 69 24 08 E ma
13. line or isotherm from the IR Image Syntax flag object AnalysisDeleteFunc funcName Description object The ThermaCAM Re For example Session1 searcher object funcName The name of the function to For example sp1 be removed By indicating you can remove all functions at once Boolean TRUE if the function has been removed 4 12 AnalysisFuncNames Method You can use the AnalysisFuncNames method to become informed about the cur rently active analysis functions spotmeters areas lines and isotherms Syntax string object AnalysisFuncNames Publ No T559011 Rev a318 ENGLISH EN February 20 2009 45 4 Methods Description object The ThermaCAM Re For example Session1 searcher object string Active function names sepa For example rated by line feeds sp01 102 iso01 NOTE These names will be the generic ones even if you redefine the labels that are displayed on the screen You can not expect the names to be sorted 4 13 AnalysisHistoArray Method The AnalysisHistoArray method retrieves the current histogram of an area or line Set the number of classes by the AnalysisHistoClasses Method Set the histogram limits by the SetScaling Method Syntax number object AnalysisHistoArray anaFuncName dblLowLim dblHighLimTemp dbIUflPercent dblOfiPercent fitPercentArray Description object The ThermaCAM Re For example Session sear
14. object AnalysisDefineLine useFuncName xFirst yFirst xLast yLast Description object The ThermaCAM Re For example Session1 searcher object useFuncName The name of the spotmeter lit or to be re defined Enter an empty string to make Therma Researcher pick a free name XFirst yFirst Short integer coordinates of 10 10 50 60 for example 0 0 corresponds to xLast yLast the line the top left corner of the image usedFuncName The name of the function that was re defined Publ 7559011 Rev a318 ENGLISH EN February 20 2009 43 4 Methods SEE ALSO For information about straight lines see section 4 5 AnalysisDefineBentLine Method on page 41 NOTE You can t expect any results from this function until the ThermaCAM Researcher has updated itself completely to the new conditions 4 9 AnalysisDefinePolygonArea Method The AnalysisDefinePolygonArea method lets you add move or reshape a polygon shaped area measurement function on the IR Image Syntax usedFuncName object AnalysisDefinePolygonArea useFuncName numCorners shCornerArray Description object The ThermaCAM Re For example Session1 searcher object useFuncName The name of the area to be ari or re defined Enter an empty string to make ThermaCAM Researcher pick a free name numCorners Integer indicating the number For example of corners present in the inte
15. shNumber Short integer 0 Automatic detection 1 etc 3 23 Connected Property Returns camera connection state Syntax flag object Connected Publ T559011 Rev 318 ENGLISH EN February 20 2009 13 3 Properties Object Flag 3 24 Description The ThermaCAM Researcher object Boolean Connection state Cooler Property Sets or gets the cooler state Syntax object Cooler flag flag object Cooler Description The ThermaCAM Researcher object For example Session1 TRUE Camera connected FALSE Camera disconnected For example Session1 3 25 Boolean Cooler state TRUE Cooler on FALSE Cooler off CurrentlROutput Property Gets the current type of output IR or other units Syntax type object CurrentlROutput Object type Description The ThermaCAM Researcher object Type of output NOTE You cannot set this property directly SEE ALSO For more information see section 3 52 PreferredlROutput Property on page 24 14 For example Session1 0 Temperature 2 Difference temperature 4 Object Signal 5 Difference Object Signal Difference unit images are created by the subtrac tion function Publ No T559011 Rev a318 ENGLISH EN February 20 2009 3 Properties 3 26 DefaultHistogramClasses Property Sets or gets the current default number of classe
16. 3 FOGN Method Errem 53 EocussStop Melliod vunne rcnt bon Ee 53 GetFormulaByIndex Method 54 GetFormulaByName Method GetFrameRate Method GetNamedValue Method 55 Ge tNoFormulas Methode egen e ee oo Eo E oo leet 55 GetNumPlaybTextCmts Method msearnervvnvnrorennenranennenraneravnenvavennanennenvanennenennenennenvanensenvanene 56 GetNumRecTextCmts Method AAA 56 GetPalettelnto Method a doe recs eco deett RE 56 GetPlaybTextCmt Method 57 GetPlaybTextCmtByName Method 57 GetPlayRate Method 58 GetRecTextCmt Method ens 58 GetRecTextCmtByName tnnt 58 VE le RO ue WEE GotoFirstlmage Method aee teet ertt ep GotoLastlmage Method ImageDimensions Method InternalCorrection Method KeyTrigF5 2 SEENEN EENZELNE Eoadlmage Method deed NeWSession Method ep dk c OpenSession PlayBackward Method PlayForward Method PlayStop Method RecordOnelmage Method Refresh Method eseu deene Pot e ee e RemoveAllAnalysis Method 63 RemovePlaybTextCmt Method 64 RemovePlaybTextCmtByName Method 64 RemoveRecTextCmt Method 64 RemoveRecTextCmtByName Method 65 Publ
17. 3 ger array shCornerArray Short integer array filled with For example the coordinates of the cor 10 20 30 40 5 35 ners of the area The size is 2 numCorners The coordi nates come in pairs with the xpositions before the yposi tions radius Integer radius of the circle usedFuncName The name ofthe function that was re defined NOTE You can t expect any results from this function until ThermaCAM Researcher has updated itself completely to the new conditions 4 10 AnalysisDefineSpotmeter Method The AnalysisDefineSpotmeter method lets you add or move a spotmeter on the IR Image Syntax 44 Publ T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods usedFuncName object AnalysisDefineSpotmeter useFuncName xPos yPos Description object The ThermaCAM Re For example Session1 searcher object useFuncName The name of the spotmeter sp1 or to be re defined Enter an empty string to make Therma Researcher pick a free name xPos yPos Integer coordinates withinthe 10 10 for example 0 0 corresponds to the top current image left corner of the image usedFuncName The name ofthe function that was re defined NOTE You can t expect any results from this function until ThermaCAM Researcher has updated itself completely to the new conditions 4 11 AnalysisDeleteFunc Method The AnalysisDeleteFunc method lets you remove a spotmeter area
18. 5 4 Methods em Description Description Ve Result Short Total number of de fined formulas in the session 4 36 GetNumPlaybTextCmts Method Retrieves the current number of text comments during image playback Syntax shNumber object GetNumPlaybTextCmts Teen Object The ThermaCAM Re For example Session1 searcher object shNumbert Short integer The number of text comments 4 37 GetNumRecTextCmts Method Retrieves the current number of text comments during image recording Syntax shNumber object GetNumRecTextCmts LENNNL ee Object The ThermaCAM Re For example Session1 searcher object shNumbert Short integer The number of text comments 4 38 GetPalettelnfo Method You can use the GetPalettelnfo method to retrieve information about the current palette IR colours Syntax string object GetPalettelnfo Invert Saturation OutOfRange Jen em object The ThermaCAM For example Session1 Researcher object 56 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods Description Invert Information about TRUE FALSE Saturation the current state of Out the invert show OfRange saturation and show out of range colours is returned here string The file name of the current palette is returned here 4 39 GetPlaybTextCmt Method Retrieves text comments during image playback Syntax Result object
19. 9001 vi legal disclaimer vi product warranty vi quality assurance vi quality management system vi trademarks vi warranty vi FocusFar Method 53 FocusNear Method 53 FocusStop Method 53 Freeze Property 18 G GetFormulaByIndex Method 54 GetFormulaByName Method 54 GetFrameRate Method 55 GetNamedValue Method 55 GetNoFormulas Method 55 GetNumPlaybTextCmts Method 56 GetNumRecTextCmts Method 56 75 GetPalettelnfo Method 56 GetPlaybTextCmtByName Method 57 GetPlaybTextCmt Method 57 GetPlayRate Method 58 GetRecTextCmtByName Method 58 GetRecTextCmt Method 58 GetScaling Method 59 GotoFirstlmage Method 59 GotoLastlmage Method 60 ImageDate Property 18 ImageDimensions Method 60 ImageFilename Property 18 ImageMaxTemperature Property 19 ImageMinTemperature Property 19 ImagePath Property 20 ImageTimeMSec Property 20 ImageTime Property 20 ImageTimeStr Property 21 ImageTitle Property 21 InternalCorrection Method 60 IsFirstlmage Property 21 IsLastlmage Property 22 ISO 9001 vi IsUpdated Property 22 K KeepAnalysis Property 22 KeyTrigF5 Method 61 L legal disclaimer vi Loadlmage Method 61 M methods AddPlaybTextCmt Method 39 AddRecTextCmt Method 39 AnaDefineFormula Method 40 AnaDeleteFormula Method 40 AnalysisDefineBentLine Method 41 AnalysisDefineBoxArea Method 42 AnalysisDefineCircleArea Method 42 AnalysisDefineLine Method 43
20. Number of values stored in the file area width area height 4 66 Savelmage Method You can use the Savelmage method to save the IR image to a file The format can either be IR Image format IMG or bitmap BMP Syntax result object Savelmage filename format Description object The ThermaCAM Re For example Session searcher object filename Full name of the file the im age is saved as format Type of format the image 0 IR format shall be saved as 1 BMP format 2 MatLab 3 Bitmap with analysis 4 FLIR public format 5 CSV 6 JPEG photo no IR result Boolean TRUE if the image was successfully saved FALSE otherwise NOTE Changes that you have made to the scaling etc will be permanently saved in the image when you save it format and regarded as if they came from the camera when you load it the next time 66 Publ T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods 4 67 SaveSession Method Saves active session Syntax result 2 object SaveSession filename Description object The ThermaCAM Re For example Session searcher object filename Full name of the file the ses sion is saved as An empty string saves the session with existing file name result Boolean TRUE if the session was successfully saved FALSE otherwise 4 68 SetCameraSource Method You can use the SetCameraSource method to switch between
21. RAIN10 RAIN900 4 72 SetPlayRate Method Set the image playback display rate A fast forward backward display rate is achieved by just showing every N th image A slow forward backward display is achieved by an X fold delay of the image presentation 68 Publ No T559011 Rev a318 ENGLISH February 20 2009 4 Methods Syntax bResult object SetPlayRate bDelay shRate Description Object The ThermaCAM Re For example Session1 searcher object bDelay Boolean TRUE if the image presentation shall be de layed instead of speeded up nRate Short integer The N or X value bResult Boolean TRUE if successful 4 73 SetScaling Method You can use the SetScaling method change the current scale Syntax object SetScaling scalelimtype min max coldistrtype Description The ThermaCAM Re For example Session1 searcher object The scale minimum and 15 8 33 6 The temperature is in the current unit maximum temperatures will be returned here in double precision coldistrtype The current type of colour 0 Temperature linear distribution is returned here 1 Enhanced contrast histogram equalization 2 Camera linear scalelimtype The current type of scaling 0 Limits from image 1 Autoadjused limits 2 Fix limits NOTE This method forces ThermaCAM Researcher to adapt itself to the current image 4 74 StepBackward Method You can use the StepBackward method to view the previo
22. Rev a318 ENGLISH EN February 20 2009 63 4 Methods 4 59 RemovePlaybTextCmt Method Removes text comments during image playback Syntax Result object RemovePlaybTextCmt n ndex Object Description The ThermaCAM Re searcher object For example Session1 nindex The text comment no longer wanted 0 1 2 1 will remove all text comments Result 4 60 Boolean TRUE Successful outcome RemovePlaybTextCmtByName Method Removes text comments during image playback Syntax Result object RemovePlaybTextCmtByName strLabel Object strLabel Description The ThermaCAM Re searcher object String For example Session1 The comment to remove Result 4 61 Boolean TRUE Successful outcome RemoveRecTextCmt Method Removes text comments during image recording Syntax Result object RemoveRecTextCmt n ndex Object nindex Result 64 Description The ThermaCAM Re searcher object The text comment no longer wanted Boolean For example Session1 0 1 2 1 will remove all text comments TRUE Successful outcome Publ No T559011 Rev a318 ENGLISH February 20 2009 4 Methods 4 62 RemovehRecTextCmtByName Method Removes text comments during image recording Syntax Result object RemoveRecTextCmtByName strLabel Description Object The ThermaCAM Re For exam
23. T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods 4 49 KeyTrigF5 Method Simulates selection of the function key F5 in Researcher Syntax object KeyTrigF5 Deen object The ThermaCAM Re For example Session1 searcher object mm 4 50 Loadlmage Method Use the method to load a particular image file from disk and display it full path required Syntax object Loadlmager file The ThermaCAM Re For example Session1 searcher object String Image file name full path 4 51 NewSession Method Use the NewSession method to initiate a new application session Syntax object NewSession De me object The ThermaCAM Re For example Session1 searcher object 4 52 OpenSession Method Use the OpenSession method to open a particular session file full path required Syntax object OpenSession session Publ T559011 Rev 318 ENGLISH EN February 20 2009 61 4 Methods nm em em object The ThermaCAM Re For example Session1 searcher object session String Session file full path required 4 53 PlayBackward Method You can use the PlayBackward method to continuously replay the selected disk im age s backwards Syntax object PlayBackward De meme we object The ThermaCAM Re For example Session searcher object 4 54 PlayForward Method You can use the PlayForward method to continu
24. Temperature Property 29 9 68 RefTemperatureExists Property 30 3 69 RelativeHumidity Property 30 3 70 Save900Analysis Property 46600800 tn atn tate atra nan 30 S41 ShowAnalysis Properly eei tee er nte tete en np rer dee 31 3 72 ShowAnalysisBackColor Property 31 3 73 ShowAnalysisTemp Property oo cece eee acne 32 3 74 ShowllegTemplindicator Property 32 3 75 ShowLabels Property 33 3 76 ShowTemperatureScale Property 33 3 77 TargetMotion Propery SEENEN 33 3 78 TemperatureUnit Property tette re tee eerie 34 3 79 Totallm ges Property cedi enn ite n e 34 3 80 UselmageObjParams Property 35 3 81 UselmageScale Property 35 3 82 UselmageZoom Property 35 3 83 Version Property 36 3 84 VIEWSD RrODerly tenter e eee etae aea dne tocar t drenere 36 3 65 Visible Property ie ae eco 36 3 86 Zoomfactor Propetly ein dette teeth 37 Methods Mc 39 4 1 AddPlaybTextCmt Method vsti tise teh dares i anne REDE 39 42 AddRecTextOmt Mathiod eene eee eee aeree red a greeted 39 4 3 Method 40 4 4 AnaDeleteFormula Method 40 4 5 AnalysisDefineBentLine Method 41 4 6 X AAnalysisDefineBoxArea 42 4 7 Analy
25. ThermaCAM Re For example Session1 searcher object DistrMode Level amp Span mode 0 Symmetrical 1 Auto adjust 2 Use supplied High and Low parameters Low Lower range limit High Upper range limit Result lt gt 0 if successful SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section 4 77 SubtrSaveOutput Method on page 70 4 83 SubtrSetSource Method Sets source image used for subtraction Syntax Result object SubtrSetSource FileName EE Object The ThermaCAM Re For example Session1 searcher object FileName String Source image file Publ 7559011 Rev a318 ENGLISH EN February 20 2009 73 4 Methods em em SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section a 4 77 SubtrSaveOutput Method on page 70 74 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 Index Index A AddPlaybTextCmt Method 39 AddRecTextCmt Method 39 AmbientTemperature Property 5 AnaDefineFormula Method 40 AnaDeleteFormula Method 40 AnalysisDefineBentLine Method 41 AnalysisDefineBoxArea Method 42 AnalysisDefineCircleArea Method 42 AnalysisDefineLine Method 43 AnalysisDefinePolygonArea Method 44 AnalysisDefineSpotmeter Method 44 AnalysisDeleteFunc Method 45 AnalysisDistance Property 5 AnalysisEmissivity Property 5 AnalysisFuncNames Method 45 AnalysisH
26. User s Manual ual Benutzerhandbuch zn l i k zik nyv OLE Automation For ThermaCAM Researcher 2 7 2 8 amp 2 9 Publ 559011 Revision a318 Language English EN Issue date February 20 2009 Customer help About OLE Automation programming Properties Methods Index OLE Automation User s Manual Publ No T559011 Rev a318 EN Legal disclaimer All products manufactured by FLIR Systems are warranted against defective materials and workmanship for a period of one 1 year from the delivery date of the original purchase provided such products have been under normal storage use and service and in accordance with FLIR Systems instruction All products not manufactured by FLIR Systems included in systems delivered by FLIR Systems to the original purchaser carry the warranty if any of the particular supplier only and FLIR Systems has no responsibility whatsoever for such products The warranty extends only to the original purchaser and is not transferable It is not applicable to any product which has been subjected to misuse neglect accident or abnormal conditions of operation Expendable parts are excluded from the warranty In the case of a defect in a product covered by this warranty the product must not be further used in order to prevent additional damage The purchaser shall promptly report any defect to FLIR Systems or this warranty will not ap
27. Warning the temperature is unreliable 2 Underflow too low temperature 3 Overflow too high temperature 4 Invalid the temperature could not be calculated temperature The temperature for the specified analysis function If TempState is Invalid the temperature can t be re turned NOTE The temperature is returned in the current temperature unit as double value You can only retrieve temperature values not set the values If the analysis function does not exist the return value is undefined NOTE You can t expect the temperature to be correct until the ThermaCAM Researcher has updated itself completely to the image 3 6 Sets or gets the image scale atmospheric temperature value Atmospheric Temperature Property Syntax object AtmosphericTemperature temperature temperature object AtmosphericTemperature few om em The ThermaCAM Researcher object object For example Session1 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 7 3 Properties us PORE didi ture 3 7 AutoMaxTemperature Property You can use the AutoMaxTemperature property to get the maximum temperature of the image most suitable for auto adjustment of the scale Syntax temp object AutoMaxTemperature Description The ThermaCAM Researcher For example Session1 object The maximum existing temper The temperature is in the current unit ature ofthe image when a small amount of the ho
28. ailable methods and properties To establish a reference to an application s object library in e g Microsoft Excel take the following actions Switch to a Visual Basic Module On the Tools menu click References Click the object library you want to refer to If the object library you want doesn t appear in the Available References box you can use the Browse button to search for the object library file containing the object you need Object libraries usually have a tlb or an olb filename extension The Therma Researcher object library is located in the same directory as the ThermaCAM Researcher executable file After you ve established a reference to an object library you can use its commands from the library in Microsoft Excel Visual Basic code Another way to refer to another application is either to use the CreateObject method to start the application and return a reference to an object or to use the GetObject method to return a reference to an object from an applications that is already running See your VBA documentation for a complete description of these methods Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 2 About OLE Automation programming INTENTIONALLY LEFT BLANK 4 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 Properties 3 1 AmbientTemperature Property Set or get the image scale ambient temperature value Syntax object AmbientTemperature tem
29. al This manual was typeset using Swiss 721 which is Bitstream s pan European version of the Helvetica typeface Helvetica was designed by Max Miedinger 1910 1980 The following file identities and file versions were used in the formatting stream output for this manual 20236703 xml a40 20242903 xml a2 20243003 xml a3 20243103 xml a4 20243203 xml a6 20254903 xml a55 20287303 xml a6 R0028 rcp config xml a5 80 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 AUSTRALIA FLIR Systems 10 Business Park Drive Nottinghill Victoria 3168 Australia Tel 61 3 9550 2800 Fax 61 3 9558 9853 Email infoGflir com au Web www flir com BELGIUM FLIR Systems Uitbreidingstraat 60 62 B 2600 Berchem BELGIUM Phone 32 0 3 287 87 11 Fax 32 0 3 287 87 29 E mail info flir be Web www flir com BRAZIL FLIR Systems Av Antonio Bardella 320 CEP 18085 852 Sorocaba Sao Paulo BRAZIL Phone 4 55 15 3238 8070 Fax 55 15 3238 8071 E mail flir amp flir com br Web www flir com CANADA FLIR Systems 5230 South Service Road Suite 125 Burlington ON L7L 5K2 CANADA Phone 1 800 613 0507 ext 30 Fax 905 639 5488 E mail IRCanada flir com Web www flir com CHINA FLIR Systems Beijing Representative Office Room 509 Building C Vantone Center No A 6 Chaoyangmenwai Ave Chaoyang District Beijing 100020 PRG Phone 86 10 5979 7755 Fax 86 10 8532 2460 E mail beijing flir
30. ase for existing questions and answers you do not need to be a registered user When you want to submit a question make sure that you have the following informa tion to hand The camera model The camera serial number The communication protocol or method between the camera and your PC for example Ethernet USB or FireWire Operating system on your PC Microsoft Office version Full name publication number and revision number of the manual On the customer help site you can also download the following Firmware updates for your infrared camera Program updates for your PC software User documentation Application stories Technical publications 1 Customer help Figure This figure shows the welcome page of FLIR Systems customer help site 10776203 a3 L R FLIR Customer Support Center Home MyStuff Product Registralion thon Answers AskaQuestion Downloads Service ie to the FLIR Customer Support Center This portal will mer to Announcements out of your FLIR products The port gebase egistra tup Search by Keyword Search All Answers o Ask a Question Submit a question to our technical supportteam Free download of FLIR QuickReport 1 2 Register your camera and get a free download Where can find Application stories and 9 Most Popular Answers Technical You can also clickto view one of our publications most popular answers Software download Infrar
31. bject nindex The text comment wanted 0 1 2 strLabel String The retrieved name strValue String The retrieved value Result Boolean TRUE Successful outcome 4 43 GetRecTextCmtByName Method Retrieves text comments during image recording Syntax Result object GetRecTextCmtByNamew strLabel strValue fee een Object The ThermaCAM Re For example Session1 searcher object 58 Publ 7559011 Rev 318 ENGLISH EN February 20 2009 4 Methods Description strLabel String The name to retrieve strValue String The retrieved value Result Boolean TRUE Successful outcome 4 44 GetScaling Method You can use the GetScaling method to retrieve general information about the scale Syntax scalelimtype object GetScaling min max coldistrtype Description The ThermaCAM Re For example Session1 searcher object The scale minimum and 15 8 33 6 The temperature is in the current unit maximum temperatures will be returned here in double precision coldistrtype The current type of colour 0 Temperature linear distribution is returned here 1 Enhanced contrast histogram equalization 2 Camera linear scalelimtype The current type of scaling 0 Limits from image 1 Autoadjused limits 2 Fix limits NOTE You can t expect the temperature to be correct until ThermaCAM Researcher has updated itself completely to the image 4 45 Got
32. bject Filter ThermaCAM Researcher For example Session1 object 16 bit integer Filter number 0 5 3 34 Filtering Property Sets or gets the image noise filtering value This property only affects the AGEMA 550 camera Syntax object Filtering value value object Filtering Publ T559011 Rev 318 ENGLISH EN February 20 2009 17 3 Properties Description The ThermaCAM Researcher For example Session1 object 16 bit integer Noise filtering 0 Normal medium image filtering value 1 Heavy image filtering 3 35 Freeze Property Sets or gets the image freeze state Syntax object Freeze flag flag object Freeze Description The ThermaCAM Researcher For example Session1 object Flag indicating the image freeze TRUE Image will be frozen state FALSE Unfreeze image 3 36 ImageDate Property Retrieves the IR image date Syntax imagedate object ImageDate nm om em object The ThermaCAM Researcher For example Session1 object imagedate Image date string 3 37 ImageFilename Property Retrieves the IR image filename Syntax imagefilename object ImageFilename om object The ThermaCAM Researcher For example Session1 object 18 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties LENLI em 3 38 ImageMaxTemperature Property The maximu
33. cher object anaFuncname Generic name string of an ARO1 area or line analysis function dibLowLim double temperature values in The current presentation unit is used dblHighLim which the lower and upper limits of the histogram are returned if successful dblUflPercent Percentage of the tempera Percentage from 0 0 to 100 0 tures that are below lower limit dblOflPercent Percentage of the tempera Percentage from 0 0 to 100 0 tures that are above upper limit fitPercentArray Float array that will be filled Percentages from 0 0 to 100 0 with the corresponding his togram in ascending order number Number of classes being re turned Positive if successful 46 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods NOTE The Number returned in case of failure is the negative value of the number of classes NOTE You can t expect the array to be correct until ThermaCAM Researcher has updated itself completely to the image NOTE The width of each histogram class equals db HighLim dlbLowLim number 4 14 AnalysisHistoClasses Method The AnalysisHistoClasses method will permit you to get and set the number of classes used when the histogram is calculated for an area or line Use the AnalysisHis toArray Method to retrieve the actual histogram Syntax object AnalysisHistoClasses anaFuncName number number object AnalysisHistoClasses anaFuncName Description
34. ct until the ThermaCAM Researcher has updated itself completely to the image 3 40 ImagePath Property Gets or sets the image directory Syntax str object ImagePath object ImagePath str fw The ThermaCAM Researcher For example Session1 object String C lmages for example 3 41 ImageTime Property Retrieves the IR image time in seconds since January 1 1970 Syntax longTime object ImageTime e ee me object The ThermaCAM Researcher For example Session1 object longTime Time in seconds long integer SEE ALSO If you are interested in a millisecond resolution see section 3 42 ImageTimeMSec Property on page 20 3 42 ImageTimeMSec Property Retrieves the IR image time in seconds since January 1 1970 The number of millisec onds within that second is returned in the fraction part Syntax time object ImageTimeMSec we Object The ThermaCAM Researcher For example Session1 object 20 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties o em Image time in seconds integer part number of milliseconds in the fraction part 3 43 ImageTimeStr Property Retrieves the IR image time string Syntax imagetime object ImageTimesStr Jon we object The ThermaCAM Researcher For example Session1 object imagetime Image time as string 3 44 ImageTitle Property Retrie
35. during the display of live images 4 2 AddRecTextCmt Method Adds or changes text comments during image recording Syntax Result object AddRecTextCmt strLabel strValue bChgExisting Description Object The ThermaCAM Re For example Session1 searcher object strLabel The name of the text com Label1 for example ment to be added strValue The value as a string name Value for example of the text comment to be added bChgExisting Boolean indicating if the La If bChgExisting is TRUE and the label already bel may exist in advance exists its value string is changed Publ T559011 Rev a318 ENGLISH EN February 20 2009 39 4 Methods nm em em O NOTE This method can only be used with SC 2000 SC 3000 S series and A Series cameras and only while the camera is connected These text comments are included in the recorded images 4 3 AnaDefineFormula Method Re define formula for the active session You may define all formula parameters yourself or let ThermaCAM Researcher assist you by automatically assigning for mula name or presenting formula editing dialog Syntax FormulaName object AnaDefineFormula Name Label Expresion Precision Description ThermaCAM Re For example Session1 searcher object The name of the formula to 001 fo02 fo03 or be re defined Enter an empty string to make Therma CAM Researcher p
36. eTemperature Property 29 RefTemperatureExists Property 30 RelativeHumidity Property 30 Save900Analysis Property 30 77 Index 0 properties continued ShowAnalysisBackColor Property 31 ShowAnalysis Property 31 ShowAnalysisTemp Property 32 ShowllegTemplndicator Property 32 ShowLabels Property 33 ShowTemperatureScale Property 33 TargetMotion Property 33 TemperatureUnit Property 34 Totallmages Property 34 UselmageObjParams Property 35 UselmageScale Property 35 UselmageZoom Property 35 Version Property 36 View3D Property 36 Visible Property 36 Zoomfactor Property 37 Q quality assurance vi quality management system vi R Ratio Property 24 RecAutoNameBase Property 24 ReclmgPres Property 25 RecOneFileRec Property 25 RecordOnelmage Method 63 RecStartCond Property 25 RecStartDelay Property 26 RecStartTime Property 26 RecStopCond Property 27 RecStopDelay Property 27 RecStopDuration Property 27 RecStoplmages Property 28 RecStoreCond Property 28 RecStorelmages Property 29 RecStorelnterval Property 29 ReferenceTemperature Property 29 Refresh Method 63 RefTemperatureExists Property 30 RelativeHumidity Property 30 RemoveAllAnalysis Method 63 RemovePlaybTextCmtByName Method 64 RemovePlaybTextCmt Method 64 RemoveRecTextCmtByName Method 65 RemoveRecTextCmt Method 64 RestoreAnalysis Method 65 RestoreObjParameters Method 65 S Save900Anal
37. eTime Property 20 3 42 ImageTimeMSec Property eer retta tette tetris 20 3 43 gt ImagetTimeStr Property 3er dE EE d dede date 21 3 44 EE 21 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 vii viii 3 45 IsFirstlmage Property 3 46 IsLastlmage Property 3 47 IsUpdated Property 3 48 KeepAnalysis Property 3 49 Motor Property entere a tee ci aiii Ye te 3 50 ObjectDistance Propetty em eerte 3 51 OLEEiveLinkDelay Property amt ttt ptt 3 52 PreferredlROutput Property oo 3 53 M Ratio Property 3 54 RecAutoNameBase Property 3 55 ReclmgPres Property 3 56 HecOneFileRec Properly ees en 3 57 RecStartCond Property Renate eese repa decre 3 58 HecstartDelay Propellty soe erdt dE 3 59 RecStart lime Property e eret added ste 3 60 RecStopCond Property 3 61 RecStopDelay Property 3 62 RecStopDuration Property 3 63 RecStoplmages Property tee ete rte tette 3 64 5 5 22 eee deeg 3 65 RecStorelMages Property tee rrr Ea t ettet 3 66 HecStorelnteryal Property lt 3 67 Reference
38. ed Training I manual Center Visit Tc ITC Message Board Leam more about Register to get additional benefits thermography and exchange ideas problems and infrared solutions with fellow thermographers around the world on the ITC message board Where can I download updates for FLIR Systems software RIGHT NOW Publ No T559011 Rev a318 ENGLISH EN February 20 2009 2 About OLE Automation programming With OLE Automation ThermaCAM Researcher functionality is made available to e g a VBA script an Excel module For this purpose ThermaCAM Researcher exposes an OLE Automation object Other applications can create such objects and give them two types of commands Properties whose values can be read and changed and Methods that can be called with or without arguments An application that exposes its OLE Automation objects is called an OLE server appli cation An application that can access and manipulate OLE Automation objects is called an OLE controller application Before a controller application can exchange data with the server application it must create a reference to it 2 1 Obtaining an OLE Automation object reference There are two ways to refer to the OLE Automation objects of an application One way is to refer to the application s object library n object library contains a description of all the objects an application provides including definitions of all av
39. ed camera Syntax object GetFrameRate 00 Description object The ThermaCAM Re For example Session1 searcher object dbilmageRate Current image rate as a dou Normally 50 Hz PAL or 60 Hz NTSC ble precision float value NOTE The image rate will be rounded to the nearest Hz NOTE Certain camera types that have a mode in which several small images are packed into one single frame The image rate is increased as the image height is decreased while the frame rate stays the same However you will still get the image rate value 4 34 GetNamedValue Method Use the GetNamedValue method to retrieve application values Get the current value of anamed parameter name The easiest way to find the name of a particular param eter is to copy it to the clipboard with Edit gt Copy value and link it to a spread sheet program Then study the name in the cell Use only the last part of the link name here Syntax val object GetNamedValue named_value Description object The ThermaCAM Re For example Session1 searcher object named_value String Name of value to re E g sp1 temp trieve val String Specified value E g a spot meter temperature value 4 35 GetNoFormulas Method Syntax Result object GetNoFormulas ee meme e 0 Object The ThermaCAM Re For example Session searcher object Publ 7559011 Rev a318 ENGLISH EN February 20 2009 5
40. en the IR image was taken The level value is returned as a string Syntax 10 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties cameralevel object CameraLevel LOL em object The ThermaCAM Researcher For example Session1 object cameralevel Camera level 3 15 CameraRangeMax Property Retrieves the max camera range when the IR image was taken The value is returned as a string Syntax camerarangemax object CameraRangeMax Description object The ThermaCAM Researcher For example Session1 object camera Camera range max rangemax 3 16 CameraRangeMin Property Retrieves the min camera range when the IR image was taken The value is returned as a string Syntax camerarangemin object CameraRangeMin Description object The ThermaCAM Researcher For example Session1 object camera Camera range max rangemin 3 17 CameraSerialNo Property Retrieves the serial number of camera used when the IR image was taken The serial number is returned as a string Syntax cameraserialno object CameraSerialNo Publ T559011 Rev a318 ENGLISH EN February 20 2009 11 3 Properties Description object The ThermaCAM Researcher For example Session1 object camera Camera serial number serialno 3 18 CameraSpan Property Retrieves the camera span when the IR image was taken The span value is returned as a st
41. erialNo Property 11 CameraSpan Property 12 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 properties continued CameraType Property 12 CanHaveBarCodes Property 12 Cassette Property 13 ComPort Property 13 Connected Property 13 Cooler Property 14 CurrentlROutput Property 14 DefaultHistogramClasses Property 15 Device Property 15 DistanceUnit Property 15 Emissivity Property 16 EstimatedTransmission Property 16 ExtOpticsTemperature Property 16 ExtOpticsTransmission Property 17 Filtering Property 17 Filter Property 17 Freeze Property 18 ImageDate Property 18 ImageFilename Property 18 ImageMaxTemperature Property 19 ImageMinTemperature Property 19 ImagePath Property 20 ImageTimeMSec Property 20 ImageTime Property 20 ImageTimeStr Property 21 ImageTitle Property 21 IsFirstlmage Property 21 IsLastimage Property 22 IsUpdated Property 22 KeepAnalysis Property 22 Motor Property 23 ObjectDistance Property 23 OLELiveLinkDelay Property 23 PreferredlROutput Property 24 Ratio Property 24 RecAutoNameBase Property 24 ReclmgPres Property 25 RecOneFileRec Property 25 RecStartCond Property 25 RecStartDelay Property 26 RecStartTime Property 26 RecStopCond Property 27 RecStopDelay Property 27 RecStopDuration Property 27 RecStoplmages Property 28 RecStoreCond Property 28 RecStorelmages Property 29 RecStorelnterval Property 29 Referenc
42. ermaCAM Researcher For example Session1 object Boolean TRUE Researcher is visible FALSE Researcher is hidden 3 86 Zoomfactor Property Sets or gets the IR image zoom factor Syntax object Zoomfactor zoomfactor zoomfactor object Zoomfactor om ee object The ThermaCAM Researcher For example Session1 object zoomfactor Double precision gt 1 0 lt 4 0 NOTE The zooming is performed around the centre of the IR image Changes to this property do not fire any event Publ T559011 Rev a318 ENGLISH February 20 2009 37 3 Properties INTENTIONALLY LEFT BLANK 38 Publ T559011 Rev a318 ENGLISH EN February 20 2009 4 Methods 4 1 AddaPlaybTextCmt Method Adds or changes text comments during image playback Syntax Result object AddPlaybTextCmt strLabel strValue bChgExisting Description Object The ThermaCAM Re For example Session1 searcher object strLabel The name of the text com Label for example ment to be added strValue The value as a string name Value1 for example of the text comment to be added bChgExisting Boolean indicating if the La If bChgExisting is TRUE and the label already bel may exist in advance exists its value string is changed Result Boolean TRUE Successful outcome NOTE This method can only be used with image formats that can contain text comments and not
43. es to this property it will only affect new analysis symbol labels 3 73 ShowAnalysisTemp Property Sets or gets the flag indicating if a temperature shall be displayed along with the analysis symbol name Syntax object ShowAnalysisTemp flag flag object ShowAnalysisTemp Description The ThermaCAM Researcher For example Session1 object Boolean TRUE A temperature will be displayed FALSE A temperature will not be displayed NOTE Changes to this property it will only affect new analysis symbol labels It is not relevant for the flying spot function 3 74 ShowllegTemplndicator Property By this property you can control whether an indication shall be made when a temper ature is unreliable or not It becomes unreliable when it is close to or outside the cal ibration of the camera The indicators are ES Warning temperature unreliable Temperature underflow Temperature overflow You are most likely to use this property when you link values by OLE to spread sheet programs which do not want to calculate on such decorated digits Syntax object ShowllegTemplndicator flag flag object ShowllegTempindicator LOL CNN NN object The ThermaCAM Researcher For example Session1 object 32 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties flag Boolean TRUE do indicate unreliable results FALSE dont 3 75 ShowLabels Property This property wil
44. ession object factor Float Emissivity factor 0 01 1 00 3 30 Estimated Transmission Property Sets or gets the analysis estimated transmission A value of zero which is the default means that the analysis system calculates its own transmission factor Syntax object EstimatedTransmission factor factor object EstimatedTransmission few een object The ThermaCAM Researcher For example Session1 object factor Float Estimated transmission 0 0 1 0 where 0 0 disables the estimation 3 31 ExtOptics Temperature Property Sets or gets the temperature of some external optics such as a heat shield Syntax object ExtOpticsTemperature value value object ExtOpticsTemperature 16 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties em NN Object The ThermaCAM Researcher For example Session1 object Value Float Kelvin temperature 3 32 ExtOpticsTransmission Property Sets or gets the transmission of some external optics such as a heat shield Syntax object ExtOpticsTransmission value value object ExtOpticsTransmission Description The ThermaCAM Researcher For example Session1 object Float 0 0 to 1 0 Use 1 0 if not external optics is exists 3 33 Filter Property Sets or gets the camera filter This property only affects the Thermovision 900 camera Syntax object Filter value value o
45. et the values If the analysis function does not exist the return flag will be FALSE and TempState will be invalid NOTE You can t expect the temperature to be correct until ThermaCAM Researcher has updated itself completely to the image 4 20 AutoAdjust Method Use the AutoAdjust method to automatically adjust the scale and colors of the dis played image Syntax object AutoAdjust object The ThermaCAM Re For example Session1 searcher object 4 21 AutoRewind Method Use the AutoRewind method to set the auto rewind flag in playing disk image se quences If set the image sequence will automatically rewind itself when reaching the last or the first image in the selected sequence and continue to play Syntax object AutoRewind flag The ThermaCAM Re For example Session1 searcher object Boolean TRUE to enable auto rewind 4 22 Connect Method Use the Connect method to connect the application to the camera This method is used to reconnect the camera again after a Disconnect command Syntax object Connect object The ThermaCAM Re For example Session1 searcher object Publ T559011 Rev a318 ENGLISH EN February 20 2009 51 4 Methods 4 23 CopySessionAndlmage Method Copies the IR image to the clipboard with active OLE link No return value Syntax object CopySessionAndlmage em Desnpion LN CM The EC Re For example E one searcher object 4
46. fltTempArray sStateArray object Description The ThermaCAM Researcher object For example Session1 funcname Generic name string of a line or box area analysis function Float array that will be filled with the temper ature values LIO1 The current presentation unit is used Box area temperatures are stored row by row sStateArray Array of short integers that will be filled with the corresponding temperature state val ues 0 OK 1 Warning the temperature is unreliable 2 Underflow too low temperature 3 Overflow too high temperature 4 Invalid the temperature could not be calculated Number The number of ele ments stored in the array Long integer Positive if successful NOTE The Number returned in case of failure is the negative value of the number required for this line or area NOTE You cant expect the array to be correct until ThermaCAM Researcher has updated itself completely to the image 4 18 AnalysisTemperatureArrayLen Method You can use the AnalysisTemperatureArrayLen method to retrieve the number of array elements required for a call to the AnalysisHistoArray Method or the Analysis TemperatureArray Method Syntax Number object AnalysisTemperatureArrayLen ineFuncname ee o object The ThermaCAM Researcher object For example Session1 Publ 7559011 Rev a318 ENGLISH EN February 20
47. free name For example Session1 li or NumPoints ShPointArray UsedFuncName Integer indicating the number of corners present in the inte ger array Short integer array filled with the coordinates of the cor ners of the line the beginning and end points included The size is 2 numPoints The co ordinates come in pairs with the xpositions before the ypositions The name of the function that was re defined Publ 7559011 Rev a318 ENGLISH February 20 2009 For example 3 For example 10 20 30 40 5 35 41 4 Methods SEE ALSO For information about straight lines see section 4 8 AnalysisDefineLine Method on page 43 NOTE You can t expect any results from this function until the ThermaCAM Researcher has updated itself completely to the new conditions 4 6 AnalysisDefineBoxArea Method The AnalysisDefineBoxArea method lets you add move or reshape a box shaped area measurement function on the IR Image Syntax usedFuncName object AnalysisDefineBoxArea useFuncName xPos yPos width height Description object The ThermaCAM Re For example Session1 searcher object useFuncName The name of the area to be or re defined Enter an empty string to make ThermaCAM Researcher pick a free name xPos yPos Integer coordinates within the 10 10 for example 0 0 corresponds to the top current image of the top left left corner
48. get time interval for storing images Syntax time object RecStorelnterval object RecStorelnterval time Description The ThermaCAM Researcher For example Session1 object double time elapsed between each stored image NOTE This value is only valid if storing condition is set to 1 Time interval 3 67 ReferenceTemperature Property Sets or gets the analysis reference temperature Syntax Publ 7559011 Rev a318 ENGLISH EN February 20 2009 29 3 Properties object ReferenceTemperature temperature temperature object ReferenceTemperature Description object The ThermaCAM Researcher For example Session1 object temperature Float Reference temperature 0 0 9999 9 in Kelvin 3 68 ReflemperatureExists Property Indicates if the IR image reference temperature exists Syntax bFlag object RefTemperatureExits Description The ThermaCAM Researcher For example Session1 object Boolean TRUE if a reference temperature exist otherwise FALSE 3 69 RelativeHumidity Property Set or get the relative humidity value Syntax object RelativeHumidity factor factor object RelativeHumidity om The ThermaCAM Researcher For example Session1 object Float Relative humidity factor 0 00 0 99 3 70 Save900Analysis Property Sets or gets the flag indicating if analysis shall be stored when saving images with Thermo
49. ick a free name Label User friendly description of For example SpotAreaSubtraction formula Expression Formula expression For example sp1 temp ar1 avg Enter an empty string to show formula editing dialog Precision Short Number of decimals 0 5 in result FormulaName If formula definition was suc Ok fo01 fo02 fo03 cessful the name of the for Precision lt 0 Precision must be gt 0 mula will be returned Error in formula FormulaError 4 4 AnaDeleteFormula Method Delete formula s for the active session Syntax Result object AnaDeleteFormula Name 40 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods Object Name Description The ThermaCAM Re searcher object The name of the formula to be deleted to make ThermaCAM Researcher delete all formulas For example Session fo01 or Result 4 5 Boolean TRUE Successful request AnalysisDefineBentLine Method The AnaDefineBentLine method lets you add move or reshape a linemeasurement function on the IR Image This type of line can have many corners Syntax usedFuncName object AnalysisDefineBentLine useFuncName numPointss sh PointArray Object UseFuncName Description The ThermaCAM Re searcher object The name of the line to be re defined Enter an empty string to make ThermaCAM Researcher pick a
50. il info flir it Web www flir com FLIR JAPAN FLIR SYSTEMS Japan KK Nishi Gotanda Access 8F 3 6 20 Nishi Gotanda Shinagawa Ku Tokyo 141 0031 JAPAN Phone 81 3 6277 5681 Fax 81 3 6277 5682 E mail info flir jp Web www fir com SWEDEN FLIR Systems Worldwide Thermography Center P O Box 3 SE 182 11 Danderyd SWEDEN Phone 46 0 8 753 25 00 Fax 46 0 8 753 23 64 E mail sales flir se Web www fir com USA FLIR Systems Corporate headquarters 27700A SW Parkway Avenue Wilsonville OR 97070 USA Phone 1 503 498 3547 Web www fir com USA Primary sales amp service contact in USA FLIR Systems USA Thermography Center 16 Esquire Road North Billerica MA 01862 USA Phone 1 978 901 8000 Fax 1 978 901 8887 E mail marketing flir com Web www fir com USA FLIR Systems Indigo Operations 70 Castilian Dr Goleta CA 93117 3027 USA Phone 1 805 964 9797 Fax 1 805 685 2711 E mail cbi flir com Web www corebyindigo com USA FLIR Systems Indigo Operations IAS Facility 701 John Sims Parkway East Suite 2B Niceville FL 32578 USA Phone 1 850 678 4503 Fax 1 850 678 4992 E mail cbiGflir com Web www corebyindigo com
51. ine 4 Isotherm AnalysisNum The number of the symbol 1 For SPO1 and ARO1 etc ber label The label for the analysis sym bol NOTE These generic names will not be changed by this method You should still refer to spotmeter 1 as SP01 even if you change its label to something else 3 5 AnalysisTemperature Property Get a temperature value for an analysis function Syntax temperature object AnalysisTemperature Analysis Type AnalysisNumber Analysis Value TempState gt e o ooo object The name of the Therma For example Session1 CAM Researcher object 6 Publ T559011 Rev a318 ENGLISH February 20 2009 3 Properties Description AnalysisType Type of analysis symbol 1 Spotmeter SPxx 2 Area ARxx 3 Line LIxx 4 Isotherm ISOxx AnalysisNumber The number of the symbol 1 For 5 01 and ARO1 etc AnalysisValue Type of temperature re quested 1 Temperature Spotmeter Isotherm 2 Min temperature Line Area 3 Max temperature Line Area 4 Average temperature Line Area 5 Cursor temperature Line 6 Temperature width Isotherm 7 Difference temperature Spotmeter Isotherm 8 Min difference temperature Line Area 9 Max difference temperature Line Area 10 Average difference temperature Line Area 11 Cursor difference temperature Line TempState Passed by reference The state of the tempera ture will be returned here 0 OK 1
52. istoArray Method 46 AnalysisHistoClasses Method 47 AnalysisHistoThreshold Method 47 AnalysisLabel Property 6 AnalysisResults Method 48 AnalysisTemperatureArrayLen Method 49 AnalysisTemperatureArray Method 49 AnalysisTemperatureByName Method 50 AnalysisTemperature Property 6 AtmosphericTemperature Property 7 AutoAdjust Method 51 AutoMaxTemperature Property 8 AutoMinTemperature Property 8 AutoRewind Method 51 B BBRange Property 9 CalcWhileMovingAna Property 9 CameraFilter Property 10 CameraLens Property 10 CameraLevel Property 10 Camera Property 9 CameraRangeMax Property 11 CameraRangeMin Property 11 CameraSerialNo Property 11 CameraSpan Property 12 CameraType Property 12 CanHaveBarCodes Property 12 Cassette Property 13 ComPort Property 13 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 Connected Property 13 Connect Method 51 Cooler Property 14 copyright vi CopySessionAndlmage Method 52 CurrentlROutput Property 14 customer support 1 D DefaultHistogramClasses Property 15 Device Property 15 Disconnect Method 52 DistanceUnit Property 15 E Emissivity Property 16 EstimatedTransmission Property 16 ExternalCorrection Method 52 ExtOpticsTemperature Property 16 ExtOpticsTransmission Property 17 F FastBackward Method 52 FastForward Method 53 Filtering Property 17 Filter Property 17 FLIR Systems copyright vi ISO
53. l control if the labels of the analysis functions are shown along with the symbols on top of the image or The appearance of analysis symbols as such is controlled by the ShowAnalysis Property Syntax object ShowLabels flag flag object ShowLabels Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Do show the labels FALSE Dont SEE ALSO The presence of a measurement result within the label is controlled by the following property 3 73 ShowAnalysisTemp Property page 32 3 76 ShowTemperatureScale Property Show or hide the temperature scale Syntax object ShowTemperatureScale show show object ShowTemperatureScale Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Show the temperature scale FALSE Dont 3 77 TargetMotion Property Sets or gets the target motion value This property only affects the AGEMA 550 camera Syntax Publ T559011 Rev a318 ENGLISH EN February 20 2009 33 3 Properties object TargetMotion value value object TargetMotion Description The ThermaCAM Researcher For example Session1 object Integer Target motion value 0 Still or slow moving objects 1 Fast moving objects 3 78 TemperatureUnit Property Sets or gets the temperature unit Syntax object TemperatureUnit temperatureunit temperatureunit object TemperatureUnit
54. m existing temperature of the IR image Syntax temperature object ImageMaxTemperature tempstate Description The ThermaCAM Researcher object object TempState Passed by reference The state of the temperature will be returned here temperature The maximum existing temper ature of the image For example Session1 0 OK 1 Warning the temperature is unreliable 2 Underflow too low temperature 3 Overflow too high temperature 4 Invalid the temperature could not be calculated The temperature is in the current unit NOTE You can t expect the temperature to be correct until the ThermaCAM Researcher has updated itself completely to the image 3 39 ImageMinTemperature Property Minimum existing temperature of the IR image Syntax temperature object ImageMinTemperature tempstate Description The ThermaCAM Researcher object object For example Session1 TempState Passed by reference The state of the temperature will be returned here 0 OK 1 Warning the temperature is unreliable 2 Underflow too low temperature 3 Overflow too high temperature 4 Invalid the temperature could not be calculated temperature The minimum existing tempera ture of the image Publ No T559011 Rev a318 ENGLISH EN February 20 2009 The temperature is in the current unit 19 3 Properties NOTE You can t expect the temperature to be corre
55. nction is being moved Syntax object CalcWhileMovingAna flag flag object CalcWhileMovingAna Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Calculate wile moving analysis FALSE Do not calculate NOTE ThermaCAM Researcher will calculate the analysis automatically when the movement is stopped 3 11 Camera Property Gets the camera type value This property is read only Syntax cameralype object Camera Publ T559011 Rev 318 ENGLISH EN February 20 2009 9 3 Properties Description Object The ThermaCAM Researcher For example Session1 object cameratype 16 bit integer Camera type 0 No camera connected 1 AGEMA 500 camera 2 Thermovison 900 camera 3 THV 1000 4 SC1000 5 S series 6 A series 3 12 CameraFilter Property Retrieves the type of filter used when the IR image was taken The filter is returned as a string Syntax camerafilter object CameraFilter few eine object The ThermaCAM Researcher For example Session1 object camerafilter Camera filter 3 13 CameraLens Property Retrieves the type of lens used when the IR image was taken The lens is returned as a string Syntax cameralens object CameraLens object The ThermaCAM Researcher For example Session1 object cameralens Camera lens 3 14 CameraLevel Property Retrieves the camera level wh
56. nt 22 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties 3 49 Motor Property Sets or gets the image freeze state Syntax object Motor state state object Motor ES Description The ThermaCAM Researcher For example Session1 object 16 bit integer Motor cooler 0 Motor off state 1 Motor on 4 Stirling cooler standby 3 50 ObjectDistance Property Sets or gets the measurement object distance value Syntax object ObjectDistance distance distance object ObjectDistance Description Object The ThermaCAM Researcher For example Session1 object Distance Float Object distance 0 0 9999 9 meters 0 0 32808 1 feet NOTE The current distance unit affects the value range 3 51 OLELiveLinkDelay Property Sets or gets the update delay in ms for OLE links Syntax object OLELiveLinkDelay delay delay object OLELiveLinkDelay meme me o Object The ThermaCAM Researcher For example Session1 object delay OLE link delay in milli seconds Publ 7559011 Rev a318 ENGLISH EN February 20 2009 23 3 Properties 3 52 PreferredlROutput Property Sets the preferred type of output IR or other units Syntax object PreferredIROutput type type object PreferrediROutput Description The ThermaCAM Researcher For example Session1 object Type of output 0 Temperature 1 3 Reserved
57. o 2 Time 3 63 RecStoplmages Property Set or get number of images to record Syntax nolmages object RecStoplmages object RecStoplmages nolmages Description Object The ThermaCAM Researcher For example Session1 object nolmages Short Number of images to record NOTE This value is only valid if stop condition is set to 1 Stop after XX images 3 64 RecStoreCond Property Set or get condition for storing images during recording An image may stored under five different conditions Highest possible speed Ata Time interval At each N th image User pushes the function key F5 External trig event Syntax index object RecStoreCond object RecStoreCond index em Object The ThermaCAM Researcher For example Session1 object 28 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties Description Short Storing condition 0 Tool button Key trig 1 Highest speed 2 Every N images 3 Time interval 4 External trig delay 3 65 RecStorelmages Property Set or get image interval for storing images Syntax object RecStorelmages object RecStorelmages N Object The ThermaCAM Researcher For example Session1 object nolmages short Store every N th image NOTE This value is only valid if storing condition is set to 2 image interval 3 66 RecStorelnterval Property Set or
58. oFirstlmage Method Use the GotoFirstlmage method to stop playing disk images and display the first image in the selected set of disk images Syntax object GotoFirstlmage De me object The ThermaCAM Re For example Session1 searcher object Publ 7559011 Rev a318 ENGLISH EN February 20 2009 59 4 Methods 4 46 GotoLastlmage Method Use the GotoLastlmage method to stop playing disk images and display the last image in the selected set of disk images Syntax object GotoLastlImage object The ThermaCAM Re For example Session1 searcher object 4 47 ImageDimensions Method You can use the ImageDimensions method to retrieve information about the width and height in pixels of the current IR image Syntax object ImageDimensions width height Description The ThermaCAM Re For example Session1 searcher object Integer that will receive the For example 320 width of the image Integer that will receive the For example 240 height of the image NOTE The dimensions of the actual data is returned not the dimensions visible on the screen 4 48 InternalCorrection Method Use the InternalCorrection method to calibrate the pixel to pixel differences in the camera with the internal shutter as reference This method only affects the AGEMA 500 camera Syntax object InternalCorrection object The ThermaCAM Re For example Session1 searcher object 60 Publ No
59. of the image corner of the box width height Integer width and height of the box usedFuncName The name ofthe function that was re defined NOTE You can t expect any results from this function until ThermaCAM Researcher has updated itself completely to the new conditions 4 7 AnalysisDefineCircleArea Method The AnalysisDefineCircleArea method lets you add move or reshape a circle shaped area measurement function on the IR Image Syntax usedFuncName object AnalysisDefineCircleArea useFuncName xCenter yCenter radius 42 Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods Description object The ThermaCAM Re For example Session searcher object useFuncName The name of the area to be re defined Enter an empty string to make ThermaCAM Researcher pick a free name xCenter Integer coordinates withinthe 10 10 for example 0 0 corresponds to the top yCenter current image of the top left left corner of the image corner of the box radius Integer radius of the circle usedFuncName The name ofthe function that was re defined NOTE You can t expect any results from this function until ThermaCAM Researcher has updated itself completely to the new conditions 4 8 AnalysisDefineLine Method The AnalysisDefineLine method lets you add move or reshape a linemeasurement function on the IR Image Syntax usedFuncName
60. ously replay the selected disk im age s forwards Syntax object PlayBackward object The ThermaCAM Re For example Session1 searcher object 4 55 PlayStop Method Use the PlayStop method to stop playing disk images Syntax object PlayBackward e meme mm o object The ThermaCAM Re For example Session1 searcher object 62 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods 4 56 RecordOnelmage Method Use the RecordOnelmage method to record a live image Syntax object RecordOnelmage fee Peewee object The ThermaCAM Re For example Session1 searcher object mm 4 57 Refresh Method You can use the Refresh method to order a repaint of the IR image The method will also make ThermaCAM Researcher fully adapt itself to a new image It involves updating the temperature and frequency tables scaling conditions and analysis functions Call it after you have set all the properties you like and before you start retrieving in formation from the image Syntax object Refresh object The ThermaCAM Re For example Session1 searcher object NOTE This method will not paint the image itself 4 58 RemoveAllAnalysis Method You can use the RemoveAllAnalysis method to remove all analysis functions from the IR image Syntax object RemoveAllAnalysis e meme object The ThermaCAM Re For example Session searcher object Publ No T559011
61. p the current scale when a new image is loaded 3 82 UselmageZoom Property The UselmageZoom property controls if the current zoom factor shall be kept or not when a new IR image is loaded Syntax object UselmageZoom keep flag object UselmageZoom Publ T559011 Rev 318 ENGLISH EN February 20 2009 35 3 Properties Description The ThermaCAM Researcher For example Session1 object Boolean TRUE keep current zoom factor FALSE don t keep current zoom factor 3 83 Version Property Get the current version string Syntax string object Version om me object The ThermaCAM Researcher For example Session1 object string Version ThermaCAM Researcher Version x xx 3 84 View3D Property Set or get the flag that tells if the IR image shall be displayed in 3D or 2D Syntax object View3D flag flag object View3D Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Show IR image in 3D FALSE Show IR image in 2D NOTE 3D view will decrease the performance of show images quit dramatically It is also not possible to display any analysis in the 3D view 3 85 Visible Property Get or set the visibility of the Researcher window Syntax object Visible flag flag object Visible 36 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 3 Properties Description The Th
62. perature temperature object AmbientTemperature object The ThermaCAM Researcher For example Session1 object temperature Float Ambient temperature Kelvin 3 2 AnalysisDistance Property Set or get the distance for the specified analysis tool Syntax object AnalysisDistance AnalysisName distance distane object AnalysisDistance AnalysisName Description Object ThermaCAM Re For example Session1 searcher object AnalysisName The analysis name For example SPO1 AROS distance Double The analysis dis tance 3 3 AnalysisEmissivity Property Set or get the emissivity for the specified analysis tool Syntax object AnalysisEmissivity AnalysisName emissivity emissivity object AnalysisEmissivity AnalysisName De me Object The ThermaCAM Re For example Session1 searcher object Publ 7559011 Rev a318 ENGLISH EN February 20 2009 5 3 Properties AnalysisName The analysis name For example 5 01 emissivity Double The analysis emissiv ity 3 4 AnalysisLabel Property Set or get the label for the specified analysis tool Syntax object AnalysisLabel AnalysisTool AnalysisNumber label label object AnalysisLabel AnalysisTool AnalysisNumber Description object The ThermaCAM Researcher For example Session1 object AnalysisTool Type of analysis symbol 1 Spotmeter 2 Area 3L
63. ple Session1 searcher object strLabel String The comment to remove Result Boolean TRUE Successful outcome 4 63 RestoreAnalysis Method You can use the RestoreAnalysis method to revert to the original analysis stored in the image Syntax object RestoreAnalysis object The ThermaCAM Re For example Session1 searcher object 4 64 RestoreObjParameters Method You can use the RestoreObjParameters method to revert to the original object pa rameters stored in the image Syntax object RestoreObjParameters object The ThermaCAM Re For example Session1 searcher object 4 65 SaveAreaAsCsv Method You can use the SaveAreaAsCsv method to save all temperatures in an area or the entire image in a file A specified separator separates the temperatures and a carriage return linefeed pair separates the lines Syntax Publ 7559011 Rev a318 ENGLISH EN February 20 2009 65 4 Methods temperatures object SaveAreaAsCsv filename separator areaFuncName Description object The ThermaCAM Re For example Session1 searcher object filename Path and filename for the file E g c data area1 csv where you want the tempera tures stored separator Character that separates the Most often a semicolon is used as a separator temperatures areaFuncname Generic name string of an ARO1 area An empty string will store the entire image temperatures
64. ply FLIR Systems at its option repair or replace any such defective product free of charge if upon inspection it proves to be defective in material or workmanship and provided that it is returned to FLIR Systems within the said one year period FLIR Systems has no other obligation or liability for defects than those set forth above No other warranty is expressed or implied FLIR Systems specifically disclaims the implied warranties of merchantability and fitness for a particular purpose FLIR Systems shall not be liable for any direct indirect special incidental or consequential loss or damage whether based on contract tort or any other legal theory Copyright FLIR Systems 2009 All rights reserved worldwide No parts of the software including source code may be reproduced transmitted transcribed or translated into any language or computer language in any form or by any means electronic magnetic optical manual or otherwise without the prior written permission of FLIR Systems This manual must not in whole or part be copied photocopied reproduced translated or transmitted to any electronic medium or machine readable form without prior consent in writing from FLIR Systems Names and marks appearing on the products herein are either registered trademarks or trademarks of FLIR Systems and or its subsidiaries All other trademarks trade names or company names referenced herein are used for identification only and a
65. r in one se quence file Syntax flag object RecOneFileRec object RecOneFileRec flag Description Object The ThermaCAM Researcher For example Session1 object Flag Boolean Storing condition TRUE Store images in one sequence file FALSE Store images in separate files 3 57 RecStartCond Property Set or get start condition for recording of images Recording may start on four different events User selects the start stop button on the recording toolbar User pushes the function key F5 Predefined time External trig event Publ T559011 Rev a318 ENGLISH EN February 20 2009 25 3 Properties Syntax index object RecStartCond object RecStartCond index Description Object The ThermaCAM Researcher For example Session1 object Index Short Start condition 0 Tool button Key trig 1 Time 2 External trig delay 3 58 RecStartDelay Property Set or get delay time for start of recording Syntax delay object RecStartCond object RecStartCond delay we Object The ThermaCAM Researcher For example Session1 object Delay Double delay time NOTE This value is only valid if start condition is set to 3 External Trig 3 59 RecStartTime Property Set or get time for recording to start Syntax time object RecStartCond object RecStartCond time ThermaCAM Researcher For example Session1
66. rSetReference Method on page 72 4 83 SubtrSetSource Method on page 73 4 78 SubtrSetOptions Method on page 71 4 82 SubtrSetScale Method on page 73 4 80 SubtrSetOutputDir Method on page 72 4 79 SubtrSetOutput Method on page 71 4 76 SubtrGetResultlmage Method on page 70 4 78 SubtrSetOptions Method Sets subtraction offset mode Syntax Result object SubtrSetOptions nverse OpType OffsMode Offset Description Object The ThermaCAM Re For example Session1 searcher object Inverse BOOL TRUE Inverted subtraction FALSE Normal subtraction OpType Long Not used OffsMode Offset mode 0 Atmospheric difference as offset 1 Use supplied offset 2 Don t use any offset Offset used if OffsMode 1 lt gt 0 if successful SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section a 4 77 SubtrSaveOutput Method on page 70 4 79 SubtrSetOutput Method Syntax Result object SubtrSetOutput Base OneFile OpenSel CloseSrc Palette Publ 7559011 Rev a318 ENGLISH EN February 20 2009 71 4 Methods Description Object The ThermaCAM Re For example Session1 searcher object Base String Base name for subtracted files OneFile Long lt gt 0 save in one sequence file else in separate images OpenSel Long lt gt 0 subtraction result will be selected after execution CloseSrc Long lt gt 0 close
67. re the property of their respective owners Quality assurance The Quality Management System under which these products are developed and manufactured has been certified in accordance with the ISO 9001 standard FLIR Systems is committed to a policy of continuous development therefore we reserve the right to make changes and improvements on any of the products described in this manual without prior notice vi Publ 7559011 Rev a318 ENGLISH EN February 20 2009 Table of contents 1 ede ett een D AR dte te eet e Aree 1 2 About OLE Automation programming 3 2 1 Obtaining an OLE Automation object reference 3 5 2 5 3 1 AmbientTemperature Properly cen cette tepida 5 3 2 AnalysisDistance Propetty rettet eee cene 5 3 3 AnalysisEmiissivity Propertly EE 5 3 4 AnalysisLabel Property 6 3 5 AnalysisTemperature Property 6 3 6 X AtmosphericTemperature Property 7 3 7 AutoMaxTemperature Property 8 3 8 AutoMinTemperature Property nri tecti irte 8 3 9 enemies idc 9 3 10 CalcWhileMovingAna Property 9 3 11 Camera Property 9 3 12 CameraFilter Property 10 3 13 CameraLens Property 4 10 3 14 Cameralev l Property EE 10 3 15 CameraRangeMax Property 11
68. ring Syntax cameraspan object CameraSpan LOL CNN NR object The ThermaCAM Researcher For example Session1 object cameraspan Camera span 3 19 CameraType Property Retrieves the type of camera used when the IR image was taken The camera type is returned as a string Syntax cameralype object CameraType Description object The ThermaCAM Researcher For example Session1 object Cameratype String representing the camera type 3 20 CanHaveBarCodes Property Returns the number of bar codes possible for this type of IR image not the number of codes actually present Syntax number object CanHaveBarCodes 12 Publ No 7559011 Rev 318 ENGLISH EN February 20 2009 3 Properties ewe object The ThermaCAM Researcher For example Session1 object number short integer for example 5 for Prism DS images 3 21 Cassette Property Sets or gets the camera filter cassette This property only affects the Thermovision 900 camera Syntax object Cassette value value object Cassette Description The ThermaCAM Researcher For example Session1 object 16 bit integer Filter cassette 0 3 number 3 22 Property Gets or sets the Comport number used to communicate with the camera Syntax shNumber object ComPort object ComPort shNumber Description Object The ThermaCAM Researcher For example Session1 object
69. s for new analysis Areas or Lines Syntax object DefaultHistogramClasses number number object DefaultHistogramClasses e mee ee object The ThermaCAM Researcher For example Session1 object number Number of classes Min 2 max 64 3 27 Device Property Gets or sets the Device camera interface type used Syntax shDevTyper object Device object Device shDevType Description Object The ThermaCAM Researcher For example Session1 object shDevType Short integer 0 None 1 PC Card Interface 2 IC 2 DIG 16 Frame Grabber 3 FireWire 4 6 Reserved 7 RFlashLink Frame Grabber 3 28 DistanceUnit Property Sets or gets the current distance unit Syntax object DistanceUnit distanceunit distanceunit object DistanceUnit e meme ee o object The ThermaCAM Researcher For example Session1 object Publ 7559011 Rev a318 ENGLISH EN February 20 2009 15 3 Properties Description Description distanceunit Distance unit LN Meter short integer 1 Foot NOTE Changes will affect not only the distance in the settings dialog but also the corresponding object parameter read out No event is fired by this change 3 29 Emissivity Property Sets or gets the image scale emissivity factor Syntax object Emissivity factor factor object Emissivity object The ThermaCAM Researcher For example S
70. scription The ThermaCAM Researcher object For example Session1 anaFuncSelString resultString A string that identifies the selection desired A list with the desired results One name and value on each line The name and the value are separat ed by a TAB charac ter CHR 9 sp5 Only spotmeter 5 is wanted sp All spotmeters are wanted ar1 avg Only area 1 average wanted ar avg All area averages wanted similarly for lines areas isotherms Everything is wanted For example sp01 label tab SPO1 lt linefeed gt sp01 temp tab 35 22 lt linefeed gt sp01 diff tab 0 22 lt linefeed gt sp01 emis tab ILLEGAL lt linefeed gt and so on NOTE You will not receive any multiple results such as the line stringdata and histograms in this way NOTE You can expect the string ILLEGAL to appear as a value if the value is undefined NOTE You can t expect the results to be correct until ThermaCAM Researcher has updated itself completely to the image SEE ALSO For information about performing an immediate update see section 4 57 Refresh Method on page 63 48 Publ No T559011 Rev a318 ENGLISH February 20 2009 4 Methods 4 17 Analysis TemperatureArray Method You can use the AnalysisTemperatureArray method to retrieve a whole set of tem peratures for a line or a box area Syntax Number object AnalysisTemperatureArray funcName
71. sisDefineCircleArea 42 4 8 AnalysisDefineLine Method net niente 43 4 9 AnalysisDefinePolygonArea 44 Publ T559011 Rev a318 ENGLISH February 20 2009 4 10 4 11 4 12 4 13 4 14 4 15 4 16 4 17 4 18 4 19 4 20 4 21 4 22 4 23 4 24 4 25 4 26 4 27 4 28 4 29 4 30 4 31 4 32 4 33 4 34 4 35 4 36 4 37 4 38 4 39 4 40 4 41 4 42 4 43 4 44 4 45 4 46 4 47 4 48 4 49 4 50 4 51 4 52 4 53 4 54 4 55 4 56 4 57 4 58 4 59 4 60 4 61 4 62 AnalysisDefineSpotmeter Method 4 44022 00 44 AnalysisDeleteFunc Method AnalysisFuncNames Method AnalysisHistoArray Method AnalysisHistoClasses Method AnalysisHistoThreshold 47 AnalysisR sults Method is itt diet d ende 48 AnalysisTemperatureArray Method 49 AnalysisTemperatureArrayLen Method 49 AnalysisTemperatureByName Method 50 AutoAdjust Method 51 AutoRewind Method remet Pe bakte 51 Connect MONO me M 51 CopySessionAndlmage 52 Disconnect Method en better erede tte te dn 52 ExternalCorrection Method FastBackward Method FastForward Method ier d FocusFar Method NU T TEE 5
72. source files after subtraction Palette String Palette used for subtraction Result Long lt gt 0 if successful SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section a 4 77 SubtrSaveOutput Method on page 70 4 80 SubtrSetOutputDir Method Sets the output directory for subtracted files Syntax Result object SubtrSetOutputDir DirPath Description Object The ThermaCAM Re For example Session1 searcher object DirPath String Directory for subtracted images Result Long lt gt 0 if successful SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section 4 77 SubtrSaveOutput Method on page 70 4 81 SubtrSetReference Method Set reference image file to be used in subtraction Syntax Result object SubtrSetReference FileName 72 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods Description Object The ThermaCAM Re For example Session1 searcher object FileName String Reference image file used for subtraction Result Long 0 if successful SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section a 4 77 SubtrSaveOutput Method on page 70 4 82 SubtrSetScale Method Sets Level amp Span mode used when subtracting Syntax Result object SubtrSetScale DistrModee Low High Description Object The
73. ttest pixels have been discarded NOTE You can t expect the temperature to be correct until the ThermaCAM Researcher has updated itself completely to the image SEE ALSO For more information see section 3 38 ImageMaxTemperature Property on page 19 3 8 AutoMinTemperature Property You can use the AutoMinTemperature property to get the minimum temperature of the image most suitable for auto adjustment of the scale Syntax temp object AutoMinTemperature Description The ThermaCAM Researcher For example Session1 object The minimum existing tempera The temperature is in the current unit ture of the image when a small amount of the coldest pixels have been discarded 8 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 3 Properties NOTE You can t expect the temperature to be correct until the ThermaCAM Researcher has updated itself completely to the image SEE ALSO For more information see section 3 39 ImageMinTemperature Property on page 19 3 9 BBRange Property Sets or gets the measurement range Syntax object BBRange range range object BBRange Jon em The ThermaCAM Researcher For example Session1 object Integer Measurement range 0 depends on the camera 3 10 CalcWhileMovingAna Property Set this property to FALSE to prevent the ThermaCAM Researcher from making analyses while some analysis fu
74. us disk image Syntax object StepBackward Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 69 4 Methods object The ThermaCAM Re For example Session1 searcher object 4 75 StepForward Method You can use the StepForward method to view the next disk image Syntax object StepForward object The ThermaCAM Re For example Session1 searcher object 4 76 SubtrGetResultlmage Method May be used after a successfully executed subtraction to return the name of the first subtracted image If subtraction is put in a sequence file the name of the sequence file is returned Syntax Result object SubtrGetResultlmage De me The ThermaCAM Re For example Session1 searcher object String Name of first subtracted image SEE ALSO The SubtrSaveOutput Method runs the actual subtraction For more information see section a 4 77 SubtrSaveOutput Method on page 70 4 77 SubtrSaveOutput Method Executes subtraction Syntax Result object SubtrSaveOutput RefFileMode De me Object The ThermaCAM Re For example Session searcher object 7O Publ No 7559011 Rev a318 ENGLISH EN February 20 2009 4 Methods Description RefFileMode Reference file mode 1 2 Consecutive subtraction 2 First file as reference 3 Separate reference file Result lt gt 0 if successful SEE ALSO For more information see also the sections 4 81 Subt
75. ves the IR image title Syntax imagetitle object ImageTitle em object The ThermaCAM Researcher For example Session1 object imagetitle Image title 3 45 IsFirstlmage Property This property is TRUE when the first image in the session is displayed Syntax first object IsFirstimage nm om The ThermaCAM Researcher For example Session1 object First image TRUE or FALSE Publ 7559011 Rev a318 ENGLISH EN February 20 2009 21 3 Properties 3 46 IsLastlmage Property This property is TRUE when the last image in the session is displayed Syntax last object IsLastlImage me The ThermaCAM Researcher For example Session1 object Last image TRUE or FALSE 3 47 IsUpdated Property Reveals if ThermaCAM Researcher has been updated to the current image or not Syntax flag object IsUpdated we The ThermaCAM Researcher For example Session1 object Boolean SEE ALSO To get the update done immediately see section 4 57 Refresh Method on page 63 3 48 KeepAnalysis Property The KeepAnalysis property controls if the current analysis shall be kept when a new IR image is loaded or not Syntax object KeepAnalysis keep keep object KeepAnalysis Description The ThermaCAM Researcher For example Session1 object Boolean TRUE do keep the current analysis FALSE do
76. viewing IR images from disk or viewing live images from the camera Syntax object SetCameraSource flag Description The ThermaCAM Re For example Session1 searcher object Select image source TRUE View live images FALSE View disk images 4 69 SetFrameRate Method Despite its name this method sets the image rate of the current connected camera Syntax bResult object SetFrameRate dbllmageRate Description object The ThermaCAM Re For example Session1 searcher object dbllmageRate New image rate as double 100 Hz for example precision float value Publ 7559011 Rev a318 ENGLISH EN February 20 2009 67 4 Methods em bResult TRUE if the rate could be set NOTE The image rate will be rounded to the nearest Hz NOTE The method will not succeed if the camera is unable to produce exactly the required image rate 4 70 Setinverted Method Use the SetInverted method to invert the current image palette Syntax object Setlnverted flag Description The ThermaCAM Re For example Session searcher object Invert flag TRUE Invert current palette FALSE Normal current palette 4 71 SetPalette Method Use the SetPalette method to set a particular colour palette Syntax object SetPalette oname Description The ThermaCAM Re For example Session1 searcher object String palette name GREY GREY10 IRON IRON10 MEDICAL RAIN
77. vision 900 and Thermovision 1000 format or not Syntax object Save900Analysis flag flag object Save900Analysis 30 Publ T559011 Rev 318 ENGLISH EN February 20 2009 3 Properties Description The ThermaCAM Researcher For example Session1 object Boolean TRUE do save the analysis in the image FALSE don t NOTE The image format obtained when the analysis is saved in the image is not compatible with the normal Thermovision 900 image format Such new images are not recognised by the Thermovision 900 system controller 3 71 ShowAnalysis Property Set or get the flag indicating if analysis symbols shall be displayed at all on the IR image Syntax object ShowAnalysis flag flag object ShowAnalysis Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Display the analysis symbols FALSE Dont NOTE This property does not apply to the flying spot function 3 72 ShowAnalysisBackColor Property Set or get the flag indicating if the analysis symbol label shall be drawn transparently or not Syntax object ShowAnalysisBackColor flag object ShowAnalysisBackColor Description The ThermaCAM Researcher For example Session1 object Boolean TRUE Analysis symbol lables are not transparent FALSE They are Publ 7559011 Rev a318 ENGLISH EN February 20 2009 31 3 Properties NOTE Chang
78. xtCmtByName Method 65 RemoveRecTextCmt Method 64 RestoreAnalysis Method 65 RestoreObjParameters Method 65 SaveAreaAsCsv Method 65 Savelmage Method 66 SaveSession Method 67 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 methods continued SetCameraSource Method 67 SetFrameRate Method 67 Setlnverted Method 68 SetPalette Method 68 SetPlayRate Method 68 SetScaling Method 69 StepBackward Method 69 StepForward Method 70 SubtrGetResultImage Method 70 SubtrSaveOutput Method 70 SubtrSetOptions Method 71 SubtrSetOutputDir Method 72 SubtrSetOutput Method 71 SubtrSetReference Method 72 SubtrSetScale Method 73 SubtrSetSource Method 73 Motor Property 23 N NewSession Method 61 ObjectDistance Property 23 OLELiveLinkDelay Property 23 OpenSession Method 61 P PlayBackward Method 62 PlayForward Method 62 PlayStop Method 62 PreferredlROutput Property 24 product warranty vi properties AmbientTemperature Property 5 AnalysisDistance Property 5 AnalysisEmissivity Property 5 AnalysisLabel Property 6 AnalysisTemperature Property 6 AtmosphericTemperature Property 7 AutoMaxTemperature Property 8 AutoMinTemperature Property 8 BBRange Property 9 CalcWhileMovingAna Property 9 CameraFilter Property 10 CameraLens Property 10 CameraLevel Property 10 Camera Property 9 CameraRangeMax Property 11 CameraRangeMin Property 11 CameraS
79. ysis Property 30 78 SaveAreaAsCsv Method 65 Savelmage Method 66 SaveSession Method 67 SetCameraSource Method 67 SetFrameRate Method 67 Setlnverted Method 68 SetPalette Method 68 SetPlayRate Method 68 SetScaling Method 69 ShowAnalysisBackColor Property 31 ShowAnalysis Property 31 ShowAnalysisTemp Property 32 ShowllegTemplndicator Property 32 ShowLabels Property 33 ShowTemperatureScale Property 33 StepBackward Method 69 StepForward Method 70 SubtrGetResultlmage Method 70 SubtrSaveOutput Method 70 SubtrSetOptions Method 71 SubtrSetOutputDir Method 72 SubtrSetOutput Method 71 SubtrSetReference Method 72 SubtrSetScale Method 73 SubtrSetSource Method 73 support technical 1 T TargetMotion Property 33 technical support 1 TemperatureUnit Property 34 Totallmages Property 34 trademarks vi U UselmageObjParams Property 35 UselmageScale Property 35 UselmageZoom Property 35 V Version Property 36 View3D Property 36 Visible Property 36 warranty 2 Zoomfactor Property 37 Publ No T559011 Rev a318 ENGLISH EN February 20 2009 Index 2 Publ 7559011 Rev a318 ENGLISH EN February 20 2009 79 A note on the technical production this manual This manual was produced using XML the eXtensible Markup Language For more information about XML please visit http www w3 org XML A note on the typeface used in this manu

User`s Manual OLE Automation - FLIR Customer Support Center

Contents

Download Pdf Manuals

Related Search

Related Contents