Using a Surphaser Scanner

in PolyWorks
© 2017–2020 InnovMetric Software Inc. All rights reserved. PolyWorks® is a registered
trademark of InnovMetric Software Inc. InnovMetric, PolyWorks|Inspector,
PolyWorks|Modeler, PolyWorks|Talisman, PolyWorks|Reviewer, IMAlign, IMMerge,
PolyWorks|DataLoop, PolyWorks|PMI+Loop, PolyWorks|AR, PolyWorks|ReportLoop, "The
Universal 3D Metrology Software Platform", "The Smart 3D Metrology Digital Ecosystem",
and "Interconnecting Hardware, Software and People" are trademarks of InnovMetric
Software Inc.

SmartGD&T is a trademark of Multi Metrics Inc. NX is a trademark or registered trademark of

Siemens Product Lifecycle Management Software Inc. or its subsidiaries in the United States
and in other countries. Teamcenter is a trademark or registered trademark of Siemens
Product Lifecycle Management Software Inc. or its subsidiaries in the United States and in
other countries. All other trademarks are the property of their respective owners.

This manual, as well as the software described in it, is furnished under license and may be
used or copied only in accordance with the terms of such license. The content of this
document is furnished for informational use only, and is subject to change without notice.
InnovMetric Software Inc. assumes no responsibility or liability for any errors or inaccuracies
that may appear in this document.

Except as permitted by such license, reproduction in whole or in part in any way without
written permission from InnovMetric Software is strictly prohibited.

Using a Surphaser Scanner in PolyWorks

2020/03/17
PolyWorks® Metrology Suite 2020
Contents

4 Introduction

5 1. Requirements
5 1.1 Drivers

6 2. Spherical Scanning
6 2.1 Scanning with a Surphaser device
7 2.1.1 Choosing the device plug-in and connecting to the device
8 2.1.2 Setting scanning parameters
8 2.1.2.1 The Scan dialog box
18 2.1.2.2 The Spherical Scan Options dialog box
23 2.1.3 Understanding the Scanner 2D View window (scanning operation)
23 2.1.3.1 Graphically defining scanning zones
25 2.1.3.2 Viewing scanning results and changing filters
26 2.1.4 Disconnecting from the device
27 3.2 Importing C3D files containing scanned data
28 3.2.1 Choosing the device plug-in
28 3.2.2 Setting the parameters applied to the scanned data
28 3.2.2.1 The Scan dialog box
34 3.2.2.2 The Spherical Scan Options dialog box
38 3.2.3 Using the Scanner 2D View window (import operation)

40 4. Scripting and Additional Functionalities

40 4.1 Introduction to scripting
43 4.2 Functionalities only available by scripting

Using a Surphaser Scanner in PolyWorks 2020 3

Introduction

The PolyWorks® Metrology Suite is a complete reverse-engineering and inspection

solution for high-density point clouds. It offers a wide choice of plug-ins that allow the
capture of 3D coordinate points by way of scanning devices, either for performing line
scanning or spherical laser scanning.

This document explains how to configure a Surphaser long-range laser scanning device
for use with the PolyWorks Metrology Suite, and describes the parameters of the
device. For any issues related to the scanner or its setup, contact a Surphaser
representative.

Related documentation

Each PolyWorks Metrology Suite module has its own complete reference guide in PDF
format. It can be accessed by pressing the ? symbol in the title bar of any open module
dialog box, or by looking under a module’s Help menu. The following documents are
closely related to the current one:

Reference
Description
guide

PolyWorks Contains a complete description of the Workspace Manager and

Reference explains how to customize the user interface.
Guide

PolyWorks| Explains the different functionalities in the PolyWorks|Inspector™

Inspector module of the PolyWorks Metrology Suite.
Reference
Guide

Using a Surphaser Scanner in PolyWorks 2020 4

1. Requirements
This chapter describes the requirements for scanning with a Surphaser 3D scanner in
the PolyWorks Metrology Suite.

Before scanning, the following requirements must be met:

 The latest intermediate release of the PolyWorks Metrology Suite 2020 must be
installed to ensure that the plug-ins are the most up-to-date (available from the
Technical Support Zone of the InnovMetric website).

For the Surphaser plug-in, the BasisSurphaser.dll file is installed in the Plugins
subfolder of the PolyWorks Metrology Suite installation folder.

 Surphaser must be selected on the Plug-ins page of the Workspace Manager

Options dialog box. This dialog box is displayed the first time that the PolyWorks
Metrology Suite is opened. It is also available at any time by clicking the Workspace
Manager Options button, shown to the right, in the Workspace Manager.

For information on the different options available in the previously mentioned dialog
box, see the “Setting PolyWorks options” section of the PolyWorks Reference Guide.

 Microsoft .NET Framework 4.0 or higher must be installed.

 A valid parameter file (.rpr) must be specified.

When connecting to the device for the first time, a file browser is displayed to allow
selecting the .rpr file to be imported into the scanner parameter files folder. The
default folder is C:\ProgramData\InnovMetric\PolyWorks\Surphaser. It can be
configured through the Scan dialog box (see Section 2.1.2.1.6 Configuring the device
and controlling the azimuth position).

1.1 Drivers
The SurphaserUSB driver is required. It is available at the following location:
ftp://ftp.innovmetric.com/pub/drivers/Surphaser/

Using a Surphaser Scanner in PolyWorks 2020 5

2. Spherical Scanning
This chapter explains how to use the PolyWorks plug-in offered to obtain scanned data
with a Surphaser device. This data can either come directly from the scanning device
(see Section 2.1 Scanning with a Surphaser device) or from a file (see Section 3.2
Importing C3D files containing scanned data).

2.1 Scanning with a Surphaser device

Here is the typical workflow when scanning with a Surphaser device in
PolyWorks|Inspector. Several parameters are offered for the plug-in, which can affect
the general workflow. It is assumed that the parameters are set to their default value for
the following workflow.

1. Choose the Surphaser plug-in and connect to the device (see Section 2.1.1
Choosing the device plug-in and connecting to the device).

2. Define the resolution parameters (see Section 2.1.2.1.2 Defining resolution

parameters).

3. Specify scanning zones, if desired. Two methods are offered:

 Specify scanning zones graphically using the image of the Preview mode:

3.1 Press the Preview button.

The device performs a 360° scan; the image of the scanned data is
progressively displayed in the Scanner 2D View window. Note that the
device localizes its absolute zero the first time that a preview, a scan, or a
move to park position operation is launched.

3.2 Using the mouse, click and drag to define rectangular zone(s) in the image
to specify the zones that will be scanned.

The scanning zones can be resized, moved, or deleted through the

Scanner 2D View window (see Section 2.1.3 Understanding the Scanner
2D View window (scanning operation)).

 Specify scanning zones numerically in the Scanning zones section of the Scan
dialog box (see Section 2.1.2.1.3 Defining scanning zones).

Note that if no scanning zone is specified, the device performs a 360° scan, acquiring
everything in its field of vision.

4. Scan the objects.

Press the Scan button. The objects within the specified zones are scanned and the
image of the scanned data is progressively displayed in the Scanner 2D View

Using a Surphaser Scanner in PolyWorks 2020 6

Spherical Scanning Scanning with a Surphaser device

window. Note that the device localizes its absolute zero the first time that a preview,
a scan, or a move to park position operation is launched.

5. The post-acquisition processing is automatically launched. The following occurs:

 Filters are automatically applied to the scanned data (see Section 2.1.2.1.4 Using
filters).

 The search for targets is automatically launched (see Section 2.1.2.1.5 Working
with multiple device positions).

Rectangular and spherical targets can be detected. Spherical targets are

automatically rescanned with a higher resolution to improve the precision of
their position (see Section 2.1.2.2.2 Target options).

 Once filtered, the scanned data is displayed in the Scanner 2D View window.
Data that does not meet the specified criteria is shown in red.

6. Confirm the filters to transfer the filtered data and, in the context of multiple device
positions, any detected targets to PolyWorks|Inspector.

The Confirm filters after scan check box is selected by default and allows adjusting
the filter parameters before transferring the data. This parameter is explained in
Section 2.1.2 Setting scanning parameters.

To adjust the filter parameters, proceed as follows:

6.1 In the Scan dialog box, change the filter parameters. The image of the
scanned data (in the Scanner 2D View window) reflects the changes in real
time.

6.2 Press the Confirm button to transfer the filtered data and the detected
targets to PolyWorks|Inspector. As a result, a new surface Data object of
the Spherical Grid data type is created in PolyWorks|Inspector.

Different filters can be applied to the scanned data to create other Data objects in
PolyWorks|Inspector. To do so, adjust the filters in the Scan dialog box, then press
the Confirm button to retransfer the data to PolyWorks|Inspector (the targets are
not retransferred). Another surface Data object is created in PolyWorks|Inspector, in
the same device position as the previous data.

7. The device can be moved to another position (if required). In this case, repeat Steps
3 to 6. For more information, see Section 2.1.2.1.5 Working with multiple device
positions.

2.1.1 Choosing the device plug-in and connecting to the device

Scanning in the PolyWorks|Inspector module is supported through plug-ins. To start

the plug-in, choose the Tools > Plug-ins > Surphaser menu item, or choose the Surphaser

Using a Surphaser Scanner in PolyWorks 2020 7

Spherical Scanning Scanning with a Surphaser device

item on the menu offered by the Scan split button located on the Devices toolbar, and
then click the button icon. The button is shown to the right.

2.1.2 Setting scanning parameters

This section describes the parameters of the Surphaser plug-in:

 The parameters used most often are offered in the Scan dialog box (see Section
2.1.2.1 The Scan dialog box)

 The parameters that are usually specified once are offered in the Spherical Scan
Options dialog box (see Section 2.1.2.2 The Spherical Scan Options dialog box).

2.1.2.1 The Scan dialog box

When the Surphaser plug-in is opened, the Scan dialog box, shown in Figure 2.1, is
displayed in the Dialog Zone pane. By default, the Source list box is set to Scanner,
which means that the plug-in is configured to acquire data directly from the scanning
device.

The following subsections explain the scanning parameters offered in the plug-in. Note
that these parameters are unavailable during the preview mode and during a scanning
session.

2.1.2.1.1 Specifying the name of the Data object

When the points acquired with Surphaser are transferred to PolyWorks|Inspector, they
are stored in a surface Data object. The Data object section of the Scan dialog box
offers the following item to specify the surface Data object to receive the points:

Name
A text box that allows specifying the name of the Data object. The default name is
surface scan <number>, where <number> represents an automatically
incremented integer. The name can be edited, if desired.

2.1.2.1.2 Defining resolution parameters

The Parameters section of the Scan dialog box offers items that allow defining the
following resolution parameters:

Point spacing
A group label that allows specifying parameters relative to point acquisition. It
offers the following items:

Using a Surphaser Scanner in PolyWorks 2020 8

Spherical Scanning Scanning with a Surphaser device

Figure 2.1 The Scan dialog box configured to acquire data directly from the scanning device.

Uniform
A check box, selected by default, that enables acquiring uniformly
spaced points, which means that the horizontal and vertical spacing is
the same. When selected, the following item is offered:

Horizontal and vertical spacing

A text box that allows specifying the horizontal and vertical
spacing of acquired points. Valid values depend on the device. If
the specified value is outside the range of values supported by

Using a Surphaser Scanner in PolyWorks 2020 9

Spherical Scanning Scanning with a Surphaser device

Figure 2.2 In this example, the point spacing is not uniform, therefore allowing the horizontal
and vertical spacing to be defined separately.

the device, the nearest value supported by the device is applied.

The default value is 2.0 mm.

Note that this value is effective at the distance specified for the At
distance from scanner parameter. See the description of this
parameter for more information.

When the Uniform check box is cleared (as shown in Figure 2.2), the
following items are offered:

Horizontal spacing
A text box that allows specifying the horizontal spacing of
acquired points. Valid values depend on the device. If the
specified value is outside the range of values supported by the
device, the nearest value supported by the device is applied. The
default value is 2.0 mm.

Note that this value is effective at the distance specified for the At
distance from scanner parameter. See the description of this
parameter for more information.

Vertical spacing
A text box that allows specifying the vertical spacing of acquired
points. Valid values depend on the device. If the specified value is
outside the range of values supported by the device, the nearest
value supported by the device is applied. The default value is
2.0 mm.

Note the following:

 This value is effective at the distance specified for the At

distance from scanner parameter. See the description of
this parameter for more information.

Using a Surphaser Scanner in PolyWorks 2020 10

Spherical Scanning Scanning with a Surphaser device

Figure 2.3 The Scanning zones section of the Scan dialog box, which allows numerically
defining the zones to scan.

 If the Uniform check box is subsequently selected, the

Vertical spacing value is applied to both the horizontal
and vertical spacing.

At distance from scanner

A text box that allows specifying the distance between the scanned
object and the scanner. Valid values are greater than 0.0 mm. The default
value is 3000.0 mm.

Note that the above-mentioned point-spacing values are effective at the

distance specified for the At distance from scanner parameter. Objects
closer to the scanner than the specified distance will have a smaller point
spacing, and objects farther a greater one.

2.1.2.1.3 Defining scanning zones

The Scanning zones section, shown in Figure 2.3, offers a table that allows specifying
the zones that will be scanned. By default, the table is empty, which means the device
performs a 360° scan, acquiring everything in its field of vision.

Scanning zones can also be defined graphically in the Scanner 2D View window (see
Section 2.1.3 Understanding the Scanner 2D View window (scanning operation)).

According to the specified zones, an estimated scan time is specified at the bottom of
the Scan dialog box (Estimated scan time parameter). Note that this time does not
include the time required for post-acquisition processing or for the high-resolution
rescanning of spherical targets.

Using a Surphaser Scanner in PolyWorks 2020 11

Spherical Scanning Scanning with a Surphaser device

2.1.2.1.3.1 Creating scanning zones

To create a scanning zone, press the Create Scanning Zone button, shown to the right.
A scanning zone is added in the table using default values. The edit mode is available
by clicking a cell.

The table provides the following information:

Index
A column that displays the number used to identify the scanning zone in the list.
By default, the scanning zone index number is hidden. Right-click the column
header to display a shortcut menu that allows showing the column.

Az. Start
A column that allows specifying the azimuth for the beginning of the scanning
zone. Valid values range from -180° to 180° inclusively. The value can be edited by
clicking the cell, specifying the value, then pressing Enter (or clicking elsewhere in
the dialog box).

Az. End
A column that allows specifying the azimuth for the end of the scanning zone.
Valid values range from -180° to 180° inclusively. The value can be edited by
clicking the cell, specifying the value, then pressing Enter (or clicking elsewhere in
the dialog box).

Note that this value must be higher than the Az. Start value.

El. Start
A column that allows specifying the elevation (altitude) for the beginning of the
scanning zone. Valid values range from -45.0° to 89.5° inclusively. The value can
be edited by clicking the cell, specifying the value, then pressing Enter (or clicking
elsewhere in the dialog box).

El. End
A column that allows specifying the elevation (altitude) for the end of the scanning
zone. Valid values range from -45.0° to 89.5° inclusively. The value can be edited
by clicking the cell, specifying the value, then pressing Enter (or clicking
elsewhere in the dialog box).

Note that this value must be higher than the El. Start value.

2.1.2.1.3.2 Deleting scanning zones

Scanning zones are automatically deleted when a preview is launched or when

disconnecting from the device. They can also be deleted at any time using the Delete
Selected Scanning Zone or Delete All Scanning Zones buttons, respectively shown
to the right.

Using a Surphaser Scanner in PolyWorks 2020 12

Spherical Scanning Scanning with a Surphaser device

Figure 2.4 The Filtering section of the Scan dialog box, which offers the filters that can be
applied to the scanned data.

2.1.2.1.4 Using filters

The Filtering section of the Scan dialog box, shown in Figure 2.4, offers several filters
that are applied to the scanned data before transferring them from the plug-in to
PolyWorks|Inspector. By default, all the filters are enabled. A check box allows enabling/
disabling a filter and, in most cases, a slider is available to specify a value. As the slider is
moved, the exact value is updated in the adjacent text box. The value can also be
edited in the text box.

The Filtering section offers the items that follow:

Confirm filters after scan

A check box that enables specifying that a user confirmation is required before the
data can be transferred to PolyWorks|Inspector. By default, the check box is
selected, and a Confirm button is available in the Scan dialog box. Therefore, the
user can readjust the filter parameters as needed before confirming the transfer to
PolyWorks|Inspector.

Min distance
A check box that enables filtering the acquired points by specifying a minimum
distance between acquired points and the scanner. By default, the check box is
selected, and the adjacent slider and text box are enabled to allow specifying the
minimum distance. Acquired points are excluded when they are closer to the
scanner origin than the specified minimum distance.

Using a Surphaser Scanner in PolyWorks 2020 13

Spherical Scanning Scanning with a Surphaser device

Valid values range from 0.0 mm to 100000.0 mm inclusively. The default value is
0.0 mm, which excludes no points.

Max distance
A check box that enables filtering the acquired points by specifying a maximum
distance between acquired points and the scanner. By default, the check box is
selected, and the adjacent slider and text box are enabled to allow specifying the
maximum distance. Acquired points are excluded when they are farther from the
scanner origin than the specified maximum distance.

Valid values range from 0.0 mm to 100000.0 mm inclusively. The default value is
100000.0 mm.

The More subsection offers additional filters:

Min intensity
A check box that enables filtering the acquired points by specifying the minimum
intensity of the acquired points. By default, the check box is selected, and the
adjacent slider and text box are enabled to allow specifying the minimum
intensity. Points with a lower intensity than the specified minimum intensity are
excluded.

Valid values are integers that range from 0 to 20000 iu (Intensity Units) inclusively.
The default value is 200 iu.

Max intensity
A check box that enables filtering the acquired points by specifying the maximum
intensity of the acquired points. By default, the check box is selected, and the
adjacent slider and text box are enabled to allow specifying the maximum
intensity. Points with a higher intensity than the specified maximum intensity are
excluded.

Valid values are integers that range from 0 to 20000 iu (Intensity Units) inclusively.
The default value is 18000 iu.

Min angle of incidence

A check box that enables filtering the acquired points by specifying the minimum
incidence angle between the laser and the scanned surface. By default, the check
box is selected, and the adjacent slider and text box are enabled to allow
specifying the minimum angle. Points are excluded when they have been
acquired with an angle that is less than the specified minimum angle.

Valid values range from 0.0° to 90.0° inclusively. The default value is 5.0°.

Gap width
A check box that enables filtering the acquired points by specifying the area on
both sides of a detected gap within which acquired points are excluded. By
default, the check box is selected, and the adjacent slider and text box are enabled
to allow specifying the width.

Valid values depend on the distance from the scanner. The default value is
5.25 mm.

Using a Surphaser Scanner in PolyWorks 2020 14

Spherical Scanning Scanning with a Surphaser device

Figure 2.5 The Device positions and targets section of the Scan dialog box, which offers
parameters that allow working with multiple device positions.

Isolated area
A check box that enables filtering the acquired points by specifying the minimal
area of a group of points. Points within a smaller area are not retained. Note that
this filter is also used when finding targets. By default, the check box is selected,
and the adjacent slider and text box are enabled to allow specifying the area.

Valid values depend on the distance from the scanner. The default value is
150.00 mm2.

Reset to Default Values

A button that restores the default value for all the filters in the dialog box.

2.1.2.1.5 Working with multiple device positions

The Device positions and targets section of the Scan dialog box, shown in Figure 2.5,
offers items that allow acquiring data in different device positions as well as detecting
targets that are subsequently used to align the data:

Create device position

A check box that enables creating a new device position when transferring the
data to PolyWorks|Inspector; it uses the Targets alignment method. A new device
position is created if there is a nonempty Data object in the current device position
in PolyWorks|Inspector. By default, the check box is selected.

Find targets
A check box that enables detecting the targets that will be used to align scanned
data. Targets are transferred to PolyWorks|Inspector in the active device position.
The scanned data will automatically be aligned, as explained in the “Moving a
device using the Targets alignment method” section of the PolyWorks|Inspector
Reference Guide. By default, the check box is selected.

Note that only the Isolated area filter is applied for target detection.

If the Confirm filters after scan check box is enabled and the data is transferred more
than once without performing a new scan, the data is transferred in the same device
position, but the targets are not retransferred.

Using a Surphaser Scanner in PolyWorks 2020 15

Spherical Scanning Scanning with a Surphaser device

Figure 2.6 The Configuration dialog box.

2.1.2.1.6 Configuring the device and controlling the azimuth position

The Scan dialog box contains the Surphaser software section, which offers the
following items:

Configuration
A button that displays the Configuration dialog box that allows specifying the files
and folders used by the device. For more information on the Configuration dialog
box, see Section 2.1.2.1.6.1 The Configuration dialog box.

Azimuth Position
A button that displays the Azimuth Position dialog box that allows controlling the
azimuth position of the device. For more information on the Azimuth Position
dialog box, see Section 2.1.2.1.6.2 The Azimuth Position dialog box.

2.1.2.1.6.1 The Configuration dialog box

The Configuration dialog box, shown in Figure 2.6, allows specifying the files and
folders used by the device. It offers the following parameters:

Scanner parameter files

A group label that offers items related to the parameter file (.rpr file).

Folder
A text box that allows specifying a path to the folder that contains the .rpr
files. An adjacent Browse button opens a folder browser. The .rpr files are
required in order to run the plug-in and must be located in this folder. The

Using a Surphaser Scanner in PolyWorks 2020 16

Spherical Scanning Scanning with a Surphaser device

default folder is C:\ProgramData\InnovMetric\PolyWorks\Surphaser. Note

that write access permission to the folder is required.

Import Parameter Files

A button that opens a file browser used to select the .rpr files to be
imported into the scanner parameter files folder.

Current
A list box that allows specifying the .rpr file used to initialize and
configure the device. Choose from the list of available .rpr files.

Keep raw scans

A check box, selected by default, that enables keeping raw scans (.c3d files). When
selected, it offers the following item:

Folder
A text box that allows specifying a path to the folder that contains the
raw scans (.c3d files). An adjacent Browse button opens a folder browser.
The default folder is [workspace configuration folder]\Surphaser.

Press the OK button to apply the changes and dismiss the dialog box, or press the
Cancel button to dismiss the dialog box. Note that if the Cancel button is pressed,
modifications to the scanner parameter files folder are still applied, and imported .rpr
files are still imported.

2.1.2.1.6.2 The Azimuth Position dialog box

The Azimuth Position dialog box, shown in Figure 2.7, allows controlling the azimuth
position of the device. It offers the following parameters:

The Azimuth position (degrees) section offers parameters used to control the
azimuth position of the device. It offers a text box that indicates the current azimuth
position of the device and allows specifying a new position. The device is moved to the
specified azimuth position when the Move to button is pressed. Valid values range
from -180° to 180° inclusively. The default value is the current azimuth position of the
device. Adjacent buttons, shown to the right, move the device by increments of 10° to
the left or to the right. The following button is also offered:

Set Current as Zero

A button that sets the current azimuth position of the device as the zero position,
which is used as a reference for the other azimuth positions. When the button is
pressed, the azimuth position value of the text box above is updated to zero, and
the azimuth position values of the Scanning zones in the Scan dialog box are
made relative to the new zero position.

The Utilities section offers the following parameter:

Using a Surphaser Scanner in PolyWorks 2020 17

Spherical Scanning Scanning with a Surphaser device

Figure 2.7 The Azimuth Position dialog box.

Figure 2.8 The General page of the Spherical Scan Options dialog box.

Move to Park Position

A button that moves the device to its park position. Note that the device may need
to localize its absolute zero, which is provided by the .rpr file, before moving to its
park position.

Press the Close button to dismiss the dialog box.

2.1.2.2 The Spherical Scan Options dialog box

The Options button of the Scan dialog box displays the Spherical Scan Options dialog
box, shown in Figure 2.8, that offers options specific to the Surphaser plug-in. This
dialog box is unavailable during the preview mode and during a scanning session.

Using a Surphaser Scanner in PolyWorks 2020 18

Spherical Scanning Scanning with a Surphaser device

2.1.2.2.1 General options

The General page of the Spherical Scan Options dialog box offers general options for
the Surphaser plug-in.

The Device section offers the following device-specific options:

ID
An uneditable text box that displays the ID of the connected device. If no device is
connected, the text box is empty.

Configuration
A list box that allows specifying the device configuration to be used. Choose from
the list of configurations provided by the connected device. If no device is
connected, the list box is empty. The default value is provided by the connected
device.

Audio feedback
A check box that enables emitting a sound during the entire scanning session. By
default, the check box is cleared.

The Preview section offers the following options:

Resolution
A list box that allows specifying the resolution used when generating a preview.
Choose from: Low, Medium, and High. A higher resolution generates a more
precise preview; a lower resolution generates the preview faster. The default value
is Low.

2.1.2.2.2 Target options

The Targets page of the Spherical Scan Options dialog box, shown in Figure 2.9, offers
options used to detect targets.

The Detected target types section offers options used to detect circular, rectangular,
and spherical targets:

Circular
A check box, selected by default, that enables detecting circular targets.

Rectangular
A check box, selected by default, that enables detecting rectangular targets.

Spherical
A check box, selected by default, that enables detecting spherical targets.

The Intensity threshold for circular targets text box allows specifying the intensity
threshold used to detect circular targets. Valid values are integers that range from 0 IU
to 20,000 IU inclusively. The default value is 2,000. IU

Using a Surphaser Scanner in PolyWorks 2020 19

Spherical Scanning Scanning with a Surphaser device

Figure 2.9 The Targets page of the Spherical Scan Options dialog box.

The Constrain circular and spherical target diameter optional section, cleared by
default, enables constraining the search for circular and spherical targets. It offers the
following option:

Diameter
A text box that allows specifying the diameter used to detect circular and spherical
targets. Valid values range from 30 mm (exclusively) to 500 mm (inclusively). The
default value is 60.325 mm.

The Rescan spherical targets optional section, selected by default, enables rescanning
spherical targets to improve the precision of their position. It offers the following
options:

Clearance distance
A text box that allows specifying the clearance distance, which is used to define
the scanning zone of rescanned spherical targets. The clearance distance is added
to each side of the spherical target to define the scanning zone, as shown in Figure
2.10. Valid values are greater than 0 mm. The default value is 50 mm.

Resolution increase factor

A list box that allows specifying the factor by which the resolution is increased
when rescanning spherical targets. This resolution is obtained by dividing the
point spacing of the first scan pass by the specified factor. Choose between 2 and
4. The default value is 2.

Note the following regarding the resulting point spacing value:

 If it is outside the range of values supported by the device, the nearest value
supported by the device will be applied.

 If it is equal to the point spacing value of the first scan pass, the spherical
targets are not rescanned.

Using a Surphaser Scanner in PolyWorks 2020 20

Spherical Scanning Scanning with a Surphaser device

Figure 2.10 The Clearance distance is added to each side of the spherical target to define the
scanning zone.

Scanning zone

Clearance
distance

Spherical target

2.1.2.2.3 Data object options

The Data Object page of the Spherical Scan Options dialog box, shown in Figure 2.11,
offers options applied to the Data object after the data is transferred to
PolyWorks|Inspector. The options can be edited in the properties of the scanned Data
object.

The Filtering section offers options used to filter Data points and triangles:

Max angle to scanner

A check box, selected by default, that enables specifying a maximum angular
deviation between the normal of triangles and the scanner. Triangles are excluded
when their angle with the scanner is greater than the maximum angle. This
prevents connecting surfaces at a different depth.

Note that the normal of a spherical grid Data point is obtained by averaging the
normal of all the triangles of which it is part. A Data point can therefore be left
without a normal as a result of the filtering performed by the Max angle to
scanner if it is not part of any triangles.

Angle
A text box, available when Max angle to scanner is selected, that allows
specifying a maximum angular deviation between the normal of
triangles and the scanner. Valid values are between 0° and 90°
exclusively. The default value is 83°.

Using a Surphaser Scanner in PolyWorks 2020 21

Spherical Scanning Scanning with a Surphaser device

Figure 2.11 The Data Object page of the Spherical Scan Options dialog box.

The Distance from scanner section offers options used to filter Data points based on
the distance from the scanner:

Min distance
A check box, cleared by default, that enables a text box used to specify a minimum
distance between Data points and the scanner. Data points are excluded when
they are closer to the scanner origin than the minimum distance.

Distance
A text box, available when Min distance is selected, that allows
specifying a minimum distance between Data points and the scanner
origin. Valid values are greater than 0 mm. The default value is 1000 mm.

Max distance
A check box, cleared by default, that enables an adjacent text box used to specify
a maximum distance between Data points and the scanner. Data points are
excluded when they are farther from the scanner origin than the maximum
distance. This can be used to exclude Data points on a wall behind a scanned
object, for example.

Distance
A text box, available when Max distance is selected, that allows
specifying a maximum distance between Data points and the scanner
origin. Valid values are greater than 0 mm. The default value is
10000 mm.

Ignore points without normals

A check box that enables ignoring Data points without normal information for the
operations that use the object. By default, the check box is cleared.

Using a Surphaser Scanner in PolyWorks 2020 22

Spherical Scanning Scanning with a Surphaser device

Figure 2.12 The 2D View window in the preview mode. In this example, the scanner has
performed a 360° scan. The image to the left represents the front of the device, while
the image to the right represents the back. The center represents the 0° azimuth of the
device. In this example, two scanning zones have been defined. The one currently
selected is shown in red.

2.1.3 Understanding the Scanner 2D View window (scanning operation)

When a preview or a scan is launched, a 2D image of the scanned data is progressively

displayed in the Scanner 2D View window. This window is automatically displayed, but
it can be closed and reopened at any time by pressing the 2D View button in the Scan
dialog box.

Note that if the preview or the scanning process is interrupted, the Scanner 2D View
window is restored to its previous state.

2.1.3.1 Graphically defining scanning zones

In the preview mode, the Scanner 2D View window allows graphically defining
scanning zones. If no scanning zones are defined, the device will perform a 360° scan.

Using a Surphaser Scanner in PolyWorks 2020 23

Spherical Scanning Scanning with a Surphaser device

The following table lists the operations that can be performed when defining scanning
zones. For each of these operations, the table explains how to proceed and illustrates
the corresponding pointer (or the button used to launch the operation):

Pointer/
Operation Procedure
Button

Create scanning Click and drag to define a rectangular zone in

zones the image to specify the zone that will be
scanned. More than one scanning zone can be
created.
When a new scanning zone is created, it is
surrounded by a red rectangle, as shown in
Figure 2.12.

Select a Move the pointer over the rectangle of a

scanning zone scanning zone (a green rectangle). When the
pointer changes to a hand, click the rectangle.
More than one scanning zone can be selected.
If scanning zones overlap, the last one created
will be selected.
Once selected, a scanning zone is surrounded
by a red rectangle, as shown in Figure 2.12.

Resize a Move the pointer over an edit point of the

scanning zone scanning zone. An arrow is displayed to
indicate the direction in which the scanning
zone would be resized. Then, drag the edit
point in the appropriate direction.

Move a Click the rectangle of a scanning zone

scanning zone (anywhere on the rectangle, except on an edit
point), then move the scanning zone. While
moving the scanning zone, the pointer
changes to a closed hand.

Delete a Select one or more scanning zones. Each

scanning zone selected scanning zone becomes surrounded
by a red rectangle. Then, press the Delete
Selected Scanning Zone button on the
vertical toolbar of the Scanner 2D View
window.

Delete all Press the Delete All Scanning Zones button

scanning zones on the vertical toolbar of the Scanner 2D View
window.

Any changes made to the scanning zones are reflected in the Scanning zones section
of the Scan dialog box, and vice versa. Scanning zones are automatically deleted when
a new preview mode is launched or when the plug-in is closed.

Using a Surphaser Scanner in PolyWorks 2020 24

Spherical Scanning Scanning with a Surphaser device

Figure 2.13 In this example, two scanning zones were previously defined. Only these zones were
scanned, and the result is displayed in (a). The filter parameters were then readjusted,
and the new result is displayed in (b).
(a)

(b)

2.1.3.2 Viewing scanning results and changing filters

Once the scanning zones have been defined, the scanning process can be launched.
The device scans only the specified zones. See the example shown in Figure 2.13 (a).

Based on the specified zones, an estimated scan time is specified at the bottom of the
Scan dialog box (Estimated scan time parameter). Note that this time does not include
the time required for post-acquisition processing or for the high-resolution rescanning
of spherical targets.

At the end of the scanning process, a 2D image of the filtered data is displayed in the
Scanner 2D View window. If desired, filter parameters can be changed and the new
result can be viewed in real time in the Scanner 2D View window. See the example

Using a Surphaser Scanner in PolyWorks 2020 25

Spherical Scanning Scanning with a Surphaser device

shown in Figure 2.13 (b).The data that does not meet the specified criteria is displayed
in red and will not be transferred to PolyWorks|Inspector.

2.1.4 Disconnecting from the device

The plug-in is disconnected from the device when the scanning plug-in is closed.

Using a Surphaser Scanner in PolyWorks 2020 26

Spherical Scanning Importing C3D files containing scanned data

3.2 Importing C3D files containing scanned data

Here is the typical workflow to import a C3D file that contains data scanned using a
Surphaser device. It is assumed that the parameters are set to their default value for the
following workflow.

1. Choose the Surphaser plug-in (see Section 3.2.1 Choosing the device plug-in).

By default, the plug-in attempts to connect to the device. In the message displayed,
click OK.

2. In the Scan dialog box, select File in the Source list box.

Once File is specified as the scan source, it becomes the default value when the
plug-in is reopened. In this case, the plug-in will not automatically attempt to
connect to the device.

3. Set the parameters that will be applied to the scanned data (see Section 3.2.2
Setting the parameters applied to the scanned data).

4. Press the Import button and select a C3D file in the browser displayed.

Depending on the file size, the import operation may take a while. When the
operation is completed, the plug-in displays the scanned data in the Scanner 2D
View window using the specified filters.

5. Confirm the filters to transfer the filtered data and, in the context of multiple device
positions, any detected targets to PolyWorks|Inspector.

The Confirm filters after scan check box is selected by default and allows adjusting
the filter parameters before transferring the data. This parameter is explained in
Section 3.2.2 Setting the parameters applied to the scanned data.

To adjust the filter parameters, proceed as follows:

5.1 In the Scan dialog box, change the filter parameters. The image of the
scanned data (in the Scanner 2D View window) reflects the changes in real
time.

5.2 Press the Confirm button to transfer the filtered data and the detected
targets to PolyWorks|Inspector. As a result, a new surface Data object of
the Spherical Grid data type is created in PolyWorks|Inspector.

Different filters can be applied to the scanned data to create other Data objects in
PolyWorks|Inspector. To do so, adjust the filters in the Scan dialog box, then press
the Confirm button to retransfer the data to PolyWorks|Inspector (the targets are
not retransferred). Another surface Data object is created in PolyWorks|Inspector, in
the same device position as the previous data.

Using a Surphaser Scanner in PolyWorks 2020 27

Spherical Scanning Importing C3D files containing scanned data

3.2.1 Choosing the device plug-in

Scanning in the PolyWorks|Inspector module is supported through plug-ins. To start

the plug-in, choose the Tools > Plug-ins > Surphaser menu item, or choose the Surphaser
item on the menu offered by the Scan split button located on the Devices toolbar, and
then click the button icon. The button is shown to the right.

3.2.2 Setting the parameters applied to the scanned data

This section describes the parameters of the Surphaser plug-in that are offered when
importing data previously scanned using the device:

 The parameters used most often are offered in the Scan dialog box (see Section
3.2.2.1 The Scan dialog box)

 The parameters that are usually specified once are offered in the Spherical Scan
Options dialog box (see Section 3.2.2.2 The Spherical Scan Options dialog box).

3.2.2.1 The Scan dialog box

When the Surphaser plug-in is opened, the Scan dialog box is displayed in the Dialog
Zone pane. By default, the plug-in is configured to acquire Data directly from the
scanning device. To import a file that already contains scanned data, choose File in the
Source list box. The dialog box is displayed as shown in Figure 3.14. It offers several
parameters, which are explained in the following subsections.

Using a Surphaser Scanner in PolyWorks 2020 28

Spherical Scanning Importing C3D files containing scanned data

Figure 3.14 The Scan dialog box configured for importing a scanned data file.

3.2.2.1.1 Specifying the name of the Data object

When the points acquired with Surphaser are transferred to PolyWorks|Inspector, they
are stored in a surface Data object. The Data object section of the Scan dialog box
offers the following item to specify the surface Data object to receive the points:

Name
A text box that allows specifying the name of the Data object. The default name is
surface scan <number>, where <number> represents an automatically
incremented integer. The name can be edited, if desired.

Using a Surphaser Scanner in PolyWorks 2020 29

Spherical Scanning Importing C3D files containing scanned data

Figure 3.15 The Filtering section of the Scan dialog box, which offers the filters that can be
applied to the scanned data.

3.2.2.1.2 Using filters

The Filtering section of the Scan dialog box, shown in Figure 3.15, offers several filters
that are applied to the scanned data before transferring them from the plug-in to
PolyWorks|Inspector. By default, all the filters are enabled. A check box allows enabling/
disabling a filter and, in most cases, a slider is available to specify a value. As the slider is
moved, the exact value is updated in the adjacent text box. The value can also be
edited in the text box.

The Filtering section offers the items that follow:

Confirm filters after scan

A check box that enables specifying that a user confirmation is required before the
data can be transferred to PolyWorks|Inspector. By default, the check box is
selected, and a Confirm button is available in the Scan dialog box. Therefore, the
user can readjust the filter parameters as needed before confirming the transfer to
PolyWorks|Inspector.

Min distance
A check box that enables filtering the acquired points by specifying a minimum
distance between acquired points and the scanner. By default, the check box is
selected, and the adjacent slider and text box are enabled to allow specifying the
minimum distance. Acquired points are excluded when they are closer to the
scanner origin than the specified minimum distance.

Using a Surphaser Scanner in PolyWorks 2020 30

Spherical Scanning Importing C3D files containing scanned data

Valid values range from 0.0 mm to 100000.0 mm inclusively. The default value is
0.0 mm, which excludes no points.

Max distance
A check box that enables filtering the acquired points by specifying a maximum
distance between acquired points and the scanner. By default, the check box is
selected, and the adjacent slider and text box are enabled to allow specifying the
maximum distance. Acquired points are excluded when they are farther from the
scanner origin than the specified maximum distance.

Valid values range from 0.0 mm to 100000.0 mm inclusively. The default value is
100000.0 mm.

The More subsection offers additional filters:

Min intensity
A check box that enables filtering the acquired points by specifying the minimum
intensity of the acquired points. By default, the check box is selected, and the
adjacent slider and text box are enabled to allow specifying the minimum
intensity. Points with a lower intensity than the specified minimum intensity are
excluded.

Valid values are integers that range from 0 to 20000 iu (Intensity Units) inclusively.
The default value is 200 iu.

Max intensity
A check box that enables filtering the acquired points by specifying the maximum
intensity of the acquired points. By default, the check box is selected, and the
adjacent slider and text box are enabled to allow specifying the maximum
intensity. Points with a higher intensity than the specified maximum intensity are
excluded.

Valid values are integers that range from 0 to 20000 iu (Intensity Units) inclusively.
The default value is 18000 iu.

Min angle of incidence

A check box that enables filtering the acquired points by specifying the minimum
incidence angle between the laser and the scanned surface. By default, the check
box is selected, and the adjacent slider and text box are enabled to allow
specifying the minimum angle. Points are excluded when they have been
acquired with an angle that is less than the specified minimum angle.

Valid values range from 0.0° to 90.0° inclusively. The default value is 5.0°.

Gap width
A check box that enables filtering the acquired points by specifying the area on
both sides of a detected gap within which acquired points are excluded. By
default, the check box is selected, and the adjacent slider and text box are enabled
to allow specifying the width.

Valid values depend on the distance from the scanner. The default value is
5.25 mm.

Using a Surphaser Scanner in PolyWorks 2020 31

Spherical Scanning Importing C3D files containing scanned data

Figure 3.16 The Device positions and targets section of the Scan dialog box, which offers
parameters that allow working with multiple device positions.

Isolated area
A check box that enables filtering the acquired points by specifying the minimal
area of a group of points. Points within a smaller area are not retained. Note that
this filter is also used when finding targets. By default, the check box is selected,
and the adjacent slider and text box are enabled to allow specifying the area.

Valid values depend on the distance from the scanner. The default value is
150.00 mm2.

Reset to Default Values

A button that restores the default value for all the filters in the dialog box.

3.2.2.1.3 Working with multiple device positions

The Device positions and targets section of the Scan dialog box, shown in Figure 3.16,
offers items that allow acquiring data in different device positions as well as detecting
targets that are subsequently used to align the data:

Create device position

A check box that enables creating a new device position when transferring the
data to PolyWorks|Inspector; it uses the Targets alignment method. A new device
position is created if there is a nonempty Data object in the current device position
in PolyWorks|Inspector. By default, the check box is selected.

Find targets
A check box that enables detecting the targets that will be used to align scanned
data. Targets are transferred to PolyWorks|Inspector in the active device position.
The scanned data will automatically be aligned, as explained in the Moving a
device using the Targets alignment method section of the PolyWorks|Inspector
Reference Guide. By default, the check box is selected.

Note that only the Isolated area filter is applied for target detection.

Using a Surphaser Scanner in PolyWorks 2020 32

Spherical Scanning Importing C3D files containing scanned data

Figure 3.17 The Configuration dialog box.

If the Confirm filters after scan check box is enabled and the data is transferred more
than once without performing a new scan, the data is transferred in the same device
position, but the targets are not retransferred.

3.2.2.1.4 Configuring the device

The Surphaser software section of the Scan dialog box gives access to the
Configuration dialog box, shown in Figure 3.17, which allows specifying the files and
folders used by the device. It offers the following parameters:

Scanner parameter files

A group label that offers items related to the parameter file (.rpr file).

Folder
A text box that allows specifying a path to the folder that contains the .rpr
files. An adjacent Browse button opens a folder browser. The .rpr files are
required in order to run the plug-in and must be located in this folder. The
default folder is C:\ProgramData\InnovMetric\PolyWorks\Surphaser. Note
that write access permission to the folder is required.

Import Parameter Files

A button that opens a file browser used to select the .rpr files to be
imported into the scanner parameter files folder.

Current
A list box that allows specifying the .rpr file used to initialize and
configure the device. Choose from the list of available .rpr files.

Using a Surphaser Scanner in PolyWorks 2020 33

Spherical Scanning Importing C3D files containing scanned data

Figure 3.18 The General page of the Spherical Scan Options dialog box.

Keep raw scans

A check box, selected by default, that enables keeping raw scans (.c3d files). When
selected, it offers the following item:

Folder
A text box that allows specifying a path to the folder that contains the
raw scans (.c3d files). An adjacent Browse button opens a folder browser.
The default folder is [workspace configuration folder]\Surphaser.

Press the OK button to apply the changes and dismiss the dialog box, or press the
Cancel button to dismiss the dialog box. Note that if the Cancel button is pressed,
modifications to the scanner parameter files folder are still applied, and imported .rpr
files are still imported.

3.2.2.2 The Spherical Scan Options dialog box

The Options button of the Scan dialog box displays the Spherical Scan Options dialog
box, shown in Figure 3.18, that offers options specific to the Surphaser plug-in. This
dialog box is unavailable during the preview mode and during a scanning session.

3.2.2.2.1 The general options

The General page of the Spherical Scan Options dialog box offers general options for
the Surphaser plug-in.

The Device section offers the following device-specific options:

ID
An uneditable text box that displays the ID of the connected device. If no device is
connected, the text box is empty.

Using a Surphaser Scanner in PolyWorks 2020 34

Spherical Scanning Importing C3D files containing scanned data

Configuration
A list box that allows specifying the device configuration to be used. Choose from
the list of configurations provided by the connected device. If no device is
connected, the list box is empty. The default value is provided by the connected
device.

Audio feedback
A check box that enables emitting a sound during the entire scanning session. By
default, the check box is cleared.

The Preview section offers the following options:

Resolution
A list box that allows specifying the resolution used when generating a preview.
Choose from: Low, Medium, and High. A higher resolution generates a more
precise preview; a lower resolution generates the preview faster. The default value
is Low.

3.2.2.2.2 The target options

The Targets page of the Spherical Scan Options dialog box, shown in Figure 3.19, offers
options used to detect targets.

The Detected target types section offers options used to detect circular, rectangular,
and spherical targets:

Circular
A check box, selected by default, that enables detecting circular targets.

Rectangular
A check box, selected by default, that enables detecting rectangular targets.

Spherical
A check box, selected by default, that enables detecting spherical targets.

The Intensity threshold for circular targets text box allows specifying the intensity
threshold used to detect circular targets. Valid values are integers that range from 0 IU
to 20,000 IU inclusively. The default value is 2,000. IU

The Constrain circular and spherical target diameter optional section, cleared by
default, enables constraining the search for circular and spherical targets. It offers the
following option:

Diameter
A text box that allows specifying the diameter used to detect circular and spherical
targets. Valid values range from 30 mm (exclusively) to 500 mm (inclusively). The
default value is 60.325 mm.

Using a Surphaser Scanner in PolyWorks 2020 35

Spherical Scanning Importing C3D files containing scanned data

Figure 3.19 The Targets page of the Spherical Scan Options dialog box.

The Rescan spherical targets optional section, selected by default, enables rescanning
spherical targets to improve the precision of their position. It offers the following
options:

Clearance distance
A text box that allows specifying the clearance distance, which is used to define
the scanning zone of rescanned spherical targets. The clearance distance is added
to each side of the spherical target to define the scanning zone, as shown in Figure
3.20. Valid values are greater than 0 mm. The default value is 50 mm.

Resolution increase factor

A list box that allows specifying the factor by which the resolution is increased
when rescanning spherical targets. This resolution is obtained by dividing the
point spacing of the first scan pass by the specified factor. Choose between 2 and
4. The default value is 2.

Note the following regarding the resulting point spacing value:

 If it is outside the range of values supported by the device, the nearest value
supported by the device will be applied.

 If it is equal to the point spacing value of the first scan pass, the spherical
targets are not rescanned.

3.2.2.2.3 The Data object options

The Data Object page of the Spherical Scan Options dialog box, shown in Figure 3.21,
offers options applied to the Data object after the data is transferred to
PolyWorks|Inspector. The options can be edited in the properties of the scanned Data
object.

The Filtering section offers options used to filter Data points and triangles:

Using a Surphaser Scanner in PolyWorks 2020 36

Spherical Scanning Importing C3D files containing scanned data

Figure 3.20 The Clearance distance is added to each side of the spherical target to define the
scanning zone.

Scanning zone

Clearance
distance

Spherical target

Max angle to scanner

A check box, selected by default, that enables specifying a maximum angular
deviation between the normal of triangles and the scanner. Triangles are excluded
when their angle with the scanner is greater than the maximum angle. This
prevents connecting surfaces at a different depth.

Note that the normal of a spherical grid Data point is obtained by averaging the
normal of all the triangles of which it is part. A Data point can therefore be left
without a normal as a result of the filtering performed by the Max angle to
scanner if it is not part of any triangles.

Angle
A text box, available when Max angle to scanner is selected, that allows
specifying a maximum angular deviation between the normal of
triangles and the scanner. Valid values are between 0° and 90°
exclusively. The default value is 83°.

The Distance from scanner section offers options used to filter Data points based on
the distance from the scanner:

Min distance
A check box, cleared by default, that enables a text box used to specify a minimum
distance between Data points and the scanner. Data points are excluded when
they are closer to the scanner origin than the minimum distance.

Using a Surphaser Scanner in PolyWorks 2020 37

Spherical Scanning Importing C3D files containing scanned data

Figure 3.21 The Data Object page of the Spherical Scan Options dialog box.

Distance
A text box, available when Min distance is selected, that allows
specifying a minimum distance between Data points and the scanner
origin. Valid values are greater than 0 mm. The default value is 1000 mm.

Max distance
A check box, cleared by default, that enables an adjacent text box used to specify
a maximum distance between Data points and the scanner. Data points are
excluded when they are farther from the scanner origin than the maximum
distance. This can be used to exclude Data points on a wall behind a scanned
object, for example.

Distance
A text box, available when Max distance is selected, that allows
specifying a maximum distance between Data points and the scanner
origin. Valid values are greater than 0 mm. The default value is
10000 mm.

Ignore points without normals

A check box that enables ignoring Data points without normal information for the
operations that use the object. By default, the check box is cleared.

3.2.3 Using the Scanner 2D View window (import operation)

When the C3D file is imported, the scanned data is automatically displayed in the
Scanner 2D View window. This window can be closed and reopened at any time by
pressing the 2D View button in the Scan dialog box.

Note that the scanned data is displayed only when the Confirm filters after scan check
box is selected. Filter parameters can be changed and the new result can be viewed in
real time in the Scanner 2D View window. See the example shown in Figure 3.22. The

Using a Surphaser Scanner in PolyWorks 2020 38

Spherical Scanning Importing C3D files containing scanned data

Figure 3.22 In this example, the file is imported and the scanned data is displayed in the
Scanner 2D View window, as shown in (a). The filter parameters were then readjusted,
and the new result is displayed in (b).

(a)

(b)

data that does not meet the specified criteria is displayed in red and will not be
transferred to PolyWorks|Inspector.

Using a Surphaser Scanner in PolyWorks 2020 39

4. Scripting and Additional Functionalities
PolyWorks offers full scripting possibilities which allow automating tasks in part or
entirely, depending on the nature of the task to perform. Basic scripts contain
application commands that allow performing operations identical to those performed
directly using the GUI of an application, such as PolyWorks|Inspector (e.g., menu items,
toolbar buttons). Enhanced scripts include elements of the Macro Script Control
Language (MSCL) such as variables, IF/WHILE commands, dialog boxes to query users,
and commands to write to and read from text files.

Most application commands are easy to find. For each action performed through the
GUI of an application, the corresponding application command can be seen in the
Command History pane. However, some application commands may not be offered in
the GUI, as they offer functionalities to address only specific needs.

This chapter presents a short introduction to scripting and explains how to quickly find
the application commands for your device that are mapped to the GUI. Then, the
functionalities that are only available through application commands, if any, are
presented.

4.1 Introduction to scripting

Actions performed using the GUI of an application have a corresponding application
command that can be viewed in the Command History pane. These commands can be
pasted into the Macro Script Editor of the application, saved to a file, and then be
recalled and executed in the Macro Script Editor. For an example, see Figure 4.1.

For each command, a description of the command, the command syntax, and a
description of each command argument (e.g., type) is provided. An example of the
command help that is available for this plug-in is shown in Figure 4.2. The editor offers
help in HTML format for all the MSCL commands, as well as application commands that
are found in the specific application/module. To access the HTML help file, choose the
Help > Commands menu item in the Macro Script Editor.

The Macro Script Editor is offered in the main PolyWorks Metrology Suite modules, such
as PolyWorks|Inspector™. Scripts must be executed in the Macro Script Editor. The
editor offers automatic indentation and an intelligent color scheme to, for example,
differentiate between MSCL and application commands. In addition, blocks of
commands can be quickly commented in and out. Finally, several script execution
modes are offered. Scripts can be executed step by step, or to user-specified break
points, which is useful when debugging a script.

The MSCL commands include common programming structures, such as IF and WHILE
for the conditional execution of commands. Variables are offered to store information,
including array variables. There are also commands to query the user and to get
information from a project (e.g., the number of objects under a given branch). These
commands provide just a sample of the possibilities available through scripting.

Using a Surphaser Scanner in PolyWorks 2020 40

Scripting and Additional Functionalities Introduction to scripting

Figure 4.1 The Command History pane shows the application commands that result from user
actions performed through the GUI. Here, a probing device was selected and the
Connect to Device button was pressed. In (a), the arrow shows the corresponding
commands that appear in the Command History pane. In (b), the commands were
copied and pasted into a new script in the Macro Script Editor.

(a)

(b)

Complete information on scripting in PolyWorks is provided in the Macro Script

Reference Guide in PDF format, available from the editor’s Help menu.

Using a Surphaser Scanner in PolyWorks 2020 41

Scripting and Additional Functionalities Introduction to scripting

Figure 4.2 The list of application commands for the plug-in in the HTML command help.

Using a Surphaser Scanner in PolyWorks 2020 42

Scripting and Additional Functionalities Functionalities only available by scripting

4.2 Functionalities only available by scripting

The table that follows provides a brief description of application commands that offer
functionalities that are only available through scripting. For complete command
information, including command syntax, arguments, and notes, see the HTML help file.

Command Description

No commands available.

Using a Surphaser Scanner in PolyWorks 2020 43