harout™ manual - weeblyharotek.weebly.com/uploads/4/2/7/8/42789373/harout... · 2018. 10. 10. ·...

HaroUT™ manual

LabVIEW™ library forultrasonic phased arrays

User guide2018

Version: 1.0

HaroUT™ Manual version 1.0

2 / 206

This page was intentionally left blank


3 / 206

Table of ContentsWhite page .................................................................................................................................2Overview of HaroUT™ ...............................................................................................................7Version History ...........................................................................................................................8Copyrights ...................................................................................................................................9Software Licenses ....................................................................................................................10Requirements ............................................................................................................................11Installation .................................................................................................................................12How to get Help .......................................................................................................................13

Cursor tips ..........................................................................................................................14Context Help .......................................................................................................................15Manual ................................................................................................................................16

Programming principles ............................................................................................................17Development Architecture ..................................................................................................18UT Data Classes ................................................................................................................22

HaroUT library ..........................................................................................................................23Calculator API .....................................................................................................................24

Calculator UI .................................................................................................................25Description of Calculator UI ...................................................................................26

Instructions .......................................................................................................27Calculations ......................................................................................................31Directory structure ............................................................................................32Main Window ....................................................................................................33

Probe parameters .......................................................................................38Element positions within arrays .................................................................43Focal law parameters .................................................................................44

Refracted angle ....................................................................................50Skew angle ...........................................................................................51

Sample parameters ....................................................................................52Settings .............................................................................................................54

Search parameters .....................................................................................56Application tab ............................................................................................58

3D Viewer .........................................................................................................59Delay Plot .........................................................................................................61About ................................................................................................................63Progress bar .....................................................................................................64Error or Warning dialog ....................................................................................65File formats .......................................................................................................67Export Delays ...................................................................................................69

Disable elements ........................................................................................72Delay Calculations ........................................................................................................74

PAUT Class ............................................................................................................75Calculate Delays ..............................................................................................79Create Setup Array ..........................................................................................80Create Focal Laws ...........................................................................................81


4 / 206

PZT Element Class ................................................................................................82Delays .....................................................................................................................83Max error ................................................................................................................84RMS error ...............................................................................................................85

Ultrasonic Data ...................................................................................................................86Ascan Data ...................................................................................................................87

Ascan to Graph ......................................................................................................88Sscan Data ...................................................................................................................89

Init From Ascans ....................................................................................................90Sscan Plot ..............................................................................................................91Extract Ascan .........................................................................................................92

Focal Law .....................................................................................................................93Hardware API .....................................................................................................................94

Olympus ........................................................................................................................95Programming ..........................................................................................................96

Open FocusPX .................................................................................................97Close FocusPX .................................................................................................98Connect FocusPX ............................................................................................99Get List of FocusPX .......................................................................................100Stop Server ....................................................................................................101

Acquisition ............................................................................................................102Start Acquisition .............................................................................................103Stop Acquisition ..............................................................................................104Set PRF ..........................................................................................................105Set Encoder ....................................................................................................106Set Firing Mode ..............................................................................................107

Processing ............................................................................................................108Set Rectification Mode ...................................................................................109Set Scaling Mode ...........................................................................................110Set Filter .........................................................................................................111Set Smoothing Filter .......................................................................................112Get List of Digital Filters ................................................................................113Get List of Smoothing Filters .........................................................................114Set Ascan Averaging ......................................................................................115

Signal Control .......................................................................................................116Set Group Gain ..............................................................................................117Set Start Time ................................................................................................118Set Time Range .............................................................................................119Set Voltage .....................................................................................................120Set Pulse Width ..............................................................................................121Set Ascan Compression .................................................................................122Set Sync Gate ................................................................................................123Get Pulser Voltage List ..................................................................................124

UT groups .............................................................................................................125Add Conv Group ............................................................................................126Add PA Group ................................................................................................127


5 / 206

Change Focal Laws .......................................................................................128Remove Group ...............................................................................................129

Digital IO ...............................................................................................................130Set Digital Input ..............................................................................................131Set Digital Output Line ...................................................................................132Get Digital Input States ..................................................................................133

LAW File ...............................................................................................................134Create LAW file from Text ..............................................................................135Read LAW file ................................................................................................136

Events ...................................................................................................................137Server Connection ..........................................................................................138Server Error ....................................................................................................139FocusPX Connection ......................................................................................140List of FocusPX ..............................................................................................141Text Message .................................................................................................142Filter List .........................................................................................................143Smoothing Filter List ......................................................................................144Digital Input States .........................................................................................145UT Group Added ............................................................................................146Pulser Voltage List .........................................................................................147

Olympus US Data ................................................................................................148Olympus Ascan ..............................................................................................149Olympus Sscan ..............................................................................................150

Controls ................................................................................................................151Encoder Types ...............................................................................................152Firing Modes ...................................................................................................153Conventional UT Parameters .........................................................................154Rectification mode ..........................................................................................155Scaling mode ..................................................................................................156Ascan Averaging ............................................................................................157UT Group Type ...............................................................................................158Digital Output Line ..........................................................................................159Digital Filter Class ..........................................................................................160

Parameters to String ................................................................................161Examples ..........................................................................................................................162

Calculator ....................................................................................................................163Calculator Setup ...................................................................................................164

Olympus ......................................................................................................................169Commands ...........................................................................................................170Sscan ....................................................................................................................175SubVIs ..................................................................................................................178

Select FocusPX Dialog ..................................................................................179Select Digital Filter .........................................................................................180Extract Group from tree .................................................................................181

Controls .............................................................................................................................182Position .......................................................................................................................183


6 / 206

Utilities ..............................................................................................................................184Progress Bar FG ........................................................................................................185Tree .............................................................................................................................186

Creating an executable ..........................................................................................................187Olympus ............................................................................................................................188

Troubleshooting ......................................................................................................................192List of Common HaroUT LabVIEW Errors .......................................................................193Calculator ..........................................................................................................................194Hardware API ...................................................................................................................199

Olympus ......................................................................................................................200Debugging ..................................................................................................................204

References ..............................................................................................................................205Contact information ................................................................................................................206


7 / 206

Overview of HaroUT™ HaroUT™ is a library of functions for phased-array ultrasonics compatible with LabVIEW™ fromNational Instruments. The HaroUT library includes an ultrasonic delay calculator that can calculate time delays for ultrasonicphased arrays. The calculator can be accessed through a Calculator API, either through a userinterface (Calculator UI) or programmatically through specific Delay Calculations VIs. The calculatorcan calculate the delays between the elements of single or dual phased-array configurations to focusultrasonic waves onto target points in samples of different shapes. Several target points can beselected for given phased array and sample configurations by selecting among a choice of scan types. The HaroUT library also includes APIs to programmatically access phased-array hardware. The list ofmanufacturers that HaroUT API covers is given below: Olympus


8 / 206

Version History Manual Version History

Manualversion

HaroUT™ version

Date Modifications

1.0 1.0.0.0 Sept 27th,2018

First release

HaroUT library version history

HaroUT™version

Date Modifications

1.0.0.0 Sept 27th,2018

First release


9 / 206

Copyrights Copyright © 2018 HaroTek LLC. All rights reserved. It is strictly forbidden to copy any section of this manual in any paper or electronic form for any purposenot directly linked to the HaroUT applicaiton without the explicit and written consent of HaroTek. The HaroUT logo is a trademark of HaroTek LLC. Copyright © 2016 National Instruments Corporation. All rights reserved. Microsoft and Windows are trademarks of Microsoft Corporation. Olympus is a registered trademark of Olympus Corporation, Olympus America Inc.


10 / 206

Software Licenses Copyright © 2018 by HaroTek LLC. All Rights Reserved The text of the license is provided in the distribution directory under the name "HaroUT_License.txt".


11 / 206

RequirementsGeneric Requirements - Windows Vista, 7, 8, or 10, 32 or 64 bits. - 4 GB of RAM. - National Instruments 32 or 64-bit LabVIEW 2016 or later. Requirements for Olympus FocusPX API: - FocusPX from Olympus. - Dedicated Gigabit network. - Gigabit network card and router (if one is used) that support Jumbo Frames (> 9014 bits per frame).

https://www.olympus-ims.com/en/focus-px/?gclid=Cj0KCQjwrszdBRDWARIsAEEYhrdK34grxQmkRSZ9xa-4iLm6sa-tkgnPAkT7HrYAJmSHtBz5ZQLW9jAaAswJEALw_wcB


12 / 206

Installation Use VIPM from JKI to download from the LabVIEW Tools Network or to install the .vip file provided byHaroTek. The package requires VIPM 2017 or later. Some functionalities require Microsoft Visual C++ 2017 redistributable for x86 processor(support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads). Install all the drivers required for the hardware that you intend to use with this library, using the originalmanufacturer instructions.

https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads


13 / 206

How to get Help Additional information on HaroUT features can be obtained from the cursor tips, context help, or fromthe manual. If help is still required, HaroTek can be contacted.


14 / 206

Cursor tips The cursor tip is a small sentence shown at the cursor when it is hovering over an application control.Below is shown an example of a cursor tip.


15 / 206

Context Help Most of this library VIs have a description that can be read within the VI properties dialog or throughthe Context Help window in LabVIEW. In most cases, the context help window also provides additional information from the manual when the

small help button is blue. Clicking this button opens the HaroUT context help manual at the related

location in the manual. If no additional help is available, the small help button is grayed out: .


16 / 206

Manual The HaroUT manual provides information about the use of the application but also about licenses,requirements, installation, etc. The manual is provided in two formats: as a Windows context helpfile (HaroUT_help.chm) located in the data directory and that can be accessed through the contexthelp window, and as a .pdf file (HaroUT_manual.pdf). A copy of the manual is copied in the HaroUTapplication directory by the installer. The two formats should contain the same information unless theversions of the two files are not the same.


17 / 206

Programming principles Advices on how to develop your application using the HaroUT library.


18 / 206

Development Architecture

The HaroUT library employs extensively LabVIEW User Events. The user events give to the developedapplication the ability to react on demand at external device outputs. The user events are handledin LabVIEW through event structures, located in the Structures sub-palette of the block diagramFunctions palette. Below is an example on how two while loops can be used, each loop containing an event structure.Two types of user events originate from the ultrasonic devices: Info events and Data events. Infoevents provide informaiton about the status of the device. Data events provide the actual data providedby the device. HaroTek suggests to use at least two loops to handle those two types of events, as illustrated in theblock diagram example shown below. The top while loop handles the user interface and the device infoevents. The bottom loop handles the data event from the device. The approach proposed here canalso be combined with either a State Machine or a Queued-Message-Handler design pattern. Evenbetter, this approach can be integrated with a full development framework like Actor Framework orDQMH from Delacor. Notice that the approach proposed below presents a significant drawback. Data from the FocusPXis sent to the Data loop through the same channel, events, than the control commands from the UIloop. If for some reasons data processing is slower than data acquisition, data from the FocusPXaccumulate in the event buffer and any command from the UI loop to the Data loop will be processedwith a delay that might be very significant, preventing to shut down the application. The solution tothis problem is to use another channel than events to control the Data loop, like a queue for example.The problem with this approach is that the loop must go through a case that checks if a command wassent by the UI loop. If no command is sent, the loop continues. The check for data requires to wait aminimum timeout of 1 ms. The data loop can then only process data at a maximum rate of 1 kHz. Bothapproaches have their advantages and drawbacks and the programmer has to decide which one is thebest for his current project.


19 / 206

User Interface Loop

Loop handling the user interface and the information provided by the device. The informationevent from the device does not include data.

Info Event Data Handlers

The HaroUT library provides specific VIs to handle the data associated with each informationevent from devices. Those VIs are available within the HaroUT palettes under Events.

Info Event Handling


20 / 206

Each information event provides Event name and Data. Event name is an enum listing allpossible information events from the device. This enum should be connected to a casestructure in which each case would handle the data associated with the corresponding eventusing the data handlers provided by the HaroUT library.

Starts Communication Server

Starts the server that handles communication with the device. Typically, communicationwith the ultrasonic device is initiated using an additional step after the connection with theserver has been established. The communication with the server is established when acorresponding information user event has been received by the UI Loop.

Closes Communication Server

Closes the communication server and connection with the device.

Data Loop

Data loop handling the data provided by the device. Using a separate loop for data acquisitiontypically improves data throughput and responsivity of the user interface.

UI Loop Event

A LabVIEW user event is created to provide the Data Loop a mean to communicate to the UILoop. The Data loop need to communicate with the UI Loop if an error occurs in the Data Loopfor example.


21 / 206

Data Loop Event

A LabVIEW user event is created to provide the UI Loop a mean to communicate to the DataLoop. The UI Loop needs to communicate with the Data Loop at the time of terminating theapplication for example.

Info Event

Info event within the event structure of the UI Loop.

Data event

Data event within the event structure of the Data Loop.


22 / 206

UT Data Classes Ultrasonic data are handled using LabVIEW classes. The Ascan class contains the data and information associated with a specific A-scan (ultrasonicamplitude signal as a function of time). The Sscan class contains data and information associate with an array of A-scans, each onecorresponding to a different propagation angle.


23 / 206

HaroUT library The HaroUT library palette is installed in a HaroTek palette located in the Addons sub-palette of theFunctions palette.


24 / 206

Calculator API

<TODO>: Insert description text here... And don't forget to add keyword for this topic


25 / 206

Calculator UI

Opens the user interface of the HaroUT delay calculator and outputs the results. Calculations resultsare provided as PA Config Text that is a string corresponding to the LAW file of the delays, and as aPAUT class object. Details about the user interface of the calculator can be found at Description of Calculator UI Input parameters error in (no error) Input error. VI is not executed

if an error is present.Standard LabVIEW error cluster.

Output parameters PA Config Text String. Text of the corresponding LAW file for the

calculated delays.

PAUT class PAUT object.

error out Standard LabVIEW error cluster.


26 / 206

Description of Calculator UI Description of the main features of the HaroUT Calculator UI.


27 / 206

Instructions

Here is a short set of instructions on how to run a calculations. The Main Window is displayed. Use the Main Window to configure the calculation parameters.

Configure the Probe parameters Click on the Probe tab

Configure the parameters

1. Select a type of probe configuration: Dual or Single 2. Select the other parameters of the of the probe. or


28 / 206

Load probe parameters from a probe file by clicking

A set of example probe files is placed in the application Probes sub-directory by the installer. Configure the focal law parameters Click on the Focal law tab


1. Select the scan type: None, Sound path, Vertical, Constant depth, or Linear. 2. Select or enter the other parameters of the focal law field

Configure the sample parameters Click on the Sample tab


29 / 206


1. Select the sample configuration: Plate, Ball, or Pipe 2. Change the other parameters of the sample field.

Alternatively, all parameters can be selected by loading a previously saved result or a configuration file.

Load result

or

Load config

A set of example configuration files is placed in the configuration directory by the installer. Press Calculate


30 / 206

Progress bar dialog indicates when the calculations are completed. Verify that results are satisfactory Check the RMS and Max errors. Look at the delays using the Delay viewer or at the rays using the 2D Display or the 3D Viewer. Export the delays Select the format and save the delays using the Export Delays dialog.


31 / 206

Calculations After completing a set of calculations, the focusing position of the ultrasonic rays can be comparedwith the target position. The distance between the focusing position of each ray and the target point is calculated and thesum of the square roots of the square of distances is averaged (RMS). The maximum distance of allfocusing rays is extracted as well. Those two values are defined as the RMS and Max errors in mmand are shown in the Status info area of the Main Window along with completion time after completionof calculations. The RMS and Max errors can be decreased by increasing the Iteration and cycle values of the Searchparameters, at the cost of longer calculation times, or by decreasing the Accuracy value. In general,the Max error value should be around the Accuracy value, and the RMS error should be slightlysmaller. Max errors significantly larger than the RMS error indicate that some rays might not havefocused at the proper location. In general, it is useless to attempt to make the Max and RMS errors significantly smaller than a fractionof the ultrasonic wavelength in the sample.


32 / 206

Directory structure Example of the organization of folders for the calculator. By default, the calculator looks for theHaroUT_default_config.hfg file that contains the parameters of the last calculations. If this file is notpresent, the calculator uses default parameters. When looking for probe parameters files, the calculator UI looks for a Probes folder located in thesame directory than the project file. When looking for configuration files, the calculator UI looks for a Configurations folder located in thesame directory than the project file.

The Probes directory is the directory where probe parameter files are loaded from and saved to bydefault. The files shown in the Probes directory above are only examples and can be different for anyparticular installation. The Configurations directory is the directory where user configuration files are loaded from and savedto by default. The files shown in the Configurations directory above are only examples and can bedifferent for any particular installation.


33 / 206

Main Window

The Main window is the window that is displayed when running the Calculator UI VI. To quit the application, close the Main Window using the x-box in the top right corner.

Open results

Loads previously saved results. The results are saved in a binary file format with a .hutextension. If the file that is loaded does not have any calculation result, the configuration isloaded and the current calculation results, if present, are removed from memory.

Save results

Saves current results. The calculation results are saved in a binary file format with a .hutextension along with the . If there is currently no calculation results in memory, the currentconfiguration is saved wihtout results.

Save config


34 / 206

Saves all current configuration parameters into a file that can be loaded at a later time. Thedefault directory is \Configurations in the HaroUT application directory but another directorycan be selected by the user.

Load config

Loads all calculation parameters from a configuration file that had been previously saved. Thedefault directory is \Configurations in the HaroUT application directory but another directorycan be selected by the user.

Export Delays

Opens the Export Delays dialog to select the file format to export the ultrasonic delays.

Settings

Opens the Settings dialog window to change the settings of the calculations and of theapplication.

Calculate

Starts the calculations of the ultrasonic rays and delays using the parameters currentlyselected. During the calculations, the progress bar dialog is displayed.

3D Viewer

Opens the 3D viewer window.The window will not open if there is currently no calculationresults to display.

Delay Plot

Opens the Delay plot window. The window will not open if there is currently no delays inmemory to display.


35 / 206

Context help

Opens the context help window.

About

Opens the About dialog.

2D Display

The 2D Display provides a real-time feedback during the setup of a calculation, and gives atwo-dimensional representation of the calculation results along either the X-Y or Y-Z planes.The current representation is indicated by an optional 2-axis coordinate system in blue locatedat the origin in the 2D Display. The plane can be seleted using the 2D Display Plane selector.The 2-axis coordinate system can be shown or hidden using the Application tab of the Settingsdialog. During the setup of the calculations, the first row of piezoelectric elements are shown in the2D Display as red dots (see figure below). The sample is also shown. Notice that the planeX = 0 or Z = 0 (depending of the displayed plane) of the sample is drawn in the 2D display. In the case of a ball, the 2D drawing might not represent the actual interface between thesample and the probe. The green dot shows the position (X distance, -Depth, 0) for bothrepresentations.


36 / 206

Parameter Selector

Tab to select the parameter fields: Array parameters, Focal law parameters, and Sampleparameters.

Plotted row

Selects the rays of which row of the array are displayed in the 2D Display. This parameter isa roll-down menu that offers only the available values. The value of Plotted row controls theZ index of the displayed X row when the 2D Display plane is X-Y and the value of Plotted rowcontrols the X index of the rays emerging from a Z row (see Element positions within arrays formore info). The index refers to the position in the array (starting at 1). The rays that are plottedare the projection in the 2D Display representation plane of the rays. For dual arrays, the indexrefers to each individual array. Therefore, for dual arrays, there are 2 rows (one per array) thatare displayed in the 2D Display.


37 / 206

Notice that the red dots representing the elements of the first row of the array are alwayspresent, even if the plotted row is not the first one.

Plotted law

The Plotted law is a roll-down menu that presents the refracted angles or the elements (forlinear scans) that are available to display. This value affects the display in the 2D Display, inthe Delay Plot, and in the 3D Viewer.

Skew angle

The Skew angle is a roll-down menu that presents the skew angles that are available todisplay. This value affects the display in the 2D Display, in the Delay Plot, and in the 3DViewer.

Status info

Information about the status of the application. The information provided can be the name ofthe previously loaded file, the name of an opened window, the latest error, time and errors ofthe latest calculations, or any other information.

2D Display Plane selector

Selects which plane, X-Y or Y-Z, is displayed in the 2D Display. The value of Plotted rowcontrols the Z index of the displayed X row when the 2D Display plane is X-Y and the valueof Plotted row controls the X index of the rays emerging from a Z row (see Element positionswithin arrays for more info).


38 / 206

Probe parameters

Parameter field that defines the physical properties of the array of pzt elements and the wedge.

Type

Selects if the phased array is a single or dual array. Notice that when Single array is selected,the 2D Display is oriented parallel to the X-Y plane, whereas when Dual-array is selected, the2D Display is oriented parallel to the Y-Z plane.

Load probe parameters

Opens a dialog to select a file containing the parameters of a probe that were previouslysaved using the "Saves probe parameters". The new parameters replace the current probe


39 / 206

parameters. The default directory is \Probes in the HaroUT application directory but anotherdirectory can be selected by the user.

Save probe parameters

Opens a dialog to select a file where the current the probe parameters will be saved. Theparameters can be loaded at a later time using the Loads probe parameters button. Thedefault directory is \Probes in the HaroUT application directory but another directory can beselected by the user.

Wedge velocity

Ultrasonic velocity in the wedge. The units are in meters per second (m/s).

Wedge angle

Angle between the X direction of the array and the X coordinate axis. Notice that in the case of dual arrays, this roof angle isapplied first, and then the wedge angle is applied. The images of the 2D display below illustrate the wedge angle relative to the Xcoordinate axis in the case of a single array. Additional information about the Wedge angle can also be seen at the page Refractedangle.

Length

Length in mm along the X-axis between the first row of elements along the Z axis and the end of wedge. This parameter is used fordisplay purposes and is not used in the calculations.


40 / 206

Height

Height of the lowest pzt element relative to the X-Z plane. In the case of a 1D array, the lowest element is the first X element. Theimages of the 2D display below illustrate the height for the cases of a plane and of a sphere. Notice that the height is relative tothe X-Z plane and not relative to the sample. Additional information about the Height parameter can also be seen at the pagesRefracted angle and Skew angle.

Probe number of elements along X


41 / 206

Total number of elements in the X direction (primary axis) of the array (see Element positionswithin arrays). This parameter is not used in the calculations and is only used to represent thetotal length of the array in the 2D and 3D views. The number of elements in the X directionis represented by red dots in the 2D display in the X-Y plane view. The value used in thecalculations is the number of elements X of the focal law parameters.

Pitch X

Distance between the elements in mm in the X direction, assuming that the Wedge angle isequal to 0°. See Element positions within arrays for more information.

Probe number of elements along Z

Total number of elements in the Z direction (secondary axis) of the array (see Elementpositions within arrays). This parameter value is automatically applied to the number ofZ elements of the focal law parameters which is disabled and grayed out. The number ofelements in the Z direction is represented by red dots in the 2D display in the Y-Z plane view.The linear scan parameters of the focal law parameters are enabled only then the Number ofelements along Z is equal to 1.

Pitch Z

Distance between the elements in mm in the Z direction, assuming that the Wedge angle andthat the Roof angle parameters are both equal to 0°. See Element positions within arrays formore information.

Roof angle

Enabled only for dual arrays. The roof angle is defined by the angle between the edge of the array and the Z-axis when the arrayis rotated around the X-axis, assuming that the value of the Wedge angle is 0°. The roof angle is first applied (rotation aroundthe X-axis), and then the Wedge angle is applied, corresponding to a rotation around the Z-axis. The Roof angle parameter isillustrated in the two images of the 2D display below. Additional information about the Roof angle parameter can also be seen atthe page Skew angle.


42 / 206

Separation

Enabled only for dual arrays. Separation in mm along the Z-axis between the two arrays forming the dual array. The separationis the distance along the Z-axis of the center closest elements of each array. The images of the 2D display below illustrateseparation parameter.


43 / 206

Element positions within arrays In HaroUT, the individual piezoelectric elements of each array are aligned along the X and Z axes ofthe coordinate system assuming that the Wedge angle and the Roof angle are equal to 0°. The figuresbelow illustrate how the positions of the elements are defined in each array.

The positions of the piezoelectric elements are defined as a rectangular array along the X and Z axesof the coordinate system for values of Wedge angle and Roof angle of 0°. Each element positionis defined by the element number (indexed to 0) in the X and Z direction multiplied by the X and Zpitches. In that situation, the coordinate system Xa-Ya-Zz of each array is parallel with the worldcoordinate system X-Y-Z (left figure above). Therefore, if the values of angle and/or roof angle are different from 0°, the position of the individualelements within the array are still defined according to the situation illustrated by the left figure eventhough in reality the elements are positioned according to the coordinate system Xa-Ya-Zz of eacharray that is not parallel anymore with the word coordinate system X-Y-Z (right figure above). 1D array are defined along the X-axis only.


44 / 206

Focal law parameters

Scan type

Type of scan. Can be selected from a choice of five different types: None, Sound path, Vertical, Constant depth, and Linear. Each typeis described below. None No scan. A single target point is selected and this target point is illustrated in the 2D Display by a green point. The position (X,Y,Z) ofthis target point is defined by the Length parameter of the Array parameters and by the Depth parameter of the Focal law parametersand is equal to (Length, -Depth, 0). The Z value of this target point (and of all target points in general) is 0. Sound path Scan using the Angle scan parameters, with the target points being at a constant distance from the reference point equal to Depthfor each of the scan angles. The distance and the scan angles are calculated relative to a reference point at the sample surface andrelative to the Y axis. The reference point is the intersection of the normal of the arrays from the centers of the arrays along the X axis


45 / 206

with the sample surface. The figures below illustrate the Sound path scan type for a plate and for a pipe. Notice that the length of eachdashed green line is equal to the Depth value. The Z value of all target points is 0.

Vertical Scan using the Angle scan parameters, with the target points being at a X coordinate equal to X distance for each of the scan angles.The scan angles are calculated relative to a reference point at the sample surface and to the Y axis. The reference point is theintersection of the normal of the arrays from the centers of the arrays along the X axis with the sample surface. The figures belowillustrate the Vertical scan type for a plate and for a pipe. The Z value of all target points is 0.

Constant depth


46 / 206

Scan using the Angle scan parameters, with the target points being at a Y value equal to -Depth for each of the scan angles. Thescan angles are calculated relative to a reference point at the sample surface and relative to the Y axis. The reference point is theintersection of the normal of the arrays from the centers of the arrays along the X axis with the sample surface. The figures belowillustrate the Vertical scan type for a plate and for a pipe. The Z value of all target points is 0.

Linear The linear scan type is available only for 1D (Number Elements Z = 1) arrays (single or dual) and uses the Linear scan parameters.If Number Elements Z is larger than 1, the Linear item of the Scan Type list is disabled. If the Linear item is selected when theparameters are changed to a situation where the Linear scan is no longer possible, the scan type is switched to None. The Linear scantype creates a focal law for a number of elements of the 1D array equal to Number Elements X, starting at element # Start and focusingon the target point at position (Length, -Depth, 0). Creates new focal law for the same number of elements starting at Start + i*stepwhere i varies between 0 and (Stop-Start+1)/step. The target point is moved for each new law in the X direction by a distance equal toPitch X * Step * cos(Wedge angle). For a linear array (No of elements Z = 1) probes (single and dual array), the Start parameter is used to position the first element of thefocal law for all types of scans.

Law number of elements along X

Number of piezoelectric elements used in the focal law in the X direction of the array.

Law number of elements along Z

Number of piezoelectric elements used in the focal law in the Z direction of the array. Thisvalue cannot be changed and is always equal to the number of elements of the probe in the Zdirection.


47 / 206

Depth

When there is no scan of the focal laws (Scan type equal to None), -Depth is the Y value of the target point. For Constant depthscans, -Depth is the Y value of all target points. For Sound path scans, Depth is the distance between the reference point andthe target points for all angles. The figures below illustrate the Depth in the 2D Display. The green point in the 2D Display alwaysrepresents the position (Length, -Depth) even for Scan types different from None.

X distance

The X distance is used to define the X-coordinate of the target point when a single point isdefined, and the X-coordinate of the series of target points when the Vertical scan is selectedin the focal law parameters. The (X, Y) position of the green point in the 2D display is equal to(X distance, -Depth). See the image of the 2D display below. Additional information about theX distance parameter can also be seen at the page Refracted angle.

Refracted Angle scan parameters

Parameters used to define the Sound path, Vertical, and Constant depth scans. Units are in degrees. Creates focal laws for anglesstarting at Start and ending at Stop by step equal to Step. The angles of the focal laws are equal to Start + i * Step where i is aninteger that varies between 0 and (Stop-Start)/step. Therefore, Start must be lower than Stop if Step is positive.


48 / 206

The refracted angles in the sample are calculated relative to the projection of the normal of the phased array from the center of thephased arrays to the sample surface. In case of a dual arrays, the center of the array is the combination of both individual arrays.According to this definition, the projection on the sample surface is therefore always in the plane z = 0. The figure below illustrateshow the refraction angle is calculated. More details can be obtained at Refracted angle.

Skew Angle scan parameters

Parameters used to define the values of Skew angles for the Sound path, Vertical, and Constant depth scans. Units are indegrees. Creates focal laws for skew angles starting at Start and ending at Stop by step equal to Step. The skew angles of thefocal laws are equal to Start + i * Step where i is an integer that varies between 0 and (Stop-Start)/step. Therefore, Start must belower than Stop if Step is positive. A skew angle of 0° is always used for linear arrays. The skew angles in the sample are calculated relative to the projection of the normal of the phased array from the center of thephased arrays to the sample surface. In case of a dual arrays, the center of the array is the combination of both individual arrays.According to this definition, the projection on the sample surface is therefore always in the plane z = 0. The skew angle is definedas the angle between the Y = 0 axis and the projection of the target point in the X = 0 (Y-Z) plane.The figure below illustrates howeach skew angle is calculated. More details can be obtained at Skew angle.


49 / 206

Linear scan parameters

Parameters used to define the Linear scan. Start is the first element of the first law and Stopis the first element of the last law. Creates focal law for first elements equal to Start + i*stepwhere i an integer that varies between 0 and (Stop-Start)/step. Therefore, Start must be lowerthan Stop if Step is positive.


50 / 206

Refracted angle Illustrations of the definitions of configuration parameters and of the refracted angle in the X-Y plane.The refracted angle is calculated relative to the normal of the entry point of the central ray of theultrasonic beam.


51 / 206

Skew angle Illustrations of the definitions of configuration parameters and of the skew angle in the Y-Z plane forsingle and dual arrays. The skew angle is defined as the angle between the projection in the X-Z plane of the ultrasonic beam(central ray) in the sample and the primary axis. Skew angle for single array.

Skew angle for dual array


52 / 206

Sample parameters

Sample configuration

Sample configuration: Plane, Cylinder, or Sphere. For the cylinder configuration, the cylinderaxis is oriented along the Z axis for single arrays and along the X axis for dual arrays. TheCenter and Radius parameters are relevant only for the Cylinder and Sphere configuration andare therefore disabled for the plane configuration. For the plane configuration, the sample interface is always in the X-Z plane (Y = 0).

Sample velocity

Ultrasonic velocity in sample in meters per second.

Outer diameter

Outer diameter of the pipe or ball samples in mm. This parameter is disabled when the sampleconfiguration is plane.


53 / 206

Thickness

Thickness of the sample plate or wall thickness of a pipe. This parameter is used only fordisplay purposes and is not used for calculations. This parameter is disabled for Ball samples.

Pipe axis

Orientation of the axis of a pipe sample. The pipe axis can be parallel to the X or Z axes.Parameter is disabled for Plate and Ball samples.

Sample center

This parameter is disabled when the sample configuration is plane. Center of the cylinder orsphere in 3D coordinates in mm. For the cylinder configuration, the cylinder axis is orientedalong the Z axis for single arrays and along the X axis for dual arrays.


54 / 206

Settings

Accessed by clicking the Settings button of the Main window. No other functions of the application can be accessed when this dialog is open. To access otherfunctions, this dialog must be closed.

Reload default config

Reloads the default configuration in the HaroUT application. The configuration include theprobe, focal law, and sample parameters, and the search and application settings. Theconfiguration is loaded from the file HaroUT_default_config.hfg.

Save current config

Saves the current parameters as the default parameters of the HaroUT application. Thoseparameters will be loaded in the HaroUT application when the application is started or whenthe Reloads default configuration button is clicked. The parameters include the , phased array,


55 / 206

focal law, and sample parameters, and the search and application settings. The configurationis saved into the file HaroUT_default_config.hfg. Notice that the Save current config operationcannot be canceled after clicking this button, even if the Cancel button is clicked to close theSettings dialog.

Context help


Search param and App tabs

Clicking the tab to see and change the Search parameters or the Application settings.

OK button

Closes the Settings dialog and changes the settings in the current HaroUT session but thedefault settings will be reloaded upon restart of the HaroUT application unless the Save theCurrent configuration has been clicked.

Cancel button

Closes the Settings dialog and do not change the Settings of the current HaroUT session.


56 / 206

Search parameters

HaroUT uses an iterative approach to calculate the ultrasonic rays. The default parameters, as givenin the figure below, should provide an acceptable solutions in most cases. However, it is possible tochange those parameters if the need arises.

Iterations

Number of iterations per cycles. This number should be increased when the number of cyclesis decreased. For a single cycle, the angular resolution of the result is equal to Angle rangedivided by the number of iterations.

Accuracy

Value for which the iterations are stopped for a given ray if the currently calculated focal pointis found within a distance shorter than Accuracy from the target point. Setting this value to0 ensures that the absolute best solution is found at the cost of increased calculation times.However, there is no physical reason to find a solution having a distance from the target pointshorter than a fraction of the ultrasonic wavelength.

Angle range

Range of angles explored to find the solution. To find each ray, solutions within the range± Angle range / 2 are explored. The angular resolution of the possible solutions is equal toAngle range / (4^(Cycles-1) * Iterations). For very large angles, the Angle range might be toosmall and increasing it might help to find a solution. However, too large a value decreases thesolution resolution and might lead to false solution if the angle range exceeds Pi (3.14).

Cycles


57 / 206

Number of repetition of the iterations. For each cycle, the best solution is found and theangular range is decreased by a factor 4. A larger number of iterations should be used if thenumber of cycles is decreased.


58 / 206

Application tab

The application parameters are related to the 2D Display and do not affect the results of thecalculations.

2D X offset

Changes the position of origin of the coordinate system along the X axis in the 2D display. Anoffset of 0 sets the origin of the coordinate system on the left edge of the 2D display. Units arein pixel (not affected by the 2D Pix/mm value)

2D Pix/mm

Scale of the 2D Display. Number of pixels to represent 1 mm in the real world. A largernumber results in more details of a smaller portion of the setup.

2D Coord Syst

Shows or hides the representation of the coordinate systems at the origin of the 2D Display.This representation is useful to differentiate the orientation of the 2D Display (X-Y plane or Y-Z plane).


59 / 206

3D Viewer

Accessed by clicking the 3D Viewer button of the Main Window. The 3D viewer displays in 3D the calculated ultrasonic rays for the currently selected plotted law andskew angle.

Reset viewpoint

Repositions the camera to view the phased array(s) and the sample. Useful when the 3D pointof view has been changed using the cursor to the point where the results cannot be seenanymore.

Background


60 / 206

Current color of the background of the 3D display area. Can be changed by clicking thecolored square and selecting a different color. Each time the 3D Viewer is open, thebackground color reverts to black.

3D Display area

Area where the ultrasonic rays are displayed in 3D for the focal law currently selected inthe Main window. The rays in the wedge are in red, the rays in the sample are in green, thephased arrays are in blue. The origin of the coordinate system are shown in orange (notvisible in the figure above). The point of view can be changed by the following actions: Click and drag: Rotates the view in the direction of the drag.Shift-key click and drag up: Zoom in.Shift-key click and drag down: Zoom outControl-key click and drag: Pan in the direction of the drag.

Status information

Information about the 3D viewer. Shows information about the currently displayed focal lawand type of scan. Also displays the last error if any.


61 / 206

Delay Plot

Accessed by clicking the Delay Plot button of the Main Window.

Save delays

Save the currently displayed delays into a tab-delimited text file.

Plot area


62 / 206

Area where the delays in nanoseconds are plot as a function of the element position in therow. Rows are aligned along X-axis when the 2D Display plane value is X-Y and along Z-axis when the value is Y-Z. All rows are plotted for single arrays and one row for each arrayis plotted for dual arrays. The plotted rows are corresponding to the values of the controlsPlotted row, Plotted law, and Skew angle (Main Window).

Status information

Information about the Delay viewer. Shows information about the currently displayed focal lawand type of scan. Also displays the last error if any.


63 / 206

About

Accessed by clicking the About button of the Main window. No other functions of the application can be accessed when this dialog is open. To access otherfunctions, this dialog must be closed.


64 / 206

Progress bar

During relatively long operations, like calculations, a progress bar dialog is displayed. No otherfunctions of the application can be accessed when this dialog is open. To access other functions, eitherwaits until the operation is completed or cancel the operation by clicking the Cancel button.

Information area

Area where text information about the current operation is displayed.

Progress bar dialog

Indicates the progress of the operation currently displayed in the information area.

Cancel button

Cancels the operation currently in progress.


65 / 206

Error or Warning dialog

If an internal error occurs, the HaroUT application will display an error dialog giving information aboutthe error. The most important information is the Error number. Please, take note of that number if youcontact HaroTek about an error. The Error dialog gives the choice to the user to continue operating the application, to quit using thenormal process, or to abort and immediately terminate the application. No other functions of the application can be accessed when this dialog is open. To access otherfunctions, this dialog must be closed.

Error or Warning number

Most important information about the internal error or warning of the application. Take note ofthis number before contacting HaroTek.

Origin of error

Section of the code where the error originates. This information might help to determine the reason of the error.

Continue

In case of an error: closes the dialog, cancels all previously requested operations, and put theapplication in idle mode, ready to process new commands. In case of a Warning: closes thedialog and processes the requested operations as if no warning had occurred. In some cases,the dialog might immediately reappears. If this is the case, it might be necessary to press theQuit normally button.

Quit normally


66 / 206

For both Error and Warning: Closes the dialog and initiates the process to close the HaroUTapplication. In some cases, the dialog might immediately reappears. If this is the case, it mightbe necessary to abort the application.

Abort

For both Error and Warning: Closes the dialog and immediately terminates the applicationwithout going through the normal closing process.


67 / 206

File formats

HaroUT file formats There are three file types associated with HaroUT: configuration, probe, and results. These file typeseach have an associated extension and icon. If properly installed, double-clicking any file of that typeopens the HaroUT application and loads it, if the HaroUT application is not already started. If theapplication is already started, its window is brought to the front but the file is not loaded Configuration file *.hfg The configuration files contain all parameters for a given probe/focal law/sample combination. When aconfiguraiton file is loaded, all parameters are replaced with the parameters of the configuration file.

Configuration files can be saved or loaded using the save and load config buttons located in the toolbar of the Main Window. When saving or loading a configuration file, the application will open a standard Windows dialog firstlooking into the \Configurations sub-directory of the application. The HaroUT_default_config.hfg is a special case of configuration file that contains all parametersloaded at the start of the application. This file is located in the /data sub directory of the application.The parameters of the default configuration file can be changed by using the Settings window dialog. Probe file *.hpb The probe files contain all probe parameters. When a probe file is loaded, all probe parameters arereplaced with the parameters of the probe files. All other parameters are unchanged.

Probe files can be saved or loaded using the save and load probe parameters buttons located in the Probe parameters tab. When saving or loading a profe file, the application will open a standard Windows dialog first lookinginto the \Probes sub-directory of the application. Result file *.hut The result files contain all ray tracing data resulting from a calculation along with all calculationparameters. The result files contain the same information than a configuration file plus the ray tracing


68 / 206

data. When a result file is loaded, all parameters and current calculation data are replaced with theparameters and data of the result file. After loading, the RMS and Max errors for the loaded data aredisplayed in the Status info area of the Main Window.

Result file can be saved or loaded using the save and load results buttons located inthe toolbar of the Main Window.


69 / 206

Export Delays

Accessed by clicking the Export Delays button of the Main window.

Context help

Opens context help window.

Probe skew

Angle between the primary axis of the probe and the scanning direction in °. Range between0° and 359.9°. Angle is positive when moving from the positive scan axis direction towards thepositive index axis direction.

Beam gain

Gain applied for each focal law in dB. This value is set for all the focal laws of the current fileeven though it could be different for each focal law. Range: 0 to 80 dB. Default value is 0.


70 / 206

Excitation amplitude

Excitation amplitude applied to all elements in volts. Range: 50 to 200. Default value is 180.

Excitation width

Width of the excitation pulse in ns. Range: 50 to 500. Default value is 50.

Sum gain

Gain working range in dB. -1 is automatic mode. Range: -1 to 30. Default value is -1.

Electronic delay

Delay associated with the electronic hardware in ns and is characteristic of each particularsystem. This delay is added to the wedge delay (round trip) and to the law delay. Default valueis 0.

Filter

Specifies the filter applied at reception. Value is selected from a roll-down menu. Possiblevalues are: 0.5 to 20 MHz (no filter); 0.5 to 5 MHz; 2.0 to 10 MHz; and 5.0 to 15 MHz. Defaultvalue is 0.5 to 20 MHz (no filter).

Element order

Defines how the numerical values for order are assigned to the elements. Type 1 is forthe element order increasing with the primary and secondary axes. Type 2 is for elementsincreasing along the primary axis for even secondary axis index, and decreasing for oddsecondary index. Default value is Type 1.

Reference point


71 / 206

X-Z Position of the probe reference point relative to the origin point of the calculations. Forcalculations, the X = 0 is to the X value of the first element of the array and the Z = 0 is thecenter of the array. The X and Z axes of the calculations correspond to the primary andsecondary axes of the probe arrays when the wedge and roof angles are equal to 0°.

List of disabled elements

List of the elements that are currently software disabled. The list can be directly edited bytyping the element numbers separated by comas. The list can also be modified by clicking theDisable Elements button.

Disable elements button

Opens a dialog to disable elements by clicking.

OK button

Closes the current window and uses the current parameters to create the delay export file.

Cancel button

Closes the current window and cancels the delay export operation (no file is saved).

Export Delay to FocusPX

Exports the calculated delays directly to the currently connected FocusPX.


72 / 206

Disable elements

Context help


Enable / Disable PZT elements

2D representation of the pzt elements of the phased array probe. Each individual element canbe software disabled by clicking on it. Red is disabled and green is enabled.

OK button


73 / 206

Closes the window and lists the currently disabled elements. The disabled elements are listedin the disabled element list of the parameter dialog where additional changes can be made tothe list.

Cancel button

Closes the window and list no disable element.


74 / 206

Delay Calculations Ultrasonic delays and rays can be calculated programatically. This section presents the VIs to do it. Anexample is also available.


75 / 206

PAUT Class A PAUT Class object that contains the parameters and, after successfull calculations, of the results ofultrasonic delay calculations. The parameters of the calculations can be written and read using a property node and are:

Experimental Parameters Experimental Parameters can be written and read. Sample : Cluster containing the sample parameters.

Focal Laws : Cluster containing the focal law parameters to calculate the ultrasonic delays.


76 / 206

Probe :


77 / 206

Search Parameters : Cluster containing the search parameters for the iterative calculations.

Calculation Results Calculation Results can only be read. DataAvailable: Boolean. True if calculation results are available. False is not calculation results areavailable or if any experimental parameter is written to.


78 / 206

Delays : 5-D array of doubles. Each value represents the ultrasonic delay in nanoseconds of a specificpzt element for specific focal law relative to the pzt element having the shortest delay for the samespecific focal law. PZT Array : 5-D array of the PZT Element class. Below are examples on how to access the values from the PZT or Delays 5D array. Using auto-indexing and For Loops:

Using the index array function:


79 / 206

Calculate Delays

Calculates the delays for each of elements of the setup array using the current PAUT objectparameters. The Cancel and Progress DVRs are used to monitor, cancel, and report progress to a paralleloperation like a progress bar. Not used when Report progress is set to false (default value). Input parameters PAUT in Required. PAUT class object

Cancel DVR Data Value Reference of aboolean.

Monitors the value during the calculation tocheck if a cancel is requested. Not required ifReport Progress is false.

Progress DVR Data Value Reference of adouble

Progress of the calculation is reported to thevalue associated with the DVR. Values arebetween 0 (start) and 1 (end of calculations). Not required if Report Progress is false.

Report Progress (F) Boolean Indicates if the DVRs are used. If True, validDVR values are required.

error in (no error) Input error. VI is not executedif an error is present.

Standard LabVIEW error cluster.

Output parameters PAUT out PAUT class object.

RMS error Double. RMS error between target positions andcalculated positions in mm.

Max error Double.Maximum error between target positions andcalculated positions in mm.



80 / 206

Create Setup Array

Using the parameters of the focal laws, of the probe, and of the sample, generates the array of setupparameters to calculate the delays for each pzt element. The Cancel and Progress DVRs are used to monitor cancel and report progress to a parallel operationlike a progress bar. Cancel DVR refers to a boolean and Progress DVR to a double which takes valuesbetween 0 and 1. Not used when Report progress is set to false (default value). Input parameters PAUT in Required. PAUT class object

Cancel DVR Data Value Reference of aboolean.


Progress DVR Data Value Reference of adouble


Report Progress (F) Boolean Indicates if the DVRs are used. If True, validDVR values are required.



Output parameters PAUT out PAUT class object.



81 / 206

Create Focal Laws

Converts the calculated delays from the PAUT class into an array of Focal Laws. Generates an error isno delay data is available in the PAUT class. The maximum progagation time in the wedge for each focal law is used as a global delay. Input parameters PAUT in Required. PAUT class object



Output parameters PAUT in Required. PAUT class object

Focal Laws Array of Focal law objects



82 / 206

PZT Element Class Object from a class that contains the results of a delay calculations for a specific pzt element and for aspecific law.

Experimental Parameters Origin : Position cluster. Position of the pzt element. Target : Position cluster. Position of the target point for the current focal law. Interface : Position cluster. Position of the point defined by the projection along the normal of the pztarray from the center of the pzt array onto the wedge/sample interface. Calculation Results R1 : Position cluster. Solution vector betweeen the pzt element position (Origin) and the interfacewedge/sample for the current pzt element and the current focal law. R2 : Position cluster. Solution vector betweeen the interface wedge/sample and the target point(Target) for the current pzt element and the current focal law.


83 / 206

Delays Five-dimension array of doubles giving the required ultrasonic delays in seconds for each pzt elementof the defined probe to produce the provided focal laws. All delays have positive values and represent the delay applied to each pzt element relative to the pztelement that has the shortest travel time for each focal law. This latter pzt element would then have adelay value of 0 for that specific focal law. Each of the dimension of the five-dimension array represents a subset of delays as detailed in thetable below: Dimension Delay sub-set

1 Refractive FocalLaws

2 Skew AngleFocal Laws

3 Multiple array(single or dual)

4 Z direction orSecondary Axisof probe

5 X direction orPrimary axis ofprobe

Each subset can be accessed in LabVIEW using either the index array function or auto-indexing, asillustrated below:


84 / 206

Max error Maximum difference between the calculated and desired target position for all pzt elements and allfocal laws of the current delay calculations.


85 / 206

RMS error Root square of the average of the square of the differences between the calculated and desired targetposition for all pzt elements and all focal laws of the current delay calculations.


86 / 206

Ultrasonic Data Generic types related to ultrasonic data.


87 / 206

Ascan Data Class representing an Ascan. An Ascan is an ultrasonic signal as a function of time from a single pztreceiver

Angles give the refracted and skew angles associated with the current Ascan. Data a 1D array containing the actual ampitude signal as a function of time. Position is a location associated with the current Ascan. TStart is the time of the start of the current Ascan. TStep is the time step between each of the Data array.


88 / 206

Ascan to Graph

Creates a waveform graph cluster from a Ascan datatype. Input parameters Ascan_Data in Required. Ascan data object.



Output parameters Graph LabVIEW waveform graph cluster.



89 / 206

Sscan Data Class representing a Sscan. A Sscan is a 2D plot using Ascans to represent the amplitude ofultrasonic signals by color for various angles.

Angles is a 1D array of doubles giving the angles of the Ascans contained in the current Sscan object. Ascans is a 1D array of Ascan Data objects. AscanSize is the length in points of the contained Ascans. DepthStep is a double giving the value (time or depth) between the points of each Ascans. PosStep is a double giving the distance between two consecutive Ascans.


90 / 206

Init From Ascans

Creates an instance of Sscan Data using Ascans as an input. Input parameters Sscan_Data in Required. Sscan data object.

Ascans Required. 1D array of AscanData objects.



Output parameters Sscan_Data out Sscan data object.



91 / 206

Sscan Plot

Creates a 2D array corresponding to a Sscan plot using the current Sscan data object. To define theresolution and size, a reference to the intensity graph where the Sscan data will be plotted must beprovided. Input parameters Sscan_data in Required. Holo Event

Message.Generic Data associated with the Hololens userevents.

IntensityGraph ref Required. Reference toLabVIEW intensity graph.

Reference to intensity graph where the Sscanwill be plotted



Output parameters Sscan_Data out Sscan Data object.

Graph data 2D array of floats.



92 / 206

Extract Ascan

Calculates the angle of the provided position cluster within an intensity graph showing a Sscan plotand provides the Ascan and the time value corresponding to the cursor position. Input parameters Sscan_data in Required. Holo Event

Message.Sscan object.

IntensityGraph ref Required. Reference toLabVIEW intensity graph.

Reference to intensity graph where the Sscan isplotted

Cursor Position Required. Position cluster. Cursor position in the intensity graph.



Output parameters Sscan_Data out Sscan Data object.

Ascan Ascan Data object.

Angle Float.

Time value Float.



93 / 206

Focal Law Class representing a Focal Law. A Focal Law is a set of ultrasonic delays resulting differentpiezoelectric element generating or detecting ultrasonic waves towards or from a specific point inspace.

Elements is an array of Focal Element objects. NumberActElem is an I32 giving the number of piezoeletric elements used in the current focal law. R_First is an I32 giving the index (not 0-indexed) of the first receiving piezoeletric element. T_First is an I32 giving the index (not 0-indexed) of the first emitting piezoeletric element.


94 / 206

Hardware API Palette containing the various sub-palettes of the available hardware API.


95 / 206

Olympus Palette containing the API to access the functions of a FocusPX from Olympus.


96 / 206

Programming Functions related to the basic programming of a FocusPX from Olympus.


97 / 206

Open FocusPX

Starts and connects with the HaroUT server. There is no need to use Control or Data port values and IP other than the default ones unless there isa conflict with another application. Notice that the FocuxPX Port IP is the IP address of the port to which the FocusPX is connected andnot the IP address of the FocusPX . Input parameters Control port I32. Default value: 6667

Response port I32. Default value: 6668

Data port I32. Default value: 6669

FocusPX Port IP String. Default value:192.168.0.1



Output parameters FocusPX Events Cluster containing control and data event reference.

The cluster can be directly connected to the input ofthe Register For Events function in LabVIEW.



98 / 206

Close FocusPX

Closes the connection with the FocusPX and stops the LabVIEW server. Input parameters error in (no error) Input error. VI is not executed


Output parameters error out Standard LabVIEW error cluster.


99 / 206

Connect FocusPX

Connects to the FocusPX that has the provided Serial Number. The list is returned as a user event. Input parameters Serial Number Required. String.





100 / 206

Get List of FocusPX

Gets the list of the serial numbers of the FocusPX available for connection. The list is returned as auser event. Input parameters error in (no error) Input error. VI is not executed




101 / 206

Stop Server Closes the HaroUT server but send the corresponding event before doing so.


102 / 206

Acquisition Palette containing the functions related to data acquisition from a FocusPX from Olympus.


103 / 206

Start Acquisition

Starts acquisition of the Olympus hardware.. Input parameters error in (no error) Input error. VI is not executed




104 / 206

Stop Acquisition

Stops acquisition of the Olympus hardware. Input parameters error in (no error) Input error. VI is not executed




105 / 206

Set PRF

Sets the Pulse Repetition Frequency to the PRF input value. The acquisition must not be running whenchanging PRF.. Input parameters PRF Required. I32. Pulse Repetition Frequency for data acquisition.





106 / 206

Set Encoder

Sets the resolution and type of encoder corresponding to Encoder Index. Input parameters Encoder Index Required. I32. Index corresponding to the encoder on the

Olympus hardware (typically 0 or 1).

Resolution Required. I32. Number of pulses on the encoder to increasethe value by 1.

Type Required. Encoder Typesenum.





107 / 206

Set Firing Mode

Sets firing mode of the Olympus hardware. Input parameters Mode Required. Firing Modes

enum.Generic Data associated with the Hololens userevents.





108 / 206

Processing Palette containing the functions related to data processing with a FocusPX from Olympus.


109 / 206

Set Rectification Mode

Sets the rectification mode of the A-scans to the input value. Input parameters Rectification mode Required. Enum. Index corresponding to the voltage value

provided by the Get Pulser Voltage List function.

Group Required. I32. Index of the ultrasonic group that will have itspulser voltage set.





110 / 206

Set Scaling Mode

Sets the scaling mode (linear or logarithmic) of the A-scans to the input value. The logarithmic modeworks only with conventional groups and the group must be in Bipolar rectification. Input parameters Scaling Mode Required. Scaling Mode

enum.I

Group Required. I32. Index of the ultrasonic group.





111 / 206

Set Filter

Sets the digital filter of an ultrasonic group. Input parameters Filter Index Required. I32. Index corresponding to the voltage value

provided by the Get List of Digital Filtersfunction.






112 / 206

Set Smoothing Filter

Sets the smoothing filter of an ultrasonic group. Filter index refers to the list of smoothing filters thatcan be obtained using the corresponding function. Input parameters Filter Index Required. I32. Index corresponding to the voltage value







113 / 206

Get List of Digital Filters

Requests the list of digital filters available for a UT group type. The list is returned as a SmoothingFilter List event. Input parameters Type Required. UT Group Type. Grup Type of the UT technology.





114 / 206

Get List of Smoothing Filters

Requests the list of smoothing filters available for a specific UT type. The list is returned as a specificSmoothing Filter List event.. Input parameters Type Required. UT Group Type. Grup Type of the UT technology.





115 / 206

Set Ascan Averaging

Sets the number of averages used to acquire the A-scans. The Averaging input is an enum. Input parameters Averaging Required. Averaging enum.






116 / 206

Signal Control Palette containing the VIs related to signal control on a FocusPX from Olympus.


117 / 206

Set Group Gain

Sets the Group Gain to the Gain input value. Input parameters Gain Required. I32. Gain in dB to be applied to the provided group.






118 / 206

Set Start Time

Sets the start time of the A-scans to the input value in nanoseconds. Input parameters Start Time (ns) Required. Double. Start time in nanoseconds of the Ascans for the

provided group.






119 / 206

Set Time Range

Sets the time range of the A-scans to the input value in nanoseconds. Input parameters Time Range (ns) Required. Double. Time range in nanoseconds of the Ascans for

the provided group.






120 / 206

Set Voltage

Sets the pulser voltage of the provided group. The voltage is set to the value corresponding to theelement of the voltage list corresponding to the voltage index. The list of voltages available for the group can be obtained using Get Pulse Voltage List. Input parameters Voltage Index Required. I32. Index corresponding to the voltage value







121 / 206

Set Pulse Width

Sets the width in nanoseconds of the excitation voltage pulse. Input parameters Voltage Index Required. I32. Index corresponding to the voltage value







122 / 206

Set Ascan Compression

Sets the Ascan compression value for the specified group. Input parameters Compression value Required. I32. Index corresponding to the voltage value







123 / 206

Set Sync Gate

Sets the parameters of a synchronization gate for the specified UT group. Start, Length, and Thresholdare required if Enable? is true. Input parameters Enable Required. Boolean. Enables (true) or Disables (false) the

synchronization gate of the specified UT group.


Threshold (%) Double. Threshold of pulse detection in thesynchronization gate in %.

Start (ns) I32. Start of the synchronization after the generationpulse in ns.

Length (ns) I32. Duration of the synchronization gate in ns.





124 / 206

Get Pulser Voltage List

Requests the list of pulser voltages available for the provided group. Input parameters Group Required. I32. Index of the ultrasonic group from which the list

of available pulser voltages is requested.





125 / 206

UT groups Palette containing the VIs related to the creation and control of ultrasonic groups on a FocusPX fromOlympus.


126 / 206

Add Conv Group

Requests the FocusPX to add a new conventional UT group, using the provided pulser andreceived indices. Pulser indices vary from 0 to 7 (P1..P4R4), and Receiver indices vary from 0 to 3(P1R1..P4R4). Input parameters Conv GroupParameters

Required. Conventional UTParameters cluster.





127 / 206

Add PA Group

Sends an array of focal laws to create a phased-array group on device having index Device. Groupname provides a name to the group for display purposes. Input parameters Group Name Required. String. Name provided to the group. This name is sent

back along with the Ascans.

Focal laws Required. Array of Focal Lawobjects.

Gives the appearance of the mesh.

Device Required. I32 Index of FocusPX. Currently works only withindex 0.





128 / 206

Change Focal Laws

Sends an array of focal laws that will replace the current focal laws of group index Group of the FocusPX with index Device. Input parameters Group Name Required. String. Name provided to the group. This name is sent

back along with the Ascans.

Focal laws Required. Array of Focal Lawobjects.

Group Required. I32. Index of group to be modified.

Device Required. I32 Index of FocusPX. Currently works only withindex 0.





129 / 206

Remove Group

Removes the UT Group specified by Group Index from the FocusPX. Notice that the groups having anindex higher than the one removed have their index shifted by -1. Input parameters Group Index Required. I32. Index of the UT group to be removed from the

FocusPX.





130 / 206

Digital IO Palette containing the VIs related to the control of digital hardware input/output lines on a FocusPXfrom Olympus.


131 / 206

Set Digital Input

Enables or disables the digital input control of the FocusPX. Input parameters Enable? Required. Boolean.





132 / 206

Set Digital Output Line

Sets the output (high or low) of a specific digital line of the FocusPX. Input parameters High Required. Boolean. False is low and True is high.

Line Required. Digital Output LineEnum.

Index of the line to be set high or low.





133 / 206

Get Digital Input States

Gets the status of the digital input lines on the FocusPX. Input parameters error in (no error) Input error. VI is not executed




134 / 206

LAW File LAW file is a class containing the information from a .LAW file. A .LAW file is a file defining the delaysand parameters corresponding to a specific set of focal laws.


135 / 206

Create LAW file from Text

Populates an LAW file object with parameters extracted from the text of a .LAW file. Input parameters LAW File Object in Required. LAW File object.

.LAW file text Required. Text extracted froma .LAW file.



Output parameters LAW File Object Out LAW File object.



136 / 206

Read LAW file

Reads a .LAW file and populates a LAW file object with the corresponding parameters. Input parameters LAW File Object in Required. LAW File object.

Path Required. Path to the .LAWfile to be read.



Output parameters LAW File Object Out LAW File object.



137 / 206

Events Palette containing the functions related to the different user events from a FocusPX from Olympus. The HaroUT library employes LabVIEW user events for asynchronous communication with devicesand server. The HaroUT library provides VIs to make the conversion of the event data into usable data easier tothe developer.


138 / 206

Server Connection

Extracts the status of the connection with the FocusPX server Input parameters Generic Event Data Required. FocusPX server

data.Generic Data associated with Olympus events.



Output parameters Server Data out Server event object out.

Connection Status of the server connection



139 / 206

Server Error

Extracts the error from a server error event. Input parameters Generic Event Data Required. FocusPX server




Output parameters Server Data out Server event object out.

error data Error sent from the server.



140 / 206

FocusPX Connection

Extracts the status of the connection and the serial number of a connected FocusPX server. Input parameters Generic Event Data Required. FocusPX server




Output parameters Server Data out FocusPX connection event object out.

Serial Number String. Serial Number of the connected Focus PX

Connection Boolean. Connection status of the connectedFocuxPX



141 / 206

List of FocusPX

Extracts the list of the FocusPX connected to the current system. Input parameters Generic Event Data Required. FocusPX server




Output parameters Server Data out FocusPX connection event object out.

Serial Number String. Serial Number of the connected Focus PX



142 / 206

Text Message

Extracts the text message sent by the FocusPX.. Input parameters Generic Event Data Required. FocusPX server




Output parameters Text Message objectout

Text Message Event object out.

Message String. Message sent by the FocusPX



143 / 206

Filter List

Extracts the list of digital filters from the corresponding event sent by the FocusPX . Input parameters Generic Event Data Required. FocusPX Generic

Event data.Generic Data associated with Olympus events.



Output parameters Filter List object out Filter List object out containing the data associated

with the corresponding event.

Type UT Group Type of the provided list of filters.

List of filters Cluster of a UT Group Type and array of the DigitalFilter class.



144 / 206

Smoothing Filter List

Extracts the list of frequencies of the smoothing filters from the corresponding event. Input parameters Generic Event Data Required. FocusPX Generic




Output parameters Smoothing FilterMessage out

Filter List object out containing the data associatedwith the corresponding event.

Type UT Group Type of the provided list of frequencies ofthe available smoothing filters.

Frequencies Array of doubles. Frequencies in MHz of theavailable smoothing filters.



145 / 206

Digital Input States

Extracts an array of boolean corresponding to the states of the digital inputs lines of the FocusPX.Indices 0 to 3 of the array correspond to digital input lines 1 to 4 on the FocusPX (false = low, true =high). Input parameters Generic Event Data Required. FocusPX Generic




Output parameters Digital Input StateMessage object

Digital Input state object out containing the dataassociated with the corresponding event.

States Array of four booleans. Indices 0 to 3 correspond todigital input lines 1 to 4 on the FocusPX.



146 / 206

UT Group Added

Extracts the group index and type of a UT group that was just added or modified on the FocusPX.Notice that modifications of conventional groups do not generate an event. Input parameters Generic Event Data Required. FocusPX Generic




Output parameters Group Message objectout


Group Index of the group.

Type UT Group Type of the added or modified group.



147 / 206

Pulser Voltage List

Extracts the list of pulser voltages from the corresponding event. Input parameters Generic Event Data Required. FocusPX Generic




Output parameters Smoothing Filter Listobject out


Type UT Group Type of the provided list of voltages.

Voltages Array of I32. Voltages in volts available for theexcitation pulse for the given UT group type.



148 / 206

Olympus US Data Ultrasonic data associated with Olympus hardware.


149 / 206

Olympus Ascan Child of the Ascan Data class.

DeviceName: String. Name of the device (serial number of the FocusPX). EncoderValue: 1-D array of I64. Values of the encoders. Group: String. Name of the ultrasonic group of the current Ascan. Name: String. Name of the current Ascan.


150 / 206

Olympus Sscan Child of the Sscan Data class.


151 / 206

Controls List of controls associated with the Olympus API.


152 / 206

Encoder Types

Enum providing the varous types of encoder.


153 / 206

Firing Modes

Various firing modes available on the Olympus hardware.


154 / 206

Conventional UT Parameters

Clusters containing the parameters of a conventional UT group for the Focus PX.


155 / 206

Rectification mode Enum listing the various rectification modes available for the FocusPX.


156 / 206

Scaling mode

Enum listing the scaling mode available for the Ascans on the FocusPX


157 / 206

Ascan Averaging

List of averaging values available for Ascans from the FocusPX.


158 / 206

UT Group Type

Type UT groups available on the FocusPX.


159 / 206

Digital Output Line List of available digital output line on the FocusPX.


160 / 206

Digital Filter Class

Class representing a digital filter from the Olympus FocusPX. Characteristics is "TOFD" or "not TOFD" (Time Of Flight Diffraction). HighCutoff is the filter high frequency cutoff in Hz. LowCutoff is the filter low frequency cutoff in Hz. Type is the type of filter: None, Low pass, High pass, Band Pass.


161 / 206

Parameters to String

Creates a string out containing the characteristics of an Olympus digital filter class object. Input parameters Digital Filter object. Required. Digital Filter Class

object.One of the elements of one of the clusters fromthe array from Filter List Event

Input index Required. I32. Index of the filter initially selected.



Output parameters String out String. String listing the properties of the filter.



162 / 206

Examples The HaroUT library comes with examples on how to use the calculator and hardware functions. Thoseexamples are described in this section.


163 / 206

Calculator Examples related to the calculator.


164 / 206

Calculator Setup

Example showing how to programmatically setup parameters and calculate ultrasonic delays and rays.The Calculator UI can be used to learn how to populator parameter fields.

Calculator UI

Opens the Calculator UI. The Calculator UI can be used to populate the parameter and resultfields.


165 / 206

Calculate

Uses the parameter fields to calculate ultrasonic delays and rays.

Focal law parameters

Cluster containing the Focal Law Parameters.


166 / 206

Sample parameters

Cluster containing the Sample Parameters.

Probe parameters


167 / 206

Cluster containing the Probe Parameters.

Search parameters

Cluster containing the Search Parameters.

Max and RMS errors


168 / 206

RMS Error and Max Error of the calculation results.

Calculated ultrasonic delays

Calculated Ultrasonic Delays for each pzt element of the probe and for each focal law as perthe input parameters.

PZT Element array

Array of objects of the PZT Element Class for all pzt element of the probe and all focal laws.A PZT Element object contains all the parameters and results for a specific pzt element for agiven focal law..

Beam entry positions

2D array giving the position [X,Y,Z] of the projection central point of the phased array on thesample surface for each of the refracted and skew angles of the input focal laws.


169 / 206

Olympus Examples related to the FocusPX from Olympus.


170 / 206

Commands Example for the Olympus FocusPX showing how to setup phased-array and conventional ultrasonicgroups, acquire A-scans, and setup the parameters of the FocusPX. This example uses a single loopfor both UI and data acquisition for sake of simplicity.

Import Delays for PA Group

Imports the delays of a set of Focal Laws from a .LAW file and adds or modify a phased-array(PA) group.

Calculator for PA Group

Opens the calculator user interface that can be used to calculate delays of a set of FocalLaws from a .LAW file and adds or modify a phased-array (PA) group. See Add PA Group andChange Focal Laws VIs for more information.

Add Conventional UT Group


171 / 206

Adds a conventional ultrasonic group using the Pulser and Receiver values as pulser andreceiver. The selected pulser is assigned as name of the group. See Add Conv Group VI formore information.

Send Encoder Parameters

Clicking the button sends the setting of the selected encoder and enables the encoder. Setthe resolution to a negative number to disable the encoder. See Set Encoder VI for moreinformation.

Synchronization Gate

Parameters of the synchronization gate for the current group. See Set Sync Gate VI for moreinformation.

Connectors

Pulser and receiver connectors used when adding a conventional group. See Add Conv GroupVI for more information.

Acquisition control

Parameters to control the acquisition. See Start Acquisition, Stop Acquisition, Set Firing Mode,and Set PRF VIs for more information.

Processing


172 / 206

Controls for the signal processing on the FocusPX. See Set Rectification Mode, Set ScalingMode, Set Ascan Averaging, and Set Filter VIs for more information.

Ascan Timing

Sets the duration (Range) and start time of the Ascan. See Set Time Range and Set StartTime VIs for more information.

Signal Gain

Gain of the signal. See Set Group Gain VI for more information.

Pulse Parameters

Voltage of the excitation pulse as selected from the ones available on the FocusPX for thecurrent group type and pulse width. See Set Voltage, Get Pulser Voltage List, and Set PulseWidth VIs for more information.

Digital Output Lines

Clicking the check mark button sets the state of the selected line according to the selectedstate. See Set Digital Output Line VI for more information.

Digital Input Lines

Clicking the button requests the status of the digital input lines 1 to 4 on the FocusPX. Thestatus of the lines is provided in the boolean array. LED is light green when line is high, dark


173 / 206

green when low. Input lines 1 to 4 status are shown from left to right. See Set Digital Input, GetDigital Input States, and Extract Digital Input States VIs for more information.

Reconnect

When clicked, the application attempts to reconnect with the FocusPX. If this button is clickedduring a valid connection, the connection is terminated and a new connection is initiated.Notice that the application always make two attempts to connect to a FocusPX in case the firstone fails.

Connection status

Indicates the connection status with the FocusPX. When light green, the application isconnected with the FocusPX.

Acquisition rate

Actual acquisition rate of the signals. This rate is for the aggregate of all Ascans and notfor each Ascan. The total acquisition is the total number of Ascans times this rate. Theabsolute maximum total acquisition rate capability of a FocusPX is 20 kHz but this numberis reduced depending of the acquisition parameters. If the actual acquisition rate (this value)is significantly different from the PRF value, it means that the requested PRF is higher thecapability of the FocusPX, in which case the FocusPX simply limits the acquisition rate andissues a message accordingly; or that the current application cannot process the Ascanquickly enough and Ascan signals are accumulating in memory, in which case the applicationbecomes unresponsive and application memory usage rapidly increases.

Tree

List of the Ascan signals being acquired from the FocusPX. Ascans are numbered from 1 tothe total number of acquired Ascans. Conventional Ascan signals are under a header PXRY


174 / 206

where X and Y indicate from which conventional receiver the Ascan comes from. Phased-Array Ascan signals are under a PA header. All those headers are under a single headergiving the serial number of the FocusPX.

Ascan graph

Graph of the Ascan signal currently selected in the tree.

Message Field

Field giving the latest message from the FocusPX or from the application.


175 / 206

Sscan Example for the Olympus FocusPX showing how to setup a sectorial scan (S-scan). This exampleillustrates the use of two loops, one for UI and the other one for data acquisition, to improve dataacquisition rates and user interaction responsivity.

Connection status

Indicates if a FocusPX is connected to the application.

Focal Laws

Opens the calculator or import from a .LAW file for new focal laws for the Sscan.

Acquistion controls

Starts, Stops, and sets pulse repetition frequency of the data acquisition.


176 / 206

Time parameters

Start is the intial time of the Ascans and Range is the duration of the Ascans.

Excitation Pulse Parameters

Voltage is the amplitude of the excitation pulse, the selection is from the FocusPX.

Rectification

Sets signal rectification of the Ascans.

Gain

Sets the amplitude gain of the Ascans.

Compression

Factor reducing the number of points in time of the Ascans. The resulting time step is 10 nstimes the compression value.

Actual Acquisition Rate

Actual acquisition rate for each group of Ascans (not for individual Ascan).

Reconnect


177 / 206

Starts or restarts a connection with the FocusPX. Clicking this button closes the currentconnection if currently connected.

Message field

Information text from the FocusPX or from the application.


178 / 206

SubVIs Sub-VIs used in the Olympus examples.


179 / 206

Select FocusPX Dialog

Dialog offering to the user to select one of the FocusPX among those found by the application.


180 / 206

Select Digital FilterDialog offering to the user to select one of the filters among those received available on the FocusPX.

Dialog to select a digital filter from a list Input parameters List of filters Required. Array of strings. Obtained from Filter List Event

Input index Required. I32. Index of the filter initially selected.



Output parameters Selection index. I32. Index of filter selected by the user.

Canceled? Boolean. True if user canceled.

Selected filter I32. Index of the selected UT group.



181 / 206

Extract Group from tree

Extracts the name of the group, its index, and type (PA or conventional) from the currently selected A-scan using the loop data cluster of the Commands example as data in. Input parameters data in Required. Cluster used as

loop data in Commandsexample.



Output parameters Name String. Name of UT group of Ascan currently

selected.

Type Enum. UT Group Type.

Index I32. Index of the selected UT group.



182 / 206

Controls Generic controls used by the HaroUT Library.


183 / 206

Position Cluster defining a position or a direction.


184 / 206

UtilitiesVarious VIs used at utilities in the HaroUT library.


185 / 206

Progress Bar FG

Functional Global Variable handling the progress bar of the HaroUT Calculator. The use of DVRsallows for any function to monitor the progress and to provide cancel capabilty. Input parameters Command Required. PAUT class object

Info in Data Value Reference of aboolean.


Start text Data Value Reference of adouble


Progress Boolean Indicates if the DVRs are used. If True, validDVR values are required.



Output parameters Info out PAUT class object.

Canceled? Double. RMS error between target positions andcalculated positions in mm.



186 / 206

Tree

Creates a new tree with three levels or adds an item to a new or already existing top or mid-level item. Input parameters Tree ref Required. Reference to

LabVIEW tree control.Tree control to be modified.

Top level Required. String. Top level of the new tree. If empty, item is set inthe highest level of the tree.

Mid-level Required. String. Second level of the new item.

Bottom level Required. String. Third level of the new item.

New Tree? Required. Boolean. If true, existing information in tree is deleted.





187 / 206

Creating an executable This section describes the additional steps that are required to build an executable using the HaroUTlibrary for some of the hardware APIs.


188 / 206

Olympus The steps to build an executable using the HaroUT library for an Olympus FocusPX are given below. The steps describe how to build an executable for the Olympus - Example Sscan.vi that is provided asan example with the HaroUT library. 1. Locate the Firmware Packages and Server directories and add them as Auto-Populatingfolders to your project. The Firmware Packages folder is located in <LabVIEW>\vi.lib\HaroTek\HaroUT\Hardware Libraries\Olympus Library\OpenView Interface and the Server folder is located in <LabVIEW>\vi.lib\HaroTek\HaroUT\Hardware Libraries\OlympusLibrary\OpenView Interface\OpenView Server. <LabVIEW> refers to the directory of the LabVIEW version where you installed the HaroUT library.

2. Add the two directories to the Always Included field of the Source Files category of the buildproperties of the executable.


189 / 206

3. Create two folder destinations in the Destinations field of the Destinations category of thebuild properties of the executable. The two folder destinations are: Destinations Destinations PathServer <executable>\Olympus\Server

FocusPx <executable>\Olympus\FirmwarePackages\FocusPx

where <executable> refers to the path of the executable in the build properties. Select Directory and check "Preserve disk hierarchy" in the Destination type field.


190 / 206

4. In the Source File Settings category, select FocusPx and Server in "Set destination for allcontained items" field for the "Firmware Packages" and the "Server" folders in the "ProjectFiles" field respectively.


191 / 206

5. Now you can build your executable using the other parameters for your own specificexecutable.


192 / 206

Troubleshooting This section provides a list of possible errors and solutions related to the HaroUT library.


193 / 206

List of Common HaroUT LabVIEW Errors A set of LabVIEW custom errors is installed along with the HaroUT library. An exhaustive list of theseerrors can be seen using an Error Ring and look for "HaroTek HaroUT" for the Error Code Range. Some of the most common custom error codes assigned to the HaroUT library are given below alongwith a context and a description.

Code Context Description Solution

8200 .LAW File Error loading .LAW file Make sure file exist

8300 HaroUT Olympus Server Error launching HaroUTserver.

Make sure that the HaroUT library was properly installed. Check ifTCP Port values have been modified.

8302 HaroUT Olympus Server HaroUT ServerDisconnected.

See Olympus Troubleshooting.

8304 HaroUT Olympus Server TCP communication error. See Olympus Troubleshooting.

8320 HaroUT Olympus Server Generic Error from HaroUTremote server

Checks specific message added to error 8320.

8332 HaroUT Olympus Server No FocusPX discovered. Make sure that the FocusPX is turned and appropriately connectedto the network.

8336 HaroUT Olympus Server Could not find firmwarepackage.

FocusPX Firmwave files have been deleted or moved. Reinstall theHaroUT library using VIPM from JKI. See Olympus Troubleshooting.

8338 HaroUT Olympus Server Desired FocusPX not found. Connection to the requested FocusPX failed. Make sure thatyou used a valid serial number and that the FocusPX is properlyconnected.

8342 HaroUT Olympus Server Error while trying to uploador start firmware package

See Olympus Troubleshooting.

8438 HaroUT Olympus Server Internal error while gettingdigital input line states.

Internal error of the FocusPX. Restart the FocusPX.

8500 HaroUT Calculator No delay data available. Make sure that calculations were completed.

8510 HaroUT Calculator At least one of the rays has alength of 0.

Repeat calculations using valid parameters.


194 / 206

Calculator Calculations take too much time Description

Calculations take a long time to complete. Solution

Depending on the number of elements, the number of focal laws, and the computercapabilities, calculations can take some times. For example, on a I7 CPU running at 3.5 GHzwith 8 cores, a 32x32 elements dual-array for a single focal law takes about 2.7 seconds.This duration would approximately scale linearly with the number of elements and the numberof focal laws (for example, a 64x64 single-array elements with 6 focal laws would takeapproximately 2x2 x 0.5 x 6 x 2.7 seconds = 32.4 seconds.

Factoring the type of computer used, the value given above should give an idea if thecalculations take longer than they should. If you still determine that the calculations take toolong, check the following: 1. Calculation parameters

Verify that the parameters you use for the calculations are really those you want. Asmall typing error might result in a calculation much larger than necessary.

and/or 2. Settings

Verify that the search parameters of the Search param tab of the Settings dialog. If theparameters are the same, or if the calcuations still take too long, look at the informationprovided in the Search tab to try to minimize the duration of the calculations.

Missing rays or rays not on target or both Error #1088 in error dialog Description

Some rays are not on the target point or are missing, as can be seen in the 2D Display orthe 3D Viewer (see examples below). An error dialog often occurs with this problem if the 3DViewer is open.


195 / 206

Solution

This problem occurs because the search parameters are not properly set or because thecalculation parameters involve angles that are too extreme. 1. Change calculation parameters.

a. Look if the chosen range of angles for the Focal law scans or the angle or roof angleof the sample parameters are appropriate.b. Try to reduce the extreme angles

and/or 2. Change search parameters.

a. Look at the search settings and follow the recommendation to try to optimize thoseparameters.

Error #7 when exporting delays Description

When attempting to export delays, a error dialog with error #7 appears and no delay are saved.

Solution

This problem occurs because there is a mismatch between the .xml files in the PAUT infodirectory and the .lvlibp files in the Classes directory. 1. Make sure that the .xml and the .lvlibp files that were provided for the desired export fileformats were copied in the appropriate directories. or 2. Select another format to export the delays.


196 / 206

Error #7 when starting application or loading config file

(when loading config file).

Description

At the start of the application, or when loading the default configuration file, an error dialogappears with error #7.

Solution

This problem occurs because the default configuration file could not be found. 1. Create a new default configuration file.

a. Click Continue.b. Set the parameters as the desired default parameters.c. Go to the Settings dialog and save the default configuration file.

or 2. Replace the config file

a. Click Quit normally.b. Find the default configuration file and copy it in the appropriate directory.


197 / 206

Error #1108 when starting application or loading the default configuration file

(when loading config file):

Description

At the start of the application, or when loading the default configuration file, an error dialogappears with error #1108.

Solution

This problem occurs because the default configuration file does not have the expectedstructure. 1. Create new config file.

a. Click Continue.b. Set the parameters as the desired default parameters.c. Go to the Settings dialog and save the default configuration file.

or 2. Replace the config file.

a. Click "Quit normally"b. Find a copy of the config file that has the appropriate format.c. Copy this config file over the olde one in the appropriate directory.

Warning #8510 after calculations


198 / 206

Description

After calculations are completed, a warning dialog with Warning #5000 appears stating that atleast one calculated ray had a length equal to 0.

Solution

This problem occurs because no solution was found for one of the ray. 1. Change calculation parameters.

a. Look if the chosen range of angles for the Focal law scans or the angle or roof angleof the sample parameters are appropriate.b. Try to reduce the extreme angles

and/or 2. Change search parameters.

a. Look at the search settings and follow the recommendation to try to optimize thoseparameters.


199 / 206

Hardware API Troubleshooting for specific hardware APIs.


200 / 206

Olympus No feedback from FocusPX after HaroUT Server has connected. Description

The HaroUT server has connected but the FocusPX does not respond. Example is stuck at"HaroUT Server Connected".

Possible Cause

If the firmware was not successfully installed, the FocusPX becomes unresponsive.

Possible solution 1. Restart the FocusPX by turning it off, then back on.

Message "Error: Server has disconnected" without full connection to FocusPX Description

Application terminates with message "Error: Server has disconnected" after selection of theFocusPX serial number, while "Connecting to device S/N QC-WXYZ".

Possible Cause

First attempt to communicate with FocusPX might not be successful. If there is heavy traffic on the network used to communicate with the FocusPX, communicationmight fail. Firewall might block communication.

Possible solution 1. Restart the application. 2. Restart the FocusPX 3. Try using a network dedicated to the FocusPX. 4. Remove any firewall or virus protection.

Error 8336 : Cannot find firmware files.


201 / 206

Description The HaroUT server has connected but after successfully connecting to the FocusPX, error isgenerated.

Possible Cause

Firmware files could not be found.

Possible solution Make sure that the Firmware files are appropriately located, using the same hierarchy asused in the <LabVIEW>:\vi.lib\HaroTek\HaroUT Library\Hardware Libraries\Olympus Library\OpenView Interface\Firmware Files. Notice that the exact same capitalization should beused, as shown below. The names of the packages might be slightly different. The FirmwarePackages directory must be located in the same directory than the HaroUT server or up tothree generation of parent directories.

Application fails to connect to HaroUT server. Description

The HaroUT server does not connect to the LabVIEW application

Possible Cause

Failure of the TCP connection between HaroUT server and LabVIEW application. Windows might have block one or more port values.

Possible solutions 1. Using Task Manager, check if an instance of the HaroUT server is already running. If yes,terminate it using Task Manager. 2. Restart the computer.


202 / 206

3. In some rare instances, the port values might be used by another application. Port valuesare assigned in the LabVIEW application using the inputs of the Open FocusPX VI. If portvalues conflict with another application, use port values different from the default ones.

Server disconnects during Acquisition (Errors 8302, 8304, 8330 to 8340) Description

Application terminates during data acquisition at high repetition rates.

Possible Cause

FocusPX has an absolute maximum acquisition rate of 20 k Ascans per second. The maximumacquisition rate is generally lower depending on the setup used. The HaroUT server disconnects if the application cannot sustain the acquisition rate of theFocusPX.

Possible Solutions

1. Close all applications on your computer other than the one using ASI. 2. Lower the data throughpurt by either lowering the acquisition rate or by using a lighter setup. 3. If you use a network switch, make sure that it support jumbo packets up to 9014 bytes. 4. Try replacing the hardware linking the devices to the computer: network cable and switch. 5. Reboot your computer and the FocusPX. 6. Use a faster computer.

Server Disconnects when changing Parameters (Errors 8302, 8304, 8330 to 8340) Description

When changing one of the parameter of one of the UT groups, the connection is lost with eitherthe FocusPX or the server.

Possible Cause

One possible cause is associated with the acquisition rate being at or near its maximum valuefor the current setup.

Possible Solutions

1. Reduce the repetition rate slightly below (10% below for example) the maximum repetitionrate of the FocusPX for the desired setup.


203 / 206

Error 8342 : Error while trying to upload or start firmware package. Description

After initial connection with the FocusPX, an error occurs during the upload or startup of thefirmware package.

Possible Cause

Network connection dropped to 100 MHz, or FocusPX is in an incompatible state, or firewall prevent transmission of the firmware package.

Possible solution

1. If network connection dropped to 100 MHz (network indicator on FocusPX is amber), try tounplug and plug the network. Network indicator should become nearly steady green. 2. Re-attempt connection. After two attempts, restart the FocusPX. 3. Restart FocusPX 4. Turn firewall off.


204 / 206

DebuggingFor debugging purposes, it is possible to open a command line window that gives a hint of theinteractions with the HaroUT server.The command line window can be opened by creating an empty text file named "debug.txt" in thesame directory than the LabVIEW project containg the VI using the FocusPX API. To stop using thecommand line window, just delete the "debug.txt" file and restart the VI. Notice that when using the debug window, the command line window remains open after theapplication terminates.


205 / 206

References Advanced calculator User’s manual Software Version 2.1 DMTA-20039-01EN [U8778741] – Revision AAugust 2012 (Olympus' website). L. W. Schmerr, "Fundamentals of Ultrasonic Phased Arrays", Springer International Publishing,Switzerland, 2015 (ISBN: 978-3-319-07271-5). N. Dubé, "Introduction to Phased Array Technology Applications, R/D Tech Guideline, 2004, ISBN:0-0735933-4-2 (Olympus' website). Actor Framework: forums.ni.com/t5/Actor-Framework/ct-p/7001?view=overview. DQMH from Delacor: delacor.com/products/dqmh/

https://forums.ni.com/t5/Actor-Framework/ct-p/7001?view=overview

https://delacor.com/products/dqmh/


206 / 206

Contact information For any question about HaroUT™, this manual, or any other product from HaroTek, contact: Marc [email protected] or go to www.harotek.com

www.harotek.com

harout™ manual - weeblyharotek.weebly.com/uploads/4/2/7/8/42789373/harout... · 2018. 10. 10. ·...

Documents