Professional Documents
Culture Documents
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.
Contents
24 1. Getting Started
25 1.1 Starting IMSurvey
25 1.1.1 Starting IMSurvey from the Workspace Manager
27 1.1.2 Starting IMSurvey from the Windows shortcut
28 1.1.3 Starting IMSurvey from the command line
29 1.2 About IMSurvey
29 1.3 Using the Support Assistant
29 1.4 Exiting IMSurvey
30 1.5 Getting help
30 1.5.1 The Reference documentation
31 1.5.1.1 Related documentation
31 1.5.1.2 Accessing the Reference documentation from dialog boxes
31 1.5.1.3 Topics not yet documented
31 1.5.2 Finding what’s new in IMSurvey
32 1.5.3 V11 to V12 menu correspondences
32 1.6 Getting technical support
33 2. Introduction to IMSurvey
34 2.1 IMSurvey – An object-oriented measurement and verification tool
34 2.1.1 Reference objects
35 2.1.2 Data objects
35 2.1.3 Data alignment objects
36 2.1.4 Data color map objects
36 2.1.5 Feature primitive objects
36 2.1.6 Cross-section objects
36 2.1.7 Measurement objects
37 2.1.8 Coordinate system objects
37 2.1.9 Report objects
37 2.2 The IMSurvey rapid surface inspection methodology
38 2.2.1 Overview of object alignment techniques
40 2.2.2 Overview of point-to-surface comparison methods
40 2.2.2.1 Controlling the comparison distance computation
40 2.2.2.2 Specifying surface tolerances for pass/fail inspections
40 2.2.2.3 Performing cross-sectional comparisons
40 2.2.3 Overview of point-to-surface error visualization methods
41 2.3 Comparing primitives to Data points
41 2.3.1 Extracting and fitting primitives
41 2.3.2 Measuring the deviations of Data points from primitives
45 3. Fundamentals
46 3.1 Automatic project update
46 3.1.1 Introduction
47 3.1.2 Automatic project updating
47 3.1.2.1 Automatic project update status
48 3.1.2.2 Objects update status
49 3.1.2.3 Events that trigger the automatic project update
49 3.1.2.4 Deactivating automatic project updating
50 3.1.3 Updating selected objects individually
51 3.1.4 Updating report items and formatted reports
52 3.1.4.1 Updating formatted reports
52 3.1.4.2 Updating table report items
53 3.1.4.3 Updating snapshot report items
54 3.1.5 Updating EZLayout report items individually
55 3.2 Customizing the module
55 3.3 Setting the units for the project
55 3.3.1 Importing objects with inconsistent units
56 3.3.2 Importing objects with unknown units
56 3.4 Editing the user configuration
76 5. Managing Projects
77 5.1 Introduction
77 5.2 Opening projects
77 5.2.1 Opening new projects
77 5.2.2 Opening existing IMSurvey projects
78 5.2.3 Opening IMInspect projects
79 5.2.4 Opening recent IMSurvey projects
79 5.3 Saving IMSurvey projects
80 5.3.1 Saving projects
81 5.4 Defining project and piece properties
88 6. Importing Objects
89 6.1 Introduction
89 6.2 Importing files
91 6.3 Importing point clouds
92 6.3.1 Import parameters
93 6.3.1.1 Project-related parameters
94 Object units
94 Object type
95 Alignment group
96 Subsampling factor
96 6.3.1.2 File-related parameters
96 Leica PTX files
97 Mensi SOI files
97 Riegl 3DD files
97 Text files
98 6.3.2 Particularities when importing IMAlign projects
99 6.3.3 Importing Data objects as huge Data objects
99 6.3.3.1 A general overview
100 6.3.3.2 Importing a first Data object
296 10.14 Georeferencing objects using the N Pairs of Center Points alignment method
297 10.15 Setting alignment options in the IMSurvey Options dialog box
839 Glossary
845 Index
This chapter explains how to start IMSurvey and access documentation, and obtain technical support.
4. Click PolyWorks.
Drag a valid object (i.e., IMAlign project, polygonal model, point cloud) onto the
Start IMSurvey button on the Modules toolbar.
Select and click in the Wizard pane on a phrase preceded by the IMSurvey icon.
Right-click over an IMSurvey project and click Open in IMSurvey on the shortcut
menu.
Right-click over a polygonal model or a point cloud and click Import in IMSurvey on
the shortcut menu.
To open the IMSurvey module without specifying a file on start up, proceed as follows:
Right-click over the IMSurvey Projects branch and click Create using IMSurvey on the
shortcut menu.
Right-click over the Point Clouds branch in the active workspace and click Import in
IMSurvey on the shortcut menu.
Select the top level object in the active workspace, make choices in the Wizard
window, and click a phrase that is preceded by the IMSurvey icon.
To start IMSurvey using the Windows shortcut that is created at installation, proceed as
follows:
4. Click IMSurvey.
If the PolyWorks/Workspace Manager was not already open, it opens and the IMSurvey
module starts. The Workspaces area contains an empty, untitled workspace with an
empty IMSurvey project. If the PolyWorks/Workspace Manager was already open, the
IMSurvey module starts with an empty IMSurvey project in the active workspace.
IMSurvey may be invoked from a command line. A general call to IMSurvey has the
following format:
[-verbose]
where,
UserconfigDirectory\.innovmetric.version\macro\ApplicationName\
PolyWorksInstallationDirectory\macro\ApplicationName\
If the PolyWorks/Workspace Manager was not already open, it opens and the IMSurvey
module starts. If the PolyWorks/Workspace Manager was already open, only the
IMSurvey module starts.
On choosing the command, a splash screen is displayed that displays the software’s
version and build number. The build number helps InnovMetric Software’s
development team track the precise source code used to compile the module.
If the No button is pressed, the Support Assistant tool can always be accessed from the
Help menu of the PolyWorks/Workspace Manager, or the Help menu of the module.
The Support Assistant can also be invoked by way of a command line, executed from
the bin subdirectory of the PolyWorks installation directory. A general call to the
Support Assistant has the following format:
The system_report_filename parameter specifies the file name and location for the
created report.
The -p parameter specifies that the system report should display in a Notepad
application.
These two parameters are optional. If they are not specified, the report appears directly
in the Command Prompt window.
For technical support, send this report directly to your PolyWorks provider, or to the
InnovMetric Software technical team by e-mail at support@innovmetric.com.
If the current IMSurvey project has been modified, a message is displayed to prompt
saving the project. Press the Yes button to specify saving the project, the No button to
specify not saving the project, or Cancel to end the operation and return to IMSurvey. If
saving the project is specified and the associated workspace is untitled, the PolyWorks/
Workspace Manager prompts for a workspace name, which is used to save the project.
The Help > Reference Guides menu offers commands that provide access to the
InnovMetric Software manuals related to IMSurvey. These manuals consist of Adobe
PDF files which require that Adobe Reader be installed on your system:
Commands
Loads the Command Reference Guide in a Web browser. This document presents
the application commands that are specific to the module as well as the elements
of the Macro Script Command Language.
Macro Script
Loads the Macro Script Reference Guide into Adobe Reader. This document
explains how to create basic macros by saving and editing macros using the Macro
Script Editor. It also describes the Macro Script Command Language that enables
users to add programming functionalities to macros.
PolyWorks SDK
Loads the PolyWorks SDK Reference Guide into Adobe Reader. This document
provides information concerning plug-ins and COM architecture. Many samples
are provided.
A custom document is available for each standard PolyWorks plug-in offered from a
module’s Tools > Plug-ins menu. Each document provides information concerning
device setup and requirements, and describes specific parameters offered in the
device-related dialog boxes.
The following documents offered in PDF format, available from the Help > Reference
Guides menu of the PolyWorks/Workspace Manager, offer related information:
The PolyWorks® Reference Guide presents the PolyWorks software suite, including the
PolyWorks/Workspace Manager, and explains how to customize the user interface by
means of visual layouts. It also explains how to invoke modules from the PolyWorks/
Workspace Manager. Finally, appendixes describe the installation procedure for both
node-locked and floating licenses.
The IMAlign™ Reference Guide describes IMAlign, a PolyWorks module used to acquire
and align 3D point clouds with respect to each other.
On clicking the question mark on the title bar of an IMSurvey dialog box, the PDF
version of the appropriate reference guide, or other appropriate document, opens to
the related section. Pressing the F1 key performs the same operation with respect to a
dialog box, and displays the appropriate Wizard when in an interactive mode if the
Wizard is not already displayed.
Topics not yet documented will be available shortly in the documentation of upcoming
major and intermediate releases of PolyWorks 12.1.
Summary information on this topic may be found in the “What’s New in IMSurvey”
document, available under the Help menu of the PolyWorks/IMSurvey module, or in a
learning video.
For immediate information on this subject, please contact your technical support
personnel.
The Help > What’s New submenu of the IMSurvey module offers documents that
summarily explain what is new in the major and intermediate releases of PolyWorks:
The “What’s New in IMSurvey V12.0” document is useful for users who have worked
with previous versions of this module. It contains a summary of what is new in the
latest major release of IMSurvey.
A summary of what is new in all modules is available under the Help > What’s New
submenu of the PolyWorks/Workspace Manager.
Figure 1.3 The V11 to V12 menu correspondence displayed in a tooltip (a) and in a window (b).
(a)
(b)
The “Intermediate Release Notes” document provides the list of fixes and
enhancements in each intermediate release of PolyWorks since the last major release
of PolyWorks. It is also available under the Help > What’s New submenu of the
PolyWorks/Workspace Manager.
In version 12, the menu structure of IMSurvey has been improved. To help the transition
between V11 and V12, a menu correspondence item is offered on the Help menu.
On choosing the Help > V11 to V12 Menu Correspondence command, a V11 menu bar is
displayed, allowing users to navigate within the V11 menu structure. When the pointer
is over a menu item, a tooltip is displayed to indicate the new item name and position
within the V12 menu structure (see Figure 1.3 (a)). If the menu item is clicked, the new
item name and position are displayed in a window (see Figure 1.3 (b)), which allows
users to view the menu correspondence while navigating within the V12 menus.
This chapter provides an introduction to the objects of an IMSurvey project and an overview of the IMSurvey
methodology.
The CAD Layers branch contains the imported surfaces of a CAD Reference object
divided into one or more CAD layer objects. The CAD surfaces that are not assigned
to a layer are assigned to the default CAD layer called default layer.
The Element Groups branch may contain user-defined groups of elements (i.e.,
triangles or CAD surfaces).
Reference objects can be edited to have a virtual surface (i.e., created using an offset or
a thickness). While only original surfaces can be edited or selected, picking and
anchoring operations and measurement tools (i.e., cross-sections) consider virtual
surfaces.
Information and several tools related to Reference objects are found in Chapter 23
Editing Reference and Data Objects.
A Data object consists of an object that is the representation of the actual object that is
to be inspected with respect to the Reference object. There are two categories of Data
objects: surface and boundary Data objects. Data objects may be imported from file or
from other PolyWorks projects or as a result of an operation on an existing Data object
(e.g., Create Duplicate). The points that compose Data objects, data points or triangle
vertices, are considered the elements of the object, and they can be selected, and then
hidden, or deleted for example.
Data objects can have one type of child object, the Element Groups branch, which may
contain user-defined groups of points.
Information and several tools related to Data objects are found in Chapter 23 Editing
Reference and Data Objects.
Organized and unorganized point clouds are supported. When an organized point
cloud is being processed, surface normals are computed for the Data points, and these
normals are used when the Data objects are rendered. Otherwise, rendered 3D points
are assigned a uniform color. Polygonal Data objects are also supported. All Data
objects have point normal information, except for unorganized point clouds.
A data alignment consists of the position of a Data object after an alignment operation,
as well as the parameters used and the type of alignment that was performed. Data
alignments are updatable. Data alignments are presented in Section 10.13 Using data
alignments.
Data color maps are a tool that allows representing a large number of deviation results
as colors as defined by the current color scale, and they hold the related creation
parameters, which enables updatability. Data color maps are presented in Section 12.2
Data color maps.
The following standard geometrical feature primitives are offered: circles, cones,
cylinders, planes, points, polygons, polylines, rectangles, spheres, and vectors.
Cones, cylinders, planes and spheres can be trimmed when extracted from Reference
object elements. Most often the Reference object elements only describe the primitive
partially. Certain operations (e.g., selection, comparison, extraction) use the associated
Reference object elements, and not the entire surface of these primitives, to obtain
results.
Information and tools related to feature primitives are found in Chapter 13 Feature
Primitives.
Cross-sections are created by slicing Data and Reference objects in the 3D scene within
an area delimited by a bounding rectangle. The cross-section retains the definition of
the slicing plane and the bounding rectangle, and has one child data cross-sections
and one child reference cross-section for, respectively, each Data and Reference object
sliced by the slicing plane. When a cross-section is updated, the slicing operation is
repeated and new child cross-sections replace the old ones.
IMSurvey projects come with a default coordinate system. It is called world and
corresponds to the standard Cartesian coordinate system, whose origin is located at 0,
0, 0. New coordinate systems can be created and the active coordinate system can be
specified from among the existing coordinate systems. New coordinate systems are
created under the Coordinate Systems branch in the tree view. Coordinate systems can
only be created when the Huge Translation is not used (i.e., is set to 0, 0, 0).
Information and tools related to coordinate systems are found in Section 22.1
Coordinate systems.
Complete reporting capabilities are offered. Available report items include screen
snapshots, figure captions, statistical tables and pie charts, text fields, headers, footers,
and animated reports. They are found in the Items subbranch of the Reports branch
and can be exported with limited formatting to Word and Excel, a HTML editor, and to
text file format.
It is also possible to create formatted reports using the EZLayout tool. Formatted
reports are saved under the Formatted Reports subbranch of the Reports branch.
Information and tools related to report items and formatted reports are found in
Chapter 20 Creating Report Items and Exporting Reports, and Chapter 21 Creating
Formatted Reports and Layouts.
Once the Data points are in the proper position, their deviation from the Reference
surface can be measured. A comprehensive set of distance measurement techniques is
available: shortest point-to-surface distance, oriented distances, point-to-boundary
distance, and so on. In addition, global tolerances can be defined for objects, and
specific tolerances can be defined for selected CAD surfaces, in order to perform
tolerance-based deviation measurements. Finally, special measurement techniques are
available, such as local measurements using the cross-section measurement objects.
Measurement results may then be displayed by means of color maps and/or colored
deviation vectors. An advanced color scale editor allows customizing color scales for
specific applications.
Finally, report items (i.e., screen snapshots, 2D vector graphics, statistical tables, pie
charts) can be generated and exported external document formats including HTML,
Microsoft Word, or Microsoft Excel documents with added header and footer
information. In addition, formatted reports can be easily created using the EZLayout
tool that include IMSurvey report items, user-specified text, company logos, and so on.
Formatted reports can be printed and exported to PDF format. It is also possible to
produce 3D animated reports using the video generation capabilities.
Macro scripts allow users to automate an entire inspection process. Users may record
actions performed by way of menus and toolbars to a macro script, and enhance the
macro script using the Macro Script Control Language, the simple but powerful
programming language offered by PolyWorks.
There are several alignment techniques to bring a set of unaligned Data points onto a
Reference surface:
Manual alignment
Match 1 pair of points between the Data and Reference objects to provide an
approximate alignment.
N pairs of points picked on Data and Reference objects are matched to provide an
approximate alignment.
Center Points
Reference surface
CAD surfaces
Polygonized surface
Point-to-surface measurements
Distances
Tolerances
Cross-sections
Visualization of results
Color plots
Vectors
(and more)
Inspection reports
Project properties
An alignment method that matches source primitives (i.e., 1 planar primitive, 1 axial
primitive, and 1 center-point-based primitive) to destination primitives (i.e., 1 planar
primitive, 1 axial primitive, and 1 center-point-based primitive).
Perpendicular Planes
Once the Data points are aligned to the Reference surface, comparison operations can
be performed. A single Data point, all Data points, or selected Data points can be
compared to a Reference surface.
It is also possible to quickly perform part-to-part comparison without meshing the scan
data. In this scenario, a scanned object plays the role of a virtual Reference object.
Virtual Reference objects can consist of polygonal Data objects, and point cloud Data
objects with normal vectors.
The type of distance used for the comparison of Data points to Reference surfaces can
be specified. Shortest distance means that the minimum point-to-surface distance will
be computed. Oriented distance computations are also possible. Distances can be
computed along the X, Y, or Z axis, or along any vector. Finally, point-to-boundary
distance measurement techniques are available for contour inspection.
Once distances have been computed, results can be compared to surface tolerances in
order to perform a pass/fail type of inspection.
A global surface tolerance is defined for each imported object using tolerance
templates. The default tolerance templates can be modified. In addition, a specific
tolerance can be defined for individual CAD surfaces.
Generate cross-sections of aligned Data and Reference objects and compare the Data
cross-sections to the corresponding Reference cross-sections. Several creation
methods are offered. For example, it is possible to create cross-sections along a curve,
by anchoring, radially, from certain primitives, and so on.
Comparison results can be displayed as colors mapped onto the Data points, colors
mapped onto the Reference surface, or colored error vectors attached to the Reference
surface and pointing toward a related Data point.
An advanced color scale editor allows the customization of the colors for a variety of
purposes. In the standard mode, error distances are directly converted to colors. A pass/
fail mode is also available in which the error distance is first mapped in the tolerance
space before being converted to a color. The pass/fail mode allows different tolerances
for different CAD surfaces.
IMSurvey provides tools that allow creating primitives (i.e., circles, cones, cylinders,
planes, points, polygons, polylines, rectangles, spheres, and vectors).
It is possible to measure the deviations of Data points from primitives using specific
computation techniques:
Primitives Measurement
IMSurvey starts in the default visualization mode. The pointer consists of an arrow, and
rotations and translations can be performed on the current set of 3D objects. Chapter 9
Controlling the Display provides a complete description of the 3D object visualization
capabilities.
To interactively select object elements (i.e., points and surfaces), the Select Elements
mode must be active. To access/exit Select Elements mode, press the Select Elements
button on the Selection toolbar or press the SPACEBAR (shown to the right). In this
mode, the pointer becomes a cross, and it is not possible to translate or rotate a set of
3D objects. Chapter 8 Selecting Objects and Elements describes element-selection
capabilities.
4. Exit the specific operation mode. Some operations exit as soon as a user’s action
completes its execution. Other operations need to be explicitly terminated. In all
cases, the ESC key can be used at any time to exit or cancel an operation mode.
The Edit menu offers commands that allow undoing certain operations (i.e., object
creation cannot be undone) that were previously performed:
Operation Description
Operation Description
Redo
Reperforms the last undone operation. The Redo command does not indicate the
last editing operation that was performed. The Redo operation must be done
immediately after the Undo operation. It becomes unavailable once another
operation is performed, including translation/rotation operations in the 3D scene.
Note that it is possible to remove the last transformation operations and return to
the last editing operation.
Remove Undos
A submenu that offers two commands:
Transformation
Removes all rotation/translation operations from the Undo stack.
All
Removes all operations from the Undo stack. This may be useful if system
memory is low. On choosing All, a confirmation window is displayed.
Press the Yes button to continue, or the No button to end the operation.
Figure 2.3 A diagram explaining the navigation between the basic modes. The buttons shown
are located on the Standard toolbar.
Ctrl+Shift
Spacebar Default mode
Spacebar
interactive
Select modes
Elements
mode
Spacebar
TAB
Interrupt mode
Select Objects
mode
Spacebar
active. If the modes are compatible, their functionalities may stack. Otherwise, the new
mode ‘bumps’ the previously active one, ending it.
In the default mode, the model and other objects can be viewed and translated/
rotated.
The Select Elements mode allows selecting object elements (i.e., Data points, triangles
and CAD surfaces of Reference objects), and the Select Object mode allows selecting
objects in the 3D scene.
The other interactive modes refer to the operations that are invoked to view, align,
compare, and so on. Some operations depend on a preselection, others offer picking or
anchoring modes, and some permit to go to an Interrupt mode to rotate/translate the
3D scene.
The schema in Figure 2.3 shows how to navigate between the three main modes.
Notice that depending on the context, the SPACEBAR can be used to go to Select
Elements mode or to Interrupt mode.
Projects are updated automatically when Reference objects, Data objects, data
alignments, or measurement objects are changed, and the change results in at least
another object having to be remeasured. For more information, see Section 3.1.2
Automatic project updating. Selected objects can be updated individually when the
Automatic project update mode is deactivated. For more information, see Section 3.1.3
Updating selected objects individually.
3.1.1 Introduction
There are two types of measurement objects: feature primitives and cross-sections.
They have common characteristics and behaviors; they can be measured, updated,
reported, and remeasured. They have the capability of memorizing a measurement
method, its related measurement parameter values, and the relationships to other
objects, such as data alignments and coordinate systems, that were used to produce
the measurement results.
All measurement objects, data color maps, data alignments, and Data objects display
whether they have a measured status or not. A green check sign is superimposed on
the icon of objects that are measured (see Figure 3.1). For more information, see
Section 4.6.8 Visualizing the status of certain objects. The measured status has a
different meaning depending on object types:
The Automatic project update mode can be activated/deactivated by clicking the icon’s
menu button (shown to the right) located at the right end section of the status bar, and
selecting the Automatic project update command. When activated, the command is
preceded by a check mark. The menu also offers the Troubleshoot Project Update
command. For more information, see Section 22.3 Troubleshooting project updating.
When the Automatic project update mode is active, the normal icon is displayed on
the status bar (shown to the right).
When the Automatic project update mode is deactivated and, or when at least one
object is incompatible (i.e., created with an earlier version of PolyWorks), a No sign is
superimposed on the normal icon (shown to the right).
When at least one object could not be updated, a warning triangle is superimposed
on the normal icon (shown to the right). A notification is displayed above the status
bar informing that at least one object could not be updated and offering to click on
a link for details. Clicking the link displays the Troubleshoot Project Update dialog
box containing the list of objects that could not be updated. See Figure 3.2 for an
example of a notification.
When a project or an object is in the process of being updated, the names of the
objects being updated are displayed on the left end of the status bar, as follows:
Updating objects: <name of the object being updated>. When more than one object is
being simultaneously updated, the suffix <, and more...> is added to the name of the
object being updated.
A Long Operation in Progress dialog box also appears, displaying an update progress
bar and the name of the objects being updated. The Cancel button allows cancelling
the ongoing update operation. For more information, see Section 3.1.2.4 Deactivating
automatic project updating.
When an update operation is finished, the object update status (out-of-date , in error
, warning , or nonupdatable ) may be displayed on the object icon in the tree
view, depending on the status of the Automatic project update mode and the setting
of the Show update status on objects when update is deactivated check box on the
Tree View subpage of the Display page of the IMSurvey Options dialog box (see
Section 24.3.2 Tree view display options). Object update status and their corresponding
symbols are described in Section 4.6.8 Visualizing the status of certain objects.
Warning triangle symbols and x mark symbols are displayed when the Automatic
project update mode is active, or when it is deactivated and the Show update status
on objects when update is deactivated check box is selected on the Tree View
subpage of the Display page of the IMSurvey Options dialog box (see Section 24.3.2
Tree view display options).
Out-of-date symbols are displayed when the Automatic project update mode is
deactivated, and the Show update status on objects when update is deactivated
check box is selected on the Tree View subpage of the Display page of the IMSurvey
Options dialog box.
Moving the cursor over the icon displays a tooltip that describes the reason for the
object update status.
When an object of any type cannot be updated, all objects, except table and
snapshot report items, that are depending on it cannot be updated. The tooltip of
the object that is in error displays the reason of the error, while the tooltip of objects
having warnings and depending on the object in error displays the name of the first
object, located one level backwards, that is causing the warnings. Table report items
have a warning only when all reported objects are in error.
Ignored objects are not updated and are not listed as out-of-date objects.
Data alignments:
Split View, Center Data Object on Screen, interactive Manual Alignments, Best-Fit
Cross-Sections, and Auto-Match Data Points.
Table report items (do not have the Updatable check box on their property sheet):
Auto-Match Data Points, Color Map Point Annotations, and several others.
When the Automatic project update mode is active, the following events trigger an
automatic project update:
Changes to an object linked to another object. When changes are made to an object,
objects that depend on it are updated (e.g., feature-based alignments).
Although the Automatic project update mode is normally active, it can be useful to
deactivate it when performing a sequence of operations. For example, a best-fit
alignment could no longer work if a Data object is replaced by one located at a different
initial position. Deactivating the Automatic project update mode allows rebuilding the
pre-alignment of the best-fit alignment. After the series of operations is performed, the
Automatic project update mode can be reactivated.
The Automatic project update mode can be manually deactivated by clicking the icon’s
menu button and selecting the Automatic project update command (no check mark
precedes the command when the mode is deactivated) or by clearing the Automatic
project update check box on the Project page of the IMSurvey Options dialog box. For
more information, see Section 4.5 The status bar and Section 24.2 Project options.
Figure 3.2 An example of a notification that can be displayed above the Automatic project
update icon of the status bar.
When an update is cancelled by pressing the Cancel button on the Long Operation in
Progress dialog box, the current change is maintained, the partial project update is
undone, the Automatic project update mode is deactivated, and a notification is
displayed above the status bar informing that the Automatic project updating has been
deactivated. See Figure 3.2 for an example of a notification.
When the importation of a new Data object creates a new alignment group and results
in at least another object being out-of-date, a notification is displayed above the status
bar informing that the Automatic project updating has been deactivated and offering
to click on a link for details. See Figure 3.2 for an example of a notification. Clicking the
link displays a message window that informs to align the new Data object before
reactivating the Automatic project update mode.
The Automatic project update mode is temporarily deactivated when in the certain
interactive modes. These include certain alignment modes (i.e., Split View Alignment,
Manual Alignment, .
Once the interactive mode is exited, the Automatic project update mode is
automatically reactivated.
When the Automatic project update mode is deactivated (see Section 3.1.2.4
Deactivating automatic project updating), selected objects can be updated individually
by choosing the Edit > Update Objects command. This allows updating linked objects in
a specific order. No other objects than the selected ones are updated, which means that
if a selected object depends on an out-of-date object, the selected object will be
updated using an out-of-date object, therefore will be out-of-date from a project-
update point of view.
Certain objects are linked to alignments (e.g., feature primitives, report items) or
coordinate systems (e.g., data color maps, report items) and must first activate those
alignments and coordinate systems before being updated. When the Automatic
project update mode is deactivated, these objects are updated in the active data
alignments and coordinate system.
Alignments can only be updated one at a time. They cannot be part of a group of
selected objects when performing an individual update since they are themselves
linked to other alignment objects. When updating an alignment, the alignments
preceding the selected alignment in each alignment group are activated, then the
selected alignment is updated and activated.
In general, formatted reports, table and snapshot report items, as well as EZLayout
table and snapshot report items are updatable. For more information on report items
that cannot be updated, see Section 1.1.2.2 Objects update status.
In the tree view, an anchor symbol is superimposed on the normal icon of formatted
reports and report items that are nonupdatable, or rendered nonupdatable.
Report items and formatted reports are updated when the Automatic project update
mode is active. In order to optimize the Automatic project mode, report items and
formatted reports are not constantly updated in real-time. For example, they are not
updated when in certain interactive alignment modes, or when remeasuring an
alignment. Rather, they are updated in these specific situations:
Formatted reports cannot be updated and exported when they are not up to date. A
message is displayed informing the user that the export operation cannot be
performed in this context.
The current status of formatted reports displayed in the tree view can change even if
they have not been updated.
When the Automatic project update mode is active, the values of objects in error or
with warnings, as well as those depending on nonmeasured data alignments, or linked
to missing data alignments or coordinate systems, are not available in table report
items and formatted reports. To indicate that these values are not valid, table report
items and formatted reports display the letters N/A, and these letters are displayed/
exported instead of values. Note the following:
When the Automatic project update mode is deactivated, the invalid values of
objects in error or with warnings are displayed in table report items and formatted
reports and can be exported.
Ignored objects always display N/A instead of values in formatted report, whether
the Automatic project update mode is active or not.
For more information on object update status, see Section 4.6.8 Visualizing the status of
certain objects. For more information on the Automatic project update, see Section 3.1
Automatic project update.
By default, formatted reports are updatable. The Updatable check box of the Default
formatted report update parameters section of the Reports page of the IMSurvey
Options dialog box allows specifying whether new formatted reports are updatable or
not. For more information, see Section 24.8 Report options.
Each formatted report has a Updatable check box on the Formatted report tab of the
report property sheet to control this behavior. For more information, see Section 7.6.8
Properties of Reports.
When modifying a formatted report (including the update properties of a report item)
in EZLayout, it must be saved in order to be updated.
The update properties are the coordinate system, the data alignments and, for
snapshots, the object visibility properties. They are displayed on the Report item tab of
the item property sheet.
By default, table report items are updatable. The Updatable check box of the Default
report item update parameters section of the Reports page of the IMSurvey Options
dialog box allows specifying whether new table report items are updatable or not. By
default, updatable table report items are set to Updatable. For more information, see
Section 24.8 Report options.
Each table report item has a Updatable check box on the Report item tab of the table
report item property sheet to control this behavior. For more information, see Section
1.0.0.1 Updating a tTable’s contents and update properties. The Report item tab can be
accessed from the Items branch of the tree view, or from the EZLayout pane by
selecting a table and choosing the Edit > Item Properties command or the Properties
command of the shortcut menu.
Table report items are updated when the objects they refer to are changed.
Coordinate systems
It is possible to specify whether new updatable table report items are, by default,
updated using the active coordinate system or using a specific coordinate system that
was active at table creation time. This is determined by the Coordinate system option
of the Default report item update parameters section of the Reports page of the
IMSurvey Options dialog box. For more information, see Section 24.8 Report options.
When the Updatable property is selected, the Coordinate system list box of the
Report item tab of a table property sheet allows editing the coordinate system to
which the table report item is linked for update purposes. For more information, see
Section 1.0.0.1 Updating a tTable’s contents and update properties.
Data alignments
It is possible to specify whether new updatable table report items are, by default,
updated using the active data alignments or using specific data alignments that were
active at table creation time. This is determined by the Data alignments option of the
Default report item update parameters section of the Reports page of the IMSurvey
Options dialog box. For more information, see Section 24.8 Report options.
When the Updatable property is selected, the Data alignments list box of the Report
item tab of a table property sheet allows editing the data alignments to which the
table report item is linked for update purposes. For more information, see Section
1.0.0.1 Updating a tTable’s contents and update properties.
By default, snapshot report items are updatable. Each snapshot report item has a
Updatable check box on the Report item tab of the snapshot report items property
sheet to control this behavior. The Updatable check box of the Default report item
update parameters section of the Reports page of the IMSurvey Options dialog box
allows specifying whether new snapshot report items are updatable or not. By default,
updatable snapshot report items are set to Updatable. For more information, see
Section 24.8 Report options.
The Report item tab can be accessed from the Items branch of the tree view, or from
the EZLayout pane by selecting a snapshot and choosing the Edit > Item Properties
command or the Properties command of the shortcut menu.
Snapshot report items are updated when the objects they refer to are changed.
Coordinate systems
It is possible to specify whether new updatable snapshot report items are, by default,
updated with the active coordinate system or with a specific coordinate system that
was active at snapshot creation time. This is determined by the Coordinate system
option of the Default report item update parameters section of the Reports page of
the IMSurvey Options dialog box. For more information, see Section 24.8 Report
options.
When the Updatable property is selected, the Coordinate system list box of the
Report item tab of a snapshot property sheet allows editing the coordinate system to
which the snapshot report item is linked for update purpose.
Data alignments
It is possible to specify whether new updatable snapshot report items are, by default,
updated with the active data alignments or with specific data alignments that were
active at snapshot creation time. This is determined by the Data alignments option of
the Default report item update parameters section of the Reports page of the
IMSurvey Options dialog box. For more information, see Section 24.8 Report options.
When the Updatable property is selected, the Data alignments list box of the Report
item tab of a snapshot property sheet allows editing the data alignments to which the
snapshot report item is linked for update purpose.
When the Automatic project update mode is deactivated and the formatted report is
updatable, it is possible to update individual EZLayout table and snapshot report items
that are updatable without updating the entire piece. The operation updates the report
item objects in the piece using the active data alignments and coordinate system, that
information replaces the current specifications on the property sheet of the report
items, and the report items are updated in the formatted report.
This operation is only possible when the formatted report is saved in EZLayout, unless
no updatable EZLayout table or snapshot report items were added to it, removed from
it, or no updatable report item update properties were modified.
To proceed, select the desired table and snapshot report items on the current page and
choose the Edit > Update items command, or right-click over the selection and click
Update on the shortcut menu.
New instances of modules use that unit by default for the Length option of the Units
section on the General page of their options dialog box. The Length option can be
changed to other systems of units. All objects in a project must be expressed in the
same units of length. The units of length can be changed, and all objects in the project
are converted to the new units of length.
Objects that are imported into a module fall into three categories:
Objects containing units information, and those units are the same as the project’s
units of length.
Objects containing units information, and those units are not the same as the
project’s units of length. These inconsistent units must be resolved. This is explained
in Section 3.3.1 Importing objects with inconsistent units.
Note that in the case of an object in a project that is expressed in the incorrect units, the
Units Conversion method of the Scale Objects dialog box, available on the Edit menu,
can be used to convert the object to the correct units of length.
When an object is imported that contains units information which is different from a
project’s units of length specification, the object is automatically converted to the
project’s units of length.
For these few cases that do not yet respect these standards, the Inconsistent Units
message window, shown in Figure 3.3, is displayed, indicating the units of length and
the object’s units, and asking the user to confirm converting the object to the project’s
units of length:
Figure 3.3 Inconsistent units are detected when an object on import has units information
different from the project’s working units of length. The user is prompted to convert
the object to the current working units of length.
On pressing the Yes button, the object is converted to the project’s units of length.
The object retains its Original units information and its Units factor property
reflects the conversion operation. For example, Working units is set to feet and an
IGES file import operation has detected that the IGES file’s units information reads
millimeters. Once imported, its Original units property is set to millimeters and its
Units factor property is set to .00328.
On pressing the No button, the object is imported but not converted. Its Original
units property is the same as the project’s units of length and its Units factor
property is set to 1.
The import parameters determine the units of imported objects that do not contain
units information. Its use is configured on the General page of the IMSurvey Options
dialog box (see Section 24.1 General options).
4.1 Introduction
As shown in Figure 4.1, the user interface offers a menu bar, a Standard toolbar, other
toolbars, a status bar, and several main dockable panes. The Tree View pane offers a tree
view where each object is represented. The 3D Scene pane hosts a 3D rendering
window where 3D objects are displayed. Here, mouse-based rotations/translations are
applied globally to all objects. The status bar displays messages about the status of the
application and the name of interactive modes invoked by the user.
The graphical user interface elements (e.g., menu bars, toolbars, dockable panes, macro
scripts) are completely customizable by way of visual layouts offered on the Tools >
Visual Layout submenu.
Menu Description
Standard
toolbar
Menu Description
Menu Description
This menu offers all the secondary tools that are not part of the main
module workflow, such as operations that apply to Data/Reference
objects, Data/Reference elements, and huge data objects. In
addition, the tolerance assigned to objects and CAD surfaces may be
viewed and edited. It offers as well commands that allow recording
macro scripts, using the Command History pane, and modifying and
saving visual layouts.
Tools
The menu offers standard PolyWorks plug-ins and allows
customizing the plugins menu directory using standard Windows
techniques.
Finally, it allows modifying the options of the module, which include
general options (e.g., units, browsers, using wizards), project
settings, default names, display options, object-specific options, and
selection options. It also allows modifying the user configuration.
4.4.1 Contents
The Standard toolbar offers operations that allow loading and saving projects, undoing
operations, and more.
The area to the left displays tooltips and the status of operations (e.g., Ready).
The area to the right is the Notification Area. It displays icons that have their own
infotip. An icon may display information (e.g., the current mode or the current units of
length) and certain items may be clicked to access shortcuts to tools for those items
(e.g., access to the General page of the IMSurvey Options dialog box that allows
defining the units of length for the project). See the table that follows for a description
of the icons that may appear to the right on the status bar, a short description of the
item, and a reference to where complete information can be found.
Active layer. Clicking the icon’s menu button displays a list that
shows the available layers; the active layer has a check mark.
Click any layer to make it active. Clicking the icon opens the
Layers dialog box. For more information, see Section 7.10
Editing layers.
Objects created appear in the Tree View pane. They are placed in logical categories, the
topmost object being the project itself. As a result, objects can be rapidly located and
easily selected to be managed (e.g., hidden) or as input for certain operations. Shortcut
menus are offered by right-clicking most objects and branches in the tree view, making
it easy to apply operations to specific objects, or those objects grouped under a branch.
Standard Windows-based selection operations can be used to select objects in the tree
view.
4.6.1 Introduction
The Tree View pane is a central and hierarchal object management unit.
Each object is represented by an item in the Tree View pane. Items are displayed using a
tree view, and consist of an icon and an object name.
To select an object, click over it. Other selected objects are automatically deselected.
Click the first object, press and hold the SHIFT key, and then click the second
object.
Drag a selection rectangle in the tree view. As soon as any part of an object name
is included within the rectangle, the object is selected.
To select a set of nonconsecutive objects, press and hold the CTRL key while clicking
the objects.
The order of objects within a branch can be modified by dragging selected objects.
Objects can also be transferred into objects that allow this operation (i.e., object
groups).
While dragging objects, a visual indication shows where the object selection will be
relocated in the branch:
Releasing the mouse button on the red line relocates the selected objects at that
location, and releasing it on the highlighted object transfers the selected objects into
that object.
When an object changes position within its branch, its index changes as well to
represent its new position. By default, the object index number is not displayed. For
more information, see Section 24.3.2 Tree view display options.
The visibility status of an object can be switched by middle-clicking the object in the
tree view. The visibility status can also be switched for more than one object at a time:
For a selection of objects, hold down the SHIFT key and middle-click. The current
object selection is maintained.
For the objects that are located in the same branch, middle-click the branch:
If at least one object in the branch is visible, all objects in the branch will be
hidden when middle-clicking.
If all objects in the branch are hidden, they will become visible when middle-
clicking.
Note that object selection in the tree view is maintained while middle-clicking.
Branches of the tree view can be expanded and collapsed using the following
operations:
Click the plus (+) sign to expand a branch or the minus (-) sign to collapse a branch.
Select an object contained in a branch and use the left arrow to collapse the branch,
or select a collapsed branch and use the right arrow to expand the branch. Note that
using the left arrow on a branch will collapse the entire tree view.
Shortcut menus provide a subset of key operations that are related to the selected or
clicked objects. Shortcut menus are offered for objects in the Tree View pane and
objects in the 3D Scene pane.
The tree view’s shortcut menus add functionality to this object management tool. The
shortcut menus provide a wide range of functions without offering all of the operations
available using the main menus. On the other hand, they may offer some items that are
not found on the main menus; for example, a branch menu typically offers selection
operations for only objects under its branch. This guide follows primarily the menu bar
organization, but also documents those shortcut menu items that are not offered on
the main menus.
Right-click a branch to display a branch menu. Operations are offered that are
specific to the object type. They include creating and importing objects and
selection operations. See Figure 4.2 (a).
If a branch, or an object is right-clicked with the CTRL key pressed and held down, a
menu is displayed offering operations that will be carried out on the clicked object,
regardless of the current selection in the tree view; see Example 1 that follows. The
current selection is preserved, unless a dialog box operating on the clicked object
needs to be displayed; see Example 2 that follows. This is referred to as the Focus
mode. The first item on the shortcut menu indicates the name of the focused object.
See Figure 4.2 (c).
Example 1 – Hiding a Data object when other objects are already selected: A
cone and a plane are selected and visible, and the CTRL key is pressed and held
down. A Data object can be hidden by right-clicking the Data object, pointing
(a) A branch shortcut menu offers operations specific to its object type. If the branch has a
parent branch, its menu items are also offered as the submenu at the bottom of the menu.
(b) To the left, a shortcut menu for a selection of same-type objects. To the right, a shortcut
menu for a selection of not same-type objects; only operations available for all of the types of
objects are offered.
(c) The Focus mode allows preserving the selection in the tree view, in most cases, while
displaying a shortcut menu specific to the focused object. A red rectangle encloses the name
of the focused object. To activate this mode, hold down the CTRL key and right-click an object/
branch. See the two preceding examples.
View, and clicking Hide Objects. The cone and plane objects remain selected and
visible.
pressed and held down. A Data object is right-clicked and the Properties
command is clicked. The cone and plane become deselected, the Data object is
selected, and the property sheet relative to the Data object is displayed.
A shortcut to the Focus mode exists when only one object is to be selected – select
the object and right-click over the object.
Note that the focused object is enclosed within a red rectangle, indicating a focus.
Object index number – Displayed to the right of the object icon; by default, the
object index number is not displayed.
Object name. Many object types have a default name that can be changed, and that
is used at creation time.
Object visibility – When an object is visible in the 3D scene, its icon is displayed in the
tree view. When an object is hidden, its icon is also hidden.
See Figure 4.3 for an example of the visual conventions concerning object properties.
Certain objects may have different statuses (e.g., measured/unmeasured) and this
information is useful to the user in understanding the current state of the project. For
this reason, the status of certain objects is displayed in the tree view by way of special
object icons or by overlaying standard object icons with additional icons. The following
statuses are displayed in the tree view.
When measurement objects, data color maps, data alignments, and Data objects are
measured, a green check sign is superimposed on the normal icon. For more
information, see Section 3.1 Automatic project update.
When an object could not be updated because at least one of the objects it depends on
is in error (i.e., could not be updated) or has itself a warning, a warning triangle is
superimposed on its normal icon. When an object is incompatible (i.e., created with an
earlier version of PolyWorks), is in error, or is, at the same time, in error and has a
warning, an x mark is superimposed on its normal icon. When an object is out-of-
date or is, at the same time, in error and out-of-date, a clock icon is superimposed on
its normal icon. An object can have an out-of-date status only when the Automatic
project update is deactivated.
See Figure 4.3 for an example of the visual conventions concerning the status of certain
objects.
The icon of certain primitives (i.e., circles, polygons, rectangles) shows their in-space
orientation, which can be either internal or external (see Section 13.7 Using the
property sheet of primitives for detailed information). See Figure 4.5 for an illustration
of these icons.
Figure 4.4 The visual conventions used to represent the status of objects with regards to the
Automatic project update function.
Figure 4.5 The icon of certain primitives show their in-space orientation.
Internal circle
External circle
Internal polygon
External polygon
Internal Rectangle
External rectangle
For complete information on how to dock/undock panes, see the section Section 4.3.1
Customizing the docking panes in the PolyWorks Reference Guide.
The 3D Scene pane contains the main graphical window. It is used to view and edit
visible objects, anchor on objects, select objects/elements, and so on. Shortcut menus
are available for visible objects as well. The EZLayout pane is tabbed with the 3D Scene
pane.
ALT+right-click to access the shortcut menu by object type for objects visible in the 3D
scene. The name of the clicked object appears at the top of the menu. For an example,
see Figure 4.6.
The 3D Scene pane features a PolyZoom window (see Figure 4.7). The PolyZoom
window consists of a second graphical window embedded in the main graphical
window that zooms on the location pointed by the mouse pointer. It is used as follows:
The PolyZoom window is enabled/disabled by pressing the Z key when the 3D Scene
pane has the focus.
Decrease zoom
Increase zoom
Close window
Drag window
The PolyZoom window can be dragged by holding the Z key down and moving the
mouse pointer.
The PolyZoom window can be stretched by picking one of the three stretching
arrows. The + and - buttons increase/decrease the zooming factor.
The X button in the title bar dismisses the window (as does pressing the Z key).
Any operation performed in the main graphical window, such as selecting and picking,
can also be performed in the PolyZoom window. Within an interactive picking mode,
points can be picked alternately in both windows. A key benefit of the PolyZoom
window is to reduce the number of zooming operations needed to pick an elongated
feature, such as a polyline. The user can look at the 3D scene from a global perspective,
move the mouse pointer to a location, press the Z key, and pick a point, without having
to zoom in and out.
Shortcut menus are offered for visible objects in the 3D scene. They can be accessed as
follows:
Enter Pick Objects mode, configure the Picking Context dialog box, and right-click
over a visible object.
In Default mode, or an interrupted mode that allows it, ALT+right-click over a visible
object. Note that the first button on the 3D Scene toolbar must be selected in order
to allow using the ALT key.
The menu header displays the name of the object. Note the following:
The selection in the tree view is not affected unless a command is executed that
requires an object selection (e.g., Edit > Object Properties).
4.7.1.4 Visibility
The Dialog Zone pane is an area where most dialog boxes are displayed. By default, it
appears tabbed with the Tree View pane in order to allow maximum space for the 3D
Scene pane. In certain circumstances, the Tree View pane is automatically brought on
top of the Dialog Zone pane. For example, when a dialog box is closed and the Dialog
Pane becomes empty, the Tree View pane is brought on top of it.
In the Dialog Zone pane, if two dialog boxes are open at the same time, they become
tabbed. Parts of a dialog box that are partially hidden can be viewed by using the
pane’s scroll bars or by holding down the middle mouse button and dragging the
dialog box.
The Macro Script Editor pane, shown in Figure 4.8, can be used to record each of your
actions in the software as commands and save them as a macro script to a Unicode text
file. A macro script can then be edited, enhanced by a simple but powerful
programming language, and assigned to toolbar buttons for execution. Refer to the
Macro Script Reference Guide for complete documentation on the Macro Script Editor
and the macro script programming language. Note that Chapter 26 Plug-ins and
Macros also provides some summary information.
Note that this pane cannot be used when certain operation modes are active (e.g.,
Point Cloud Organizer).
The Command History pane echoes the commands that result in actions given by way
of menus, interfaces, and toolbars, as well as those executed by macro scripts.
It also offers a command line area that allows the user to give individual commands to
see what they do. Echoed commands may be copied and pasted to the command line
Figure 4.8 The Macro Script Editor allows recording, editing, enhancing, and running macro
scripts.
area, and the TAB key can be used to complete partial command words to create
commands more quickly.
For more information on using this pane, see Section 2.1.2 The Command History pane
of the Macro Script Editor Reference Guide.
The EZLayout pane is a complete tool, with its own tree view and menus, that allows
the creation of formatted reports using embedded IMSurvey report items and external
images. It is tabbed with the 3D Scene pane. For complete information, see Chapter 21
Creating Formatted Reports and Layouts.
Several commands on the View menu allow displaying the module’s dockable panes:
Dialog Zone
Displays a dockable pane of the same name that contains most dialog boxes. For
more information, see Section 4.7.2 The Dialog Zone pane.
Tree View
Displays a dockable pane of the same name that offers a tree view. For more
information, see Section 4.6 The Tree View pane.
Note that the 3D Scene pane is always visible. These panes can be moved to any
desired location, unless the Lock docking windows check box is enabled. The check
box is located on the Options tab of the Customize Visual Layout dialog box. For more
information, see the section Section 4.3.2.14 Customizing options of the PolyWorks
Reference Guide.
1. Specify a location, and specify an output file name in the File name text box.
2. Specify a format in the Save as type list box. Choose from: Microsoft’s Bitmap Files
(*.bmp), JPEG Files (*.jpg; *.jpeg), SGI Files (*.rgb), and TIFF Files (*.tif).
3. Press the Save button to launch the operation, or press the Cancel button to end
the operation.
The background color used for the snapshot is defined by the Snapshot Background -
Bottom and the Snapshot Background - Top colors, which are white by default. The
colors can be edited; for more information, see Section 24.3.3 Interface color display
options.
Options
5.1 Introduction
The File menu offers commands that allow opening and saving IMSurvey projects.
The File > New Project command allows creating a new IMSurvey project. It removes the
current set of objects from the application to create a completely new set. The new,
empty IMSurvey project has the default name Untitled. If the current project contains
unsaved changes, a message window is displayed indicating the situation and asking
to save the changes – the Yes button save the changes and continues, the No button
does not save the changes and continues, and the Cancel button ends the operation.
The File > Open Project command allows importing an IMSurvey or an IMInspect project.
On choosing the command, the file browser shown in Figure 5.1 is displayed to specify
an existing IMSurvey or IMInspect project. The left part of the browser window offers
two shortcuts, Open Workspaces and PolyWorks, to allow easily locating the
IMSurvey or IMInspect projects. The first shortcut gives access to the open workspaces,
while the second one gives access to all workspaces in the PolyWorks folder. The path
associated with this folder is specified on the General page of the PolyWorks/
Workspace Manager Options dialog box.
When a project is selected in the file browser and the browser preview pane is
displayed, the preview image of the project appears in the right part of the browser.
If a project is already open in the module when the command is given, and it has
unsaved changes, a message window is displayed indicating the situation and asking
to save the changes. Press the Yes button to save the changes and to continue, or press
the No button to continue without saving.
Note that the File > Open Project command allows opening IMSurvey projects
contained in workspaces (i.e., V9 and higher). Projects created in a previous version can
only be opened using the correct application command given in the Command History
Browse in open
workspaces, or
workspaces in the
PolyWorks folder
pane or executed from a script; for more information, see the Macro Script Reference
Guide.
Also, if application settings are contained in the specified project, they may be applied
to the IMSurvey module doing the importing. See Section 24.2 Project options for more
information on the Load application settings list box.
The PolyWorks browser displays the names of the IMInspect or the IMSurvey projects in
the active workspace. Opening an IMInspect project is the equivalent of importing all
of its objects that are supported in IMSurvey, along with its report items and
comparison results. Note the following:
If the IMInspect project contains more than one piece, a dialog box is displayed (see
Figure 5.2) to allow choosing the piece from which the objects will be imported.
Figure 5.2 The dialog box displayed when opening an IMInspect project that contains more
than one piece.
Data color maps are only imported when the following conditions are met: the
importation of all of the objects supported by IMSurvey is successful, all of the
comparison results are supported by IMSurvey, and in the case of a Data-to-Primitive
data color map, all the primitives must be supported and imported successfully.
The File > Recent Projects command allows opening recently processed IMSurvey
projects.
To open successfully, recently processed projects must still be located at the location of
the previous import.
Window sizes and positions, display modes, color information, and several geometrical
and project management parameters can also be saved in a configuration file that will
be used the next time the IMSurvey project is loaded into IMSurvey. Optional items can
be added to the IMSurvey configuration file and used either on loading or/and on
saving an IMSurvey project.
IMSurvey projects are saved under the IMSurvey Projects branch of the current
workspace.
The following commands on the File menu allow saving surveying projects:
Save Project
Saves the current IMSurvey project to its associated workspace.
If the project has never been saved, see the procedure described in the following
topic (Save Project As).
Save Project As
Saves the current IMSurvey project in a specified workspace.
The project is automatically associated to the active workspace. This setting can be
changed by browsing in the list of existing workspaces.
When the workspace is specified, the dialog box shown in Figure 5.3 is displayed
to allow specifying a file name. Specify a project name manually. Note that the
following characters cannot be used in the name of a project: /, \, :, *,?, “, <, > and |.
Press the Save button to launch the operation, or the Cancel button to end the
operation.
The current IMSurvey project will be assigned the specified name and be saved to
the workspace. If a workspace other than the currently associated workspace is
specified in the address bar, the project and its dependent objects are copied to
the new workspace. The workspace where the project is copied becomes the
active workspace, and the instance of the IMSurvey module doing the saving is
associated with the active workspace.
Figure 5.3 The dialog box used to save the current IMSurvey project as a new project.
project are saved to the workspace, which is then compressed (has the pwzip
extension).
To see the project properties, choose the File > Project Properties command. The project
properties page of the dialog box is displayed by default. See Figure 5.4 for an example.
To see the properties of the piece, click on the piece in the tree view located to the left
of the dialog box to see the piece properties page. See Figure 5.5 for an example.
The tree view displays the project name followed by the piece included in the project.
Project properties
The top section of the project properties page of the dialog box offers the following
item:
Workspace name
A view-only text box that displays the name of the workspace.
The Project section of the project properties page of the dialog box offers the
following options:
Name
A view-only text box that displays the name of the project.
Property
A column that lists the fields of information pertaining to the IMSurvey project.
Value
A column that displays the editable value of each field for the project. To enter a
value in a field, click it in the list, and type in the desired value in the Value column.
Organization
A field that allows specifying organization information. Click in the Value column
to specify the information.
Part number
A field that allows specifying part number information. Click in the Value column
to specify the information.
Part name
A field that allows specifying part name information. Click in the Value column to
specify the information.
User-defined fields can also be created and edited in the list to automate the capture of
additional information pertaining to the surveying project.
To add a user-defined field to the list, press the Add button , or right-click the list
and choose the Add command on the shortcut menu. Once the new user-defined field
is added to the list, enter a unique name in the Property column. Note that the dollar
sign ($) cannot be used in a user-defined field name, and the field cannot be empty. To
enter a value in a user-defined field, click it in the list, and type in the desired value in
the Value column, as shown in Figure 5.6.
Figure 5.6 The dialog box of project properties with values added to standard fields. A user-
defined field with a value has also been created.
To remove one or multiple user-defined fields from the list, select them and press the
Remove button , or right-click the list and choose the Remove command on the
shortcut menu.
The Pieces section of the project properties page of the dialog box offers the following
options:
Number of pieces
A view-only text box that displays the number of pieces of the project (i.e., always
only one piece).
The list with the piece included in the IMSurvey project offers the following columns:
No.
A column that contains a sequential number assigned to the piece. This column is
displayed by default.
Name
A column that displays the name of the piece. This column is displayed by default.
Date
A column that displays the date of creation for the piece. This column is displayed
by default.
Time
A column that displays the time of creation for the piece. This column is displayed
by default.
Serial number
A column that displays the serial number for the piece.
Operator name
A column that displays the operator name for the piece.
E-Mail Address
A column that displays the E-mail address of the operator for the piece.
Device
A column that displays the device used for the piece.
Other columns of information can be displayed for each user-defined field that is
specified in the piece properties.
Press the Apply button to apply changes made in the dialog box, press the Cancel
button to cancel them, and press the OK button to apply the changes and dismiss the
dialog box.
Piece properties
The piece properties page of the dialog box displays a list with the following columns:
Property
A column that lists the fields available to automate the capture of information
pertaining to the piece.
Value
A column that displays the value of each field for the piece. To enter a value in a
field, click it in the list, and type in the desired value in the Value column.
Piece name
An editable field that specifies the piece name. If desired, modify the information
by clicking in the Value column.
Date
An editable field that displays, by default, the date the piece was created. If
desired, click in the Value column to display the calendar tool used to modify a
date. The date is displayed using the short date setting in the Windows Regional
Options (e.g., mm/dd/yyyy).
Time
A field that specifies the time the piece was created, which is not editable.
Serial number
An editable field that specifies the serial number. Click in the Value column to
specify the information.
Operator name
An editable field that allows specifying the operator name. Click in the Value
column to specify the information.
E-Mail address
An editable field that allows specifying the E-mail address of the operator. Click in
the Value column to specify the information.
Device
An editable field that allows specifying the device used. Click in the Value column
to specify the information.
To add a user-defined field to the list, press the Add button , or right-click the list
and choose the Add command on the shortcut menu. Once the new user-defined field
is added to the list, enter a unique name in the Property column. Note that the dollar
sign ($) cannot be used in a user-defined field name, and the field cannot be empty. To
enter a value in a user-defined field, click it in the list, and type in the desired value in
the Value column, as shown in Figure 5.7.
To remove one or multiple user-defined fields from the list, select them and press the
Remove button , or right-click the list and choose the Remove command on the
shortcut menu.
Fields from the project and piece properties are available to formatted reports or
layouts when they are created (Chapter 21 Creating Formatted Reports and Layouts)
and can be configured for each formatted report or layout. The field information is
available through fixed and variable text field items and more generally for macro
scripting use. For more information, see Section 21.2.2 Specifying the report properties
and Section 21.4.6 Specifying the layout properties.
Figure 5.7 The dialog box of piece properties with values added to standard fields. A user-
defined field with a value has also been created.
Point clouds
Polygonal models
CAD models
6.1 Introduction
In IMSurvey, objects to be inspected are imported either as Reference objects (i.e.,
nominal objects) or Data objects (i.e., measured objects). These objects may be:
Point clouds (Data objects, and some formats may also be imported as Reference
objects)
The objects to be inspected can also be located in other projects created using
PolyWorks (i.e., IMEdit project, IMInspect project, or IMSurvey project) and be imported
in IMSurvey. In this case, Reference objects in the specified project are imported as
Reference objects, while Data objects are imported as Data objects.
The commands used to import Reference and Data objects are available from the File >
Import menu. This menu also allows importing measurement objects, such as feature
primitives, which are used to inspect Reference and Data objects. Measurement objects
can be imported from another project (i.e., IMEdit project, IMInspect project, IMSurvey
project).
Note that certain measurement objects (e.g., feature primitives) can be created by
importing text files. This creation method is called From File and is available when
creating a specific type of object (e.g., Measure menu). For information on this creation
method, see the chapter that covers the measurement object that you want to create.
A primitive object is created for each primitive included in the specified file or
project.
The imported primitive is assigned its imported name or a default name. Default
names can be customized; for more information, see Section 24.3.11 Default name
options.
Figure 6.1 The file browser used to importfiles from folders and PolyWorks workspaces.
(a) Browse in
open workspaces,
or workspaces in
the PolyWorks
folder
Open Workspaces: Contains a shortcut for each workspace that is currently open in
PolyWorks. This shortcut points to a subdirectory (called Open Workspaces) of the
PolyWorks directory.
PolyWorks: Contains the above-mentioned directory (Open Workspaces) and the list
of all workspaces previously saved in the PolyWorks subdirectory.
Multiple file selection is possible and a file type filter is offered (see Figure 6.1 (b)). When
required, import options are offered during the import process, either through the
Options button in the window browser (see Figure 6.1 (c)) or once the import
operation is launched.
See the following sections for information on the commands used to import objects
from the File > Import menu.
Note that imported objects are always imported into the active layer, even when
importing objects from another IMInspect or IMSurvey project that were contained in a
different layer.
Imported point clouds are added to the workspace associated with the module doing
the importing and are linked to the IMSurvey project. This is also the case for IMAlign
projects that are standalone or that reside in a workspace other than the one associated
with the module doing the importing.
Figure 6.2 If the file type cannot be determined, a new file type may be specified using the dialog
box shown here.
By default, all point clouds are viewed in the browser window. However, a filter may be
set for the browser window using a list box. The list box allows filtering point cloud files
by category (i.e., Spherical Grids or Unorganized Point Clouds) or by type (e.g., *.ris,
*.sab, *.rtpi). Point clouds can be imported from disk or from workspaces.
Once the file selection is made and the Open button is pressed, a dialog box may
display to offer import parameters (see the following subsection for information on
each parameter). Note that if the file does not have a known file extension (e.g., .abc),
this is detected on opening the file, and a dialog box displays (see Figure 6.2), which
offers all available formats. Choose the correct format and then press the OK button to
continue the import operation, or the Cancel button to cancel the operation.
When point clouds are imported, they may be copied to the workspace associated with
the IMSurvey module that is doing the importing and the resulting Reference or Data
object is linked to the point cloud. These objects are used by the IMSurvey project, but
are not encapsulated within the project on saving. However, if the objects are
transformed during the import operation (e.g., imported as huge data, converted to
polygons), then they are not copied to a workspace but rather added directly to the
IMSurvey project. Any editing applied to point clouds within an IMSurvey project does
not affect in any way its linked point clouds in the workspace.
When point clouds and polygonal models are imported, a surface normal can be
computed for each point (except for specific point cloud file formats). These normals
are used for various operations, such as rendering, primitive fitting, and Data-to-
Reference deviation operations.
The supported point cloud file formats are shown in the table that follows. The points
clouds are divided into categories, which allows offering import options by category
when required.
Text Files (.asc, .ascii, .pc, .pt, .xyz, .txt) Perceptron (.bin)
IGES Files (.igs, .iges) STL Files (.stl)
LAS Files (.las) STL Binary Files (.stlb)a
Laser Design (.scn)
a. It is possible to import point clouds with normal vectors from STL binary
files. In addition, very large STL files, exceeding 1 gigabyte in size, are
supported.
Point clouds in workspaces may also be imported into the module, depending on the
format.
This subsection explains the parameters offered during the import process, once the
file selection has been made and the Open button has been pressed. As explained
below, there are two types of parameters:
Figure 6.3 The dialog box that displays import parameters. In this example, more than one file
format is imported, including Mensi SOI and text files.
project-related
parameters
file-related
parameters
These parameters allow specifying whether point clouds are imported as Reference
objects or Data objects, as well as specifying object units for the imported files that
do not contain unit information. They are documented in Section 6.3.1.1 Project-
related parameters).
Parameters that depend on the format of the imported files. They are documented in
Section 6.3.1.2 File-related parameters.
This subsection explains the import parameters that are used to determine how the
point cloud file is integrated in the project. The parameters offered during the import
process depend on the specifications made in the IMSurvey Options dialog box. Note
that this subsection contains the whole list of parameters. They are listed in the order
they appear in the dialog box displayed during the import process.
If it is specified that point clouds be imported as huge Data objects, a second dialog
box is displayed during the import process, which contains parameters specific to this
functionality. See Section 6.3.3 Importing Data objects as huge Data objects for
complete information.
If the Unknown units option on the General page of the IMSurvey Options dialog box
has been set to Specify at import, the following items are offered in the Import
Parameters dialog box for files with unknown units:
Object units
A list box that allows specifying the units of length for the imported files. Choose
from: Nanometers, Microns, Millimeters, Centimeters, Decimeters, Meters,
Kilometers, Micro-Inches, Mils, Inches, Feet, US Survey Feet, and Miles. The
default value is Millimeters. Press the OK button to continue, or the Cancel button
to end the operation. On pressing the OK button, the following occurs:
If the object units and the module’s units of length are the same, the objects
are imported and their Original units property is set to the specified units.
If the object units and the module’s units of length are different, the objects
are scaled to the module’s units of length, which becomes the objects’ Units
factor property, and their Original units property is set to the specified
units.
Note that if multiple files of different formats are imported and they do not have
unit information, only one dialog box is displayed to allow specifying the unit for
the objects (i.e., the unit will apply to all imported files). To import multiple files
with different units, one import process must be performed for each unit that
needs to be specified.
When the Confirm import as reference objects or data objects option has been
selected on the Reference/Data > Point Clouds page of the IMSurvey Options dialog
box (see Section 24.5.2 Point cloud import options), the following items are offered in
the Import Parameters dialog box when at least one of the selected file formats may
result in the creation of Reference and Data objects:
Object type
A group label that offers options used to specify whether point clouds are
imported as Reference objects or as Data objects:
Reference objects
An option button that allows importing point clouds as Reference
objects. If any of the selected files cannot be imported as a Reference
object, they are not imported.
Data objects
An option button, selected by default, that allows importing point clouds
as Data objects.
Options with respect to alignment groups may be offered when importing or replacing
Data objects. These options are described in the subsections that follow.
When the Confirm at import option has been selected on the Reference/Data page of
the IMSurvey Options dialog box (see Section 24.5 Reference object and Data object
options), the items that follow may be offered in the Import Parameters dialog box if
there is at least one alignment group or more than one file is imported at the same
time.
The Alignment group section, shown in Figure 6.3, offers the following parameters
that allow specifying the alignment group to use when importing point cloud files as
Data objects:
Name
A list box that allows choosing the alignment group for the object. Choose either
an existing group or (Create New) to import the objects in a new alignment
group.
This item is available only if there are one or more alignment groups.
This item is available only if an existing alignment group is selected in the Name
list box.
This option is displayed only when more than one file is imported at the same time
and one of these conditions is met: there are no alignment groups, or (Create
New) is selected in the Name list box.
Note that the default values for these parameters are the ones set in the IMSurvey
options.
When the Confirm at replacement option has been selected under the Alignment
group group label on the Reference/Data page of the IMSurvey Options dialog box
(see Section 24.5 Reference object and Data object options), the items that follow are
offered in the Replacement Parameters dialog box.
Alignment group
A group label that offers the following item:
When the Confirm at import option of the subsampling factor has been selected on
the Reference/Data > Point Clouds > Spherical Grids page of the IMSurvey Options
dialog box (see Section 24.5.2.2 Spherical grid import options), the following item is
offered in the Import Parameters dialog box.
The Spherical grids section offers the following parameter that allows specifying the
subsampling factor to use when importing spherical grid point clouds:
Subsampling factor
A list box that offers subsampling factors to reduce the number of points in the
point cloud. For example, a factor of 1/4 keeps one point in every four. The default
value is the one set in the IMSurvey options. Note that this subsampling operation
is not applied to 3DD and RXP Riegl files.
This subsection explains the import parameters that are specific to the type of
imported files. During the import process, only the parameters relevant to the file
selection are displayed in the Import Parameters dialog box.
The Leica PTX files section of the Import Parameters dialog box offers a parameter
used when importing a Leica PTX file:
Color
A list box that specifies a type of color information to import from the input files.
Choose from: Color (RGB colors) or Intensity (intensity levels, which range from 0
to 255). The default value is Color. When Color is specified, each point is assigned
an RGB color. When Intensity is specified, each point is assigned a shade of gray
that corresponds to its intensity level.
If Color is specified and the file being imported only contains intensity information,
each point is assigned a shade of gray that corresponds to its intensity level.
If Color is specified and the file being imported contains no color information
(neither color nor intensity), each point is assigned the color white.
If Intensity is specified and the file being imported does not contain intensity
information, each point is assigned the color white, even if the file contains color
information.
The Mensi SOI files section of the Import Parameters dialog box offers a parameter
used when importing a Mensi SOI file:
Fill holes
A check box, available for the SOI file format only, that offers to automatically add
extra points in order to fill some holes in the grid. By default, the check box is
cleared.
The Riegl 3DD files section of the Import Parameters dialog box offers a parameter
used when importing a Riegl 3DD file:
Color
A list box that specifies a type of color information to import from the input files.
Choose from: Color (RGB colors) or Intensity (intensity levels, which range from 0
to 255). The default value is Color. When Color is specified, each point is assigned
an RGB color. When Intensity is specified, each point is assigned a shade of gray
that corresponds to its intensity level.
If Color is specified and the file being imported only contains intensity information,
each point is assigned a shade of gray that corresponds to its intensity level.
If Color is specified and the file being imported contains no color information
(neither color nor intensity), each point is assigned the color white.
If Intensity is specified and the file being imported does not contain intensity
information, each point is assigned the color white, even if the file contains color
information.
The Text files section of the Import Parameters dialog box offers parameters used
when importing unorganized point clouds:
Figure 6.4 When importing a standalone IMAlign project, and an associated file cannot be
found, the dialog box shown here is displayed to resolve the path to the file or to
cancel the import operation.
This parameter is available only when importing ASCII and IGES text files.
Template
A list box that allows choosing a context-specific template used to read text files,
including ASCII point clouds. To access other standard templates, or to define
custom templates, press the Templates button. See Section 5.3.1 Importing from
text files of the PolyWorks Reference Guide for more information on templates
used in reading text files.
If the IMAlign project and its associated files are not in the workspace associated with
the IMSurvey module doing the importing, then they are copied into the workspace
associated with the IMInspect module.
When importing an IMAlign project, the data points of the raw 3D images are imported,
and not the interpolated 3D image points.
If, on reading the IMAlign project, an associated file cannot be found, the dialog box
shown in Figure 6.4 is displayed to resolve the path to the missing file. The name of the
missing file is indicated in the first text box. A new path to the file may be specified
directly in the second text box, or by pressing the Browse button and locating the file.
Then, press the OK button. Or, press the Skip button and the import will continue
without the file. To cancel the import operation, press the Cancel button.
If the IMAlign project contains image reference points and/or global reference points,
they are used to create point primitives. The name of a reference point in IMAlign is
assigned to the created point primitive in IMSurvey. The global reference points are
placed within an object group and made visible. The image reference points belonging
to the same 3D image are placed within an object group and are not made visible.
Object groups are given descriptive names.
Note that any editing done on the IMAlign project in the IMAlign module (e.g., 3D
image points were deleted) affects the number of raw data points imported into
IMSurvey.
If the Huge Translation values of the IMAlign project are different from 0:
If there are no objects in the IMSurvey project, the Huge Translation values of the
IMAlign project are assigned to the IMSurvey project and the IMAlign project is
imported. It is situated in space as it is in the IMAlign project.
If there are objects in the IMSurvey project as well as Huge Translation values
different from 0, the IMAlign project is imported and translated by the difference
between the two Huge Translation values.
If there are objects in the IMSurvey project and its Huge Translation values equal 0,
the user is prompted to translate existing objects or not. If the answer is Yes, the Huge
Translation values of the IMAlign project are assigned to the IMSurvey project and
the Huge Translation values are added to the existing objects and subtracted from
the incoming objects. If the answer is No, existing objects are not translated and the
incoming objects are imported as large numbers, which may result in a loss of
precision.
IMSurvey can handle huge Data objects consisting of hundreds of millions of Data
points using the Manage Huge Data Objects tool. It is especially useful on 32-bit
computers. This feature is particularly suited for large surveying point clouds that cover
thousands of square meters.
The huge dataset manager is activated by selecting the Import as huge data option
on the Reference/Data > Point Clouds page of the IMSurvey Options dialog box.
The methodology consists in managing point clouds by using grid cells uniformly
distributed along the XY plane. As physical memory may not be large enough to load
Figure 6.5 The dialog box used to specify values for the grid used to subdivide a Data object
imported using the Import as Huge Data option.
all of the Data points simultaneously, incoming point cloud files are read scan by scan,
and points are relocated into their respective cells and written back to disk. The
application also builds coarse shaded representations of the cells as they are being
updated. Once all points have been imported, users may then manage the visualization
of these points through a grid cell manager that prevents the exhaustion of physical
memory.
Important: Once a huge Data object is read in IMSurvey, it cannot be aligned – moving
the points among grid cells would be too time-consuming. If the huge Data object
must be georeferenced, please see the IMAlign module for all of the necessary tools.
When importing a point cloud file and the Import as huge data option has been
selected, a dialog box shown in Figure 6.5 is displayed. It contains the following items:
Note that the object size is displayed at the bottom of the group box in
the current unit of length.
By pressing the OK button, the Manage Huge Data Objects dialog box is displayed to
specify the cells to load in memory. For detailed information on managing huge Data
objects, see Section 23.3.9 Using the huge Data object manager.
The general procedure is similar to the one explained for the first imported Data object.
Note the following differences:
The huge Data object manager is displayed, showing the grid defined when the first
huge Data object was imported. The grid will be extended if necessary to include the
new object. All huge Data objects are displayed, even if they have a hidden visibility
status.
The currently imported huge Data object group is created in the tree view, with a
point cloud object for each grid cell. If a grid cell was already used for the creation of
a point cloud object, then a point cloud object created using the same grid cell for
the current Huge Data Object will always share the same loaded status. For example,
if two point clouds were created from the grid cell at (0,1), then inverting that cell‘s
status in the huge Data object manager flags the cell for loading or for being
removed from memory, and all point clouds that correspond to that cell will be
loaded or removed from memory when the Apply button is pressed.
Point clouds imported in an IMSurvey project using the Import as huge data option
can only be imported into another IMSurvey project if their cell grid has the same
dimensions as the ones in the current project. Therefore, the same Square side
length should be used for one project split into several IMSurvey projects.
Figure 6.6 If the file type cannot be determined, a file type may be specified using the dialog box
shown here.
On choosing theFile > Import > Polygonal Modelscommand, a file browser similar to the
one shown in Figure 6.1 is displayed to specify polygonal model files. The table that
follows provides the list of supported file formats.
By default, all polygonal model files are viewed. However, a filter may be set for the
browser window using a list box.
Note that if the file does not have the correct file extension (e.g., .abc), this is detected
on opening the file, and a dialog box displays (see Figure 6.6), which offers all available
formats. Choose the correct format and then press the OK button.
It is not the original polygonal model file that is loaded into the module, but a copy,
which is then transformed into an internal format.
project-related
parameters
Once the file selection is made and the Open button is pressed, a dialog box may
display. The parameters offered in this dialog box are composed of project-related
parameters that depend on import option specifications. See Figure 6.7 for an example
of parameters.
If the Unknown units option on the General page of the IMSurvey Options dialog box
has been set to Specify at import, the following items are offered in the Import
Parameters dialog box for files with unknown units:
Object units
A list box that allows specifying the units of length for the imported files. Choose
from: Nanometers, Microns, Millimeters, Centimeters, Decimeters, Meters,
Kilometers, Micro-Inches, Mils, Inches, Feet, US Survey Feet, and Miles. The
default value is Millimeters. Press the OK button to continue, or the Cancel button
to end the operation. On pressing the OK button, the following occurs:
If the object units and the module’s units of length are the same, the objects
are imported and their Original units property is set to the specified units.
If the object units and the module’s units of length are different, the objects
are scaled to the module’s units of length, which becomes the objects’ Units
factor property, and their Original units property is set to the specified
units.
Note that if multiple files of different formats are imported and they do not have
unit information, only one dialog box is displayed to allow specifying the unit for
the objects (i.e., the unit will apply to all imported files). To import multiple files
with different units, one import process must be performed for each unit that
needs to be specified.
When the Confirm at import option has been selected on the Reference/Data >
Polygonal Models page of the IMSurvey Options dialog box (see Section 24.5.3
Polygonal model import options), the following items are offered in the Import
Parameters dialog box, shown in Figure 6.7, when at least one of the selected file
formats may result in the creation of Reference and Data objects:
Object type
A group label that offers options used to specify whether polygonal models are
imported as Reference objects or as Data objects:
Reference objects
An option button that allows importing polygonal models as Reference
objects. If any of the selected files cannot be imported as a Reference
object, they are simply not imported at all.
Data objects
An option button, selected by default, that allows importing polygonal
models as Data objects.
Options with respect to alignment groups may be offered when importing or replacing
Data objects. These options are described in the subsections that follow.
When the Confirm at import option has been selected under the Alignment
group group label on the Reference/Data page of the IMSurvey Options dialog box
(see Section 24.5 Reference object and Data object options), the items that follow may
be offered in the Import Parameters dialog box if there is at least one alignment group
or more than one file is imported at the same time.
The Alignment group section, shown in Figure 6.7, offers the following parameters
that allow specifying the alignment group to use when importing polygonal model
files as Data objects:
Name
A list box that allows choosing the alignment group for the new object. Choose
either an existing group or (Create New) to import the objects in a new alignment
group.
This item is available only if an existing alignment group is selected in the Name
list box.
This option is displayed only when more than one file is imported at the same time
and one of these conditions is met: there are no alignment groups, or (Create
New) is selected in the Name list box.
Note that the default values for these parameters are the ones set in the IMSurvey
options.
When the Confirm at replacement option has been selected under the Alignment
group group label on the Reference/Data page of the IMSurvey Options dialog box
(see Section 24.5 Reference object and Data object options), the items that follow are
offered in the Replacement Parameters dialog box.
Alignment group
A group label that offers the following item:
Several operations on the File > Import submenu allow importing CAD models
containing trimmed surfaces as Reference objects using the standard file browser
shown in Figure 6.8. Using the file browser is explained in Section 6.2 Importing files.
The CAD models are saved within the IMSurvey project, and not as an object in a
workspace.
Note that if the file does not have the correct file extension (e.g., .abc), this is detected
on opening the file, and a dialog box displays (see Figure 6.9), which offers all available
formats. Choose the correct format and then press the OK button, or press the Cancel
button to exit the operation.
Figure 6.9 If the file type cannot be determined, a file type may be specified using the dialog box
shown here.
CAD model import options are offered on the CAD Models page of the IMSurvey
Options dialog box, and its subpages. The table that follows provides the related
information for the supported CAD formats.
Import options
Import hidden entities
Translator is optional
Supported versions
CAD file translator
File extensions
Select parts in
assembly files
Heal model
If an imported CAD model contains duplicated CAD surfaces, they are placed in an
element group called duplicated surfaces under the Element Groups branch of the
related Reference object.
Figure 6.10 The Import Parameters dialog box offers project-related parameters.
project-related
parameter
Once the file selection is made and the Open button is pressed, a dialog box may be
displayed. The parameters offered in this dialog box are composed of project-related
parameters that depend on import option specifications, or file-related parameters that
are file specific. See Figure 6.10 for an example of these types of parameters.
When the Confirm at import option has been selected in the Default properties
section on the Reference/Data > CAD Models page of the IMSurvey Options dialog
box (see Section 24.5.1 CAD model options), the Import Parameters dialog box, shown
in Figure 6.10, offers the following items:
Tessellated surfaces
An option button, selected by default, that specifies using tesselated
surfaces (i.e., polygonal representation) when inspecting a part with
respect to its CAD model. This option is appropriate when processing
data points produced by point cloud digitizing devices, or when
inspecting parts that have a size in the range of 0 to 10 meters. Such CAD
models can be tessellated with a small enough tolerance to prevent any
impact on the accuracy of the inspection results. In addition,
mathematical operations involving a large number of data points are
significantly quicker when using tessellated surfaces (e.g., measuring
deviations between Data and Reference objects is typically five times
faster than using NURBS surfaces). The following item is offered:
Tessellation tolerance
A text box that allows specifying a value that represents the
maximum chordal deviation between an imported CAD surface
and its polygonal representation. Valid values are greater than
zero. The default value is 0.01 mm.
Note that an automatic loop removal algorithm is applied that gets rid of
self-intersections, which are the result of self-intersecting trim curves,
and ensures the proper tessellation of CAD surfaces.
NURBS surfaces
An option button that specifies using NURBS surfaces for computations.
This option is appropriate for very large and detailed CAD models (i.e.,10
meters or more) which would take too long to tessellate, or in the context
of high-accuracy requirements (e.g., in the range of a few microns). CAD
model import time is accelerated, and the accuracy of mathematical
operations applied to CAD Reference objects is in the sub-micron range.
The following items are offered:
Tessellation tolerance
A text box that allows specifying a tolerance value used to
tessellate CAD models for display purposes as well as to
accelerate mathematical operations on NURBS surfaces. The
default value is 0.5 mm.
When Select CAD layers is selected on the Reference/Data > CAD Models page of the
IMSurvey Options dialog box, the Import Parameters dialog box, shown in Figure 6.10,
offers the following items:
CAD layers
An area that lists all of the CAD layers in the CAD file, preceded by a selection check
box, which is selected by default. All CAD surfaces that are not assigned to a CAD
layer are regrouped under the CAD layer named default layer.
In the case of a parts selection, only the CAD layers checked will be imported for all
parts. In the case of an assembly parts selection, only the CAD layers checked will be
imported for all selected parts of that assembly.
Imported CAD layers are represented as CAD layers located beneath their respective
CAD Reference object. A CAD layer has a name constructed using the name and/or the
ID of the layer in the CAD file. Each CAD layer is assigned a color; CAD layers with the
same name have the same color.
On choosing the File > Import > From Project command, a browser is displayed to specify
the projects from which to import objects. If the browser preview pane is displayed, the
preview image of the last specified project appears in the right part of the browser.
Once a project is read, a tree view is displayed, containing the importable objects.
Select the objects to import using standard Windows selection techniques, then press
the Import button, or press the Cancel button to cancel the operation.
When importing from workspaces and several projects are selected, a tree view dialog
box is displayed for each selected project consecutively.
Objects may be imported from a project that is currently open. In this case, the open
project becomes unavailable until the import operation is complete, as the import
Figure 6.11 The dialog box used to select the CAD layers to import.
operation uses the last-saved project on disk. If the project contains new objects not
yet saved to disk, they do not appear in the list of importable objects.
When importing objects from an IMEdit project, an object tree view like the one shown
in Figure 6.12 is displayed.
The following object types can be imported: polygonal models, NURBS models, curves,
points, planes, cross-sections, and point clouds.
The imported objects keep their original name. Same-name conflicts are resolved by
adding a number between parentheses after the name of the imported object.
Figure 6.12 In (a), the dialog box containing an object tree view, used to import objects from an
IMEdit project.
(a) (b)
(c)
The table that follows provides information concerning specific aspects of the import
operation.
Figure 6.13 The dialog box used to import objects from an IMInspect project. In (a), the project
contains only one piece. In (b), the project contains more than one piece, and a list
box is displayed to allow choosing the piece from which the objects will be imported.
(a) (b)
When importing objects from an IMInspect project, an object tree view like the one
shown in Figure 6.13 is displayed, containing the importable objects. If the project
contains more than one piece, a list box is displayed on top of the tree view to allow
choosing the piece from which the objects will be imported.
The imported objects keep their original name. Same-name conflicts are resolved by
adding a number between parentheses after the name of the imported object.
The table that follows provides information concerning specific aspects of the import
operation.
Object group The group is imported along with the objects in the
group.
When importing objects from an IMSurvey project, an object tree view like the one
shown in Figure 6.14 is displayed.
The imported objects keep their original name and status (e.g., ignored, hidden). Same-
name conflicts are resolved by adding a number between parentheses after the name
of the imported object.
Figure 6.14 The dialog box used to import objects from an IMSurvey project.
Note that the selected recently imported file may not be imported successfully if the
file is no longer found at the location of the previous import.
Once the desired elements have been selected, several editing operations are available that allow deleting
elements, inverting the orientation of surface elements, and more.
Undo operation_name
Undoes the last undoable operation. The name of the operation to undo forms the
last part of the command (e.g., Undo Create (Duplicate Object)).
Redo operation_name
Redoes the last redoable operation. The name of the operation to redo forms the
last part of the command (e.g., Redo Create (Duplicate Object)).
Some operations are not redoable. In addition, certain operations require clearing the
undo stack, such as deleting a Data object. When an operation affects the undo stack, a
message is displayed to inform the user.
The Edit > Delete > Objects command removes all of the objects selected in the tree
view from the current surveying project.
If a selected object cannot be deleted, a message is displayed to let the user know why
(e.g., the object may be used by another object). If deleting the object has an effect on
the project, a message is displayed to inform the user as well.
If the selection contains objects for which the deletion cannot be undone, a
confirmation window is displayed; press the Yes button to continue and delete the
selected objects without the possibility of recovering them and remove all undos as
well, or press the No button to end the operation. Objects for which the deletion
cannot be undone include Reference and Data objects.
The Edit > Delete > Elements command deletes all selected object elements.
7.2.3 Deleting all color map point annotations of the visible color map
The Edit > Delete > All Color Map Point Annotations of Visible Color Map command deletes
all color map point annotations of the visible color map.
The Edit > Delete > All Color Map Point Annotations command deletes all color map point
annotations.
The Edit > Delete > All Coordinate Annotations command deletes all coordinate
annotations.
The Edit > Delete Interactively > Color Map Point Annotations command enables an
interactive mode that allows deleting color map point annotations. Only color map
point annotations are visible in this mode. The pointer icon is the pencil. Delete
individual annotations by clicking them. Right-click to exit the mode.
The Edit > Delete Interactively> Coordinate Annotations command enables an interactive
mode that allows deleting coordinate annotations. Only coordinate annotations are
visible are visible in this mode. The pointer icon is the pencil. Delete individual
annotations by clicking them. Right-click to exit the mode.
The Edit >Recover Deleted Elements command allows recovering the original data files.
The operation undoes all deletion operations performed on the visible objects selected
in the tree view.
Note that in the case of Reference objects with virtual surface specifications, only the
original surfaces can be edited. For more information on virtual surfaces, see Section
23.6.4.1 Reference objects and virtual surfaces.
The Edit > Duplicate Objects operation allows duplicating selected objects. A name that
is unique within the project is assigned to each new object. Duplicated objects are
added to the active layer.
When duplicating objects that have links between them (e.g., a circle and its
constraining plane), an identical link is applied to the duplicated objects. As a result, a
duplicated circle would be constrained by its duplicated constraining plane.
Figure 7.1 The dialog box that is displayed when inverting the orientation of objects with both
axis and in-space orientations.
The Edit > Invert Object Orientation command inverts the orientation of selected Data
objects (i.e., 3D digitized datasets, IMAlign projects, polygon-based objects), Reference
objects, and primitives, with the exception of points and polylines.
To perform the operation, select the objects to edit and choose the Edit > Invert Object
Orientation command. When the selection includes an object with two orientations,
the Inversion Options dialog box shown in Figure 7.1 is displayed, offering the
following items:
Press the OK button to launch the editing, or press the Cancel button to end the
operation.
The items flip the in-space orientation of selected circles, cones, cylinders, planes,
polygons, rectangles, or spheres, and inverts the axis orientation of axial primitives.
It is possible to mirror objects (i.e., Reference and Data objects, primitives, cross-
sections, basic and survey measurements) using the Edit > Mirror Objects command. On
choosing the command, the dialog box shown in Figure 7.2 is displayed.
Type
A list box that offers two types of mirroring: About Origin (scale by -1), and About
Plane (mirror about a plane).
Mirror plane
A list box that specifies the mirror plane. Choose from Standard (in which case a
standard plane defined in the Standard planes group box would be used as a
mirror plane) or an existing plane. This item is only available when Type is set to
About Plane.
Standard planes
A group box that is available when Mirror plane is set to Standard. It offers the
following items:
XY, YZ, ZX
Three option buttons that allow choosing a plane parallel to the specified
plane. By default, ZX is selected.
When the check box is selected, the mirroring operation results in the creation of
new objects. When mirroring objects that have links between them (e.g., a circle
and its constraining plane), an identical link is applied to the new mirrored objects.
As a result, a new mirrored circle would be constrained by its new mirrored plane.
Preview
A button that offers a preview of the mirroring of the selected objects in the 3D
scene. On pressing the button, an interactive mode is launched. The mode uses a
special pointer consisting of an arrow and a capital V (for View). In this mode, it is
possible to select other objects in the tree view. Press the Preview button again to
preview the mirroring of the newly selected objects.
Note that hidden selected objects are made visible when previewing the
mirroring operation. When the Preview button is pressed, the Apply button
becomes the Confirm button. Press the ESC key to exit the mode.
When no preview has been displayed, the Apply button performs the mirroring
operation. When a preview has been displayed, the Confirm button applies the
mirroring operation. The new objects appear under the same branch as the selected
objects in the tree view.
When only dependent primitives are selected, a mirrored copy of the primitives
is created without a dependency.
When a dependent primitive and some of its source objects are selected, a
mirrored copy of all selected objects is created without a dependency.
When dependent primitives and all their source objects are selected, a mirrored
copy of all selected objects is created and an equivalent dependency
relationship is applied to the mirrored dependent primitives.
When only dependent primitives are selected, they are not mirrored.
When both dependent and non-dependent primitives are selected, only the
non-dependent primitives are mirrored.
When dependent primitives and all their source objects are selected, the non-
dependent objects are mirrored but the dependent primitives are not. However,
the dependent primitives are updated when the Automatic project update
option is selected.
Objects can be scaled. The selected objects must be used and unlocked. Selected Data
and Reference objects, as well as other specific objects, can be scaled along an axis.
Figure 7.3 The dialog box used to scale objects. It offers several scaling types.
To scale selected objects, choose the Edit > Scale Objects command. The dialog box
shown in Figure 7.3 is displayed. It is used as follows:
Uniform – Scale all selected objects uniformly (i.e., equally applied to the x, y,
and z coordinates). All scaling operations, including successive operations, apply
to the objects’ original dimensions. To return any 3D object to its original
dimensions after a uniform scaling operation, apply a scaling Factor of 1 (100%).
Units Conversion – Convert an object from its original units to different units.
This operation affects an object’s Original units and Units factor properties, but
does not affect its Uniform scaling factor property.
For example, an object is imported into a project whose units of length are
millimeters. The object’s Original units and Units factor properties are
millimeters and 1, respectively. The user knows however that the object was
measured in centimeters. A centimeters to millimeters conversion could be
performed. The new Original units and Units factor properties would be
centimeters and 10, respectively, and the object would be expressed in
millimeters in the project.
Along Axis – Scale selected objects (i.e., data and reference objects, points,
polylines, and rectangles) along a standard axis, or a plane’s axis, or the axis of an
axial primitive.
If Along Axis is chosen, choose in the Axis list box from X, Y, Z, and available
planes and axial primitives.
If Units Conversion is chosen, specify a unit in the From list box. The initial value
is the Original units value of the selected object(s), if they are identical for all
objects; otherwise choose a unit. The To list box is unavailable and set to the
project’s units of length (see the Units section on the General page of the
IMSurvey Options dialog box).
3. Specify a value in the Factor text box that is applied to the objects’ original
dimensions.
4. When available, the Reset button allows setting the Factor to 1 and the From list
box to the project’s units of length.
Data and Reference objects can be split using elements selected from one or more Data
and/or Reference objects. Two operations on the Edit > Split Objects submenu allow
splitting objects.
Copy Elements
Creates new Data and/or Reference objects, based on the selected elements. For
each Data and/or Reference object having one element selected, a new object of
the same type is created, and the original object’s selected elements are copied to
the new object (i.e., the selected elements are not removed from their parent
object). As a result, selected elements are duplicated.
Move Elements
Creates new Data and/or Reference objects, based on the selected elements. For
each Data and/or Reference object having one element selected, a new object of
the same type is created, and the original object’s selected elements are attributed
to the new object (i.e., the selected elements are removed from their parent
object). In this case, selected elements are not duplicated.
With respect to both operations, the new objects remain in the same layer, and group if
applicable, as the source objects. In addition, once the operation is complete, the
selected elements are deselected.
By selecting the object in the tree view and choosing the Edit > Object Properties
command.
If only one object is selected, the window displays the properties of the selected object.
If several objects are selected, the window only displays common properties whose
values are shared by all selected objects, leaving a blank when the values throughout
the set are different. The selection in the tree view can be edited while the property
sheet is displayed.
The Previous and Next buttons allow displaying information about the previous or
next object within the current set of objects. These buttons are disabled when more
than one object is selected.
Most object properties can be edited through the property sheet. Press the Apply
button to transfer the values of the modified properties to the application. If the Auto-
apply check box is selected, pressing the Previous or the Next button also transfers
the values of the modified properties to the application. The Close button dismisses
the dialog box.
Name
A text box that specifies the name of the object. A default name is provided. It can
be edited to assign more significant names to objects. The default names assigned
to objects on creation can also be edited; for more information, see Section 24.3.11
Default name options.
Type
A text box that specifies the object type.
The property sheet of most objects offers a Color item to the right of the object Type
that displays the object’s color. The color can be edited by clicking the colored
rectangle to display the Windows color editor.
The property sheet of most objects offers a Layers list box. It displays the layer with
which the object is associated. The list box is editable. For information on layers, see
Section 7.10 Editing layers.
7.6.4 Display properties of Reference and Data objects, and primitives and
cross-sections
When the selected objects are Reference, Data, or primitive objects or cross-sections, a
Display tab is available.
The Display tab of a Reference or a Data object’s property sheet offers several items.
For complete information, see Section 23.6 Using the property sheet of Reference
objects and Section 23.7 Using the property sheet of Data objects.
The Display tab of a primitive’s property sheet is offered for all primitives, except points
and vectors. Refer to Section 13.7.0.1 Display properties of primitives for detailed
information on the display properties of primitives.
Hidden
A check box that enables hiding objects in the 3D scene.
Ignored
A check box that enables ignoring objects in the 3D scene. Ignored objects are not
considered by most operations and they are not displayed.
Annotation
A check box that enables displaying an object’s annotation in the 3D scene. Screen
annotations are fully configurable. See Section 22.2 Annotations for more
information.
The Hidden, Ignored, and Annotation check boxes are also available for multi-object
editing. To modify the properties of several objects at once, select the objects and
choose the Edit > Object Properties command. Then, perform the desired editing using
the property sheet.
The Data tab is present on the property sheet when only one Data object is selected.
For more information, see Section 23.7 Using the property sheet of Data objects.
The Reference tab is present when only one Reference object is selected. For more
information, see Section 23.6 Using the property sheet of Reference objects.
Reports only have two properties, which are common to all objects: Name and Type.
Most objects are described in a section dedicated to them. Please see the table that
follows for the exact section that describes the properties of a given type of object.
Data object Section 23.7 Using the property sheet of Data objects
Note that report items may also have properties. See the table that follows for section
references:
Lock Objects
Locks selected Data objects and Reference objects in their current position. A
padlock is superimposed on the objects’ normal icon.
Unlock Objects
Unlocks the alignment of the selected Data objects and Reference object’s. The
padlock superimposed on the objects’ icon (i.e., see the preceding Lock Objects
command) is removed.
The Edit > Ignore Objects command allows ignoring objects (except Measurements,
coordinate systems, and report items). The command specifies to temporarily not
display, and to set aside, the selected objects from the current surveying project,
Ignored objects are not considered by most operations, except those specifically for
ignored objects (e.g., Select > Objects > Ignored). For example, ignored objects are not
used in alignment or measurement computations, they cannot undergo the majority of
the editing operations, they cannot be used for conversion to other primitives, and so
on.
Note that while ignored objects are not displayed, they are not considered to be hidden
by the module.
It is possible to edit these properties through the property sheet (see Section 7.5.5
Splitting objects).
The Edit > Use Objects operation allows removing the ignored status from the selected
objects. Selected objects that are not ignored are not affected. The objects that are no
longer ignored are now considered part of the current project, and their display is no
longer prohibited.
Groups of same-type objects, called object groups, can be created manually. This
allows unburdening the tree view, and provides quick access to the grouped objects.
For example, selecting the object group automatically selects all of the objects in the
object group, and ignoring the object group ignores all of the objects within the object
group.
Objects can only belong to one group at a time. Furthermore, it is not possible to create
empty object groups. Consequently, object groups that become empty are
automatically deleted.
Some operations that automatically create multiple objects place them in object
groups with a name that refers to the object creation operation. An example is creating
polylines from cross-sections, as more that one polyline may be created from a cross-
section.
The icon of an object group shows the status of the objects in the group when all of the
objects in an object group have one or more similar properties. For example, when all
of the objects in an object group are hidden, the icon of the object group is hidden as
well. This may communicate helpful information quickly, without having to open the
object group branch.
Object groups do not have their own property sheet. Rather, they offer a property sheet
configured for the state of the objects within the group. Changes made and applied to
the property sheet are applied to the objects in the group.
Two operations on the Edit menu allow the grouping and ungrouping of objects.
The Edit > Group > Objects operation allows grouping selected same-type objects under
their branch. The selection may consist of objects as well as object groups. When an
object group is selected, its objects are transferred to the new object group, and the
original group is deleted. Note that objects may be dragged from one group to another
within the same branch in the tree view.
Grouping objects may change their index number (index numbers are sequential
within the branch). As a result, macro scripts that make use of an object index may be
affected by object grouping.
Element groups can be defined for Reference and Data objects, which enables
preserving the output of a selection operation, and using the grouped elements at a
later time. Several operations allow creating, selecting, and deleting element groups.
The Edit > Group > Elements operation allows creating element groups from selected
elements. For example, if n Reference and/or Data objects have elements selected in
the 3D scene, choosing this command creates n groups of elements, one for each
Reference or Data object having one or more elements selected.
Element groups are objects, and are located under the Element Groups branch of the
tree view, which can be a child of a Reference object and/or a Data object branch. Two
element groups of a Data object are shown in Figure 7.5.
Data object
Element groups
Element groups, like other objects, are deleted by first selecting them and then
choosing the Edit > Delete > Objects command.
The Edit > Ungroup > Objects operation allows ungrouping selected objects located
within object groups. Objects may also be ungrouped by dragging them out of their
group, within their branch.
The ungrouped objects are distributed under their branch in order of their object
indices. Empty object groups are automatically deleted.
The Edit > Ungroup > Elements operation allows ungrouping the elements located in
selected element groups. Empty element groups are automatically deleted.
Grouping objects in layers allows rapid selection and visualization capabilities (e.g.,
select and show only the objects of a certain layer). The objects that follow always
belong to a layer: Reference and Data objects, primitives, cross-sections, 3D
measurements (i.e., interactive basic and survey measurements), and coordinate
systems. Child objects always belong to the same layer as their parents.
Figure 7.6 The active layer is shown on the status bar (a). The split button displays the existing
layers and allows activating a different layer. Clicking the active layer button displays
the layers management tool (b) that lists the layers, and offers various operations,
including creating layers and activating a layer. The Layers dialog box, which is the
same, is shown in (c).
(a) (c)
(b)
Each new piece contains a layer, layer 1, that is, by default, the active layer. New layers
may be created and made active - only one layer can be active at a time. Normally, new
objects are added to the active layer on creation, or when importing objects. The active
layer is shown on the status bar (see Figure 7.6 (a)). Note the following:
When creating a child object (e.g., child cross-sections), it belongs to the same layer
as its parent, even if it is not the active layer.
When importing objects from an IMInspect or an IMSurvey project, they are added
to the active layer.
It is possible to manually change objects from one layer to another. If changing a parent
object’s layer, its children automatically follow the parent and change layer as well.
The layer that an object belongs to is an object property, and appears on its property
sheet, except in the case for child objects, as they always belong to the same layer as
their parent.
Figure 7.7 In (a), the dialog box used to change the layer of selected objects. The layer of selected
objects can also be changed by means of the property sheet, as shown in (b).
(a) (b)
Layers in a project are managed using the Layers dialog box. It offers creation and
activation operations, as well as selection and visualization operations that apply to the
objects contained within selected layers.
The Edit > Layers > Change Object Layer operation allows changing the layer with which
selected objects are associated. Any selected child objects (i.e., primitives and cross-
section children) are ignored by the operation. On choosing the command, the Change
Object Layer dialog box shown in Figure 7.7 (a) is displayed. It offers the following item:
Layer
A list box that allows specifying the new layer for the selected objects. Choose
from the list of layers in the piece. The default value is the active layer.
Press the Apply button to launch the operation. Make a different object selection and
repeat, if desired. Press the Close button to dismiss the dialog box.
The layers of selected objects can also be changed by using the Layer list box offered
on the property sheet. Note that the property sheet is automatically configured for the
object selection. Figure 7.7 (b) shows a property sheet configured for a selection of
objects that are not of the same type.
Figure 7.8 The dialog box used to manage layers, and the shortcut menu for layers.
View objects
Select
objects
The Edit > Layers > Manage Layers command opens the Layers dialog box shown in
Figure 7.8.. The list area displays the existing layers and offers operations, by means of
check boxes, buttons, and a shortcut menu, that allow creating, activating, deleting,
and renaming layers, as well as operations that allow controlling the selection and
visibility status of objects in selected layers. The order of a layer in the list may be
changed by dragging it.
The list area offers four columns per layer. Each column offers the following items per
line:
Object Selection
A tri-state check box that allows changing the selection status of the objects of a
layer. When the check box is selected, all of the objects are selected. When the
check box is deselected, all of the objects are deselected. When the check box is
grayed, it means that objects in the layer have different selection statuses. On
selecting or deselecting the check box, the respective selection status is applied
immediately to the objects of the layer. If the layer contains no objects, the check
box is not available.
Object Visibility
A tri-state check box that allows changing the visibility of the objects of a layer.
When the check box is selected, all of the objects are visible. When the check box
is deselected, all of the objects are hidden. When the check box is grayed, it means
that objects in the layer have different visibility statuses. On selecting or
deselecting the check box, the respective visibility operation is applied
immediately to the objects of the layer. If the layer contains no objects, the check
box is not available.
Color
A color box that displays the current color of the layer. Clicking the color box opens
a tool that allows specifying a different color.
Name
The name of the layer. It can be edited. The name of the active layer is displayed in
bold.
A shortcut menu, shown in Figure 7.8, is also available, offering the operations that
follow. Most operate on a selection of layers, while a few commands operate on the last
clicked layer. The main operations also have a button located at the bottom of the list
area (see to the right in Figure 7.8).
Create
Creates a new layer, which contains no objects. A color is automatically assigned
for the first ten layers, after which new layers are all pale gray; a color box in the list
area allows specifying a different color. The default name for new layers is layer
<number>, where <number> is an automatically incremented integer. This
operation is also offered by the button located at the bottom of the list area.
Activate
Activates the last clicked layer. This operation is also offered by the button
located at the bottom of the list area. A layer can also be activated by double-
clicking it in the list area.
It is also possible to activate another layer using the Layer split button on the
status bar. The active layer is the one that is selected. Click another layer to make
it the active layer.
Delete
Deletes the selected layers. The active layer cannot be deleted. Objects in a
deleted layer are transferred to the active layer. This operation is also offered by
the button located at the bottom of the list area.
Rename
Renames the last clicked layer.
It is also possible to rename a layer by double-clicking the name in the list, which
enters an editing mode, and typing a new name.
Hide Objects
Hides the objects of the selected layers.
Restore Objects
Restores the visibility of the objects of the selected layers.
Keep Objects
Makes visible the objects of the selected layers, and makes the objects of the other
layers hidden.
Select Objects
Selects the objects of the selected layers. This object selection is added to the
current selection in the tree view, if any.
Deselect Objects
Deselects the objects of the selected layers.
The Options section of the Layers dialog box offers the following item:
Element selections can be made using standard selection operations, or made interactively in the 3D scene
by means of the Select Elements mode. Elements may also be selected by selecting groups or layers. Data
points may also be selected based on several different criteria, like their color or normal vector.
Note that in the case of Reference objects with virtual surface specifications, only the original surfaces and/
or their elements can be selected. For more information on virtual surfaces, see Section 23.6.4.1 Reference
objects and virtual surfaces.
The tree view offers standard Windows-based techniques that allow selecting objects:
Select a range of objects by clicking over the first object, pressing and holding the
SHIFT key, and then clicking over the last object.
Select a set of objects that are not contiguous by pressing and holding the CTRL key
while selecting objects with the mouse.
Several methods are offered on the Select > Objects submenu to select objects:
All
Selects all objects.
Invert
Switches the current selection status of the objects. Selected objects become
deselected while objects not selected become selected.
None
Deselects all objects.
Interactively
Allows selecting objects in the 3D Scene pane by object type by picking or using
a selection rectangle.
Hidden
Selects all hidden objects.
Ignored
Selects all ignored objects.
Finally, the last method makes a link between 3D object selection and the 3D scene:
Figure 8.1 The dialog box used to configure the picking context in the Select Object mode.
From Elements
Selects all 3D objects for which at least one element is selected.
The Select > Objects > Interactively command makes a link between object selection and
the 3D scene.
The Select > Objects > Interactively command enables the interactive Select Object
mode that allows selecting objects in the tree view by picking or by dragging a
selection rectangle in the 3D scene. Selected objects are highlighted in the 3D scene.
On choosing this command, the Picking Context dialog box, shown in Figure 8.1 is
displayed to configure what objects can be picked in the 3D scene. Check boxes
represent the pickable objects in the order that they appear in the tree view:Reference,
Data, Features/Primitives, Cross-sections, and Measurements. The Do not show
this window check box, when selected, disables the display of this window. The
window may be made available again when in this mode by choosing the View >
Contextual Parameters command.
The mode offers two selection methods. An object can be selected in the 3D scene by
clicking over a screen pixel belonging to the object. Or, the middle mouse button can
be used to drag a rectangular selection zone. Visible objects partially or completely
enclosed within the rectangular selection zone, are then identified.
If the CTRL key is up when a selection operation is successfully performed, all other
items in the tree view are deselected, and the picked object or objects is/are selected. If
the CTRL key is down, tree view selections are preserved and the selection status of the
picked object or objects is/are switched. The interactive mode is exited by pressing the
ESC key.
This mode can also be invoked by using the CTRL + SHIFT + SPACEBAR shortcut, or by
pressing the Select Objects button on the Selection toolbar.
8.1.4 Selecting objects of the same type using tree view shortcut menus
Most of the tree view’s branch menus offer a Select submenu allow performing
selection operations of only those types of objects that are contained under the branch
and its subbranches. For example, the Select submenu of the Measurements branch’s
menu offers selection operations for each type of Measurement.
Most Select submenus offer the All, Invert, None, Hidden, and Ignored commands. They
may also offer commands specific to the branch.
The Selection mode controls the selection status of elements when a selection is
performed.
The Selection Mode menu button on the Selection toolbar (located to the right of the
3D Scene pane) provides three modes that apply to all elements:
The Selectable Faces menu button on the Selection toolbar (located to the right of the
3D Scene pane) allows further specifying the Selection mode for elements that have
faces (i.e., triangles and surfaces of CAD Reference objects):
Interactive element selection is possible when in Selection mode. There are several
ways to enter Selection mode: choose the Select > Elements > Interactively command,
click the Select Elements button on the Selection toolbar, or press the SPACEBAR. For
the SPACEBAR shortcut to work, the Tree View pane or the 3D Scene pane must have
the focus. The pointer becomes a cross in this mode. It is not possible to rotate or
translate the scene when Selection mode is activated.
The left mouse button is used to select one object element (i.e., a Data point, a
Reference triangle, or a CAD surface).
The middle mouse button is used to select regions (groups of object elements).
Surface-based and volume-based selection methods are available.
With the SHIFT key pressed and held down, the left mouse button used over Data or
Reference objects displays a menu used to select the elements of a group, or
connected sets of CAD surfaces (if the click occurred on a CAD Reference object).
These methods are shown mapped onto the mouse in Figure 8.2.
To select one object element, place the pointer over the element and click. The type of
element selected depends on the object type:
Figure 8.2 The mouse is used for interactive element selection. Selections may be individual or
region-based (surfacic or volumetric), or use object-based menu operations.
Group/island Volume
SHIFT selection (freeform
menu contour)
Mouse buttons used
in conjunction with Surface
keys CTRL (polygonal
contour)
SHIFT+ Volume
CTRL (polygonal
contour)
For point clouds and polygonal Data objects, the closest 3D point is selected. The size
of points can be increased by using the Point size list box on the Object Display
Options menu button of the 3D Scene toolbar.
For polygonal Reference objects, the triangle underneath the pointer is selected.
For CAD Reference objects, the CAD surface underneath the pointer is selected.
Note that other types of 3D objects, which are not mentioned in the preceding list, are
ignored.
There are two interactive techniques that allow selecting points, triangles, and CAD
surfaces. One is surface based and the other is volume based The surface-based
technique can be applied to polygonal Data and Reference objects, as well as CAD
Reference objects. The volume-based technique can be applied to all types of Data and
Reference objects.
The two region-selection methods are accessed through the middle mouse button and
proceed similarly. A 2D area is delimited in the 3D scene while the middle mouse
button is pressed. Once the middle mouse button is released, the set of selected
elements is found.
If the SHIFT key is not initially pressed at the beginning of the selection operation, a
surface-based selection method is used that finds the set of visible triangles or CAD
surfaces enclosed within the delimited 2D area. A triangle or CAD surface is visible if
it encloses at least one screen pixel. As a result, this selection method should be used
when the region of interest is sufficiently close to the observer so that the element
boundaries are clearly visible in the 3D scene.
Note that in the case of polygonal Data objects, the triangle selection is
automatically converted to a point selection.
If the SHIFT key is initially pressed, a volume-based selection method is used that
finds all geometric elements whose projections completely lie within the 2D contour.
The resolution of the method is independent of the resolution of the 3D scene.
The 2D selection contour can be freeform or polygonal. If the CTRL key is not initially
pressed at the beginning of the selection operation, drag the mouse to describe a
closed contour. To define a polygonal contour delimiting a selected area, press and
hold the CTRL key, middle-click to generate vertices of the polygonal region, and right-
click to indicate the last vertex.
The 2D contour is rendered using the Pencil color, which is yellow by default. The color
can be edited; for more information, see Section 24.3.3 Interface color display options.
Select Group
Selects the element group to which the picked element belongs. See Section 7.9.3
Grouping elements of Reference and Data objects for additional information
concerning groups of elements.
Figure 8.3 The dialog box used with the Select Smooth Island operation.
Figure 8.4 The dialog box used to display and configure the selection context.
Select Island
Selects the CAD surfaces connected to the picked one.
The Selection Context dialog box, shown in Figure 8.4 is displayed by default when
performing interactive selection operations.
The Elements to select group box offers two check boxes, Data points and Reference
triangles/CAD surfaces, that allow specifying the elements to select.
The middle of the dialog box offers two reminder labels with adjacent status labels:
The bottom part of the dialog box features two list boxes that allow visualizing the
current Selection mode parameters, and editing them if desired. The left list box offers
the Mark, Toggle, and Unmark options, while the right list box offers the Back, Front,
and Front and Back options.
The last item in the dialog box is the Do not show this window check box, which
disables this window for future selection operations. To redisplay the dialog box when
in this operation mode, choose the View > Contextual Parameters command. Note that
closing the window exits the Selection mode.
For information on the Selection mode, see Section 8.2.1 Setting the Selection mode.
Element selection operations are offered through the main menu that apply to all
visible Data and Reference objects. Element selection operations that apply to a
selected and visible Data or Reference object are also offered through the tree view.
The Select > Elements submenu offers standard selection tools that apply to all visible
elements. Note that the specifications made for the Selection mode do not apply to the
first three tools, as they are of a global nature.
All
Selects all visible elements.
Invert
Inverts the selection status of the visible elements if at least one element is
selected.
None
Deselects all selected elements.
Interactively
Enables the mode that allows selecting elements interactively.
Select a visible Reference or Data object in the tree view and right-click. The Select >
Elements submenu offers the All, Invert, and None commands that apply to the
elements of the selected object. See Section 8.2.3.1 Selecting elements of visible
Reference and Data objects for a description of these commands.
The Select > Elements > From Groups command allows selecting the elements of all
selected Groups.
The Select > CAD Layers > From Elements command allows selecting all layers for which
at least one element is selected.
The Select > Element Groups > From Elements command allows selecting all groups for
which at least one group element is selected.
One tool on the Select > Reference Elements submenu enables the selection of
considered Reference elements:
The Select > Reference Elements > From CAD Layers command allows selecting elements
of CAD Reference objects by their membership in a layer. It selects the elements of all of
the selected layers.
The Select > Data Points submenu offers commands that allow selecting Data points
within a given distance from the surface or the boundaries of Reference objects as well
as from primitives.
It is possible to select the Data points within the selection Max distance from selected
Reference objects. In the case of Reference objects with virtual surface specifications,
the effective virtual surfaces are considered. For more information on virtual surfaces,
see Section 23.6.4.1 Reference objects and virtual surfaces.
Preselect Reference and Data objects if desired, or specify them later in the dialog box.
To launch the operation, choose the Select > Data Points > Using Reference Object
Surfaces command that displays the dialog box shown in Figure 8.5.
Direction
A list box that specifies a distance computation method to use when measuring
between Data points and a reference surface. Choose from the following:
Axis
A list box, offered for the Along Axis measurement direction method, that allows
specifying an axis along which to measure deviations. Choose from the standard
axes (i.e., +X, -X, +Y, -Y, +Z, -Z), (Custom Vector), and available axial primitives. The
default value is +X. When (Custom Vector) is chosen, the following items are
displayed to allow defining an axis:
i
A text box that allows specifying the i coordinate of the axis. The default
value is 1.0.
j
A text box that allows specifying the j coordinate of the axis. The default
value is 0.0.
k
A text box that allows specifying the k coordinate of the axis. The default
value is 0.0.
Reference objects
A list box that allows specifying the Reference objects to use. Choose from All (all
Reference objects) and Specific. The default value is All. When Specific is chosen,
a list box is offered under this list box. It offers the available Reference objects,
preceded by a check box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects)
and Specific. When Specific is chosen, a list box is offered under this list box. It
offers the available Data objects, preceded by a check box. If necessary, select the
desired objects or elements.
Figure 8.5 The dialog box used to select points within a distance from the surface of reference
objects.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the reference surfaces. Valid values are greater than 0. The default value is
300.0 mm.
Ignore – Ignores the Data points. When a Data object is larger than the
Reference object, or misaligned, this choice allows restricting the
measurement to the portion of the Data object located over the Reference
surface. The default value is Ignore.
This item is only offered for the Shortest measurement direction method.
Max angle
A check box that enables specifying a maximum angle, in degrees, between a Data
point’s normal vector and the reference surface’s normal vector at surface points
within the Max distance value. When selected, an adjacent text box is made
available to enter a value. Valid values range from 0 to 180 inclusively. The default
value is 45 degrees. By default, the check box is selected.
This item is not used in the case of Data points that belong to a Data object
without point normal information.
This item is not offered when the Data objects specification is Boundary.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Figure 8.6 The dialog box used to select points within a distance from the boundaries of
Reference objects.
Press the Select button to launch the operation. Press the Close button to dismiss the
dialog box.
It is possible to select all the Data points within the selection Max distance from the
boundaries of Reference objects.
If desired, preselect Reference and Data objects. To launch the operation, choose the
Select > Data Points > Using Reference Object Boundaries command. The dialog box
shown in Figure 8.6 is displayed, offering the items that follow:
Direction
A list box that specifies a distance computation method to use when measuring
between Data points and a reference surface. Choose from the following:
Shortest to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found and the total point-to-
curve distance is computed. When this method is chosen, the Deviation
sign list box is made available in the Parameters section that allows
obtaining signed deviations.
Normal to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found, and then only the normal
component of the distance is retained, based on the surface normal vector
at the closest point. This type of distance is signed. If positive, the point is
above the surface, otherwise it is below the surface.
Tangent to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found, and then only the
tangent component of the distance is retained, based on the surface’s
tangent plane at the closest point. This type of distance is signed. If positive,
the point is outside the surface, otherwise it is within the surface.
Reference objects
A list box that allows specifying the Reference objects to use. Choose from All (all
Reference objects) and Specific. The default value is All. When Specific is chosen,
a list box is offered under this list box. It offers the available Reference objects,
preceded by a check box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects)
and Specific. When Specific is chosen, a list box is offered under this list box. It
offers the available Data objects, preceded by a check box. If necessary, select the
desired objects or elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the reference surfaces. Valid values are greater than 0. The default value is
300.0 mm.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Press the Select button to launch the operation. Press the Close button to dismiss the
dialog box.
It is possible to select Data points within the selection Max distance from selected
primitives, including trimmed primitives.
If desired, preselect primitives. To launch the operation, choose the Select > Data Points
> Using Feature Primitives command. The dialog box shown in Figure 8.7 is displayed,
offering the following items:
Direction
A list box that specifies a distance computation method to use when measuring
between Data points and primitives. Choose from the following:
Shortest to Boundary – For each measured Data point, the closest point on
a feature primitive’s surface/curve is found and the total point-to-surface/
curve distance is computed. When this method is chosen, the Deviation
sign list box is made available in the Parameters section that allows
obtaining signed deviations.
Normal to Boundary – For each compared Data point, the closest point on
a feature primitive’s surface/curve is found, and then only the normal
component of the distance is retained, based on the surface/curve normal
vector at the closest point. This type of distance is signed. If positive, the
point is above the surface, otherwise it is below the surface.
Figure 8.7 The dialog box used to specify the primitives to use when selecting Data points within
a certain distance from selected feature primitives.
Tangent to Boundary – For each compared Data point, the closest point on
a feature primitive’s surface/curve is found, and then only the tangent
component of the distance is retained, based on the surface’s/curve’s
tangent plane at the closest point. This type of distance is signed. If positive,
the point is outside the surface, otherwise it is within the surface.
Primitives
A list box that allows specifying the feature primitives to use. Choose from All (all
available feature primitives) and Specific. The default value is All. When Specific is
chosen, a list box is offered under this list box. It offers the available feature
primitives, preceded by a check box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects)
and Specific. When Specific is chosen, a list box is offered under this list box. It
offers the available Data objects, preceded by a check box. If necessary, select the
desired objects or elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the surface/curve of the primitives. Valid values are greater than 0. The default
value is 300.0 mm.
Max angle
A check box that enables specifying a maximum angle in degrees between a Data
point’s normal vector and a feature primitive’s normal vector at the point on the
surface/curve closest to the Data point. When selected, an adjacent text box is
made available to enter a value. Valid values range from 0 to 180 inclusively. The
default value is 45 degrees. By default, the check box is selected.
This parameter allows eliminating from the measurement results Data points that
have an orientation incompatible with the closest reference surface area. This item
is not used in the case of Data points that belong to a Data object without point
normal information.
This item is not offered when the Data objects specification is Boundary.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Press the Select button to launch the operation. Data points are selected within the
specified distance from the selected primitives. For an example of a selection operation
Figure 8.8 Selecting Data points (in red) using an standard cone and a trimmed cone. The
results for the trimmed primitive depends largely on the surface represented by its
associated Reference object elements.
Primitive
used for the
selection.
result using an untrimmed and a trimmed primitive, see Figure 8.8. Press the Close
button to dismiss the dialog box.
The table that follows provides information with respect to measuring deviations by
type of primitive.
Surface-based
Distances are measured to the surface.
primitives
It is possible to select the Data points measured by primitives and data color maps, as
well as the Data points measured by constraining planes.
It is possible to select the Data points measured by certain objects. The objects that
have measured Data points are presented in the table that follows.
1. Select same-type valid objects in the tree view (e.g., a fitted primitive).
2. Choose the Select > Data Points > Measured Data Points command.
To select the Data points used to fit the constraining plane of a fitted curve-based
primitive, proceed as follows:
2. Choose the Select > Data Points > Measured Data Points of Constraining Planes
command.
One tool on the Select > Data Points submenu enables the selection of considered Data
elements:
The Select > Data Points submenu offers two operations that allow selecting a layer of
boundary points from one or more point cloud or polygonal Data objects that are
aligned to Reference objects. These selection operations use the options specified in
the Select Options dialog box (see Section 8.5.6 Setting selection options in the
IMSurvey Options dialog box). Selections can be made in the tree view prior to using
the dialog box.
For each point sampled on the boundary curve of a Reference object, the best
boundary points in the Data objects are found, resulting in the selection of all the
boundary points. One of the Split operations, described in Section 7.5.5 Splitting
objects, can then be used to create a new Data object containing only the boundary
points, or the selection can be used for comparison to the Reference objects along the
surface boundaries (see Section 12.1.2 Measuring deviations of Data objects from
Reference object boundaries).
3. Choose the Select > Data Points > Point Cloud Boundaries command. The dialog box
shown in Figure 8.9 is displayed.
Specify two items under the From reference object boundaries group label:
Maximum distance
A text box that allows specifying the maximum distance between a Data point and
a boundary curve of a Reference object. Only points within this range are
considered when extracting a list of boundary points. The default value is 300 mm.
Sampling step
A text box that allows specifying a point-to-point sampling step on the boundary
curves of the Reference objects. This value should be larger than the average
point-to-point distance in the Data objects.
Figure 8.9 The dialog box used to select boundary points of point cloud Data objects.
4. Press the Select button to perform the selection, and the Close button to dismiss
the dialog box.
The set of points located on the boundary of a polygonal mesh can be extracted. A
boundary edge is one that belongs to only one triangle. The two vertices of a boundary
edge are considered boundary points. The procedure is as follows:
3. Choose the Select > Data Points > Polygonal Model Boundaries command.
The Select > Data Points > With Color command displays the dialog box, shown in Figure
8.10, which is used when selecting points on visible Data objects based on their color or
their luminance. It can be used as follows:
1. Specify a color in the first list box, from Luminance (corresponds to a gray level),
Red, Green, and Blue.
2. Specify an operator in the second list box from: Is Less than, Is Less than or Equal
to, Is Equal to, Is Greater than or Equal to, Is Greater than, Is Between
(Exclusive), and Is Between (Inclusive).
Figure 8.10 The dialog box used to select points on Data objects based on their color or their
luminance.
3. Specify a value in the (0-255) text box. Note that if the operator chosen is Is
Between, a new (0-255) text box appears in the dialog box – enter a value in each
of the two (0-255) text boxes to specify the desired range. Colors are internally
represented by a number between 0, the minimum, and 255, the maximum.
Selecting one color will select points whose color is composed of the chosen color. For
example, specifying Red Is Greater than 150 will select all those points whose color is
made up of an average to very high degree of Red.
Points on Data objects can be selected based on their normal vector. Choose the
Select > Data Points > With Normal Vector command. The dialog box shown in Figure
8.11 is displayed. Its parameters express the selection as a sentence. For example,
Select elements with normals Closer than a number of degrees from a Plane’s
Normal Vector, the plane being plane 1. To select Data points whose normals are
closer than 20 degrees from the positive Y axis, proceed as follows:
1. Choose Closer than in the list box under Select elements with normals.
2. Enter 20 in the text box that precedes the degrees from label.
3. Specify Vector in the list box that follows, and choose +Y Axis in the adjacent list
box.
Note that when Vector is specified in the second list box from the top of the dialog box,
the adjacent list box offers signed standard axes (+- X Axis, +- Y Axis, +-Z Axis), existing
Figure 8.11 The dialog box used to select points of Data objects based on their normal vector.
Vector primitives, and Custom Vector. If Custom Vector is specified, press the Specify
Custom Vector button and specify an (i, j, k) vector in the dialog box that is displayed.
When Plane’s Normal Vector is specified in the list box, the adjacent list box offers
existing planes.
The Select > Data Points > Above DTM Surface command selects visible Data points that
are beyond a user-specified distance from the ground in visible point cloud Data
objects. This operation may be used, for example, to remove vegetation. On choosing
this command, the dialog box shown in Figure 8.12 is displayed. It offers the following
items:
DTM surface
A group box that offers one parameter used to define the DTM surface, which is
created in the background:
Minimum height
A text box that specifies a distance from the DTM surface beyond which all of the
visible Data points are selected.
Press the Apply button to launch the operation and the Close button to dismiss the
dialog box. To cancel the operation, press the Cancel button in the progress window
that is displayed.
Figure 8.12 The dialog box used to select Data points above a DTM surface.
Note that it is possible to create a DTM surface and save it as a polygonal Data object.
For more information, see Section 23.3.3 Triangulating Data points.
Selection options are located on the Selection page of the IMSurvey Options dialog
box; for complete information, see Section 24.9 Selection options. To access the page,
choose the Tools > Options command to display the dialog box and click Selection in
the tree view.
All
Selects all primitives.
Invert
Switches the current selection status of the primitives. Selected primitives become
deselected while primitives that are not selected become selected.
None
Deselects all primitives.
Figure 8.13 The dialog box used to select primitives based on their feature code.
As explained in Section 14.12 Managing and assigning feature codes, feature codes
may be assigned to all primitives. Primitives may then be selected based on their
feature code:
1. To select primitives of any type, choose the Select > Feature Primitives > From Feature
Code command.
2. To select primitives of only a certain type, right-click over the related object’s
branch, point Select, and then click From Feature Code on the submenu.
If at least one primitive is assigned a feature code, the dialog box shown in Figure
8.13 is displayed. Otherwise, a message is displayed informing the user that no
primitives have a feature code.
3. Specify a feature code in the Feature code list box. The list box only offers the
feature codes currently assigned to the specified primitives.
4. Press the OK button to launch the operation, or press the Cancel button to cancel
the operation.
All primitives, or just those under the clicked branch that have the specified feature
code, are selected. Note that this selection does not deselect currently selected objects
in the tree view if the Focus mode (i.e., right-click directly over the branch) is used. For
information concerning the Focus mode, see Section 4.6.6 Introducing the shortcut
menus.
Specific selection operations are offered for dependent primitives and their source
objects. See the table that follows for detailed information:
Operation Command
Selecting the source objects The shortcut menu of dependent primitives, offers
ofdependent primitives the Select > Source Objects command that allows
selecting their source objects.
Selecting the objects that The shortcut menu of the following objects offers
depend on objects the Select > Dependent Objects command that
allows selecting the objects that depend on the
selected objects:
• Primitives
• Data color maps
• Cross-sections
The different display modes for Data and Reference objects, primitives, and cross-sections, and
the color modes that together control what is displayed in the 3D scene.
Controlling the display of object annotations. For most 3D objects, an annotation attached to the
object may be drawn. The annotation can display useful information about the object, such as its
name or geometric properties. Annotation templates allow a complete customization of
annotation contents on creation. In addition, the content of individual annotations can be
customized.
Using the mouse to modify the position and orientation of the 3D scene.
There are two display modes. The Static display mode is the standard mode used to
draw a set of 3D objects. The Dynamic display mode controls the rendering when the
user changes the position and orientation of the 3D scene. Specifying a coarse
subsampling factor for the Dynamic display mode to increases the display rate when
the 3D scene is moving. When the movement stops, the application switches back to
the Static mode in order to draw a more accurate graphical representation of the scene.
Certain categories of objects allows the definition of default Static and Dynamic display
modes. These include Reference and Data objects and primitives. When a new object in
these categories is added to an IMSurvey project, its Static and Dynamic display modes
are automatically set to Default. The new object will therefore be rendered using the
Static and Dynamic display modes of its object category.
The default display modes of Reference and Data objects, primitives, and cross-sections
can be modified using the IMSurvey Options dialog box; for more information, see
Section 24.3 Display options. Any changes are automatically applied to those objects
whose display mode is set to Default.
For certain categories of objects (i.e., Reference and Data objects and primitives), an
individual object’s display mode can be set to specific values, such as the Static Flat, or
Dynamic Point drawing types, or the Static 1/4, or Dynamic 1/64 subsampling
factors. When an object’s drawing type or subsampling factor is set to a specific value, it
will not be affected by modifications made to the default display modes of its object
category. It is also possible to modify the display modes of a selected set of 3D objects.
Proceed as follows:
Note that to modify the display mode of primitives, select them directly in the tree
view.
Then:
3. Point View.
4. Point Static or Dynamic. Set the drawing type and subsampling factor from the list
of possible display modes. The modifications are then applied only to the selected
3D objects.
Note that when modifying the display mode of primitives, only the display modes
common to all selected objects are offered.
Or:
5. Click Properties on the tree view’s shortcut menu to access a property sheet. Click the
Display tab, edit the drawing type and subsampling factor for the Static and
Dynamic display modes, and press the Apply button.
The Static and Dynamic drawing types can always be set to Default. An object
displayed using the default drawing type is drawn using its category’s default
drawing type.
If only one category of objects is selected, the Static and Dynamic list boxes will also
offer the category’s drawing types. Typical values include Flat, Flat+Wireframe,
Point, Smooth, Wireframe, or Bounding Box. If several categories are selected,
then only the drawing types common to all selected objects will be offered.
If all selected objects support a subsampling factor, Subsampling combo boxes will
be available for the Static and the Dynamic display modes. The subsampling factors
can be set to Default, 1/1, 1/4, 1/16, or 1/64. A number can also be entered following
the 1/ characters to define a custom subsampling factor.
A Reference object’s drawing types can also be set to Curve and Flat+Curve. If the
Flat+Curve type is used, the surfaces are drawn using flat shading, and the boundary
(marks the limit of the object’s surface) and the internal trim curves are
superimposed on the flat-shaded surfaces. If the Curve type is used, there is no flat
shading. The boundary trim curves are displayed in yellow, and the internal trim
curves are displayed in green. These colors may be modified. For more information,
see Section 24.3.3 Interface color display options.
Note that the objects to which elements belong must be visible in order to be able to
control the visibility of their elements.
The View > Hide submenu offers operations that hide the selected objects or object
elements, or hide all annotations by type.
Objects
Hides the selected objects.
Elements
Hides the selected elements.
All Annotations
Hides all annotations. This operation does not apply to min and max color map
point annotations displayed by data color maps.
Several operations are offered on the View > Hide Interactively submenu that allow
hiding annotations of a particular type by clicking them.
Annotations
Enables an interactive mode that allows hiding annotations by clicking in the 3D
scene. This operation does not apply to min and max color map point annotations
displayed by data color maps. See the instructions that follow.
Coordinate Annotations
Enables an interactive mode that allows hiding coordinate annotations by clicking
in the 3D scene. See the instructions that follow.
Primitive Annotations
Enables an interactive mode that allows hiding primitive annotations by clicking
in the 3D scene. See the instructions that follow.
2. Press the SPACEBAR to temporarily exit the mode and perform rotations/
translations.
The View > Restore submenu offers operations that restores the visibility of selected
hidden objects, elements, and annotations by type.
Objects
Restores the visibility of selected objects.
Elements
Restores the visibility of selected elements.
All Annotations
Restores the visibility of all annotations. This operation does not apply to min and
max color map point annotations displayed by data color maps.
The View > Keep submenu offers operations that keep only selected objects and
elements visible:
Objects
Keeps only the selected objects visible, hiding all other objects.
Elements
Keeps only the selected object elements visible, hiding all other elements.
The View > Toggle Visibility submenu offers operations that allow inverting the visibility
status of objects or elements:
Objects
Inverts the visibility status of selected objects. Visible objects are hidden, and
hidden objects are made visible.
All Objects
Inverts the visibility status of all objects. Visible objects are hidden, and hidden
objects are made visible.
All Elements
Inverts the visibility status of the elements of selected objects. Visible elements are
hidden, and hidden elements are made visible.
For more information on CAD layers, see the description of the Reference object in
Section 2.1 IMSurvey – An object-oriented measurement and verification tool.
9.5.1 Introduction
To display cross-sectional views of the 3D scene, choose the View > Section View
command. This displays the Section View dialog box and enables an interactive mode.
Specify a clipping plane that serves as a reference for displaying the 3D scene (e.g.,
above or below the plane). The clipping plane also serves to section objects in the 3D
scene and is used to create a temporary cross-section (which is built using the
sectioned Data and/or Reference objects) whose display status can be controlled. The
clipping plane can then be displaced, and several viewing options are available. The
temporary cross-section can be exported to DXF or IGES formats, or it can be used for
the extraction of a cross-section object.
The Point size (pixels) and the Line width (pixels) list boxes, located on the Object
Display Options menu button of the 3D Scene toolbar, set the point size and the line
width for cross-sections. The mouse-based rotation, translation, and zoom operations
remain active at all times in the 3D viewing mode, while rotations are not allowed in the
2D viewing mode.
The View > Section View command displays the tabbed dialog box shown in Figure 9.1.
The top of the dialog box offers an item that allows exporting the temporary cross-
section that results from the clipping plane defined by the user:
Export
A group box that offers two items that allow exporting the temporary cross-
section:
DXF
A button that allows exporting the temporary cross-section to DXF
format. For complete information, see Section 25.13.1 Exporting
primitives and cross-sections to DXF.
IGES
A button that allows exporting the temporary cross-section to IGES
format. For complete information, see Section 25.13.2 Exporting
primitives and cross-sections to IGES.
Figure 9.1 The dialog box used to display a cross-sectional view of the 3D scene.
The Plane tab offers items to create and displace the clipping plane and to convert it to
a cross-section. At the top, three methods of creating the clipping plane are offered:
From Primitive
A button that specifies using the selected plane primitive as the clipping plane.
Anchor Line
A button that invokes an interactive method that allows defining a clipping plane
orthogonal to the screen by clicking two locations in the 3D scene. The 3D scene
can be rotated, translated, and zoomed by pressing the SPACEBAR, using the
standard mouse-based operations, and pressing the SPACEBAR again when
finished.
Standard planes
A group box that defines a clipping plane obtained from a standard plane and an
offset. It offers the following items:
XY/YZ/ZX
Three buttons that allow specifying a standard plane: XY, YZ, or ZX. On
pressing a button, a plane is displayed at the distance from origin
specified above.
The clipping plane is extended to the limits of the bounding box of the project.
The Displacement group box provides two items that allow moving the clipping plane
along its normal vector, and one item to create a cross-section using the clipping plane:
Displacement step
A text box that specifies a step by which the clipping plane is translated when the
Position slider’s displacement arrows are clicked. The default value is 1 mm.
Position
A slider that can be used to move the clipping plane along its normal vector.
Create Cross-Section
A button that allows creating a cross-section using the current temporary cross-
section displayed in the 3D scene. When possible, the cross-section is created with
an extracted nominal and an extracted measured component. The measured
component is created using the Extract method, with the Standard sub-method.
The Extraction Options button on the Options tab gives access to parameters
used in the creation of the measured cross-section component.
The Options tab offers options that control the display mode, as well as access to
options used to create a cross-section from the slicing plane that is displayed in the 3D
scene. Initially, when the clipping plane is defined, the scene is rendered in 3D. The
Options tab offers the following items:
Display
A group box that offers items that control the display in the 3D scene with respect
to the clipping plane. Two Viewing modes are offered:
2D
An option button that specifies displaying the scene in a 2D view
specified by the clipping plane. In the 2D mode, true cross-sections are
computed for all polygonal and CAD model objects. When this viewing
mode is activated, an item below the option button becomes available:
Mirror view
A check box that enables flipping the 2D view by 180 degrees. By
default, the check box is cleared.
When the 3D Scene pane has the focus, the TAB key can be used to switch
between the 2D and the 3D viewing modes.
3D
An option button, selected by default, that specifies displaying the scene
in a 3D view specified by the clipping plane. When this viewing mode is
activated, the following items become available:
Plane
A check box that enables displaying the clipping plane. It is
selected by default.
Nominal component
A check box that enables displaying the nominal component of
the temporary cross-section. By default, It is selected.
Measured component
A check box that enables displaying the measured component of
the temporary cross-section. By default, It is selected.
Clipping mode
A list box that allows specifying a display mode using the clipping
plane. Choose from the following: Show Clipping Range
(displays a 3D range of the 3D scene above and below the
clipping plane), Show Above (displays only the 3D scene above
the clipping plane), and Show Below (displays only the 3D scene
below the clipping plane). The default value is Show Clipping
Range. To makes a change effective, press the Apply button.
Clipping range
A text box that specifies the 3D range to display, centered at the
clipping plane. The default value is 5.0 mm. To makes a change
effective, press the Apply button.
When the 3D Scene pane has the focus, the TAB key can be used to switch
between the 2D and the 3D viewing modes.
A key also affects the display in the 3D scene. Press SPACEBAR to temporarily
display the complete scene.
Extraction Options
A button that opens the IMSurvey Options dialog box to the Cross-Sections >
Extract Measured page, where options used to extract measured cross-section
components are found.
Press the Apply button to apply changes made in the dialog box. Press the Close
button to dismiss the dialog box.
Figure 9.2 The Cross-Section Navigator allows viewing cross-sections one by one.
A specialized navigator tool is offered that allows viewing cross-sections one by one.
Hidden cross-sections may also be viewed, as the tool displays any specified cross-
section.
To launch the tool, preselect cross-sections if desired, and choose the View > Object
Navigator > Cross-Sections command. On choosing the command, the Cross-Section
Navigator dialog box, shown in Figure 9.2, is displayed.
The dialog box offers items that allow controlling the visibility of cross-section
components, tools that allow editing cross-sections, and a tool that allows creating
polylines from closed contour loops.
To exit the object navigation mode, press the ESC key or click the X on the dialog box’s
title bar.
9.6.1.1 Introduction
For example, points can be picked on the displayed cross-section to: take
measurements (e.g., angles, distances, radii), pick a point, create primitives, and so on.
When entering a picking mode in a 2D view, the pointer becomes a pencil and the
nearest point on an object is automatically highlighted. When available, a contextual
parameter window item also allows picking the nearest vertex using the SHIFT key. An
internal link is created between the cross-section and any object created by picking
points on it so that when a cross-section is displayed in this mode, its linked objects are
displayed as well. This link disappears when the mode is exited or when the displayed
cross-section changes.
Cross-section
A list box that offers either the preselected cross-sections, or all of the cross-
sections if no preselection was made.
Mirror 2D view
A check box that enables flipping the view by 180 degrees when the viewing
mode is 2D. By default, the check box is cleared.
On launching the navigator, all visible objects are hidden and a zoom is performed on
the first cross-section in the Cross-section list box. A cross-section may appear alone or
with the objects linked to it.
Data children of cross-sections, that compose the measured component, are displayed
using their object color. Reference children of cross-sections, that compose the nominal
component, are displayed using the color defined on the Cross-Sections subpage of
the Display page of the IMSurvey Options dialog box.
The UP ARROW and the DOWN ARROW keys allow navigating through the cross-
sections. The name of the currently displayed cross-section is shown in the Cross-
section list box. The display of a specific cross-section can also be specified by
choosing its name in the list box.
The dialog box offers operations that allow editing the displayed cross-section. Note
that when a cross-section is later updated, either manually or automatically, the current
cross-section children are deleted and new cross-section children are created.
The editing operations are launched by pressing one of the following buttons in the
Edit cross-sections group box:
(Extend)
A button that enables an interactive mode that allows extending the open
contours of the displayed child cross-sections within their cross-section plane. The
pointer becomes a pencil. Use the mode as follows:
Press SPACEBAR to enter the Interrupt mode that allows rotating and
translating the 3D scene. Press SPACEBAR again to return to the editing
mode.
Click in the cross-section plane to add vertices. The contour of the child
cross-section is extended to include each new vertex.
Press and hold down the SHIFT key and click to join the currently
extended contour to another open contour endpoint belonging to the
same cross-section child.
Press SPACEBAR to enter the Interrupt mode that allows rotating and
translating the 3D scene. Press SPACEBAR again to return to the editing
mode.
(Cut segments)
A button that enables an interactive mode that allows deleting part of the contour
of the displayed cross-section children. The pointer becomes a hand with a
pointing finger. Use the mode as follows:
Press SPACEBAR to enter the Interrupt mode that allows rotating and
translating the 3D scene. Press SPACEBAR again to return to the editing
mode.
If the contour is open, the portion of the contour lying between the two
locations is deleted. If the contour is closed, click the portion of the contour
to delete.
It is possible to create a polyline from a loop (i.e., closed contour). Press the Pick button
in the Convert loop to polyline group box to enable an interactive mode that allows
creating polylines from displayed loops. The pointer becomes a pointing finger. Use the
mode as follows:
Press SPACEBAR to enter the Interrupt mode that allows rotating and translating the
3D scene. Press SPACEBAR again to return to the editing mode.
If the loop is closed, a polyline is created and displayed in the 3D scene. Its area is
displayed in the Area text box.
Repeat if desired.
The View > Standard Views submenu contains a set of standard operations related to
rigid transformations and projection types. If the operation is offered on the 3D Scene
toolbar, its icon appears below in the right margin as part of its description.
View +X
Centers visible objects in the 3D scene and makes the positive X axis point toward
the user.
View -X
Centers visible objects in the 3D scene and makes the negative X axis point toward
the user.
View +Y
Centers visible objects in the 3D scene and makes the positive Y axis point toward
the user.
View -Y
Centers visible objects in the 3D scene and makes the negative Y axis point toward
the user.
View +Z
Centers visible objects in the 3D scene and makes the positive Z axis point toward
the user.
View -Z
Centers visible objects in the 3D scene and makes the negative Z axis point toward
the user.
The View > Custom Views submenu contains operations to save a view and then load it
at a later time:
Load
Loads a pose file containing a 4x4 rigid transformation matrix and a projection
type. This transformation and projection is applied to the current set of objects.
Choosing this command results in the display of a standard file browser. Specify a
file name and location, and press the Open button. Press the Cancel button to end
the operation.
Save
Saves the pose of the object to a file. The pose consists of a 4x4 rigid
transformation matrix and a projection type. Choosing this command results in
the display of a standard file browser. Specify a file name and location, and press
the Save button. Press the Cancel button to end the operation.
The View > Normal View operation uses the normal of a selected cross-section or
primitive (axial or planar) to specify a new orthogonal viewpoint.
9.7.4.1 Introduction
Once objects and their annotations have been positioned correctly in the 3D scene, the
list of displayed objects, elements and annotations and their position in the 3D scene,
which includes certain conditions related to the current display, can be captured and
saved to a named project view. Project views are used to restore the content of the 3D
scene at a later time. They are very useful for IMSurvey projects with respect to the
Automatic project update function.
It is possible to capture project views and to restore them at a later time. Project views
store the visibility status of Data and Reference object elements. Generally, when a
project view is updated, invisible Data object elements remain invisible. This is useful
for users who do not have to recreate the project view again.
Figure 9.3 The dialog box and shortcut menu used to capture and restore project views.
The View > Project Views command displays the dialog box shown in Figure 9.3. It allows
saving, restoring, deleting, and renaming project views.
The dialog box offers a list area containing the project views in the current piece. The
following operations can be performed in the list area:
The order of project views within the list can be modified by dragging one or more
selected project views. While dragging them, a visual indication shows where the
selected project views will be relocated in the list.
To modify the name of a selected project view, right-click to open the shortcut menu,
click Rename and type in the desired value.
The Project Views dialog box also offers the following buttons that perform operations
on selected project views or allow creating new project views:
– Capture New
A button that saves the current contents of the 3D scene to a new project view.
When pressed, this button displays the Capture New Project View dialog box.
Specify a project view name, which must be unique, if not, a message window is
displayed indicating the situation and asks to overwrite the project view that has
the same name. Press the Capture button, or press the Cancel button to cancel
the operation. For more information, see Section 9.7.4.3 Project view content).
– Recapture
A button that replaces the project view currently selected in the list area with the
current contents of the 3D scene.
– Restore
A button that loads the project view currently selected in the list area and restores
the contents of the 3D scene. The restore operation can be configured using items
found in the Restore options section of the dialog box. This operation hides all of
the objects, and then restores the 3D Scene using the information in the project
view. This way, new objects, created after the project view was created, are not
displayed.
Note that the restore operation can also be launched by double-clicking over a
project view name in the list area.
When restoring a project view that contains a color scale, it replaces the active
color scale. The Scale type list box of the Color Map Display Options dialog box
(see Figure 19.1) is automatically set to (From Project View). This choice is
available only when restoring a project view, and is removed from the list when
applying another color scale.
Restoring a project view also involves activating data alignments. A project view
cannot be restored when it requires aligning a Data object that is locked. A
message informs the user that at least one data alignment could not be activated.
– Delete
A button that deletes the project views selected in the list area. Multiple project
views selected in the list can be deleted at once.
The Restore options section offers items used by the Restore operation that control
the visibility of child objects (e.g., child Reference cross-sections) of captured parent
objects, and that also apply to child objects of captured parent objects created after the
capture of the project view :
Object visibility
A group box that, when restoring a project view, offers items that control the
visibility of Data objects and their elements, and children of captured cross-
sections:
Data objects
A list box that allows controlling the visibility of Data objects and their
elements. Choose from: Surface (all surface Data objects and their
elements), Boundary (all boundary Data objects and their elements), All
(all Data objects and their elements), Captured Objects (objects that
were visible when the project view was captured and all their elements),
and Captured Elements (objects that were visible when the project view
was captured and their elements that were visible when the project view
was captured). The default value is Captured Elements.
When deleting an object and creating a new one with the same name,
this new object will not appear in the existing project views, except when
the Data objects list box is set to Surface (new surface Data objects are
considered by the project view), Boundary (new boundary Data objects
are considered by the project view), or All (new Data objects are
considered by the project view).
Nominal
A list box that allows controlling the visibility of nominal cross-section
children. Choose from: Show (all nominal children are visible), Hide (all
nominal children are hidden), and As Captured (nominal children are
visible or hidden depending on their visibility status when the project
view was captured). The default value is Captured Objects.
Measured
A list box that allows controlling the visibility of measured cross-section
children. Choose from: Show (all measured children are visible), Hide (all
measured children are hidden), and As Captured (measured children are
visible or hidden depending on their visibility status when the project
view was captured). The default value is Captured Objects.
Note that when a Reference object or a Data object is replaced, the current visibility
status of all elements of the object is deleted in all project views and all elements are
visible. To have a project view corresponding to the one created before the object
replacement, the user has to recreate the project view again.
Project views contain the information required to restore a 3D scene at a later time.
When restoring a project view, the visibility status of objects, elements, and
annotations is displayed in the 3D scene the same way it was when the project view
was captured, and their position and orientation reflect the coordinate system and data
alignments that were active at that time.
The content of a 3D scene is updated without modifying the visibility status of surfaces
and points of objects captured in project views. For example, elements that are ignored
or hidden in the 3D scene while capturing a project view remain ignored or hidden
when restoring it after modifying and updating the 3D scene. This behavior is useful
since the 3D scene does not need to be recreated after each update, in order to capture
project views that correspond to the 3D scene that was initially created. Note that
objects and elements that are deleted after capturing a project view will not be
displayed when restoring it.
Reference objects are always restored using the visibility status of all of their elements
captured in the project view, while Data objects and their elements can be restored
using specified visibility options. For more information on these options, see Section
9.7.4.2 Capturing and restoring project views.
A selected image’s project view can be restored using the Tools > Restore Project View
from Snapshot command on the Standard toolbar of the EZLayout pane. On choosing
the Restore Project View from Snapshot command, the selected image’s original project
view information is automatically restored (see Section 9.7.4 Viewing project views). If
the image was captured in the View One by One mode or the 2D Vector mode, the
mode is activated as well.
The View > Center submenu offers other operations that center objects in the 3D scene:
Objects
Centers selected objects in the 3D scene.
All Objects
Centers visible objects in the 3D scene.
The View menu offers an operation that rotates the 3D scene around the viewing axis:
The View > Mirror View submenu offers operations that allow mirroring the current
view:
Mirror about XY
Mirrors the current view about the standard XY plane.
Mirror about YZ
Mirrors the current view about the standard YZ plane.
Mirror about ZX
Mirrors the current view about the standard ZX plane.
The View menu offers an operations that allows mirroring the lights in the 3D scene:
Mirror Lights
Mirrors the light sources about the 3D scene’s vertical axis.
The View > Contextual Parameters command controls the display of special contextual
dialog boxes (e.g., additional dialog boxes to help users) that have been hidden by the
user. The command is only available if the current mode has a special contextual dialog
box. Such dialog boxes offer a Do not show this window check box to enable disabling
their display.
When a contextual dialog box is hidden by the user, selecting the Contextual
Parameters command displays the hidden contextual dialog boxes and clears the
dialog box’s Do not show this window check box.
The View menu offers operations to show individual panes that are hidden. If the pane
is displayed, the operation has no effect.
Dialog Zone
Displays the Dialog Zone pane.
Tree View
Displays the Tree View pane.
All six degrees of freedom needed to reach any desired position and orientation in 3D
space can be accessed using the mouse in a very intuitive manner. Object-centered
methods allow moving freely in 3D space. The mouse allows picking a 3D object and
then rotating and translating the object. Using only the mouse, three translations and
two rotations may be performed. One further rotation may be performed using the
SHIFT key. Each operation is described in the subsections that follow.
In the default mode, several choices under the Mouse Button Behavior menu button
on the 3D Scene toolbar are available to specify the allowed transformations in the 3D
scene using the mouse, as shown in Figure 9.4. Note that these toolbar buttons are not
available when the current mode does not allow transformations of the 3D scene.
In the subsections that follow, references to the X, Y, and Z axes refer to the screen
orientation.
To rotate about the X axis and the Y axis viewing axes, click and hold the left mouse
button inside the 3D scene. Rotations are performed by moving the mouse in the
desired directions. See Figure 9.5 (a). When a click occurs over a screen pixel belonging
to a 3D surface, the (x, y, z) coordinates of the point are computed. The 3D scene is then
rotated about the 3D location. If the click occurs over a background pixel instead of a
surface pixel, the rotations are performed about the center of the bounding box. While
Figure 9.4 A menu offered on the 3D Scene toolbar, available in the default mode and other
specific modes, that controls the transformations permitted in the 3D scene using the
mouse.
The first button allows access to all of the standard mouse-based rotation/translation/
zoom operations. The other buttons assign one same operation to all of the mouse
buttons, which is useful for new users who have not yet mastered the standard mode.
rotating about the X axis and the Y axis, the pointer icon changes to the one shown to
the right.
To translate along the X axis and the Y axis, click and hold the middle mouse button.
Translations along the X axis or the Y axis are performed by moving the mouse in the X
or Y directions respectively, inside the 3D scene. See Figure 9.5 (b). While translating
along the X axis and the Y axis, the pointer icon changes to the one shown to the right.
Figure 9.5 Using the left and middle mouse buttons to change the position and orientation of a
3D object. In (a), the left mouse button is used to rotate the 3D object about the X axis
and the Y axis. In (b), the middle mouse button is used to translate the 3D object along
the X axis and the Y axis.
y
z
(a) -x (b) +y
-y +y -x +x
+x -y
pointer icon changes to the one shown to the right.Note that in the case of a mouse
that has a wheel button as the middle button:
Rotating the wheel forward and backward will cause the 3D scene to, respectively,
zoom in and zoom out using the center of the 3D scene.
Pushing and holding down the SHIFT key while rotating the wheel forward and
backward will cause the 3D scene to, respectively, zoom in and zoom out using the
current pointer position in the 3D scene.
The pointer does not change when zooming with the wheel button.
Press and hold down the SHIFT key to access this operation. Rotating about the Z axis is
performed by clicking and holding the right mouse button, then moving the mouse in
the right or left direction. See Figure 9.6 (b). While rotating about the Z axis, the pointer
icon changes to the one shown to the right.
It is also possible to rotate the 3D scene by increments of 90 degrees about the viewing
axis. The rotation is performed by holding down the SHIFT key and quickly right-
clicking. If the right mouse button is held down for less than half a second, a
counterclockwise rotation of 90 degrees is applied about the rotation axis. If the right
Figure 9.6 Using the right mouse button to change the position and orientation of the 3D
object. In (a), the right mouse button is used to translate the 3D object along the Z
axis. In (b), the right mouse button enables rotation about the Z axis when the SHIFT
key is pressed.
y
x
z
+z + Shift key
(a) (b)
-z +z
-z
mouse button is still down after half a second, the standard unconstrained rotation
mode is activated.
In addition to zooming using the Z axis translation method, zooming can be performed
on an object part by delimiting a rectangular area:
A zoom will operate on the delimited area. While zooming on the delimited area, the
pointer icon changes to the one shown to the right.
PolyWorks user interfaces use two display modes. The Dynamic display mode is used
when the 3D scene is rotated and/or translated. The Static mode is applied when the
3D scene is not moved. Applications automatically switch between the Static and
Display modes, depending on the actions of the user. To remain in the Dynamic display
mode for a sequence of rotations and translations, press and hold the CTRL key. When
the actions have stopped, and the CTRL key has been released, the display mode
automatically switches back to the Static mode.
The Edit > Undo Transformation (Description) command allows undoing operations on
the View menu as well as user transformations. The Description field specifies the exact
operation to undo. For example, Undo Transformation (Pose Center).
One or several Data objects can be manually aligned to one or several Reference objects. The Align menu
also offers several other object alignment techniques to suit individual needs. An alignment performed on a
Data object appears as a data alignment under the Data Alignments branch in the tree view. The active data
alignment is shown in bold.
All Data objects to be aligned must be available (i.e., not ignored nor locked). While certain alignment
techniques apply to selected Data objects, others apply to all nonignored Data objects.
This chapter explains the alignment techniques. It also explains the concept of transformation groups.
(a) Modify the alignment of selected Data objects using the mouse and picking pairs
of points
Best-fit the surface of selected Data Align >Best-Fit > Data Objects 10.5.1
objects to the surface of available
Reference objects.
Match primitives extracted on Data Align > Feature-Based > Plane, Axis, 10.6.1
objects to primitives extracted on Center Point
Reference objects.
Align > Feature Based > Center 10.6.2
Points
(c) Modify the alignment of selected objects (Data and Reference objects and
primitives)
By default, all Data and Reference objects and primitives can be aligned. It is possible to
lock an object and prevent its alignment by selecting it in the tree view and choosing
the Edit > Lock Objects command. A padlock is then superimposed on the object’s icon
in the tree view. Locking a Data object is useful in order to align one Data object to
another Data object using primitives. To unlock a locked object, choose the Edit >
Unlock Objects command.
The Alignments toolbar, shown in Figure 10.1, offers shortcuts for several alignment
operations.
2. Choose the Align > Split View command, or use the CTRL + SPACEBAR shortcut.
The 3D scene is split into two viewports, as shown in Figure 10.2. Selected visible
Data objects, and visible objects in their transformation groups, are displayed in the
right viewport, while all other visible 3D objects are displayed in the left viewport.
3. Give objects in the right viewport an orientation similar to the orientation of objects
in the left viewport. Do this by applying rotations and translations in the left and the
right viewports (they are applied independently to the left and right sets of 3D
objects). These operations are the same as those described in Section 9.11 Changing
the 3D scene’s position and orientation.
Note that the alignment of 3D objects displayed in the left viewport remains fixed.
The alignment of 3D objects displayed in the right viewport is affected by
movements in either viewport.
The TAB key can be used in Split View Alignment mode to activate the 1 Point Pair
Alignment mode.
On entering the mode, the current projection type is memorized and the
Perspective projection type is automatically applied to allow transformations along
the Z axis (zooming). The user can change the projection type. On leaving this mode,
the memorized projection type is automatically reapplied.
The procedure first allows positioning objects in the two viewports similarly to facilitate
picking points on similar locations in each viewport. It then matches either one pair of
points, or 3 or more pairs of points, picked on a similar location on a) the selected Data
objects (i.e., mobile points), and b) the other 3D objects (i.e., fixed points). The
alignment operation brings the mobile point of the pair onto the fixed point of the pair,
for each point pair. When picking only one pair of points, a best-fit alignment is
automatically performed as well.
This alignment mode may be accessed from the Split View Alignment mode by
pressing the TAB key. A data alignment is added to the Data Alignments branch of the
tree view, within the alignment groups to which the transformed Data objects belong.
The other 3D objects, that remain fixed, must be visible. For the 1 Point Pair
alignment tool, at least one Reference object must be visible for use by the
incorporated best-fit alignment.
2. Choose the Align > Point Pairs command. The Point Pairs Alignment dialog box is
displayed, and the 3D scene is split into two viewports; see Figure 10.3 (a).
Only the selected Data objects, and the primitives of the transformation groups to
which the Data objects belong, are displayed in the viewport to the right, while
other visible 3D objects are displayed in the viewport to the left.
3. If desired, in the Name text box, edit the name to be used for the resulting data
alignment. The default name is point pairs <number>, where <number> is an
automatically incremented integer.
Default names may be configured; for more information, see Section 24.3.11 Default
name options.
4. Position the objects in either viewport using the mouse to facilitate the picking of
matching points, as shown in Figure 10.3 (b). Only the two independent camera
positions change – the objects are not being transformed at this point.
If the goal is to use the 1 Point Pair picking method, it is important to position the
objects quite similarly in order to provide an optimal starting point for the
alignment algorithm.
5. To align objects by picking one point, click the 1 Point Pair button to the right of the
Method label. Proceed as follows:
When using the 1 Point Pair method, click over two corresponding points in the
left and right viewports.
As soon as the second point is anchored, the set of selected Data objects is
automatically translated based on the matched points, and then the best-fit
object alignment algorithm is invoked. If the alignment is successful, the mode
is exited and the dialog box is closed.
If the alignment succeeds, it means that the iterative image alignment algorithm
has converged to an accurate solution. If the automatic alignment fails, a message is
displayed to that effect. The procedure can be performed again picking two other
points, or it may be preferable to match N pairs of points (see below) and then
Figure 10.3 In (a), the Point Pairs Alignment dialog box and the 3D scene configured with two
viewports. The right one contains a selected Data object. In (b), the objects have been
positioned using the mouse to facilitate picking points. In (c), four points are picked.
Corresponding points have the same number and color.
(a)
(b)
(c)
manually invoke the best-fit object alignment algorithm (see Section 10.5.1 Best-
fitting Data objects).
6. To align objects using several points, click the N Point Pairs button to the right of
the Method label. The N Point Pairs method consists in picking a minimum of three
pairs, but at least five pairs are recommended as the quality of the alignment
increases with the number of point pairs. Pick points as follows:
The SPACEBAR may be pressed to temporarily exit the mode and perform
rotations/translations which are applied to the two sets of objects. Press the
SPACEBAR again to return to the alignment mode.
Click pairs of points by clicking first in one viewport and then in the other
viewport for each pair, or pick all of the points (e.g., mobile points) in the right
viewport and then click all of the matching points (e.g., fixed points) in the same
order in the left viewport to complete the point pairs.
A pair of points is easily identified – the points are displayed using the same color
and have the same number in subscript (e.g., 1, 2, 3); see Figure 10.3 (c).
Right-click to compute the alignment, or press the ESC key to exit the picking
mode (any points already picked are discarded). If the alignment is computed,
the mode is exited and the dialog box is closed.
The alignment mode is activated by choosing the Align > Manual Alignment command.
On choosing the command, the dialog box shown in Figure 10.4 is displayed. It allows
specifying rotations/translations in text boxes, or launching an interactive mode to
perform rotations/translations in the 3D scene using sliders. Options are available in the
interactive mode, as shown in Figure 10.4 (b); they are described in Section 10.4.7
Specifying interactive alignment options.
When finished, press the Close button or the ESC key to dismiss the dialog box. Note
that zooming on the object automatically terminates the interactive mode. A data
alignment is added to the active data alignment group. On leaving the manual
alignment tool, objects that are no longer up-to-date are automatically updated.
Figure 10.4 In (a), the Manual Alignment dialog box, and in (b), the Interactive Alignment
Options dialog box.
(a)
(b)
In the Manual Alignment dialog box, press the Interactive button to activate the
interactive manual alignment mode. When activated:
A vertical slider is displayed to the right of the 3D scene and a horizontal slider at the
bottom of the 3D scene that allow performing vertical and horizontal translations.
When the x, y, or z check boxes in the 3D rotation group box are selected,
corresponding sliders are automatically displayed that allow performing 3D
rotations about the corresponding axis.
Place the mouse pointer over a slider to display the type of slider, its step, and the total
rotation/translation of that type (e.g., Rotation about X) performed using that slider.
Figure 10.5 The display in the 3D scene when using the interactive manual alignment mode. The
three sliders at the top are activated by selecting the corresponding check boxes at
the top of the Manual Alignment dialog box.
(a)
Display of total
translations/
rotations applied to
currently selected 3D
objects
Rotation center
(b)
A slider can be used by dragging the slider, clicking the slide bar, or by clicking the
slider’s arrow buttons. Each click of a slider arrow button translates the selected 3D
objects by a positive or a negative step value. To change the step value, click a slider’s
icon. The dialog box shown in Figure 10.5 (b) is displayed to specify a new step. Press
the OK button to transfer the value to the application.
Figure 10.5 (a) shows the display in the 3D scene when performing an interactive
manual alignment.
Operations may be performed interactively using the sliders or the mouse, which are
applied immediately. In addition, there are two methods that allow applying discrete
rotations/translations in the dialog box and pressing either the Apply button or the
ENTER key:
When the Apply button is pressed, all of the rotations/translations specified in the
dialog box are globally applied in the following order: the 3D rotation, the 3D
translation, and 2D translation.
When the ENTER key is pressed, the mouse pointer is located, and only the
transformation specified in the group box identified by the pointer location is
applied.
To reset all of the angular rotation or displacement values to 0, press the Reset button.
The 3D rotation group box is used to apply a 3D rotation about the X axis, the Y axis,
and the Z axis, or the horizontal, vertical, and viewing vectors, and proceeds as follows:
1. Specify the type of axes in the Rotate about list box. Two choices are offered: the X,
Y, Z axes, or Horiz., Vert., View (the horizontal, vertical, viewing vectors which
correspond to the axes of the display screen).
The choice will determine the labels displayed for the three check boxes below and
to the left:
When Horiz., Vert., View is chosen, the labels displayed are Ht, Vt, and Vw. To
simplify the text that follows, the x, y, and z labels will be used when referring to
the check boxes.
To rotate about a major axis, first select the x, the y, and/or the z check box
related to this axis.
To rotate about a screen viewing vector, first select the Ht, the Vt, and/or the Vw
check box related to this vector.
Press the Pick Center button. This enables an interactive mode that allows
picking a rotation center in the 3D scene. Once a rotation center is picked, the
sliders are reset to their middle position and their total translation/rotation value
is reset to zero.
Enter values in the text boxes under the Rotation center label. If a rotation in x
is specified, provide the (y, z) coordinates of the rotation center. If a rotation in y
is specified, provide the (x, z) coordinates of the rotation center. Finally, if a
rotation in z is specified, provide the (x, y) coordinates of the rotation center. If
two or three rotation axes are specified, provide all three coordinates of the
rotation center.
Note that a rotation center may be converted to a point by pressing the Create
Point button. After this operation, it may be necessary to reselect in the tree view
the objects to be manually aligned.
Specify an angle for each of the chosen axes, under the Angle label. If two or
three rotations are combined in the same operation, they are performed in the
following order: x, y, and z.
Use the sliders in the 3D scene. There is one for each axis check box that is
selected.
The 3D translation group box offers x, y, and z text boxes that allow specifying a 3D
translation along the X axis, the Y axis, and the Z axis.
The Vector group box allows translating selected objects along a vector, or rotating
selected objects about a vector. A vector must first be selected using the Vector list
box.
A rotation is performed by selecting the Rotation angle check box, entering a value,
and pressing the ENTER key.
Specify values in the Horizontal and/or Vertical text boxes of the 2D translation
group box and press the ENTER key.
In the interactive manual alignment mode, drag in the 3D scene (using either the left
or the middle mouse buttons).
Use the horizontal and the vertical sliders that are superimposed on the 3D scene
and that allow horizontal and vertical translations.
When entering the interactive alignment mode, the Interactive Alignment Options
dialog box, shown in Figure 10.6, is displayed, offering the following items:
window when in the operation mode, choose the View > Contextual Parameters
command.
To undo the translation/rotation operations stored in the Undo stack, use the Edit >
Undo command, or give the focus to the main user interface and use the CTRL+Z
shortcut.
The tool offers two methods: Fit to Reference Object Surfaces, a point-to-surface
method that minimizes the error over the entire surface of a part, and Fit within
Tolerance Zone that use a zone rather that a surface; the latter is recommended when
objects are deformed and a good alignment cannot be achieved by minimizing the
error over the entire surface of a part.
The possibility of specifying the degrees of freedom that will be optimized by the
alignment algorithm.
Certain objects must meet certain criteria to be used by the alignment algorithm:
Make sure that the Reference and Data objects that will be processed are available
and not locked.
Pre-align the Data objects to the Reference objects using one of the techniques
presented in Section 10.2 Using the interactive Split View mode or Section 10.3
Matching pairs of points.
It is assumed that any required pre-alignment has been performed and that the objects
to use for the alignment operation are available.
1. If aligning using elements, select them in the 3D scene. If aligning using objects,
they may be preselected in the tree view, or later using the dialog box (see text that
follows).
Note: When aligning using a tolerance zone defined between two Reference
objects, the Reference objects are selected using the dialog box and not directly in
the tree view.
2. Choose the Align > Best-Fit > Data Objects command, or press the corresponding
button on the Alignments toolbar (shown to the right). This displays the dialog box
shown in Figure 10.7.
3. If desired, in the Name text box, edit the name to be used for the resulting data
alignment. The default name is best-fit <number>, where <number> is an
automatically incremented integer. Default names may be configured; for more
information, see Section 24.3.11 Default name options.
4. Specify an alignment method by clicking the button to the right of the Method
label. Choose from:
The subsections for each method explain any parameters that pertain to the
method.
A data alignment is added to the appropriate data alignment groups under the Data
Alignments branch in the tree view.
7. View the current alignment statistics in the Statistics section (see Section 10.5.1.6
Viewing alignment statistics). After each iteration of the alignment algorithm, the
values are updated.
The Fit to Reference Object Surfaces best-fit method uses a high speed, parallel
implementation on multiprocessor systems. When this method is specified, the
contextual dialog box is configured as shown in Figure 10.8. If offers a pre-alignment
operation, as well as basic and advanced parameters that control the set of points to
use for the best-fit alignment algorithm.
Pre-alignment
A list box that offers the following pre-alignment methods:
Point Pairs – Allows matching pairs of points on Reference and Data objects
situated in separate viewports. When the Start button is pressed, a dialog
box is displayed, the 3D scene is configured using two viewports, and two
point-picking modes are offered. For complete information, see Section 10.3
Matching pairs of points.
This option is not offered if any constraints are specified for the alignment (see
Section 10.5.1.5 Constraining the alignment).
Reference objects
A list box that allows specifying the Reference objects to use for the alignment.
Choose from: All, Specific, and Selected Elements (selected elements of used
Reference objects). The default value is All, unless one or more Reference objects
are used and selected when opening the tool. In this case, the default value is
Specific, and a list box is displayed that offers a list of the available Reference
objects, preceded by a check box, which enables object selection. The check boxes
of the used and selected Reference objects are selected by default.
Data objects
A list box that allows specifying the Data objects to use for the alignment. Choose
from: Surface (all used, unlocked surface Data objects), Boundary (all used,
unlocked boundary Data objects), All (all used, unlocked Data objects), Specific,
Figure 10.8 The Best-Fit Data Objects dialog box configured for the Fit to Reference Object
Surfaces method.
and Selected Elements (selected elements of used, unlocked Data objects). The
default value is Surface, unless one or more Data objects are used, unlocked, and
selected when opening the tool. In this case, the default value is Specific, unless
elements of the Data objects are selected, in which case, the default value is
Selected Elements.
When the value is Specific, a list box is displayed that offers the available Data
objects, preceded by a check box, which enables object selection. The check boxes
of the used, unlocked, and selected Data objects are selected by default.
Max distance
A text box that allows specifying the maximum search distance when Data points
are matched to a Reference surface. Valid values are greater than 0 mm. The
default value is 300 mm.
Subsampling
A combo box that specifies the fraction of Data points that will be processed.
Choose from: 1/1, 1/4, 1/16, and 1/64, or specify a value by entering 1/n, where n
is a positive integer value. The default value is 1/4.
Max angle
A check box that enables an adjacent text box used to specify an angle in degrees.
The angle represents a maximum deviation between a Data point’s normal vector
and a matched Reference object’s normal vector. This angle is used to match
surfaces with compatible orientations. When the deviation between normal
vectors exceeds the maximum value, the search for a Reference object is resumed
until a Reference point with a compatible orientation is found, or the Max
distance has been reached. The default value is 45 degrees.
Data segmentation
A check box that enables automatically detecting high-discrepancy areas in order
to remove Data points that do not match well to the Reference surfaces before
computing a final, accurate alignment. Otherwise, all Data points are used in the
alignment computations. By default, the check box is cleared.
Offset
A check box that enables specifying in the adjacent text box a Reference offset,
normal to the Reference surface, to be used to perform the alignment. The offset
sign refers to the orientation of a Reference surface. A positive offset is above the
actual surface, while a negative offset is below the actual surface. The default
value is 0 mm. By default, the check box is cleared.
Note that the alignment offset cannot be used if a Reference object has a
Thickness type virtual surface and Effective surface(s) is set to Both. See Section
23.6.4.1 Reference objects and virtual surfaces for more information on virtual
surfaces.
When a Reference object has a nonzero offset value, Data points are automatically
aligned and distances are measured to the offset of the Reference surface.
Ignore – The Data points are ignored for the current iteration. When the
Data object is larger than the Reference object, or misaligned, this choice
allows restricting the measurement to the portion of the Data object located
over the reference surface. The default value is Ignore.
Align to Surface Extension– For each Data point, the surface belonging to
the boundary curve is extended virtually (to infinity), and that surface is used
by the Data point.
Align to Boundary– For each Data point, the boundary curve is used by the
Data point.
For an alignment that uses selected elements of Reference objects, the limit
between the selected and the unselected elements is considered to be a
boundary.
Convergence target
A group label that offers options used to specify the convergence target criteria,
used to stop the alignment operation:
Automatic
An option button, selected by default, that specifies automatically
computing a convergence target criterion.
Custom
An option button that enables an adjacent text box that allows
specifying the convergence target (i.e., the desired difference between
an incremental alignment matrix and an identity matrix).
When a convergence target value is specified, the alignment process stops when
the incremental transformation matrices computed in one iteration are nearly
identity matrices. This convergence criterion value is computed for each
computed incremental matrix, and is defined as the sum of the squared
differences between the identity matrix elements and the incremental matrix
elements. The criterion value converges towards zero as the incremental matrices
tend toward identity matrices. When the convergence criterion is 0, the
incremental alignment matrix is exactly an identity matrix.
The alignment algorithm will stop when either one of the convergence criteria is met.
The alignment is considered successful even if the alignment stops at the maximum
number of iterations before reaching the convergence target. A message window is
displayed to inform the user of this situation.
Figure 10.9 The Best-Fit Data Objects dialog box configured for the Fit within Tolerance Zone
method. The Tolerance zone list box offers two ways of defining the tolerance zone.
When the Fit within Tolerance Zone best-fit method is specified, two ways are offered
to define the tolerance zone: Reference Object Tolerances or Between Two
Reference Objects. Both require specifying Reference objects (or elements) and Data
objects (or elements). The contextual dialog box configured for each is shown in Figure
10.9.
The tolerance zone is defined by specifying Reference objects or their elements. The
items offered depend on the type of tolerance zone.
A tolerance zone is defined using the Positive High and Negative High limits of the
tolerance of each individual Reference object and CAD surface (see Figure 10.10 (a)).
The following item allows specifying the Reference objects or elements to use.
Reference objects
A list box that allows specifying the Reference objects to use for the alignment.
Choose from: All, Specific, and Selected Elements (selected elements of used
Figure 10.10 The two options for best-fitting Data objects within a tolerance zone: using the high
tolerance limits specified for Reference objects (a) and using the surfaces of an upper
and a lower Reference object (b).
(a) Tolerance zone defined using the high (b) Tolerance zone defined using
tolerances of a Reference object the surfaces of Reference objects
Negative high
tolerance limit Surface of lower
Reference object
Reference objects). The default value is All, unless one or more Reference objects
are used and selected when opening the tool. In this case, the default value is
Specific. When Specific is chosen, it makes available a list box offering the
available Reference objects, preceded by a check box which enables object
selection. By default, the check boxes are cleared, unless Reference objects are
used and selected when opening the tool. In that case, their check boxes are
selected by default.
Upper object
A list box that allows specifying the Reference object to use as the upper object.
Choose from the list of available Reference objects. If Reference objects are
selected in the tree view, the first Reference object is selected by default.
Lower object
A list box that allows specifying the Reference object to use as the lower object.
Choose from the list of available Reference objects. If Reference objects are
selected in the tree view, the second Reference object is selected by default.
The Data objects or elements to use are specified using the item that follows:
Data objects
A list box that allows specifying the Data objects to use for the alignment. Choose
from: Surface (all used, unlocked surface Data objects), Boundary (all used,
unlocked boundary Data objects), All (all used, unlocked Data objects), Specific,
and Selected Elements (selected elements of used, unlocked Data objects). The
default value is Surface, unless one or more Data objects are used, unlocked, and
selected when opening the tool. In this case, the default value is Specific, unless
elements of the Data objects are selected, in which case, the default value is
Selected Elements.
When Specific is chosen, it makes available a list box offering the available Data
objects, preceded by a check box which enables object selection. By default, the
check boxes are cleared, unless Data objects are used, unlocked, and selected
when opening the tool. In that case, their check boxes are selected by default.
The Constraints section of the best-fit alignment dialog box (see Figure 10.11) provides
sophisticated constraining capabilities; when constraints are specified, the Pre-
alignment option is made unavailable. Three choices are offered by the Constraint list
box, all of which are configurable:
Plane – Specifies constraining the best-fit alignment such that the motion is
performed onto a plane selected in the tree view. It is configurable through the
Degrees of freedom group label that offers the following items:
Translation
An option button that allows two translational degrees of freedom on the plane.
Vector – Specifies constraining the best-fit alignment such that the motion is
performed along a vector selected in the tree view. It is configurable through the
Degrees of freedom group label that offers the following independent items (when
no check box is selected, no motion is allowed):
Figure 10.11 The Constraints section of the Best-Fit Data Objects dialog box, configured for
different constraints (e.g., Plane, Vector, Standard).
(a) (c)
(b)
Rotation axes
Three check boxes, X, Y, Z, that each enable using a standard axis to specify the
rotational degrees of freedom. By default, they are selected.
Translation axes
Three check boxes, X, Y, Z, that each enable using a standard axis to specify the
translational degrees of freedom. By default, they are selected.
Rotation center
Three check boxes, x, y, z, that enable specifying the rotation center. The value for
the rotation center can be entered manually, or provided by dragging a center-
point-based primitive over one of the three text boxes.
The Translation axes and Rotation center check boxes are mutually exclusive.
When the X check box is selected after Translation axes, the optimal translation in X
is automatically computed. The translation in X then becomes an unconstrained
degree of freedom. Alternately, select the x check box after Rotation center, and
specify the x position of the rotation center to optimize rotational degrees of
freedom. In this case, the translation in X is fixed and is not optimized.
the application to optimize these degrees of freedom (i.e., the check boxes after the
Translation axes label), or by explicitly selecting the y and z positions of the
Rotation center. The dialog box ensures that user settings are always consistent.
Iteration
A text box that specifies the current iteration of the alignment algorithm.
Convergence
A text box, available for the Fit to Reference Object Surfaces method only, that
specifies how close an incremental alignment matrix is to an identity matrix. The
result is defined as the sum of the squared differences between the identity matrix
elements and the incremental matrix elements. When the convergence criterion is
0, the incremental alignment matrix is exactly an identity matrix.
After each iteration, the convergence value converges towards zero as the incremental
matrices tend toward identity matrices.
An option, Align data objects, allows aligning Data objects to Reference objects using
a selected Data cross-section. In this case, the operation adds an alignment to each
Data object’s alignment history.
10.5.2.1 Introduction
The Data cross-sections are uniformly sampled for the fit operation, so no part of a
cross-section has more weight than any other part.
The alignment is always constrained to the plane associated with the cross-sections.
For each cross-section, all of its Data cross-sections are aligned globally to all of its
Reference cross-sections, which produces a global transformation.
It is assumed that any required pre-alignment has been performed and that the objects
to use for the alignment operation are available.
2. Choose the Align > Best-Fit > Cross-Sections command, or press the corresponding
button on the Alignments toolbar (shown to the right). This displays the dialog box
shown in Figure 10.12.
3. Specify an alignment method by clicking the Method menu button. Choose from:
Fit within Tolerance Zone, which uses a tolerance zone based on the cross-
sections’ tolerances or the surface of Reference objects (described in Section
10.5.2.4 Using the Fit within Tolerance Zone method).
6. View the current alignment statistics in the Statistics section (described in Section
10.5.1.6 Viewing alignment statistics) of the dialog box. After each iteration of the
alignment algorithm, the values are updated.
The result of the operation is that the selected Data cross-sections are transformed.
Note that their Auto-update property is set to Off in order to avoid the modification of
the cross-sections after the alignment operation. For more information on this
property, see Section 15.7 Using the property sheet of cross-sections.
Max distance
A text box that specifies a maximum search distance between a sample point on a
Data cross-section and a Reference cross-section. The default value is 300 mm.
Figure 10.13 The Best-Fit Cross-Sections dialog box, configured for the Fit within Tolerance Zone
method and shown for each tolerance zone choice.
Max angle
A check box that enables an adjacent text box used to specify an angle in degrees.
The angle represents a maximum deviation between a sample point’s normal
vector on a Data cross-section and a Reference cross-section’s normal vector. This
angle is used to match surfaces with compatible orientations. When the deviation
between normal vectors exceeds the specified value, the search for a Reference
cross-section is resumed until a Reference point with a compatible orientation is
found, or the Max distance has been reached. The default value is 45 degrees.
Sampling step
A combo box that specifies a distance between sample points on the children of a
measured cross-section component. The children of a measured cross-section
component are sampled so that no part of a cross-section has more importance
than any other part; the sample points are used for the fit operation. Choose
Automatic (all children of the cross-section are subsampled to have the same
number of sample points) or specify a positive value. The default value is
Automatic.
On choosing the Fit within Tolerance Zone method, the dialog box is configured as
shown in Figure 10.13. It offers the following basic and advanced items:
Tolerance zone
A list box that allows specifying how the 2D tolerance zone is defined for the
Reference cross-sections. Choose from:
Between Two Reference Objects – Use the zone delimited by the surfaces
of two Reference objects (see Figure 10.14 (a)). When chosen, two list boxes
are displayed to specify the Reference objects: Upper object and Lower
object. The two objects must have the same orientation as the Reference
cross-sections that are situated between the two objects. In addition, the
two objects must not intersect each other.
Sampling step
A combo box that specifies a distance between sample points on the children of a
measured cross-section component. The children of a measured cross-section
component are sampled so that no part of a cross-section has more importance
than any other part; the sample points are used for the fit operation. Choose
Automatic (all children of the cross-section are subsampled to have the same
number of sample points) or specify a positive value. The default value is
Automatic.
Figure 10.14 The two options for best-fitting cross-sections within a tolerance zone, using the high
tolerance limits specified for child Reference cross-sections (a) and using the surface
of an upper and a lower reference object (b).
(a) Tolerance zone defined using the (b) Tolerance zone defined using
tolerances specified for the child Reference object surfaces
Reference cross-section
Negative high
tolerance value Lower Reference
object surface
default. When the check box is selected, the following items can be specified in the
Degrees of freedom group box that is available:
Translation
An option button that specifies performing only a translation in a cross-section’s
plane.
Rotation
An option button that specifies performing only a rotation about a rotation point
in a cross-section’s plane. This option is selected by default. When selected, the
Rotation center group box allows specifying a point using the x, y, and z text
boxes. Enter values in the text boxes or drag a center-point-based primitive over a
text box to use its coordinates. The rotation center is projected on the cross-
section’s plane prior to being used.
Alignment statistics are displayed in the Statistics section of the dialog box (see Figure
10.13). One item is displayed for all methods:
Iteration
Displays the number of iterations performed by the best-fit algorithm.
One item is displayed only for the Fit within Tolerance Zone method:
Figure 10.15 The Constraints section of the Best-fit Cross-Sections dialog box.
The pre-alignment of a best-fit to Reference object surfaces data alignment may have
not succeeded, or may no longer be valid following an operation such as replacing a
Data object, such that the best-fit alignment could not provide good results.
Two operations allow performing a new pre-alignment, which may result in the best-fit
alignment obtaining a better result. These operations can only be performed on best-fit
to Reference object surfaces data alignments that have no specified constraints. For
more information on the alignment operation, see Section 10.5.1 Best-fitting Data
objects.
The Align > Best-Fit > Pre-Align Automatically command allows performing a new pre-
alignment for the selected best-fit to Reference object surfaces data alignment
automatically. This method requires that the Data objects, or their selected elements,
completely describe the surfaces modeled by the Reference objects. Based on this new
pre-alignment, the best-fit operation is reperformed.
The Align > Best-Fit > Pre-Align using Point Pairs command allows performing a new pre-
alignment for the selected best-fit to Reference object surfaces data alignment using
the Point Pairs alignment method, presented in Section 10.3 Matching pairs of points.
The Data objects specified in the data alignment are located in the right viewport.
Based on this new pre-alignment, the best-fit operation is reperformed.
A best-fit data alignment may be remeasured using newly selected Reference elements
and/or Data points.
If a best-fit data alignment can make use of Reference elements (i.e., triangles, CAD
surfaces), the Align > Best-Fit > Remeasure using Reference Elements command allows
remeasuring a selected best-fit data alignment using selected elements of Reference
objects. The selected elements are used for the operation, and the Reference objects
specification of the best-fit data alignment is automatically set to Selected Elements.
If a best-fit data alignment can make use of Data elements (i.e., Data points), the Align >
Best-Fit > Remeasure using Data Points command allows remeasuring a selected best-fit
data alignment using selected elements of Data objects. The selected elements are
used for the operation, and the Data objects specification of the best-fit data
alignment is automatically set to Selected Elements.
If a pre-alignment was specified but is missing, for example following an Edit > Delete >
All Measurements operation, a pre-alignment using the Point Pairs method is
automatically launched.
Typically the primitives created on the Data objects are the source primitives, and the
alignment method aligns them to the destination primitives created on the Reference
object. The operation transforms all nonignored, nonlocked Data objects and their
transformation groups.
The operation transforms all nonignored, nonlocked Data objects and their
transformation groups. A data alignment is added to the appropriate data alignment
groups under the Data Alignments branch in the tree view.
Specify standard planes and a point. For example, if the normal of the
destination planar primitive is parallel to one of the major axes (i.e., X, Y, Z), the
destination axis is parallel to one of the major axes, and/or the coordinates of the
destination point are known, they may be used.
Note that at least one primitive must be created to obtain at least a partial
alignment.
3. Choose the Align > Feature-Based > Plane, Axis, Center Point command, or press the
corresponding button on the Alignments toolbar (shown to the right). The dialog
box shown in Figure 10.16 is displayed.
4. If desired, in the Name text box, edit the name to be used for the resulting data
alignment. The default name is plane, axis, center point <number>, where
<number> is an automatically incremented integer. Default names may be
configured; for more information, see Section 24.3.11 Default name options.
5. Specify the alignment sequence using the Sequence list box of the dialog box.
A sequence specifies which pair of primitives will be aligned first, then second, and
then last. The alignment of the second pair of primitives must preserve the
alignment of the first pair. The alignment of the third pair of primitives must
Figure 10.16 The dialog box used to perform an alignment using planar, axial, and center-point-
based primitives. In (a), the alignment is performed using primitives. In (b), the
alignment is performed using both primitives and user-defined values.
(a) (b)
preserve the alignment of the first two pairs. All permutations of the Plane, Axis,
Center Point items are offered as sequences.
6. In the Parameters section, specify the source and destination primitives. The items
are offered in the dialog box in the order that corresponds to the selected sequence.
A list box is not available if the pair of primitives in the preceding group box have
not yet been specified.
Note that primitives can be specified either by using the appropriate list box or by
clicking the hand symbol (shown to the right) adjacent to the list box to pick them
in the 3D scene. For information on the interactive picking mode, see below.
Note that each time a pair of primitives is selected, a real-time preview of the
alignment is displayed in the 3D scene. At least, one pair of primitives must be
specified to perform the alignment.
Plane
A group box that allows specifying the source and destination planar primitives of
the alignment. It offers the following items:
Source
A list box that allows specifying the source planar primitive.
Destination
A list box that allows specifying the destination planar primitive.
x, y, or z
A text box that is made available when the Destination list box is
set to a standard plane. This text box enables defining the offset
that will be applied to the selected plane along the third axis. The
offset can be a positive or a negative value. The default value is
0.0.
Axis
A group box that allows specifying the source and destination axes of the
alignment. It offers the following items:
Source
A list box that allows specifying the source axis-based primitive.
Destination
A list box that allows specifying the destination axis-based primitive.
Note that if the destination axis is parallel to one of the major X, Y, or Z
axes, it can be directly specified in the dialog box by selecting the axis
orientation (i.e., +X, -X, +Y, -Y, +Z, or -Z).
x, y, or z
Two text boxes are made available when the Destination list box
is set to an axis orientation. These text boxes enable defining the
axis position. The label to the left of each text box indicates along
which major axes the position of the axis may vary. The +X/-X
major axis is positioned along the Y and Z axes, the +Y/-Y major
axis is positioned along the X and Z axes, and the +Z/-Z major axis
is positioned along the X and Y axes. The position can be a
positive or a negative value. The default value for both text boxes
is 0.0.
Center point
A group box that allows specifying the source and destination center points of the
alignment. It offers the following items:
Source
A list box that allows specifying the source center-point-based primitive.
Destination
A list box that allows specifying the destination center-point-based
primitive. Note that the x, y, z coordinates of the center point can be
directly specified in the dialog box by entering the coordinates in the x,
the y, and the z text boxes. Also, a center-point-based primitive may be
dragged over a text box to specify the x, y, z coordinates.
x
A text box that enables specifying the coordinate on the X axis
that will be used to define the destination center point. The
default value is 0.0.
y
A text box that enables specifying the coordinate on the Y axis
that will be used to define the destination center point. The
default value is 0.0.
z
A text box that enables specifying the coordinate on the Z axis
that will be used to define the destination center point. The
default value is 0.0.
Using the interactive picking mode for aligning objects using primitives
Press the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
Pick pairs of primitives in the 3D scene (at least one pair of primitives must be
specified). When the interactive mode is enabled for an item, the hand symbol in
the dialog box appears with a blue background to identify which primitive is
currently in a picking mode.
Pick two planar primitives, two axial primitives, and two center-point-based
primitives in the 3D scene, pair by pair, by clicking directly on the primitives
or their annotation. First pick the source primitive and then the destination
primitive.
Right-click or press the Confirm button to launch the alignment procedure and
exit the mode.
A tool allows aligning pairs of center points. A pair of center points is composed of a
center point located on a Data object (source point) and a paired center point located
on a Reference object (destination point). The alignment automatically matches the
source point to the destination point for each pair of points. Center-point-based
primitives have a center point.
The alignment operation transforms all nonignored, nonlocked Data objects and their
transformation groups, and scales them if scaling is specified.
1. Create primitives on the Data objects to obtain the desired source center points, and
create primitives on the Reference objects to obtain the desired destination center
points.
Note also that circles, polygons, rectangles, and spheres can have different radii,
even within a pair, since only the center points are matched.
2. Choose the Align > Feature-Based > Center Points command, or press the
corresponding button on the Alignments toolbar (shown to the right). The dialog
box shown to the left in Figure 10.17 is displayed.
Use constraints
A check box that allows enabling the Constraints tab, shown to the right in Figure
10.17, that allows specifying the degrees of freedom to optimize (explained in
Section 10.6.2.1 Using constraints). By default, the check box is cleared.
All of the available Data objects must have the same scaling factor prior to this
operation. This property may be viewed for a Data object on the Data tab of its
property sheet (i.e., Uniform scaling factor).
Figure 10.17 The dialog box used to perform an alignment using pairs of center points.
4. Specify the pairs of points to use for the alignment. Pairs of points are assigned the
same color in the 3D scene. There are two ways to specify a pair of points using
existing primitives:
For each pair of points, choose a source primitive and then a destination
primitive using the list boxes in the Source and the Destination lists.
Use the interactive picking mode which is automatically enabled when the
dialog box is displayed:
Pick the primitives in the 3D scene, pair by pair (first the source primitive and
its destination primitive) by clicking the primitive or its annotation. The
name of the first primitive will appear in the list box in the Source list and the
name of the second primitive will appear in the list box in the Destination
list.
The SPACEBAR can be used to temporarily exit the mode to rotate and
translate the 3D scene.
Each pair of matched primitives also comes with a left check box labeled Pair # N,
where N is the index of the pair in the list. The check box is used to disable/re-enable
a pair once it has been created.
6. To disable one or more pairs of picked points and perform another alignment, clear
the check boxes associated with the pairs of points and press the Align button.
7. When finished, press the Done button or right-click to dismiss the dialog box.
The Constraints tab, shown to the right in Figure 10.17, offers three options to
constrain the operation:
Constrained by a Plane
An option button that specifies constraining the best-fit alignment such that the
motion is performed onto a plane selected in the tree view. It makes available two
options:
Constrained by a Vector
An option button that specifies constraining the best-fit alignment such that the
motion is performed along a vector selected in the tree view. It makes available
two options:
Standard constraints
An option button, selected by default, that specifies directly controlling degrees of
freedom with respect to a standard x, y, z axes. Nine check boxes in the Allowed
degrees of freedom group box are enabled: three x, y, z check boxes below the
Rotation label enable/disable the rotational degrees of freedom, three x, y, z
check boxes below the Translation label enable/disable the translational degrees
of freedom, and three x, y, z check boxes below the Rotation center label allow
specifying the rotation center. The value for the rotation center can be entered
manually, or provided by dragging a center-point-based primitive over one of the
three text boxes.
The Translation and Rotation center check boxes are mutually exclusive. When
the x check box below Translation is selected, the application automatically
computes the optimal translation in x. The x translation then becomes an
unconstrained degree of freedom. Alternately, the x check box below Rotation
center can be selected, and then the x position of the rotation center can be
specified to optimize rotational degrees of freedom. In this case, the x translation
is fixed and is not optimized by the application.
When a rotational degree of freedom is being optimized by the application, its two
complementary translations must either be optimized or explicitly set to specify a
rotation center. For example, if the x check box below Rotation is selected, y and z
translations must be specified. These translations can be specified either by letting the
application optimize these degrees of freedom (check boxes below Translation), or by
explicitly setting the y and z positions of the Rotation center. The dialog box ensures
that user settings are always consistent.
The Align > Feature-Based > Perpendicular Planes command allows aligning Data objects
to Reference objects using three pairs of perpendicular planes. The operation
transforms all nonignored, nonlocked Data objects and their transformation groups,
and is performed as follows:
1. Create, extract, or fit three perpendicular planes on the source Data objects.
Figure 10.18 The dialog box used to perform an alignment using three pairs of perpendicular
planes.
3. Choose the Align > Feature-Based > Perpendicular Planes command, or press the
corresponding button on the Alignments toolbar (shown to the right). The dialog
box shown in Figure 10.18 is displayed.
4. Specify the source and destination planes. There are several ways to specify
primitives. The first involves picking pairs of planes:
Use the interactive primitive-picking mode to pick three pairs of planes in the 3D
scene, pair by pair, by clicking the primitives or their annotations. Note that a red
rectangle encloses the pickable primitive list box in the dialog box.
If the Alignment method is set to Refit using Weights, a value may be specified
in the Weight text box adjacent to the list box of each source primitive.
The SPACEBAR can be used to temporarily exit the mode to rotate and translate
the 3D scene.
The other methods are explained as they apply to specifying source and then
destination primitives:
Specify source primitives by choosing planes in, respectively, the 1st plane, 2nd
plane, and 3rd plane list boxes in the Source group box.
If the Alignment method is set to Refit using Weights, a value may be specified
in the Weight text box adjacent to the list box of each source primitive.
To specify a plane, select the option button to the left of the 1st plane list
box and choose a plane.
Proceed in a similar fashion for the 2nd plane and the 3rd plane items.
5. In the Alignment method group box at the bottom left of the dialog box, specify
the alignment method using the list box. Three choices are offered: Do Not Refit (3-
2-1), Refit using Priority, and Refit using Weights. Each choice is explained in the
following text.
Do Not Refit (3-2-1) does the equivalent of a 2 Planes, 2 Axes, 2 Center Points
alignment. For both source and destination primitives, it intersects the 1st and 2nd
planes and computes an axis, intersects the three planes and computes a point, and
then matches two planes, two axes, and two center points.
Refit using Priority uses a refitting process to get three perpendicular source
planes. The second plane is refitted perpendicular to the first one, and the third
plane is refitted perpendicular to the first and second planes. Once the measured
planes are perpendicular, they are matched to the three destination planes. Note
that the second and the third planes must have fitted Data points.
Refit using Weights makes available the Weight text boxes in the Source group
box. It uses the weights assigned to the source planes to fit the best triplet of
perpendicular planes on the Data points onto which the three source planes were
fitted. If the first plane has a weight of 10, and the two others have a weight of 1, the
first plane would have a strong influence on the fit, and would almost lock three
degrees of freedom. The two other planes would have an equal importance with
respect to locking the three remaining degrees of freedom. Note that the three
planes must have fitted Data points.
The Auto-Match Data Points tool is most efficient with a small number of points. For
best results, the two Data objects should collectively have a maximum of 200 Data
points. A typical application would consist in having CAD coordinates in the
Destination Data object and corresponding Data points in the Source Data object.
On choosing the Align > Auto-Match Data Points command, the dialog box shown in
Figure 10.19 is displayed, offering the following items:
Degrees of freedom
A group box that offers two options that allow specifying the degrees of freedom
to optimize:
Rotations/Translations
An option button that allows rotations and translations, without any
constraints.
Tolerance
A text box that defines a distance used to auto-match the source Data points to
the destination Data points. The default value is 0.5 mm. Values must be greater
than 0.0 mm for the alignment to be performed.
The Auto-Match Data Points dialog box also offers the Advanced button to access the
bottom section of the dialog box that offers the following item:
Figure 10.19 The dialog box used to perform an alignment by auto-matching Data points.
Press the Align button to launch the alignment operation or the Cancel button to end
the operation and dismiss the dialog box. An alignment report is automatically
generated and added to the Reports > Items subbranch of the tree view.
If the alignment is launched and the Data objects contain too many points, a message
window is displayed offering the possibility of cancelling the operation. Press the OK
button to continue or the Cancel button to end the operation.
Figure 10.20 Data objects have two transformation matrices (a), and Reference objects have one
transformation matrix (b). The matrices are properties of these objects, and can be
viewed by means of their property sheet.
(a) (b)
When a Data or a Reference object is imported, the object elements (i.e., Data points,
triangles and CAD surfaces of Reference objects) are expressed in their original
position. The objects may then be transformed into their new position. For example, if a
point cloud Data object is aligned to a Reference object, the position of the Data point
cloud is modified. The application always keeps the object elements in their original
position, and represents the position transformations by means of transformation
matrices. These matrices are found on the Matrix tab of an object’s property sheet.
As shown in Figure 10.20, a Data object has two transformation matrices, and a
Reference object has one transformation matrix:
The global transformation matrix transforms the original object into the current
IMSurvey position.
The last transformation matrix contains the results of the last transformation
operation performed on a Data object.
These matrices can be exported, modified, and used to apply transformations to other
nonignored geometric objects.
2. Specify a method in the Method list box. Choose from the following methods:
From Data Object – A method that allows specifying the transformation matrix
of a Data object. For complete information, see Section 10.8.2.1 Transforming
objects using a matrix from a Data object.
From File – A method that allows specifying an external file that contains a
transformation matrix. For complete information, see Section 10.8.2.3
Transforming objects using a matrix from a file.
3. Press the Transform button to launch the operation. The selected objects are
transformed.
4. If desired, transform other objects by making new object selections and/or dialog
box specifications, and pressing the Transform button.
The From Data Object method allows performing a transformation using one of the
matrices of a Data object. When this method is specified, the dialog box is configured
as shown in Figure 10.21 (a). The Parameters section offers the following items:
Data object
A list box that allows specifying a Data object. Choose from the list of available
objects.
Matrix
A group label that allows specifying the type of transformation to use:
Figure 10.21 The dialog box used to transform geometric objects using a transformation matrix
from a Reference or a Data object. It is shown configured for each possible method.
Global transformation
An option button, selected by default, that specifies using the object’s
global transformation matrix.
Last transformation
An option button that specifies using the object’s last transformation
matrix.
Invert transformation
A check box that enables using the inverse of the specified transformation matrix.
By default, the check box is cleared.
The From Reference Object method allows performing a transformation using the
matrix of a Reference object. When this method is specified, the dialog box is
configured as shown in Figure 10.21 (b). The Parameters section offers the following
item:
Reference object
A list box that allows specifying a Reference object. Choose from the list of
available objects.
Invert transformation
A check box that enables using the inverse of the specified transformation matrix.
By default, the check box is cleared.
The From File method allows performing a transformation using a matrix obtained
from a file. When this method is specified, the dialog box is configured as shown in
Figure 10.21 (c). The Parameters section offers the following item:
File
A text box that allows entering a path to an external matrix file. An adjacent
Browse button displays a file browser. Specify a file name and location, and press
the Open button.
Invert transformation
A check box that enables using the inverse of the specified transformation matrix.
By default, the check box is cleared.
This section presents two applications of the transformation matrices of Data and
Reference objects.
The context:
A user has two aligned digitized point clouds, Data1 and Data2, and a CAD
Reference1. The two Data objects are in position 1, and the Reference object is in
position 2.
Data1 and Reference1 are loaded, and Data1 is aligned to Reference1 (the CAD
model). As a result, Data1 is now expressed in position 2.
Does the user have to repeat the alignment operations? No. Instead, proceed as follows:
1. Select Data2.
The context:
A user has digitized a car and has created a polygonal representation, Data1, using
PolyWorks. The digitized car’s position, position 1, is not yet related to a CAD model.
Using a CMM, a set of points, Data2, is digitized and expressed in the CAD model’s
position, which is in position two.
The polygonal model and the CMM point cloud are loaded in IMSurvey, and the
point cloud is aligned to the polygonal model.
Is it possible to bring the polygonal model in the CAD’s position 2? Yes. Proceed as
follows:
The global matrix of the CMM point cloud transforms position 2 into position 1. The
Invert transformation check box allows the user to bring back objects expressed in
position 1 in the desired CAD position 2.
The Align > Move Reference/Data Objects to Initial Position command resets the
alignment of selected Reference and Data objects, that are unlocked and nonignored,
by setting their global transformation matrix to Identity.
Such groups are called transformation groups. A transformation group may contain one
or several Reference or Data objects. In addition, individual Reference or Data objects
may have child objects, which may be any other type of 3D object, such as primitives
and cross-sections. For an example, see Figure 10.22 (a).
For each new Data object, a new transformation group is created having the Data
object as its only child. Note that in some cases, a new Data object is added to an
existing transformation group.
When the Data object is an IMAlign project containing reference points, the resulting
point primitives automatically become children of the Data object.
When a Data object is associated with a data alignment group on import, it is placed
in the transformation group of the first Data object of the alignment group.
As a result, the user can import Data objects, fit primitives, apply transformations, and
the primitives will follow their parent Data object.
Transformation groups can be created interactively for special purposes, and existing
transformation groups can be edited. The Align > Transformation Group submenu offers
the following commands:
Figure 10.22 For each Reference and Data object, IMSurvey automatically creates a
transformation group containing the object. Below, the transformation group of
each contains primitives created on those objects (a). In (b), the status (i.e., locked,
ignored) of Reference and Data objects is shown in the list area.
(a) (b)
Data object
Children
Selected objects that already belong to a different transformation group are first
removed from that group, and then added to the transformation group of the
selected Reference or Data object.
Figure 10.23 The dialog box that is displayed when grouping Data objects that belong to different
alignment groups.
Data objects that are linked to different alignment groups may be grouped, but
they must first be relinked to the same alignment group. As a result, when
grouping such Data objects, the dialog box shown in Figure 10.23 is displayed,
offering the following item:
Alignment group
A list box that allows specifying the alignment group to which the Data
objects must be linked. The alignment groups offered are those that each
selected Data object is currently linked to. No alignment group is
selected by default.
On pressing the OK button the relink operation is performed, and then the
grouping operation is performed. If the Cancel button is pressed, the grouping
operation is cancelled.
New transformation groups have the name Group - <number>, where <number> is an
automatically incremented integer (e.g., Group - 1).
Examples of the grouping and ungrouping operations are provided in the next
subsection, within the context of managing transformation groups.
Figure 10.24 Before the grouping operation (a) and after the operation (b).
(a) (b)
The Align > Transformation Group > Manage Transformation Groups command displays
the Transformation Groups dialog box, shown in Figure 10.22, which allows visualizing
and managing transformation groups, which includes grouping and ungrouping the
transformation groups of Reference and Data objects, and removing objects from a
transformation group.
The transformation groups are organized within a tree view. Each group is a branch
containing Reference and/or Data objects and their children. A contextual menu is
available that presents the commands that follow, that offer the same operations
represented by the buttons at the bottom of the tree view area:
Group
Put selected Data and/or Reference objects in the same transformation group.
Empty transformation groups are removed. See Figure 10.24 for an example of a
grouping operation.
If dragging a Data object onto another Data object as a grouping operation, and
the Data objects are not linked to the same alignment group, see Section 10.12.1
Creating and editing transformation groups for information on the dialog box that
is displayed.
Ungroup
Removes selected Data and/or Reference objects from the current transformation
group, and puts them in a new transformation group.
Remove
Removes selected objects from their transformation group.
The contextual menu of a Reference and a Data object offers operations that allow
selecting the objects bound to the object, or in the same transformation group as the
object. A multiple selection of same-type objects (e.g., Data objects) may be clicked.
The commands are located on the Select > Transformation Group submenu:
All Objects
Selects all of the objects in the same transformation group as the clicked objects.
Reference/Data Objects
Selects all of the Reference and Data objects that belong to the same
transformation group as the clicked objects.
Bound Objects
Selects all of the objects bound to the clicked Reference or Data objects.
Figure 10.25 The Data Alignments branch may contain one or more alignment groups. Under
each alignment group, the alignment in bold is the active data alignment of the
alignment group.
The Data Alignments branch of the tree view groups the data alignments applied to
one or to multiple Data objects in data alignment groups. All Data objects that share
the same data alignments are part of the same alignment group and their data
alignments are listed in the alignment group. The alignments are listed chronologically
and their order cannot be changed. Each alignment group contains an original
alignment which is the equivalent of the Data object identity matrix. The active data
alignment of each alignment group is indicated in bold (see Figure 10.25).
When importing a first Data object, the Data Alignments branch containing
alignment group 1 is added to the tree view. The Data object is automatically linked to
the alignment group. When adding subsequent Data objects, it is possible to specify
whether they should be linked to an existing alignment group or added to a new
alignment group. See Section 6.3.1.1.3 Alignment group for more information.
If the Data objects are ungrouped from the transformation group and a data alignment
is performed on these Data objects, a new alignment group is created.
A Data object’s annotation can be modified to display the name of the active alignment
(for information on modifying annotation templates, see Section 22.2.2 Managing
annotation templates). The active data alignment can also be included in reports where
a measurement involving a Data object is present. For complete information on
customizing table reports, see Chapter 20 Creating Report Items and Exporting
Reports.
Activating a data alignment in an alignment group brings the Data objects linked to the
alignment group to the exact position when the alignment was recorded and copies its
matrix into the properties of the Data objects. In order to activate a data alignment in
an alignment group, all Data objects linked to the data alignment group must be
unlocked.
Only one data alignment per alignment group can be active. The active data alignment
is displayed in bold in the tree view; for an example, see Figure 10.25.
Two operations on the Align > Data Alignments submenu allow activating data
alignments using the selected data alignments (maximum one per alignment group):
Activate
Makes each selected data alignment the active alignment of its alignment group.
It is also possible to activate a data alignment linked to multiple Data objects using the
shortcut menu of Data objects. Simply select the Data objects in the tree view and
right-click to display a shortcut menu containing data alignments shared by the Data
objects. Point Data Alignment and click the desired data alignment in the list. The
selected data alignment is made active in the alignment groups to which the Data
objects are linked, and a check mark is added to the data alignment on the shortcut
menu.
Data alignments that result from a Surface Point or a N Point Pairs alignment may be
remeasured by selecting the data alignment and choosing the Align > Data Alignments
> Remeasure command. On choosing the command, the related mode is started.
During this operation, guiding instructions may be displayed. These instructions must
have been previously specified on the property sheet’s Data alignment tab of the data
alignment to remeasure. For more information, see Section 1.0.0.1 Data alignment tab.
A tool allows calculating the difference between two any data alignments of the same
alignment group, expressed as a translation and a rotation.
Figure 10.26 The dialog box used to compare two data alignments.
To compare two alignments, preselect them if desired, then choose the Align > Data
Alignments > Compare Data Alignments command. The dialog box shown in Figure
10.26 is displayed. It offers the following items:
Alignment group
A list box that specifies the alignment group whose data alignments are to be
compared. It offers all of the data alignment groups. If an alignment group or Data
objects were preselected, the value is automatically determined as follows:
If more than one Data object was preselected, the alignment group of the
Data object that appears first in the tree view is selected in the list box.
Data alignment
A list box that specifies the data alignment to compare to the reference data
alignment. It offers all of the data alignments for the specified alignment group.
Figure 10.27 The dialog box used to link Data objects to an alignment group.
If data alignments were preselected, values are automatically determined for the two
preceding list boxes as follows:
If only one data alignment was preselected, it is selected in the Data alignment list
box and the alignment that precedes it in the alignment group is specified in the
Reference data alignment list box.
If two data alignments were preselected, the one created earlier is selected in the
Reference data alignment list box and the other one is specified in the Data
alignment list box.
The Results section displays comparison results in real time for the specified data
alignments as translations along the x, the y, and the z axes and rotations about the
same axes. The section also offers a button:
Report
A button that specifies generating a report containing the comparison results and
adding it to the Items subbranch of the Reports branch of the tree view.
To change the alignment group of Data objects, select the Data objects in the tree view
and choose the Align > Data Alignments > Link Data Objects to Alignment Group
command. The dialog box shown in Figure 10.27 is displayed. It offers the following
items:
Alignment group
A list box that specifies the alignment group to which the selected Data objects
will be linked. Select an alignment group from those in the list. The alignment
groups are listed in the order they appear in the tree view.
Press the OK button to launch the operation, or the Cancel button to end the
operation.
To unlink Data objects currently linked to the same alignment group, and link them to
their own alignment group, select the Data objects in the tree view and choose the
Align > Data Alignments > Unlink Data Objects from Alignment Group command. The
selected Data objects are automatically unlinked from their current alignment group
and put in their own alignment group. All the data alignments are copied to each newly
created alignment group.
The Data Alignments branch menu offers a command that allows storing a new original
data alignment for each alignment group:
The alignment group branch menu offers a command that allows storing a new original
data alignment for the selected data alignment groups:
When the active data alignment is the same for more than one selected alignment
group, the command merges the data alignment groups into one, linking all their
Data objects to the newly created alignment group.
Certain operations on Data objects result in changes made to their data alignments or
the alignment groups to which they are linked:
Scaling a Data object (i.e., Edit > Scale Objects) that is not alone in an alignment group
results in it being linked to a new alignment group that has the same data alignments
as the original alignment group.
A new alignment group is created and the new mirrored Data object is
linked to that alignment group that has only the original data alignment.
If the original object is not kept (i.e., the selected Data object is mirrored),
changes are made to data alignments:
If the Data object is alone in an alignment group, its data alignments are
deleted, except for original.
If the Data object is not alone in its alignment group, a new alignment group
is created and the Data object is linked to that alignment group, which has
only one data alignment, original.
While most data alignments are updatable, some by their nature are not. Those data
alignments have an anchor symbol superimposed on their icon in the tree view and
are considered to be “permanently measured”, even within the scope of a Play
Inspection operation. They always have the same alignment matrix in all pieces.
The data alignments that are updatable have an Updatable check box on their
property sheet, which is selected by default. In a standard Play Inspection scenario of a
new piece, they are either remeasured interactively or automatically. However, it may
be useful in a scenario of inspecting a series of identical objects, each fixed to a jig one
after the other, and a good alignment having being obtained in the first piece, to not
want to remeasure the alignment in the context of a New Piece with a Play Inspection
operation. In this case, the check box may be cleared (i.e., the data alignment becomes
fixed (i.e., nonupdatable) and is displayed in the tree view with the anchor symbol) and
the data alignment is not remeasured. If it becomes necessary to remeasure the data
alignment, for example the jig is moved slightly during the inspection process, the
check box could be selected and the data alignment remeasured within the context of
a Play Inspection operation of a new piece.
Data alignments are automatically updated when the Automatic project update mode
is active. On activating the mode, the first data alignment that is not up-to-date is
identified. The source objects for this alignment are updated. Then, the data
alignments are remeasured. This operation does not change the status of the active
data alignment.
A source object for the data alignment is modified or deleted (e.g., if a plane used by
a perpendicular planes alignment is readjusted, the alignment is no longer up-to-
date).
Locking a Data object does not render the data alignments to which it is linked not up-
to-date, but they can no longer be updated. In almost all cases, ignoring a Data object
renders the data alignments to which it is linked in error.
When the Automatic project update mode is deactivated, a data alignment can be
updated individually by way of the Edit > Update Objects command. This operation does
not result in the update of any previous alignments in the alignment sequence.
10.13.10 Using the property sheet of data alignment groups and data
alignments
The properties of an alignment group can be viewed by selecting the object and
choosing the Edit > Object Properties command, or by double-clicking it in the tree view.
The property sheet of the alignment group is shown in Figure 10.28. The Name is
displayed and can be edited. The Alignment group tab provides the list of Data
objects linked to the alignment group.
The properties of a data alignment can be viewed by selecting the object and choosing
the Edit > Object Properties command, or by double-clicking it in the tree view. The
items presented on the property sheet vary according the type of alignment. For
example, the property sheets of a best-fit data alignment and a point pairs data
alignment are shown in Figure 10.29.
The Data alignment tab shows the properties specific to data alignments. The tab
provides some of the items that follow, depending on the type of data alignment:
Updatable
A check box that enables specifying whether or not the data alignment is
updatable. When selected, it is updatable and when cleared it is fixed (i.e.,
rendered nonupdatable). The check box is selected by default. It is only available
for data alignments that are updatable (e.g., best-fit, point pairs). For more
information, see Section 10.13.9 Updating data alignments.
Fixed pre-alignment
A check box, available for a best-fit to Reference object surfaces data
alignment with a pre-alignment, that enables specifying whether or not
the pre-alignment is updated, or remeasured within the context of a Play
Inspection operation.
Type
A text box that specifies the data alignment type.
Coordinate system
A text box that specifies the coordinate system in which the alignment was
performed. For most data alignment types, this information is specified in the
Parameters section, under the General header.
Method
A text box that specifies the data alignment method used for the specified data
alignment when the alignment offers multiple methods. For most data alignment
types, this information is specified in the Parameters section, under the General
header.
The Parameters section shows the parameters used by the alignment method to
perform the data alignment (see the section on each alignment method in the chapter
Chapter 10 Aligning Objects). In the case of a best-fit to Reference object surfaces data
alignment, a shortcut menu for the Pre-alignment list box is offered through the Set
Pre-Alignment button, shown to the right. It offers the following operations which
affect the current pre-alignment, after which the best-fit alignment is reperformed:
Figure 10.29 The property sheet of (a) a Best-fit and (b) a Point Pairs data alignment.
(a) (b)
Pre-Align Automatically
If no constraints are specified, performs a new pre-alignment using the
Automatically method.
Clear Pre-Alignment
Deletes the current pre-alignment.
The Translation and rotation section shows the resulting translation component
(along the X axis, the Y axis, and the Z axis), and the rotation component in degrees
about the same axes.
The best-fit data alignment offers the Statistics tab that displays the Number of
iterations and the Convergence information.
The matrix of a selected Data Alignment object can be exported using operations on
the File > Export > Data Alignment Matrix submenu. The following commands are
offered:
The Export Alignment (4x4) operation exports the selected alignment’s matrix to an
external ASCII file as a 4x4 homogeneous matrix. On choosing this command, a file
browser is displayed. Specify a directory and a file name, and then press the Save
button.
The Export Alignment (Euler) operation exports the selected alignment’s matrix to an
external ASCII file in Euler form (i.e., three rotations and three translations). On choosing
this command, a file browser is displayed. Specify a directory and a file name, and then
press the Save button.
The Export Alignment (TRF) operation exports the selected alignment’s matrix to a TRF
file. On choosing this command, a file browser is displayed. Specify a directory and a file
name, and then press the Save button.
A table report item can be generated for selected data alignments using the Report >
Create Tables > From Objects command. A table report item is created for each data
alignment and saved under the Items subbranch of the Reports branch of the tree view.
Table report items are fully configurable through their templates. See Section 20.2.5
Managing table templates for detailed information on customizing table report
templates and Chapter 21 Creating Formatted Reports and Layouts for information on
inserting tables in formatted reports.
To rename a data alignment, access its property sheet, edit the Name field, and press
the Apply button. Note that an original alignment cannot be renamed.
To delete selected data alignments, press the SHIFT+DEL keys. Note that the first data
alignment, named original (default name), cannot be deleted.
An alignment group and its data alignments are not deleted when the Data objects
linked to it are deleted. They must be deleted manually, unless the Keep data
alignment groups no longer linked to data objects option is selected on the
Alignment page of the IMSurvey Options dialog box (see Section 34.11 Alignment
options).
Typically, objects in local coordinates are imported first. Then, a huge translation
operation is invoked using coordinates in real-world coordinates. This enables
georeferencing, which is done using the N Pairs of Center Points alignment method.
Let’s assume a digitized point cloud containing targets whose positions are measured
with a GPS device. Georeferencing is performed as follows:
1. Import the Data or the Reference objects that need to be georeferenced. These
objects should be defined in local coordinates.
2. Choose the Tools > Huge Translation command. The dialog box shown in Figure
10.30 is displayed.
4. Import all GPS points as point primitives using the Measure > Feature Primitives >
Create > Points from File command.
5. Use the Align > Feature-based > Center Points command, described in Section 10.3
Matching pairs of points, to match the center of the digitized targets to the GPS
points in order to align the digitized data to the GPS coordinates.
Comparing
Chapter 12 Measuring Data Objects explains how Data points can be mapped on Data,
Reference, or primitive objects to measure deviations. Several measurement direction
are offered, and objects can be assigned tolerances for pass/fail inspection tasks. The
chapter also presents tools that allow comparing Data points to Data objects, Data
points to Reference objects, Data points to primitives, and a single point to another
point.
Chapter 13 Feature Primitives presents tools that allow creating feature primitives.
Chapter 14 Manipulating Primitives presents tools that allow editing primitives.
Chapter 18 Measuring Volume presents a tool that allow measuring the volume
between Data objects and a reference plane, or between Data objects.
Chapter 19 Configuring the Color Map Display presents tools that allow visualizing
measurement results using color scales and deviation vectors.
This chapter presents parameters and methodologies related to measuring deviations. The related
operations are located on the Measure menu.
The Measure > Deviations of Data Objects > From Reference Object Surfaces command
allows measuring the deviations of Data objects, or selected elements of Data objects,
from the surfaces of Reference objects (i.e., reference surfaces). The results are
displayed in the 3D scene by means of a data color map, which is saved under the Data
Color Maps branch of the tree view. Data color maps are presented in Section 12.2 Data
color maps.
Name
A text box that specifies the name of the data color map to be created. A default
name is provided: reference surfaces <number>, where <number> represents an
automatically incremented integer. The name can be edited.
Figure 12.2 In (a), the dialog box used to measure deviations of Data objects from the surfaces of
Reference objects. In (b), the aligned Reference and Data objects. In (c), the data color
map showing the deviations of the Data points from the Reference object’s surface.
(a) (b)
(c)
Direction
A list box that specifies a distance computation method to use when measuring
between Data points and a reference surface. Choose from the following:
Axis
A list box, offered for the Along Axis measurement direction method, that allows
specifying an axis along which to measure deviations. Choose from the standard
axes (i.e., +X, -X, +Y, -Y, +Z, -Z), (Custom Vector), and available axial primitives. The
default value is +X. When (Custom Vector) is chosen, the following items are
displayed to allow defining an axis:
i
A text box that allows specifying the i coordinate of the axis. The default
value is 1.0.
j
A text box that allows specifying the j coordinate of the axis. The default
value is 0.0.
k
A text box that allows specifying the k coordinate of the axis. The default
value is 0.0.
Reference objects
A list box that allows specifying the Reference objects to use. Choose from All (all
Reference objects), Specific, and Selected Elements (selected elements of
Reference objects). The default value is All. When Specific is chosen, a list box is
offered under this list box. It offers the available Reference objects, preceded by a
check box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects),
Specific, and Selected Elements (selected elements of Data objects). When
Specific is chosen, a list box is offered under this list box. It offers the available
Data objects, preceded by a check box. If necessary, select the desired objects or
elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the reference surfaces. Valid values are greater than 0. The default value is
300.0 mm.
Offset
A check box that enables specifying a value to be used to virtually offset the
Reference object. A positive offset would then result in smaller positive deviation
values, as if the offset value was subtracted from the measurement results prior to
visualizing and reporting them.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
This item is only offered for the Shortest measurement direction method.
Ignore – Ignores the Data points. When a Data object is larger than the
Reference object, or misaligned, this choice allows restricting the
measurement to the portion of the Data object located over the Reference
surface. The default value is Ignore.
This item is only offered for the Shortest measurement direction method.
Choose from: Closest Reference Object and Highest Reference Object (i.e., the
object the farthest away in the direction of the normal of the Data points). The
default value is Closest Reference Object. If Highest Reference Object is specified
and the Data points do not have normal information, they cannot be measured
and are assigned the color gray (i.e., No Result).
Project deviations
A check box that enables projecting the deviation vectors onto an axis or a plane,
which results in smaller deviations. This may be useful, for example, if a flat surface
is slightly irregular and the user is interested in the +Z component of the deviation
for all deviations. By default, the check box is cleared. When selected, the following
options are made available:
Plane
An option button, selected by default, that makes available a list box that
allows specifying a plane. Choose from the standard planes (i.e., XY, YZ,
ZX) and available planar primitives.
Axis
An option button that allows specifying an axis. Choose from the
standard axes (i.e., +X, -X, +Y, -Y, +Z, -Z) and available axial primitives.
Max angle
A check box that enables specifying a maximum angle in degrees between a Data
point’s normal vector and the reference surface’s normal vector at surface points
within the Max distance value. When selected, an adjacent text box is made
available to enter a value. Valid values range from 0 to 180 inclusively. The default
value is 45 degrees. By default, the check box is selected.
This item is not used in the case of Data points that belong to a Data object
without point normal information.
This item is not offered when the Data objects specification is Boundary.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Press the Measure button to launch the operation. A data color map showing the
point-to-surface deviations is displayed (see Figure 12.2 (c)). Press the Close button to
dismiss the dialog box.
The Measure > Deviations of Data Objects > From Reference Object Boundaries command
allows measuring the deviations of Data objects, or selected elements of Data objects,
from the boundaries of Reference objects (i.e., reference surfaces), or the boundaries
contained within the selected elements of Reference objects. The results are displayed
in the 3D scene by means of a data color map, which is saved under the Data Color
Maps branch of the tree view. Data color maps are presented in Section 12.2 Data color
maps.
Name
A text box that specifies the name of the data color map to be created. A default
name is provided: reference boundaries <number>, where <number> represents
an automatically incremented integer. The name can be edited.
Direction
A list box that specifies a distance computation method to use when measuring
between points and the boundaries of Reference objects. Choose from the
following:
Shortest to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found and the total point-to-
curve distance is computed. When this method is chosen, the Deviation
sign list box is made available in the Parameters section that allows
obtaining signed deviations.
Normal to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found, and then only the normal
component of the distance is retained, based on the surface normal vector
Figure 12.3 In (a), the dialog box used to measure deviations of Data objects from the boundaries
of Reference objects. In (b), the aligned Reference and Data objects. In (c), the data
color map showing the deviations of the Data points from the object’s boundaries.
(a) (b)
(c)
at the closest point. This type of distance is signed. If positive, the point is
above the surface, otherwise it is below the surface.
Tangent to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve is found, and then only the
tangent component of the distance is retained, based on the surface’s
tangent plane at the closest point. This type of distance is signed. If positive,
the point is outside the surface, otherwise it is within the surface.
Deviation sign
A list box that allows specifying the sign of the 3D distance. Choose from:
Unsigned (i.e., the 3D distance will always be positive), Normal Deviation Sign
(i.e., the 3D distance sign will be set according to the sign of the normal deviation),
and Tangent Deviation Sign (i.e., the 3D distance sign will be set according to the
sign of the tangent deviation). The default value is Unsigned.
This item is only available when the measurement direction method is Shortest to
Boundary.
Reference objects
A list box that allows specifying the Reference objects to use. Choose from All (all
Reference objects), Specific, and Selected Elements (selected elements of
Reference objects). The default value is All. When Specific is chosen, a list box is
offered under this list box. It offers the available Reference objects, preceded by a
check box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects),
Specific, and Selected Elements (selected elements of Data objects). When
Specific is chosen, a list box is offered under this list box. It offers the available
Data objects, preceded by a check box. If necessary, select the desired objects or
elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the reference surfaces. Valid values are greater than 0. The default value is
300.0 mm.
Offset
A check box that enables specifying a value to be used to virtually offset the
Reference object. A positive offset would then result in smaller positive deviation
values, as if the offset value was subtracted from the measurement results prior to
visualizing and reporting them.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Choose from: Closest Reference Object and Highest Reference Object (i.e., the
object the farthest away in the direction of the normal of the Data points). The
default value is Closest Reference Object.
Project deviations
A check box that enables projecting the deviation vectors onto an axis or a plane,
which results in smaller deviations. This may be useful, for example, if a flat surface
is slightly irregular and the user is interested in the +Z component of the deviation
for all deviations. By default, the check box is cleared. When selected, the following
options are made available:
Plane
An option button, selected by default, that makes available a list box that
allows specifying a plane. Choose from the standard planes (i.e., XY, YZ,
ZX) and available planar primitives.
Axis
An option button that allows specifying an axis. Choose from the
standard axes (i.e., +X, -X, +Y, -Y, +Z, -Z) and available axial primitives.
Max angle
A check box that enables specifying a maximum angle in degrees between a Data
point’s normal vector and the reference surface’s normal vector at the boundary
trim curve point closest to the Data point. When selected, an adjacent text box is
made available to enter a value. Valid values range from 0 to 180 inclusively. The
default value is 45 degrees. By default, the check box is selected.
This parameter allows eliminating from the measurement results Data points that
have an orientation incompatible with the closest reference surface area. This item
is not used in the case of Data points that belong to a Data object without point
normal information.
This item is not offered when the Data objects specification is Boundary.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Press the Measure button to launch the operation. A data color map showing the
point-to-boundary deviations is displayed (see Figure 12.3 (c)). Press the Close button
to dismiss the dialog box.
The deviations of Data points from several primitives can be measured simultaneously.
For an explanation of how the Max distance parameter is used to find valid Data points
by type of primitive, see Section 12.1.3.1 Processing each primitive type.
The Measure > Deviations of Data Objects > From Feature Primitives command allows
measuring the deviations of Data objects, or selected elements of Data objects, from
trimmed or standard primitives (i.e., reference surfaces). In the case of curve-based
primitives (e.g., a circle), deviations are measured to the curve. In the case of surface-
based primitives (e.g., cylinder), deviations are measured to the surface. The results are
displayed in the 3D scene by means of a data color map, which is saved under the Data
Color Maps branch of the tree view. Data color maps are presented in Section 12.2 Data
color maps.
Name
A text box that specifies the name of the data color map to be created. A default
name is provided: feature primitives <number>, where <number> represents an
automatically incremented integer. The name can be edited.
Direction
A list box that specifies a distance computation method to use when measuring
between Data points and primitives. Choose from the following:
Shortest to Boundary – For each measured Data point, the closest point on
a feature primitive’s surface/curve is found and the total point-to-surface/
Figure 12.4 In (a), the dialog box used to measure deviations of Data objects from primitives. In
(b), trimmed and standard primitives. In (c), the data color map showing the
deviations of Data points from the primitives.
(c)
Normal to Boundary – For each compared Data point, the closest point on
a feature primitive’s surface/curve is found, and then only the normal
component of the distance is retained, based on the surface/curve normal
vector at the closest point. This type of distance is signed. If positive, the
point is above the surface, otherwise it is below the surface.
Tangent to Boundary – For each compared Data point, the closest point on
a feature primitive’s surface/curve is found, and then only the tangent
component of the distance is retained, based on the surface’s/curve’s
tangent plane at the closest point. This type of distance is signed. If positive,
the point is outside the surface, otherwise it is within the surface.
Primitives
A list box that allows specifying the primitives to use. Choose from All (all available
primitives) and Specific. The default value is All. When Specific is chosen, a list box
is offered under this list box. It offers the available primitives, preceded by a check
box. Select the desired objects.
Data objects
A list box that allows specifying the Data objects to use. Choose from: Surface (all
surface Data objects), Boundary (all boundary Data objects), All (all Data objects),
Specific, and Selected Elements (selected elements of Data objects). When
Specific is chosen, a list box is offered under this list box. It offers the available
Data objects, preceded by a check box. If necessary, select the desired objects or
elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the surface/curve of the primitives. Valid values are greater than 0. The default
value is 300.0 mm.
Offset
A check box that enables specifying a value to be used to virtually offset the
primitives using their in-space orientation. A positive offset would then result in
smaller positive deviation values, as if the offset value was subtracted from the
measurement results prior to visualizing and reporting them.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Choose from: Closest Primitive and Highest Primitive (i.e., the object the
farthest away in the direction of the normal of the Data points). The default value
is Closest Primitive. If Highest Primitive is specified and the Data points do not
have normal information, they cannot be measured and are assigned the color
gray (i.e., No Result).
Project deviations
A check box that enables projecting the deviation vectors onto an axis or a plane,
which results in smaller deviations. This may be useful, for example, if a flat surface
is slightly irregular and the user is interested in the +Z component of the deviation
for all deviations. By default, the check box is cleared. When selected, the following
options are made available:
Plane
An option button, selected by default, that makes available a list box that
allows specifying a plane. Choose from the standard planes (i.e., XY, YZ,
ZX) and available planar primitives.
Axis
An option button that allows specifying an axis. Choose from the
standard axes (i.e., +X, -X, +Y, -Y, +Z, -Z) and available axial primitives.
Max angle
A check box that enables specifying a maximum angle in degrees between a Data
point’s normal vector and a primitive’s normal vector at the point on the surface/
curve closest to the Data point. When selected, an adjacent text box is made
available to enter a value. Valid values range from 0 to 180 inclusively. The default
value is 45 degrees. By default, the check box is selected.
This parameter allows eliminating from the measurement results Data points that
have an orientation incompatible with the closest reference surface area. This item
is not used in the case of Data points that belong to a Data object without point
normal information.
This item is not offered when the Data objects specification is Boundary.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Press the Measure button to launch the operation. A data color map showing the
point-to-surface/curve deviations is displayed (see Figure 12.4 (c)). Note that when
measuring deviations from selected curve-based primitives, the signed deviation is
directly related to the in-space orientation of the primitive:
When a primitive’s in-space orientation is internal, a Data point inside will result
in a positive distance value, and a Data point outside will result in a negative
distance value.
The table that follows provides information on processing each type of primitive.
Type Comment
Points within the Max distance from a circle’s perimeter are used. The
Circle Shortest measurement direction, and three types of Boundary
measurement directions, are supported.a
Points within the Max distance from a cone’s surface and whose
Cone
projection onto the cone surface falls within the cone section are used.b
Points within the Max distance from a cylinder’s surface and whose
Cylinder projection onto the cylinder axis falls within the cylindrical section are
used.b
Points within the Max distance and whose projection on the plane falls
Plane
within the cropped portion of the plane are used.b
Points within the Max distance from a polygon’s perimeter are used.
Polygon The Shortest measurement direction, and three types of Boundary
measurement directions, are supported.a
Type Comment
Polyline Points within the Max distance from polyline vertices are used.a,b
Points within the Max distance from a rectangle’s perimeter are used.
Rectangle The Shortest measurement direction, and three types of Boundary
measurement directions, are supported.a
Sphere Points within the Max distance from the spherical surface are used.b
Points within the Max distance from the vector and whose projection
Vector
falls within the vector section are used.a,b
The table that follows illustrates the Data point subsets delimited by a Max distance for
each type of primitive using a 2D illustration of individual primitives drawn in blue. For
each, a max distance criterion is used to identify a local 3D Data point subset, shown as
a shaded area, for the measurement of deviations from the primitive.
A B B A
B
B
A
Circle: The Max distance Cone : The Max distance Cylinder : The Max distance
delimits a torus with a radius delimits a 3D difference delimits a 3D difference
of md. between a larger cone A and between a cylinder A with a
a smaller cone B. radius of r+md, and a
cylinder B with a radius of r-
md.
Plane : The Max distance Point :The Max distance Polygon and Rectangle :
delimits a 3D space between delimits a 3D sphere of md The Max distance delimits a
two parallel planes situated radius centered at the Point. torus with a radius of md.
at + and - md from the
primitive.
Note that in the case of trimmed primitives, only the Data points within the Max
distance that can be projected onto the surfaces of a trimmed primitive’s associated
Reference object elements, and not onto their boundaries, are considered. For more
information on trimmed primitives, see Section 13.1.2 Trimmed primitives.
The Measure > Deviations of Data Objects > From Data Objects command allows
measuring the deviations of specific Data objects, or selected Data points, from the
remaining Data objects (called reference data objects). The reference data objects must
be polygonal Data objects or point cloud Data objects with normal vectors. The results
are displayed in the 3D scene by means of a data color map, which is saved under the
Data Color Maps branch of the tree view. Data color maps are presented in Section 12.2
Data color maps.
On choosing the command, the dialog box shown in Figure 12.5 (a) is displayed,
configured using the preselection information. It offers the following items:
Name
A text box that specifies the name of the data color map to be created. A default
name is provided: data objects <number>, where <number> represents an
automatically incremented integer. The name can be edited.
Data objects
A list box that allows specifying the Data objects to use. Choose from Specific and
Selected Elements (selected elements of Data objects). When Specific is chosen,
a list box is offered under this list box. It offers the available Data objects, preceded
by a check box. If necessary, select the desired objects or elements.
Max distance
A text box that allows specifying a maximum search distance between Data points
and the reference data objects. Valid values are greater than 0. The default value is
300.0 mm.
Offset
A check box that enables specifying a value to be used to virtually offset the
reference Data objects. A positive offset would then result in smaller positive
deviation values, as if the offset value was subtracted from the measurement
results prior to visualizing and reporting them.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Choose from Closest Reference Data Object and Highest Reference Data
Object (i.e., the object the farthest away in the direction of the normal of the Data
points). The default value is Closest Reference Data Object. If Highest Reference
Data Object is specified and the Data points do not have normal information, they
cannot be measured and are assigned the color gray (i.e., No Result).
Project deviations
A check box that enables projecting the deviation vectors onto an axis or a plane,
which results in smaller deviations. This may be useful, for example, if a flat surface
is slightly irregular and the user is interested in the +Z component of the deviation
for all deviations. By default, the check box is cleared. When selected, the following
options are made available:
Plane
An option button, selected by default, that makes available a list box that
allows specifying a plane. Choose from the standard planes (i.e., XY, YZ,
ZX) and available planar primitives.
Axis
An option button that allows specifying an axis. Choose from the
standard axes (i.e., +X, -X, +Y, -Y, +Z, -Z) and available axial primitives.
Figure 12.5 In (a), the dialog box used to measure deviations of Data objects from reference data
objects. In (b), the Data objects. In (c), the data color map showing the deviations of
the Data points from the reference data objects.
(a) (b)
(c)
Max angle
A check box that enables specifying a maximum angle in degrees between a Data
point’s normal vector and the reference surface’s normal vector at the surface
point closest to the Data point. When selected, an adjacent text box is made
available to enter a value. Valid values range from 0 to 180 inclusively. The default
value is 45 degrees. By default, the check box is selected.
This parameter allows eliminating from the measurement results Data points that
have an orientation incompatible with the closest reference data object area. This
item is not used in the case of Data points that belong to a Data object without
point normal information.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Press the Measure button to launch the operation. A data color map showing the
deviations is displayed (see Figure 12.5 (c)). Press the Close button to dismiss the dialog
box.
Commands related to data color maps are offered on the Measure > Data Color Maps
submenu:
Activate
Activates the selected data color map. It is displayed in the 3D scene using a color
map.
Deactivate Active
Deactivates the active data color map. It is no longer displayed in the 3D scene.
Figure 12.6 In (a), the aligned Reference and Data objects. In (b), the data color map showing the
deviations of the Data points of the Data object from the surface of the Reference
object.
(a)
(b)
The selected elements are used for the operation, and the Data objects
specification of the data color map is automatically set to Selected Elements.
A table report item can be generated for selected data color maps using the Report >
Create Tables > From Objects command. A table report item is created for each data
color map and saved under the Items subbranch of the Reports branch of the tree view.
Table report items are fully configurable through their templates. See Section 20.2.5
Managing table templates for detailed information on customizing table report
templates and Chapter 21 Creating Formatted Reports and Layouts for information on
inserting tables in formatted reports.
A data color map has a properties sheet that offers the related creation parameters
under the Data color map tab; for an example, see Figure 12.7.
Parameter values may be changed and the data color map is updated. The table that
follows links the Type value to the specific operation that created the data color map,
references the related section, as it presents the creation parameters found on the Data
color map tab, and lists any additional properties found on the Data color map tab
that are not among the creation parameters.
From Reference Object Surfaces Type: Reference Surface Data Color Map /
Section 12.1.1 Measuring deviations of Coordinate system used when the operation
Data objects from Reference object was performed.
surfaces
From Reference Object Boundaries Type: Reference Boundary Data Color Map /
Section 12.1.2 Measuring deviations of Coordinate system used when the operation
Data objects from Reference object was performed.
boundaries
A primitive is automatically created following a standard creation process. A primitive can also be extracted.
The extraction parameters can be preconfigured in the primitive’s property sheet. Once created, primitives
are added to the Feature Primitives branch of the tree view and are assigned a name using a scheme
described in the following subsections.
Options are offered in the IMSurvey Options dialog box related to feature primitives
and to their display. To access the dialog box, choose the Tools > Options command.
The Display > Feature Primitives page of the IMSurvey Options dialog box allows
specifying the default Static and Dynamic display mode of feature primitives. To access
the page, choose the Tools > Options command to display the dialog box, open the
Display branch, and click Feature Primitives. For complete information, see Section
24.3.8 Feature primitive display options.
The Feature Primitives page and its subpage of the IMSurvey Options dialog box allow
specifying the default feature primitive and feature codes options.
In the tree view, dependent primitives have the following symbol ( ) superimposed on
their icon.
Dependent primitives can be generated when using one of the five construction
methods (From Objects, From Intersection, From Projection, From Elements, or
From Tracking). Creating dependent primitives is specified by selecting the Create
dependencies check box (found in the More subsection of the creation dialog box,
available when choosing a primitive construction method). The initial value of the
check box is determined by the Create dependencies option, located on the Feature
Primitives page of the IMSurvey Options dialog box; for more information, see Section
34.6 Feature options.
If the Create dependencies check box is selected when launching the construction, a
dependency between the source objects and the destination primitives will
automatically be created. Otherwise, no dependency will be created for that specific
operation. The following describes the cases where dependent primitives can be
created:
Trimmed primitives are primitives extracted from Reference object elements (i.e.,
triangles or CAD surfaces) that represent a portion of their complete geometry. Only
surface-based primitives can be trimmed.
When created, trimmed primitives keep a copy of the elements used for their
extraction. As a result, a trimmed primitive remains trimmed when performing
operations on the Reference object used to create it (e.g., deleting or aligning the
Reference object), since it is associated with the copy of the Reference object elements
and not the Reference object itself. Trimmed primitives are represented graphically in
the 3D scene by their associated elements, which are displayed using the color and the
rendering specified for the primitive. For an example, see Figure 13.1.
A trimmed primitive’s associated elements are used when comparing Data objects to
the trimmed primitives (see Section 12.1.3 Measuring deviations of Data objects from
primitives) and when selecting Data points using trimmed primitives (see Section
8.5.1.3 Selecting Data points using feature primitives).
In the case of measurements involving Reference objects with virtual surfaces, the
effective virtual surface is considered, with the exception of. For complete information
on virtual surfaces, see Section 23.6.4.1 Reference objects and virtual surfaces.
Figure 13.1 In (a), the CAD surface in red was picked to extract a standard cone and picked again
to extract a trimmed cone. The display of each is shown in (b), rendered using the Flat
drawing type.
(a) (b)
Standard cone
Trimmed cone
The new primitives appear in the tree view under the branch of their type of primitive.
When extracting surface-based primitives, the following items may be specified in the
More section:
Surface-based primitives
A group label that offers an item that applies when extracting surface-based
primitives:
Figure 13.2 The dialog box used to extract primitives from CAD-based Reference objects
interactively (a) or automatically (b).
(a) (b)
Note that if a Reference object has a virtual surface, standard and trimmed primitives
are extracted interactively or automatically on its virtual surface. For complete
information on virtual surfaces and Reference objects, see Section 23.6.4.1 Reference
objects and virtual surfaces.
To extract primitives by picking in the 3D scene, select the Interactive option button
and press the Pick button. The picking mode works as follows:
When picking, users can preview a primitive by holding the left mouse button. The
picking is confirmed by releasing the button, or is cancelled by moving the mouse by
more than 10 pixels.
Press the SPACEBAR to temporarily exit the mode and move the 3D scene; press the
SPACEBAR again to return to the mode.
Curve-based primitives are picked by clicking inside a CAD surface internal trim
curve region.
Surface-based primitives are picked by pressing the SHIFT key and clicking the CAD
surface. If a primitive can be extracted, it is extracted.
When picking a trimmed primitive, it is extracted using the picked CAD surface, and
a copy of the CAD surface is associated to the primitive. While in the picking mode, if
CAD surfaces, picked consecutively, are determined to belong to a the same trimmed
primitive created during the current picking session, they are added to that
primitive’s list of associated CAD surfaces, and no new primitive is created.
Press the ESC key or right-click to exit the picking mode and the operation.
2. Select the desired check boxes to specify the extraction of Circles, Cones,
Cylinders, Planes, Polygons/Rectangles (with or without rounded corners), and
Spheres. Clear the check boxes of unwanted primitives.
4. New primitives are extracted using the criteria in the Advanced section of the
dialog box.
If the creation of trimmed primitives is specified, a copy of all the CAD surfaces that
define the same primitive is created and associated to that trimmed primitive, and
they are used to extract only that primitive.
5. If desired, clear and select check boxes to modify the primitive-type specification
and repeat the operation.
To extract surface-based primitives from polygonal models, choose the Measure >
Feature Primitives > Create > Extract from Polygonal Models command. The dialog box
shown in Figure 13.3 is displayed and an interactive mode is launched.
The new primitives appear under a parent feature primitive object in the tree view.
Primitives are extracted from polygonal Data objects and appear in the polygonal Data
object’s transformation group (i.e., binding). Primitives are extracted from polygonal
Reference objects and appear in the polygonal Reference object’s transformation
group (i.e., binding).
The Type section of the Extract Primitives from Polygonal Models dialog box offers the
following types of specific and automatic extraction:
– Automatic
A button that allows detecting automatically the type of primitive to extract.
When the Automatic type is selected, the dialog box is configured as shown in
Figure 13.3. The default Type is Automatic.
– Plane
A button that allows specifying Plane as the type of primitive to extract. When the
Plane type is selected, the dialog box is configured as shown in Figure 13.4.
– Cylinder
A button that allows specifying Cylinder as the type of primitive to extract. When
the Cylinder type is selected, the dialog box is configured as shown in Figure 13.4.
– Cone
A button that allows specifying Cone as the type of primitive to extract. When the
Cone type is selected, the dialog box is configured as shown in Figure 13.4.
Figure 13.3 The Extract Primitives from Polygonal Models dialog box for the Automatic type.
Figure 13.4 The Extract Primitives from Polygonal Models dialog box for the Plane, Cylinder,
Cone, and Sphere types.
– Sphere
A button that allows specifying Sphere as the type of primitive to extract. When
the Sphere type is selected, the dialog box is configured as shown in Figure 13.4.
The Method section of the Extract Primitives from Polygonal Models dialog box offers
the following extraction methods:
Figure 13.5 An example of a preview of a cylinder primitive extraction from a polygonal model
using the Single Detection Zone method.
The Parameters section of the Extract Primitives from Polygonal Models dialog box
offers the following items:
Figure 13.6 An example of using the Multiple Detection Zones method to extract a cylinder
primitive from a polygonal model.
The More subsection offers the following items (available only when the Automatic
type of extraction is selected):
Subsampling step
A check box that enables subsampling the points used to fit a primitive. The
Subsampling step parameter affects only the primitive created, not the trimmed
primitive. By default, the check box is cleared. It makes available a text box that
allows specifying the subsampling step. A value greater than zero must be
specified. The default value is 1.0 mm.
The points used to fit a primitive are subsampled with the goal of generating
uniformly spaced points whose point-to-point spacing is as close as possible to
the step value.
Reject outliers
A check box that specifies rejecting outliers when extracting a primitive. The
Reject outliers parameter affects only the primitive created, not the trimmed
primitive. Outliers are points that lie the farthest away from the average of the
points used to fit the primitive. The check box is cleared by default.
The primitive is first fitted to the points and the standard deviation value
is computed. Then, points that lie beyond the standard deviation
multiplied by the deviation factor value are rejected, and the primitive is
refitted using the remaining points.
Percentage of points
An option button that allows specifying a percentage of points to reject
when fitting a Primitive. The adjacent text box allows specifying a
percentage value. Valid values are greater than 0 and smaller than 100.
The default value is 1.250%.
The primitive is first fitted to the points and the average distance
between the points and the primitive is computed. Then, the specified
percentage of points that lie furthest from the average distance are
rejected, and the primitive is refitted using the remaining points.
Primitive type
An uneditable text box (visible only when the Automatic type is selected) that
indicates the type of primitive for the latest primitive extraction operation.
Number of points
An uneditable text box that indicates the number of points used to fit the primitive
for the latest primitive extraction operation.
Standard deviation
An uneditable text box that indicates the absolute value of the standard deviation
of the fit operation for the latest primitive extraction operation.
Max deviation
An uneditable text box that specifies a maximum 3D deviation of the fit operation
for the latest primitive extraction operation.
Preview
A button that offers a preview of the primitive extracted. The Preview button is
active only when the Parameters or Filtering section parameters, or the More
subsection parameters, have been modified for already previewed primitive
extractions. When the Preview button is pressed, the extracted primitive is
displayed in the preview color (green by default) with white wireframe, and the
vertices located in the detection zone are displayed in a darker color than the
vertices used for the fit operation. See Figure 13.7 for an example of a preview.
Pick
A button that enables an interactive mode that allows picking a circular zone
delimited by the detection radius around the pointer. Once all desired zones are
picked, a preview of the model is offered.
Confirm
A button that launches the operation, which extracts a primitive from the
polygonal model using the specified parameters. The extracted primitive appears
under the Feature Primitives branch of the tree view.
When the first feature primitive is picked, a message window is displayed to inform the
user that an initialization procedure is performed on the picked object to analyze its
curvature. This procedure may require a few minutes. Once the initialization has been
done, additional feature primitives can be picked and extracted quickly. If an object has
been initialized and later it is modified (e.g., some of its elements are deleted), it will be
re-initialized when the next feature primitive is picked.
Note that if a Reference object has a virtual surface, standard and trimmed primitives
are extracted interactively or automatically on its virtual surface. For complete
information on virtual surfaces and Reference objects, see Section 23.6.4.1 Reference
objects and virtual surfaces.
Use the SPACEBAR to interrupt the mode and perform rotations/translations in the
3D scene.
Use the mouse wheel to adjust the detection radius around the pointer.
Left-click a location on a polygonal model to delimit the detection zone when using
the Single Detection Zone method. Left-click again to re-initialize the detection
zone.
Left-click to select a first detection zone when using the Multiple Detection Zones
method. Left-click again to add detection zones.
Middle-click to cancel the last detection zone. When using the Multiple Detection
Zones method, press and hold Shift to cancel all detection zones.
The Measure > Feature Primitives > Create > From Files command allows importing
certain primitive types from IGES files and STEP files.
On choosing the command, a browser like the one shown in Figure 13.8 is displayed. It
offers an Options button that opens the IMSurvey Options dialog box to the Feature
Primitives page that offers import parameters for primitives. For more information, see
Section 24.6 Feature primitive options.
On choosing a file and pressing the Open button, a dialog box, like the one shown in
Figure 13.9, is displayed offering import parameters. Only the options already selected
on the Feature Primitives options page are offered in the dialog box. Select the
primitives to import, and specify the other items:
Tessellation tolerance
A text box that specifies a tolerance to apply to polylines that are tesselated on
import. This item is only offered importing polylines is specified on the Feature
Primitives options page.
Press the OK button to launch the import operation, or press the Cancel button to
dismiss the dialog box.
Figure 13.8 The browser used to import primitives from specific file types.
Figure 13.9 A dialog box that offers import parameters that apply to the selected file type.
The table that follows lists the types of primitives that can be imported from each file
type.
STEP Points
cones 156
cylinders 154
spheres 158
Primitives are imported under their respective tree view branch and are assigned a
name defined in the file. When no name is specified in the file, the primitives are
assigned a default name (see Section 24.3.11 Default name options for more
information).
The following commands on the Measure > Feature Primitives > Create submenu allow
importing points, vectors, planes, circles, and polylines from text files.
Figure 13.10 A sample dialog box used to import primitives from a text file.
On choosing a command, a file browser is displayed, similar to the one shown in Figure
13.10. Press the Open button to continue or the Cancel button to end the operation.
On pressing the Open button, the Import Parameters dialog box is displayed offering
the following import options:
Template
A list box that by default offers a primitive-specific template that allows reading
text files. To access other standard templates or to define custom templates, press
the Templates button.
Templates
A button that allows accessing other standard templates or defining custom
templates. See Section 5.3.1 Importing from text files in the PolyWorks Reference
Guide for more information on templates that used to read text files.
Press the Open button to continue or the Cancel button to end the operation.
1. Choose the Points, Vectors, Planes, Circles, Rectangles, Polygons, Cylinders, Cones,
Spheres, Surfaces, or Polylines command on the Measure > Feature Primitives > Create
submenu. A creation dialog box is displayed, configured for the type of primitive.
See Figure 13.11 (b).
A default name is automatically entered in the Name text box, which can be edited,
if desired.
If a feature code is specified (see step 3. that follows), the Name text box becomes
unavailable, and the feature code is used to construct the primitive’s name.
Feature code
A list box that allows specifying a feature code for the primitive. Choose a
feature code in the adjacent list box or choose (None), the default value. The
list of feature codes is created or imported by the user; for more information,
see Section 34.6.6 Feature code options.
When a feature code other than (None) is specified, the Name text box
becomes unavailable, and the feature code is used to construct the object’s
name.
Note that feature codes can also be assigned to selected primitives; for more
information, see Section 14.12.3 Assigning feature codes and level names to
primitives on creation.
The content of the contextual dialog box varies according to the creation method
specified in the Method list box. Several creation methods are available.
The Pick on CAD, Anchor, Numerically, and Fit creation methods follow the
standard creation process that requires specifying a Name and Parameters when
available, and results in a primitive object.
There are several construction creation methods. The From Objects, From
Intersection, and From Projection methods create primitives using existing
objects. The From Elements method creates points from selected elements. The
From Tracking method creates primitives from objects used to track polylines.
Finally, the From Data Contour Errors method uses a comparison result generated
using the Show contours option (see Section 19.2.2 Mapping the deviation on
points and surfaces) to create polylines.
The creation methods available vary according to the primitive type. The following
table identifies the methods available by primitive type:
Pick on CAD Model
From Intersection
From Projection
From Elements
Error Contours
Method
From Tracking
From Objects
Numerically
From Data
Anchor
Primitive
type
Fit
circle — — — —
cone — — — — —
cylinder — — — — —
plane — — — — —
point — — — —
polygon — — — — —
polyline — — — — — —
rectangle — — — — —
sphere — — — — —
vector — — — —
Some creation methods, such as Fit, From Objects, From Intersection, From
Projection, From Elements, and From Tracking, offer a Sub-method list box to
specify a creation sub-method, detailed in the subsections that follow. The
remaining contextual parameters are then presented under two sections according
to the specified Method and Sub-method.
Figure 13.11 The Feature Primitives toolbar buttons (a) display a creation dialog box (b).
(a) Circle Cylinder Point Polyline Sphere
(b)
Note that when creating a different type of primitive, the specified creation method
remains the same if it is available for that primitive type.
7. Press the button to launch the creation operation. The name of the button, and the
operation that is launched, is controlled by the specified creation method and sub-
method:
Specific information on each creation method and its contextual creation parameters is
provided in the subsections that follow.
Primitives, with the exception of points, polylines, and vectors, can be created by
picking a primitive on CAD model. Choose Pick on CAD Model in the Method list box
of the creation dialog box. When picking primitives on CAD models, the Creation
method section of the creation dialog box first allows specifying a Sub-method. The
following sub-methods are offered:
Single Surface – Specifies creating a feature by picking a single CAD surface in the
3D scene.
When creating surface-based features using the Single Surface sub-method, the Trim
using CAD surfaces item is offered in the Parameters section. See Section 13.2
Extracting primitives from CAD-based Reference objects, which describes the same
parameter in the context of extracting primitives from CAD Reference objects. For more
information on trimmed primitives, see Section 13.1.2 Trimmed primitives. Note that
the notion explained in the referenced section of picking a CAD surface which belongs
to a just-created trimmed primitive and having that CAD surface be automatically
associated to that primitive, instead of being used to create a new trimmed primitive,
holds true as long as the primitive creation dialog box is not closed.
Press the Pick button. This enables an interactive mode that allows picking a primitive
of the current primitive type on CAD surfaces. For more information on picking
primitives on CAD models, see Section 13.2.1 Extracting primitives interactively by
picking.
Primitives can be anchored on visible Data and Reference objects. When choosing the
Anchor creation method and pressing the Anchor button, the creation dialog box
enables an interactive mode that allows anchoring primitives.
Each type of feature is created using a specific anchoring method. The How to button
displays a window in the Dialog Zone containing a diagram illustrating how to anchor
points to create the specified primitive type. Press the Close button to dismiss the
window.
To pick the closest point on a polygonal Data object or a Reference object, click with
the SHIFT key down. See Figure 13.12.
Figure 13.12 If the SHIFT key is pressed, and the mouse click is made over the x in the 3D scene, the
triangle underneath the mouse click is localized, shown here outlined in black, and
the closest triangle vertex, V, is identified as the picked point.
V
x
Press the SPACEBAR to temporarily leave the mode and rotate/translate the 3D
scene. Press the SPACEBAR again to return to the picking mode.
When finished picking a required number of points, the exact primitive passing
through the picked points is automatically extracted and added to the tree view.
The following table describes the anchoring methods available for each type of
primitive:
Primitive
Anchor
type
Primitive
Anchor
type
Pick 1 on Surface
A sub-method that makes available the Radius text
box to specify a plane radius value, and the Number
of sides list box to specify the number of sides on the
plane. Possible values range from 3 to 20 sides. A
corresponding plane is drawn under the picking tool
for visualization purposes. Pick a single point on a
Reference surface to create a plane. The normal of
the surface under the picked point is used to define
the plane orientation.
This anchoring method is useful in creating planes
trimmed by a user-specified polygonal boundary.
Primitive
Anchor
type
Primitive
Anchor
type
Note that when Point, Center, Origin, or Apex coordinates are required, they can be
provided by manually entering the (x, y, z) coordinates, or by dragging center-point-
based primitives and dropping them over the x, the y, or the z text box. Similarly, when
Orientation or Normal coordinates are required, they can be provided by manually
entering the (i, j, k) coordinates, or by dragging direction-based primitives and
dropping them over the i, the j, or the k text box.
The following table describes the numerical creation process for each type of primitive:
Primitive
Create Numerically
type
Specify the cone’s Apex (x, y, z coordinates of the axis point at the apex of
the cone), Orientation (a vector parallel to the cone axis and pointing
toward the opening of the cone), Slope (degrees) (the angle between the
axis and the surface of the cone), Distance from apex at which the visible
section begins, and the Height of the visible section of the cone.
Specify the cylinder’s Origin (x, y, z coordinates of the axis point at the
base of the cylinder), Orientation (a vector parallel to the cylinder axis),
Radius, and Height.
Primitive
Create Numerically
type
Primitive
Create Numerically
type
Specify the sphere’s Center (x, y, z coordinates of the sphere’s center point)
and Radius.
Primitives can be fitted on visible Data and Reference objects using the Fit creation
method in the creation dialog box.
When fitting primitives, the Creation method section of the creation dialog box first
allows specifying a Sub-method. Four sub-methods are offered:
Pick, then Fit – Enables an interactive mode to pick points defining an approximate
primitive. The exact primitive passing through these points is automatically
computed, the elements within the specified Max distance and Max angle from this
primitive are identified, and then the optimal primitive is fit.
Maximize – Automatically sets the Fit type to Max. When choosing this item, a
primitive must be chosen in the Maximize from list box, available in the Parameters
section, and then the elements to be considered must be selected. The maximizing
operation fits a new max primitive to the selected elements using the specified
primitive as a starting point. This sub-method is not available when fitting vectors.
Minimize – Automatically sets the Fit type to Min. When choosing this item, a
primitive must be chosen in the Minimize from list box, available in the Parameters
section, and then the elements to be considered must be selected. Invoking the
minimizing operation fits a new min primitive to the selected elements using the
specified primitive as a starting point. This sub-method is not available when fitting
vectors.
The Parameters section of the creation dialog box offers the following common and
contextual parameters, depending on the specified fitting sub-method and the type of
primitive being created:
Max distance
A text box that defines a tolerance for the interactive Pick, then fit method. After
having defined approximate primitives by picking points, elements farther than
the maximum distance from the approximate primitives are discarded to speed up
the fitting process. The default value is 1.0 mm.
Figure 13.13 When the polygon picking modes are set to Automatic, pick three points to create
regular (3 to 8 sides) polygons. The distance between the first two picked points
determines the length of the other sides, and the angle between the second picked
point and the pointer (x) determines automatically the number of sides of the
polygon. Any new valid polygon is displayed as the mouse is displaced.
x x x
3 sides 4 sides 5 sides
x x x
6 sides 7 sides 8 sides
Fit type
A group label that allows specifying the fitting type to use when fitting primitives.
It is only available when the Fit to Elements or the Pick, then Fit sub-method is
selected, and offers three types of fit:
Best-fit
An option button that specifies using the standard best-fit algorithm that
performs a pure least-squares approach, which best-fits primitives on all
selected elements.
Min
An option button that specifies using the minimum fitting algorithm. A
Min primitive is the largest primitive that does not enclose any in-
tolerance elements.
Max
An option button that specifies using the maximum fitting algorithm. A
Max primitive is the smallest primitive that encloses all in-tolerance
elements.
Note that when fitting vectors, only a best-fit operation can be performed.
Therefore, the Fit type items are not offered.
Constraints
A group label that allows specifying one or more constraints when fitting a
primitive. It is only available when the Fit to Elements or the Pick, then Fit sub-
methods are selected, and its content is contextual to the specified Fit type. It
offers the following parameters:
Plane
A check box that enables an adjacent list box that allows choosing a
constraining plane from available plane primitives. For cones and
cylinders, the resulting primitive’s axis will be perfectly parallel to the
specified plane’s normal. For all other primitive types, all processed
elements are first virtually projected onto the specified plane. The
resulting primitive lies perfectly on the plane.
Note that when creating circles, the Plane check box, when selected,
makes available the following parameter:
Center
A check box that enables choosing, from the adjacent list box, a
center-point-based primitive used to constrain the center of the
fitted circle. When the primitive is not on the constraining plane,
its center point is projected onto the plane.
Note that the computed circle lies perfectly on the plane, its
center corresponds to the center of the selected primitive
projected onto the constraining plane, and it is fitted, as close as
possible, to the selected elements.
Radius
The radius of circles, cylinders, polygons, and spheres can be specified by
selecting this check box and entering a value in the adjacent text box.
The default value is 1 mm. This item is available when the Fit type is set
to Best-fit.
Note that the Plane, the Center, and the Radius constraints cannot all be used at
once.
Number of sides
A list box that specifies the number of sides on the polygon to fit. When set to
Automatic, the shape of the polygon being created is automatically detected. The
list box also offers six choices: 3, 4, 5, 6, 7, and 8 (see Figure 13.13 for an example).
The More sub-section offers parameters that allow configuring the fitting algorithm.
These parameters are contextual and vary according to the specified Fit type and the
type of primitive being fitted. The following parameters are offered:
Min/Max fit
A group label that offers options that apply when the Fit Type is set to Min or Max.
The options available vary according to the type of primitive. The following
options are offered:
The Filtering section offers the following options used when a primitive is fitted to an
organized point cloud:
Subsampling step
A check box that enables subsampling the Data points used to fit a primitive. By
default, the check box is cleared. It makes available a text box that allows
specifying the subsampling step. A value greater than zero must be specified. The
default value is 1.0 mm.
The Data points used to fit a primitive are subsampled with the goal of generating
uniformly spaced Data points whose point-to-point spacing is as close as possible
to the step value.
Max angle
A check box that enables eliminating from the fitting computations points
belonging to surface areas that are unrelated to the primitive being fitted. The
check box is selected by default. When selected, an adjacent text box specifies a
maximum angle between a Data point’s normal vector and the primitive’s normal
vector at the primitive point closest to the Data point, which is used to do the
filtering. The default value is 45 degrees. This angle does not apply to vectors.
Reject outliers
A check box that specifies rejecting outliers prior to fitting a primitive. Outliers are
points that lie the farthest away from the average of the Data points used to fit the
primitive. The check box is cleared by default.
When selected, it makes available the following items for specifying the outlier
rejection method:
The primitive is first fitted to the Data points and the standard deviation
value is computed. Then, Data points that lie beyond the standard
deviation multiplied by the deviation factor value are rejected, and the
primitive is refitted using the remaining Data points.
Percentage of points
An option button that allows specifying a percentage of Data points to
reject when fitting a Primitive. It makes available a text box used to
specify a percentage value. Valid values are greater than zero and smaller
than 100. The default value is 1.25%.
The primitive is first fitted to the Data points and the average distance
between the Data points and the primitive is computed. Then, the
specified percentage of Data points that lie furthest from the average
distance are rejected, and the primitive is refitted using the remaining
Data points.
The primitive is created automatically on pressing the Create button when the Fit to
Elements, Maximize, or Minimize creation sub-methods are specified. When the Pick,
then Fit creation sub-method is specified, the Pick button enables an interactive mode
that allows picking the primitive. The Pick, then Fit creation sub-method defines a
starting point and then elements are found and a primitive is fitted to those elements
using the specifications made.
Note that when picking or anchoring primitives, if the SHIFT key is up while a point is
picked, the application picks a point underneath the pointer and interpolates a point
on Data/Reference surfaces if necessary, while always interpolating a point on a
primitive. If the SHIFT key is down while a point is picked on a polygonal Data object or
a Reference object, the closest Data/Reference point will be chosen.
When a click occurs over a polygonal model or a CAD surface, the application first finds
the triangle underneath the pointer, and then picks the closest triangle vertex. For an
example, see Figure 13.12.
Description
Method Create one or more Example
primitives...
Description
Method Create one or more Example
primitives...
13.5.6.1 Introduction
When creating primitives using construction methods, the Creation method section of
the creation dialog box offers a construction Method and Sub-method. When
specifying a construction method with sub-methods, and the objects required for the
construction are preselected in the tree view, a corresponding construction sub-
method will automatically be specified according to the type of selected objects.
The creation dialog box may allow specifying a Name, as well as selecting the Create
dependencies check box in the More subsection (see Section 13.1.1.2 Enabling
primitive dependency for more information on creating dependencies), depending on
the specified construction sub-method. Note that no name can be specified when
using creation methods that create more than one primitive.
Once a construction sub-method is chosen and the parameters have been specified,
select the required objects in the tree view and press the Create button. The new
primitives are automatically added to the tree view.
The construction sub-methods available for each primitive type are described in the
subsections that follow.
Circle primitives can be created from existing objects. The From Objects construction
method offers the following sub-methods:
Average of Circles
Creates a circle by averaging the selected circles. To determine the circle’s axis
orientation, the axis orientation of the first selected circle is used as a reference.
The axis orientation of any circle is temporarily inverted if its axis is at 90 degrees
or more from the reference axis. The resulting circle’s axis orientation is then
determined by averaging the corrected axis orientations of the selected circles.
Center Points
Creates a circle best-fitted using the center points of the selected primitives.
Cones
Creates a circle at each end of a selected cone having the orientation of the cone.
The circle created for each cone is centered along the cone’s axis, has the radius of
the cone at the location where it is sliced, has a normal the same as the cone’s
orientation, and has the same in-space orientation as the cone.
The circle created for each cone is centered along the cone’s axis, has the radius of
the specified value, has a normal the same as the cone’s orientation, and has the
same in-space orientation as the cone.
Cylinders
Creates two circles at each end of each selected cylinder, having the orientation of
the selected cylinder.
Polygons
Creates a circle from each selected polygon using its radius, axis orientation, and
center point.
Rectangles
Creates the smallest possible circle from each selected rectangle that contains the
entire rectangle and has the object’s axis orientation and center point.
Circle primitives can be created from the intersection of objects. The From
Intersection construction method offers the following sub-methods:
2 Cones
Creates a circle from the intersection of two selected coaxial cones with the same
orientation extended to infinity (in the direction of their apex). If the cones are not
coaxial and the smaller of the cones was fit, the application makes an internal copy
of the smaller cone (i.e., with regards to the length of the axis) and attempts to
make it coaxial to the larger cone; if this succeeds, the creation operation
continues, otherwise it fails.
Properties of the new circle are derived from the larger of the two cones: the circle
is centered at its axis, its normal is the same as the cone’s orientation, and it has the
same in-space orientation.
When constructing cone primitives, the From Objects construction method offers the
following sub-methods:
Average of Cones
Creates a cone by averaging the selected cones.
Circles
Creates cones having the orientation of the selected circles. Each circle determines
the middle radius of a cone. The Parameters section of the creation dialog box
allows specifying the cone’s Slope (degrees) and Height. The default values are,
respectively, 45 degrees and 1 mm.
Vectors
Creates cones whose axes are the selected vectors. The Parameters section of the
creation dialog box allows specifying the cone’s Slope in (degrees).
When constructing cylinder primitives, the From Objects construction method offers
the following sub-methods:
Average of Cylinders
Creates a cylinder by averaging the selected cylinders.
Circles
Creates cylinders having the radius and orientation of the selected circles. The
Parameters section of the creation dialog box allows specifying the cylinder
Height.
Vectors
Creates cylinders whose axes are the selected vectors. The Parameters section of
the creation dialog box allows specifying a Radius value to be used for the
cylinders.
When constructing plane primitives, the From Objects construction method offers the
following sub-methods:
Average of Planes
Creates a plane by averaging the selected planes. To determine the plane’s axis
orientation, the axis orientation of the first selected plane is used as a reference. If
the axis of any plane is at 90 degrees or more from the reference axis, the axis
orientation is temporarily inverted. The resulting plane’s axis orientation is then
determined by averaging the corrected axis orientations of the selected planes.
Creates two planes tangent to three spheres centered on the specified center-point-
based primitives and of radii equal to the specified offsets.
Circles
Creates planes coplanar with the selected circles.
Points
Creates a plane from the selected points. If there are 3 points, the exact plane
passing through three points is found. If there are more than 3 points, a plane is
best-fitted using a pure least-squares approach.
Polygons
Creates planes coplanar with the selected polygons.
Rectangles
Creates planes coplanar with the selected rectangles.
Cross-Sections
Creates new planes using the cross-sections selected in the tree view. See Chapter
15 Cross-sections for more information on cross-sections.
Point primitives are useful geometric objects. They are more flexible and convenient
than points as elements of a Data object. For example, point primitives are objects in
the tree view. As such, they can be displayed along with screen annotations, their (x, y,
z) coordinates can be edited, and so on.
Point primitives can be created from existing objects. The From Objects construction
method offers the following sub-methods:
Average of Points
Creates a point by averaging the selected points.
Circle Centers
Creates points from the centers of the selected circles.
Cone Apexes
Creates points from the apexes of the selected cones.
Cone Endpoints
Creates points from the axis endpoints of the selected cones.
Cone Midpoints
Creates points from the axis midpoint of the selected cones.
Cylinder Endpoints
Creates points from the axis endpoints of the selected cylinders.
Cylinder Midpoints
Creates points from the axis midpoint of the selected cylinders.
A positive Offset value results in the creation of points in the direction of the
specified orientation. A negative Offset value results in the creation of points in
the direction opposite the specified orientation. The default value is 0.0 mm.
Polygon Centers
Creates points from the centers of the selected polygons.
Rectangle Centers
Creates points from the centers of the selected rectangles.
Sphere Centers
Creates points from the centers of the selected spheres.
Vector Endpoints
Creates points from the start point and the end point of the selected vectors.
The two point primitives that describe the smallest deviation are named min
dev - <cross-section_name> -nom-, and min dev - <cross-section_name> -
meas-.
The two point primitives that describe the largest deviation are named max
dev - <cross-section_name> -nom-, and max dev - <cross-section_name> -
meas-.
The two point primitives that describe the smallest deviation are named min
dev - <data_color_map_name> -nom-, and min dev -
<data_color_map_name> -meas-.
The two point primitives that describe the largest deviation are named max
dev - <data_color_map_name> -nom-, and max dev -
<data_color_map_name> -meas-.
Point primitives can be created from the intersection of objects. The From Intersection
construction method offers the following sub-methods:
2 Circles
Creates one or two points from the intersection of two selected coplanar circles,
depending on the number of intersections between the two circles.
2 Cone Axes
Creates a point by finding the closest midpoint between two cone axes.
2 Cylinder Axes
Creates a point by finding the closest midpoint between two cylinder axes.
2 Vectors
Creates a point by finding the closest midpoint between two vectors.
3 Planes
Creates a point by intersecting three selected planes.
Point primitives are automatically created from the selected axial primitives at
each location where their axis intersects the selected Reference objects.
Note that for Reference objects with virtual surface specifications, the locations of
the created point primitives are determined accordingly. For more information on
virtual surfaces, see Section 23.6.4.1 Reference objects and virtual surfaces.
Point primitives can be created by projecting selected points onto primitives. The From
Projection construction method offers the following sub-methods:
Onto Circle
Creates points by projecting the selected points onto the selected circle’s
circumference.
Onto Cone
Creates points by projecting the selected points onto the surface of a selected
cone. If a point is above the apex of the cone, it is projected onto the cone surface
that is extended to infinity. If the point is below the cone apex, it is projected onto
the cone apex.
Onto Cylinder
Creates points by projecting the selected points onto the surface of a selected
cylinder that is extended to infinity.
Onto Plane
Creates points by projecting the selected points onto the surface of a selected
plane that is extended to infinity.
Onto Polygon
Creates points by projecting the selected points onto the selected polygon’s
circumference.
Onto Rectangle
Creates points by projecting the selected points onto the selected rectangle’s
circumference.
Onto Sphere
Creates points by projecting the selected points onto a selected sphere.
Onto Vector
Creates points by projecting the selected points onto a selected vector that is
extended to infinity.
Point primitives can be created from selected elements. The From Elements
construction method offers the following sub-methods:
Average of Elements
Creates a point by averaging all selected elements. In this case, the elements are
Data points, which are the points of point cloud Data objects or the vertices of
polygonal Data objects. The elements are linked to the primitive in the same way
that elements used to fit a primitive are linked to the primitive.
Each Element
Creates new points using each element (i.e., Data points and vertices of polygonal
and CAD Reference objects) selected in the 3D scene.
Note that points created from elements are not dependent on the elements from which
they are created.
When constructing polygon primitives, the From Objects construction method offers
the following sub-method:
Average of Polygons
Creates a polygon by averaging the selected polygons. To determine the polygon’s
axis orientation, the axis orientation of the first selected polygon is used as a
reference. If the axis of any polygon is at 90 degrees or more from the reference
axis, its axis orientation is temporarily inverted. The resulting polygon’s axis
orientation is then determined by averaging the corrected axis orientation of the
selected polygons.
When constructing polyline primitives, the Creation method section of the creation
dialog box offers three polyline primitive construction methods and various
construction sub-methods for two of them. The three following subsections offer
detailed information on each method and sub-method.
The first following subsection explains how to automatically extract polylines from
Data Error Contours generated from the Enhanced coloring option of the Error display
function. For more information on the Enhanced coloring option, see Section 19.2.2
Mapping the deviation on points and surfaces.
The other two subsections explain how to automatically extract polylines from typical
features on visible polygonal Data objects. It is necessary to pick three points, which are
used in the following way:
The first point indicates the beginning of the polyline. Each subsection explains
where to pick the first point.
The second point is picked to define the step at which vertices will be created. It also
determines the forward direction of the polyline. A large step could be used with a
relatively straight feature, while a feature that curves somewhat may need a smaller
step so that the curved sections may be properly described by the linear segments
between vertices.
The third point determines the radius of a cylinder whose axis is the linear segment
between the first and the second picked point. As the pointer is moved to pick the
third point, a cylinder is displayed in the 3D scene to help visualize what points will
be included within the cylinder. This cylinder is used to determine what points will
be considered by the automatic extraction process at each new step. If the Data
object is a point cloud, its Data points are used; if the Data object is polygonal, its
vertices are used.
The automatic extraction algorithm extracts a polyline in both directions along the
feature, in the forward and the backward directions, starting at the picked cylinder.
Polyline primitives can be extracted from the Data Error Contours of color maps of
polygonal Data objects generated using the Enhanced coloring method in
combination with the Show contours option. For more information on color maps and
the Enhanced coloring option, see Section 19.2.2 Mapping the deviation on points
and surfaces.
The From Data Error Contours construction method extracts polylines from the
enhanced coloring data color map displayed on polygonal Data objects that are
selected in the tree view. On pressing the Create button, polyline primitives are
Figure 13.14 Creating polylines (a) from Data Error Contours generated using the Enhanced
coloring method (b) on the Data points belonging to compared polygonal data
objects. In this example, the conversion-to-color method for the color scale is set to
Use Object Tolerances.
(a) (b)
extracted using the Data Error Contours generated for each selected polygonal Data
object (see Figure 13.14).
A new object group is created for each selected polygonal Data object with the name
error contours - <Data_object_name>. Each object group contains the polylines created
from the object’s Data Error Contours. The polyline primitives are given the name
contour <number> <tolerance>, with the -nom- or the -meas- suffix according to the
specified primitive status, where <number> represents a sequential index number (e.g.,
1, 2) and <tolerance> represents a tolerance; for example, contour 12 (High+) -meas-.
The table that follows explains how the tolerance is determined.
a. The number of digits displayed after the point is determined by the # digits
after point parameter in the Color Map Display Options dialog box.
b. The tolerance value is No Comparison for polylines created at the intersection
of zones with comparison and zones without comparison, as well as for
polylines created at the boundary of the error range.
c. If a tolerance zone is displayed with more than one color, the tolerance is only
provided for the polylines that are exactly on the tolerance limits.
Note that when a feature code has been specified, the polyline primitives are given the
name of the feature code, followed by an index number.
The generated polylines provide visual color map information which can be exported,
in order to be used in other software.
Note that depending on the color scale used and the deviations measured, generating
polyline primitives from Data Error Contours may produce a large number of polylines.
If more than 500 polylines are to be generated, a confirmation message is displayed. In
order to generate a reasonable number of polylines, it may be preferable to generate a
color map on only critical portions of the polygonal Data objects.
Polyline primitives can be created from existing objects. The From Objects
construction method offers the following sub-methods:
Circles
Extracts closed polylines from selected circles. In the Parameters section of the
creation dialog box, the Sampling method group box offers items to specify a
sampling method to be used for all of the selected circles. The Tolerance option
button and the adjacent text box specify a maximum accepted distance between
the generated polylines and the source circles. The value must be greater than 0;
the default value is 0.05 mm. The Tolerance option button is selected by default.
The Step option button and the adjacent text box specify an arc length, along the
perimeter of the circles, between two consecutive vertices of the generated
polylines. The value must be greater than 0. The default value is 0.2 mm.
On pressing the Create button, a polyline is extracted using the perimeter of each
selected circle.
Cross-Sections
Extracts polylines from the cross-section children of selected cross-sections. The
cross-section points become polyline vertices.
The Parameters section offers a Create object groups check box. It enables
placing the newly created polyline primitives in a new object group. This
operation results in the creation of polyline primitives in the tree view. Polylines
created from cross-sections are never dependent on their parent objects.
If creating object groups was not specified, a polyline primitive will be created for
each cross-section child. If creating object groups was specified, a new object
group is created for each selected cross-section having the name of the cross-
section. Each object group contains a polyline primitive for each cross-section
child.
Data object (note that some part Extracted polylines (not all newly created polylines are
features are not scanned completely) shown above)
the same cross-section child have the name of the child with an incremented
integer.
Data
Creates polylines from the elements of selected polygonal and point cloud Data
objects (i.e., points and vertices). These unordered points must describe curves
and not surfaces or volumes. The polylines connect all of the points, except those
that are determined to be outliers. The Parameters section of the polyline
creation dialog box offers two items:
Max distance
A text box that defines a maximum distance that is used to determine if
a Data point can be connected to a neighboring point. If it can, the points
are on the same polyline. When the distance between two points is
greater, the current polyline is ended, and a new polyline is begun. A
value greater than 0 must be specified. The default value is 2 mm.
Figure 13.16 The dialog box used to construct polylines by slicing Reference objects and/or Data
objects. Here, the dialog box is configured for the Anchor method.
custom value for the extraction step. A value greater than 0 must be
specified. The default value is 2 mm.
When more than one polyline is created, the created polylines are added to an
object group that has the name polylines - name of cross-section. For an example of
the operation, see Figure 13.15.
Reference/Data Slicing
Polyline primitives can be extracted from used (i.e., nonignored) Reference objects
and/or Data objects by slicing them using a slicing plane, resulting in temporary
cross-sections which are converted to planar polylines.
On pressing the Create button, the dialog box shown in Figure 13.16 is displayed,
offering six creation methods for polyline primitives. The creation methods are
equivalent to the ones used to create cross-sections (i.e., Along Standard Axis,
Along Curve, Radial, Anchor, Along Custom Vector, and From Planes), with in
addition an automatic conversion-to-polylines operation. Note that all
measurements are 3D measurements (i.e., there is no error compensation, as may
be the case for cross-sections). Refer to Chapter 15 Cross-sections for detailed
information.
The first five creation methods require first creating temporary cross-sections
bounded by a rectangle. The bounding rectangle may be edited prior to creating
the polylines. The From Planes creation method requires selecting an existing
plane primitive in the tree view.
On pressing the Create button, the polylines from that result from slicing the
objects with the selected plane are automatically extracted.
Note that all point cloud Data objects are considered as a single point cloud object
during the slicing operation.
A new object group is created for each slicing operation named reference/data
slicing. Each object group contains a polyline primitive for each continuous
segment created when slicing the Reference objects and the Data objects. All
polyline primitives extracted from one slicing operation have the name reference/
data slicing (<object_group_number>) part <number> -<component type>-,
where <object_group_number> is the same number as the one assigned to the
parent object group, and <number> starts at one and is incremented by one for
each object within the group, and <component type> is meas or nom. The naming
scheme for polyline primitives constructed from Reference/Data Slicing is
illustrated in Figure 13.17.
The Cable sub-method automatically extracts polyline primitives from the linear
characteristics of visible Data objects, such as electrical cables:
On pressing the Pick button, an interactive mode is entered that allows automatically
extracting polylines from cables. It requires three clicks to provide information required
by the extraction process:
1. Click on the cable to anchor a point defining the starting point of the extraction.
2. Click again on the cable to define a point defining the direction of the extraction,
and the step of the vertices to be extracted. A line is drawn between the two points.
3. Move the mouse at a right angle to the drawn line between the first two points. The
line is used as the axis of a cylinder that opens with the mouse displacement,
defining the radius within which Data points will be considered for the extraction
process. Click a third time to define the radius of the cylinder. Note the following:
Picking may be facilitated by increasing the point size using the Point size
(pixels) list box on the 3D Scene toolbar (click the Object Display Options menu
button), which has the added advantage of hiding irrelevant points.
Use the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
Figure 13.17 An example of default names assigned to polyline primitives constructed from
Reference/Data Slicing.
The picked cylinder must contain a sufficient density of points. This is especially true
of polygonal model Data objects, since the surface information is not used.
The Data points within the cylinder must define one, and only one, cable.
Note that this operation uses the points of the Data objects. This means that in the case
of a polygonal model Data object, the vertices are used and not the triangles.
The Color sub-method automatically extracts polyline primitives from the color-per-
point or intensity-per-point information of visible Data objects, typically for road
applications:
On pressing the Pick button, the dialog box shown in Figure 13.19 is displayed to
specify the type of color information. Three types are proposed: Color boundary,
Single lines, Double lines; in the last two cases, the lines must be pale on a dark
surface. In the interactive picking mode, three clicks are necessary to provide
information required by the extraction process:
1. Click to anchor a point defining the starting point of the extraction. Here are some
suggestions as to where to pick the first point:
In the case of a color boundary, pick the first point along the boundary. In the case
of a broken single line, pick the first point on the center of the first broken line. In the
case of a double line, pick the first point between the two lines.
2. Click again to define a point defining the direction of the extraction, and the step of
the vertices to be extracted. Here are some suggestions as to where to pick the
second point:
Figure 13.18 The polyline extraction cylinder (a), and the polyline extracted from a cable (b).
(a) (b)
In the case of a color boundary, pick the second point along the boundary. In the
case of a broken single line, pick the second point on the center of the next broken
line. In the case of a double line, pick the second point between the two lines.
3. Move the mouse at a right angle to the drawn line between the first two points. The
line is used as the axis of a cylinder that opens with the mouse displacement,
defining the radius within which Data points will be considered for the extraction
process. Click a third time to define the radius of the cylinder. Here are some
suggestions as to where to pick the third point:
In the case of a color boundary, the cylinder should include a narrow band of Data
points of each intensity/color. In the case of a (broken) single line, the cylinder
should include the pale line, and a narrow band of the dark background to each side.
In the case of a double line, the cylinder should include the double lines, and a
narrow band of the dark background to the side of each of the double lines. Note
the following:
Picking may be facilitated by increasing the point size using the Point size
(pixels) list box on the 3D Scene toolbar (click the Object Display Options menu
button), which has the added advantage of hiding irrelevant points.
Use the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
Figure 13.19 The dialog box that is displayed when creating polylines from colored features.
Note that:
In the case of a double line feature, this extraction operation creates one polyline
from between the double lines.
When setting the radius of the cylinder by picking the third point, favor a smaller
rather than a larger radius; a radius that is too large may include unwanted points
with contrast and cause the automatic extraction to go in an undesired direction.
In the case of lines, they must be bright enough and contrast sufficiently with their
background.
The picked cylinder must contain a sufficient density of points. This is especially true
of polygonal Data models, since the surface information is not used.
Note that this operation uses the points of the Data objects. This means that in the case
of a polygonal Data object, the vertices are used and not the triangles.
The Edge sub-method extracts polyline primitives along the edges of visible Data
objects with point normal information:
On pressing the Pick button, an interactive mode is entered that allows automatically
extracting polylines from edges. Three clicks are necessary to provide information
required by the extraction process:
Figure 13.20 An example of automatic polyline extraction along a single line on the side of a road.
In (a) three points are picked, and in (b) the polyline is extracted.
(a)
1
2
3
(b)
1. Click on the edge to anchor a point defining the starting point of the extraction.
2. Click again on the edge to define a point defining the direction of the extraction,
and the step of the vertices to be extracted. A line is drawn between the two points.
3. Move the mouse at a right angle to the drawn line between the first two points. The
line is used as the axis of a cylinder that opens with the mouse displacement,
defining the radius within which Data points will be considered for the extraction
process. Click a third time to define the radius of the cylinder. If the edge is rounded,
the cylinder must be large enough to include Data points on the more planar areas
leading up to the edge. Note the following:
Picking may be facilitated by increasing the point size using the Point size
(pixels) list box on the 3D Scene toolbar (click the Object Display Options menu
button), which has the added advantage of hiding irrelevant points.
Use the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
Figure 13.21 An example of automatic polyline extraction along an edge. In (a) three points are
picked, and in (b) the polyline is extracted.
(a)
1 2
3
(b)
The picked cylinder must contain a sufficient density of points. This is especially true
of polygonal Data models, since the surface information is not used.
The Data points within the cylinder must define one, and only one, edge.
The edge angular deviation must be sharp enough; this does not exclude rounded
edges.
Note that this operation uses the points of the Data objects. This means that in the case
of a polygonal Data object, the vertices are used and not the triangles.
The Pipe sub-method automatically extracts polyline primitives from the center of
pipes on visible Data objects with point normal information:
On pressing the Pick button, the dialog box shown in Figure 13.22 is displayed, offering
the following items for the current extraction:
Diameter model
A group box that offers two option buttons, Constant and Variable, to specify the
nature of the pipe diameter. If Constant is chosen, enter in the adjacent combo
box the diameter of the pipe that will be extracted, or choose Automatic and let
the application automatically fit the diameter.
Pick points
A group box that offers two option buttons, Inside and Outside, to specify where
points are to be picked on the pipe.
Three clicks are necessary to provide information required by the extraction process:
1. Click on the pipe to anchor a point defining the starting point of the extraction.
2. Click again on the pipe to define a point defining the direction of the extraction, and
the step of the vertices to be extracted. A line is drawn between the two points.
3. Move the mouse at a right angle to the drawn line between the first two points. The
line anchors one side of a cylinder that opens with the mouse displacement,
defining the diameter within which Data points will be considered for the extraction
process. Click a third time to define the diameter of the cylinder. Note the following:
Picking may be facilitated by increasing the point size using the Point size
(pixels) list box on the 3D Scene toolbar (click the Object Display Options menu
button), which has the added advantage of hiding irrelevant points.
Use the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
Figure 13.22 The dialog box that is displayed when creating polylines from pipes.
The picked cylinder must contain a sufficient density of points. This is especially true
of polygonal model Data objects, since the surface information is not used.
The Data points within the cylinder must define one, and only one, pipe.
Note that this operation uses the points of the Data objects. This means that in the case
of a polygonal Data object, the vertices are used and not the triangles.
When a polyline is created by extraction along a pipe, the diameter of the pipe, if it is
constant, is added to the object name (e.g., polyline1 -d0.30-). The Data points that
belong to the pipe are determined as part of the polyline extraction process. These
points may be selected by choosing the Select > Data Points > From Fitted Primitives
command (see Section 8.5.6 Setting selection options in the IMSurvey Options dialog
box for more information). Selecting and hiding these points may facilitate the access
to other Data points.
The Step Edge sub-method extracts polyline primitives on the step edges of visible
Data objects:
On pressing the Pick button, an interactive mode is entered that allows automatically
extracting polylines along a step edge. Three clicks are necessary to provide
information required by the extraction process:
1. Click on the step to anchor a point defining the starting point of the extraction.
2. Click on the step again to define a point defining the direction of the extraction, and
the step of the vertices to be extracted.
Figure 13.23 The extraction cylinder (a). The extracted polyline centered in the pipe (b). The
polyline alone (c).
(a) (b) (c)
3. Move the mouse at a right angle to the drawn line between the first two points. The
line is used as the axis of a cylinder that opens with the mouse displacement,
defining the radius within which Data points will be considered for the extraction
process. Click a third time to define the radius of the cylinder. It should include the
step edge and a narrow band of points outside each of the two edges as to include
the three planar areas. Note the following:
Picking may be facilitated by increasing the point size using the Point size
(pixels) list box on the 3D Scene toolbar (click the Object Display Options menu
button), which has the added advantage of hiding irrelevant points.
Use the SPACEBAR to temporarily exit the mode and perform rotations/
translations in the 3D scene.
The picked cylinder must contain a sufficient density of points. This is especially true
of polygonal Data models, since the surface information is not used.
The Data points within the cylinder must define one, and only one, step edge.
The step edge angular deviation must be sharp enough; this does not exclude
rounded edges.
Note that this operation uses the points of the Data objects. This means that in the case
of a polygonal Data object, the vertices are used and not the triangles.
Figure 13.24 An example of automatic polyline extraction along a step edge. Three points are
picked (a), and the polylines are extracted (b).
(a) (b)
2
1 3
When constructing rectangle primitives, the From Objects construction method offers
the following sub-method:
Average of Rectangles
Creates a rectangle by averaging the selected rectangles. To determine the
rectangle’s axis orientation, the axis orientation of the first selected rectangle is
used as a reference. If the axis of any rectangle is at 90 degrees or more from the
reference axis, its axis orientation is temporarily inverted. The resulting rectangle’s
axis orientation is then determined by averaging the corrected axis orientations of
the selected rectangles.
When constructing sphere primitives, the From Objects construction method offers
the following sub-methods:
Average of Spheres
Creates a sphere by averaging the selected spheres.
Circles
Creates spheres having the radius and center of the selected circles.
Points
Creates spheres centered about the selected points. The Parameters section of
the sphere creation dialog box allows specifying the sphere’s Radius.
Vector primitives can be created from existing objects. The From Objects construction
method offers the following sub-methods:
If the selected vectors are parallel and have the same orientation, the new vector
is situated exactly between them, and its length is the average of the lengths of
the selected vectors.
If the selected vectors are not parallel, the resulting bisector vector has the
following properties:
Center: the average of the centers of the selected vectors projected onto the
bisector line.
Average of Vectors
Creates a vector by averaging the selected vectors.
Center Points
Creates a vector from n selected center-point-based primitives. If two are selected,
the exact vector joining the two center points is found. If more than two are
selected, a vector is best-fitted using a pure least-squares approach.
The Parameters section of the vector creation dialog box allows specifying the
vectors’ Constraining plane, Center point 1, and Center point 2 by selecting
them in the Name list boxes or by clicking the hand symbols adjacent to the list
boxes to pick them in the 3D scene. For each center point, specify a positive offset
value in the adjacent Offset text box. Note that if a center-point-based primitive,
other than a point, is dragged and dropped over an Offset text box, its radius
becomes the associated Offset value.
Cone Axes
Creates vectors from the axes of the selected cones.
Cylinder Axes
Creates vectors from the axes of the selected cylinders.
A tool allows constructing vector primitives from the intersection of objects. The From
Intersection construction method offers the following sub-method:
2 Planes
Creates a vector by intersecting two selected planes.
Figure 13.25 Three examples of creating a bisector vector (blue) from two selected coplanar
vectors (green).
Onto Plane
Creates vectors by projecting selected vectors onto a plane.
Please refer to Section 13.1.1 Dependent primitives for more information concerning
dependent primitives.
Figure 13.26 To the left, the dialog box used to create a Plane from points and offsets. To the right,
specified points, each with an offset of 3, and the created Planes situated above and
below the offset points (displayed here as spheres).
The Measure > Feature Primitives > Create > Planes from Points and Offsets command
allows creating two offset planes from three points and three offset values, which is
equivalent to three center points and three sphere radii.
On choosing this command the dialog box shown in Figure 13.26 is displayed. Make
specifications as follows:
Specify values for three points in the Points & Offsets group box; they must not be
collinear. Enter the x, y, z coordinates of three points manually, or drag center-point-
based primitives and drop them over an x#, a y#, or a z# text box.
Figure 13.27 The dialog box used to create polylines by offsetting polylines.
For each point, specify a positive offset value in the adjacent Offset # text box.
Note that if a circle or sphere is dragged and dropped, its radius becomes the
associated Offset value.
Press the Create button to launch the operation (or the Cancel button to end the
operation). Two planes are generated, one completely above the offset points, and
one completely below the offset points.
The Measure > Feature Primitives > Create > Polyline from Polyline Offset command allows
offsetting visible polylines. On choosing this command the dialog box shown in Figure
13.27 is displayed, offering the following offsetting parameters:
Offset distance
A combo box that allows specifying an offset distance. The default value,
Interactive, allows specifying the distance interactively, once in the interactive
mode. A value can be entered and used to offer limited offset options once in the
interactive mode.
3D
An option button, selected by default, that specifies a 3D offset. It makes available
one item:
Parallel to plane
An option button that specifies creating a 2D offset. It makes available the
following item:
Plane
A list box that specifies a plane. Choose from the standard planes, XY, YZ,
and ZX, and all nonignored planes in the tree view.
1. Move the hand pointer over the desired polyline vertex, which becomes
highlighted.
If desired, press the SPACEBAR to enter the mode to translate and/or rotate the 3D
scene. Press the SPACEBAR again to return to the picking mode.
2. Drag the pointer away from the polyline, in the direction where the offset polyline
is to be created. A circle is drawn centered at the polyline vertex.
When an offset distance is specified in the dialog box, the circle’s radius is fixed:
When the offset is 2D, the displacement is along the specified plane.
When the offset is 3D, the displacement is limited to valid 3D offsets to either
side of the polyline.
When the offset type is Interactive, the circle’s radius is determined by the
location of the picking tool. Release the mouse button to specify the desired
offset.
Note that polylines created by using a 3D offset are automatically fitted to the Data
object.
The Measure > Feature Primitives > Create > Vectors from Points and Offsets command
allows creating vectors from points and offsets. It creates two vectors tangent to two
circles (each defined by a center and an offset) and lying on a constraining plane. On
choosing this command the dialog box shown in Figure 13.29 is displayed, offering the
following items:
Constraining plane
A list box that allows choosing a constraining plane used in the creation of vectors
from offsets. All nonignored planes are offered.
Figure 13.28 An example of polyline offsets using a road scene viewed from above. The line in the
middle was offset once in one direction, and again in the opposite direction,
producing offset polylines of different lengths.
Press the Create button to generate two vectors on the constraining plane, one
completely above the offset points, and one completely below the offset points. Their
direction is from the first point to the second point. Press the Cancel button to end the
operation.
Primitives can be deleted. See Section 7.2.1 Deleting objects for more information on
deleting objects.
Primitives can be duplicated. See Section 7.5.1 Duplicating objects for more
information on duplicating objects.
Figure 13.29 The dialog box used to create a vector from points and offsets.
The order of objects within the feature primitives branch can be modified by dragging
single objects; see Section 4.6.3 Changing the order of objects within their branch for
more information on dragging objects in the tree view. When dragging primitives, note
the following:
When dragging a primitive upward, the primitive in question is placed above the
primitive currently under the pointer, and when dragged downward, it is placed
below the primitive currently under the pointer.
The property sheet of primitives presents each primitive’s properties under several
tabs. The subsections that follow offer a detailed description of each section of the
property sheet of primitives.
Certain object properties may be edited directly using the property sheet. Note that
the geometrical properties of a primitive, that are located on the tab that has the same
name as the type of primitive (e.g., Circle), cannot be edited using its property sheet.
Such properties can only be edited using the appropriate command on the Measure >
Feature Primitives > Edit Numerically submenu. For more information, see Section 14.3
Editing primitives numerically.
The Display tab of a primitive’s property sheet is offered for all primitives, except points
and vectors. It offers the Static and Dynamic group boxes, which offer the same items:
Drawing type
A list box that offers drawing types. Typical values include Flat, Point, Smooth,
Wireframe, and/or Bounding Box. If several categories of objects are selected,
then only the drawing types common to all selected objects will be offered.
The drawing type can always be set to Default. An object displayed using the
Default drawing type is drawn using its category’s default drawing type. See
Chapter 9 Controlling the Display for a description of the default rendering
properties of each category of object.
Note that the Static and Dynamic group boxes offer different items for polylines:
Arrows/Vertices
List boxes that specify the display of arrows and vertices in the Static and the
Dynamic display modes. Each list box offers three values: Default, Off (do not
display), and On (do display).
The tab also contains the following item available for all primitives, except for polylines:
Figure 13.30 The Fit tab (a) and the Survey tab (b) found on the property sheet of primitives. The Fit
tab is not offered for polylines.
(a) (b)
The property sheet of axial primitives, curve-based primitives, points, and spheres
offers a Fit tab. See Figure 13.30 (a) for an example. If the primitive has been fitted,
implicitly by the nature of the creation operation or explicitly by the name of the
creation command, the tab provides parameters specified for the fit as well as statistics
describing the fit result. In the case of nonfitted primitives, all of the fields are empty. In
the case of nominal primitives created using the Fit or a construction method (that
performs a fit operation), all of the fields are empty. No link is kept to the Data points
from which they are created to prevent updating the primitive. The fields are also
empty for measured primitives created on a Reference object.
The Fit statistics group box contains four items: the Number of points used for the fit,
the Mean and Standard deviation of the fitting error, and the RMS Error.
The Fit parameters group box indicates the primitive’s Fit type. It also displays the
Reject outliers status, which indicates whether the outliers were rejected or not when
fitting primitives. It displays On or Off (see Section 13.5.5.2 Primitive creation
parameters for more information on rejecting outliers). When the Fit type is Min or
Max, the group box also offers a Min/Max Parameters button that allows displaying/
editing the parameters used to perform a Min/Max fit (see Section 14.13 Setting
primitive fit parameter options in the IMSurvey Options dialog box for more
Figure 13.31 The (a) Dependencies tab and the (b) Annotation tab on the property sheet of
primitives.
(a) (b)
information on these parameters). The group box also indicates the Constraints used
to create the primitive. The Plane and Center text boxes indicate the name of the
primitive used as a constraint at creation. The Radius text box indicates the radius used
as a constraint at creation. See Section 13.5.5.2 Primitive creation parameters for more
information on these constraints.
The property sheet of all primitives offers the Survey tab that provides the Feature
code, Level name, and Comment items. Feature codes are explained in Section 14.12
Managing and assigning feature codes. See Figure 13.30 (b) for an example of a Survey
tab.
The Dependencies tab, shown in Figure 13.31 (a), is present for dependent feature
primitives only. It indicates the Type of dependency based on the creation sub-method
and lists the Source objects used to create the dependent primitive.
The Orientation section offers parameters that allow configuring the inversion of the
orientation of the dependent feature primitives. The following items are offered:
The Orientation section of planes and vectors offers the following parameters:
Invert orientation
A check box that enables inverting the orientation of the feature primitive. By
default, the check box is cleared.
The Annotation tab, shown in Figure 13.31 (b), allows customizing the contents of an
object’s annotation. For complete information, see Section 22.2.3 Customizing the
contents of an annotation.
The following noneditable properties are displayed within the Circle tab of the
property sheet for circles:
Axis angles
The three angles formed between the circle’s axis and the X, Y, and Z axes.
Axis orientation
A unit vector normal to the circle.
Center
The (x, y, z) coordinates of the circle’s center.
In-space orientation
The circle’s in-space orientation can be external or internal, meaning that the side
which is free of material (in-space side) is external or internal.
Radius
The circle’s radius.
The following noneditable properties are displayed within the Cone tab of the property
sheet for cones:
Axis angles
The three angles formed between the cone’s axis and the X, Y, and Z axes.
Axis orientation
A unit vector parallel to the cone’s axis.
Height
The height of the visible section of the cone.
In-space orientation
The cone’s in-space orientation can be external or internal, meaning that the side
which is free of material (in-space side) is external or internal.
Apex
The (x, y, z) coordinates of a cone’s apex.
Slope
The angle in degrees of the cone’s slope.
The following noneditable properties are displayed within the Cylinder tab of the
property sheet for cylinders:
Axis angles
The three angles formed between the cylinder’s axis and the X, Y, and Z axes.
Axis orientation
A unit vector parallel to the cylinder’s axis.
Axis point
The (x, y, z) coordinates of a cylinder’s axis point.
Height
The cylinder’s height.
In-space orientation
A cylinder’s in-space orientation can be external or internal, meaning that the side
which is free of material (in-space side) is external or internal.
Radius
The cylinder’s radius.
The following noneditable properties are displayed within the Plane tab of the
property sheet for planes:
A, B, C, D
The coefficients of the plane equation Ax+By+Cz+D=0.
Normal
A unit vector parallel to the plane’s normal vector.
Normal angles
The three angles formed between the plane’s normal vector and the X, Y, and Z
axes.
Point
The (x, y, z) coordinates of a plane’s point. These coordinates are automatically
specified when planes are created using one of the Create Numerically and
Anchor (Pick 1 on Surface or Pick 1 on Reference Boundary) creation methods.
For planes created using any other creation method, the coordinates represent the
projection of the origin (0,0,0) onto the plane.
The following noneditable properties are displayed within the Point group box of the
Point tab of the property sheet for points:
x
The x coordinate of the point.
y
The y coordinate of the point.
z
The z coordinate of the point.
The following noneditable properties are displayed within the Polyline tab of the
property sheet for polylines:
Type
Displays the type of polyline: Open Polyline, or Closed Polyline.
# of vertices
Displays the number of vertices.
Length
Displays the length.
Line width
A list box that allows setting the width of the polyline. Choose Default to use the
value set in the Line width list box on the Display page of the IMSurvey Options
dialog box, or choose a value from 1 to 5.
Line style
A list box that allows setting the style of the polyline. Choose from eight styles in
the 0 to 7 range.
The following noneditable properties are displayed within the Polygon tab of the
property sheet for polygons:
Center
The (x, y, z) coordinates of a polygon’s center.
Axis angles
The three angles formed between the polygon’s axis and the X, Y, and Z axes.
Axis orientation
A unit vector normal to the polygon.
Vertex direction
A vector going from the Center to one vertex.
In-space orientation
The polygon’s in-space orientation can be external or internal, meaning that the
side which is free of material (in-space side) is external or internal.
# of sides
The number of sides of a regular polygon.
Shape
Indicates the shape of the polygon. It is always set to Regular.
Diameter
The diameter of the polygon’s enclosing circle.
Radius
The radius of the polygon’s enclosing circle.
The following noneditable properties are displayed within the Polygon tab of the
property sheet for rectangles:
Center
The (x, y, z) coordinates of a rectangle’s center.
Axis angles
The three angles formed between the rectangle’s axis and the X, Y, and Z axes.
Length orientation
A vector parallel to the length of the rectangle.
Axis orientation
A unit vector normal to the rectangle.
In-space orientation
The rectangle’s in-space orientation can be external or internal, meaning that the
side which is free of material (in-space side) is external or internal.
# of sides
The number of sides of a rectangle. It is always set to 4.
Shape
Indicates the shape of the rectangle: Rectangle or Rectangle with round
corners.
Length
The length of a rectangle or a rectangle with rounded corners.
Width
The width of a rectangle or a rectangle with rounded corners.
A rectangle with round corners also has the following specific property:
Corner radius
The radius of the corners of a rectangle with round corners. The corner’s radius is
used for fitting, comparison, and rendering operations.
The following noneditable properties are displayed within the Sphere tab of the
property sheet for spheres:
Center
The (x, y, z) coordinates of the sphere’s center.
Radius
The sphere’s radius.
In-space orientation
The sphere’s in-space orientation can be external or internal, meaning that the
side which is free of material (in-space side) is external or internal.
The following noneditable properties are displayed within the Vector tab of the
property sheet for vectors:
Length
The distance between the vector’s start and endpoint.
Orientation
The (i, j, k) coordinates indicating the vector’s direction.
Origin
The (x, y, z) coordinates indicating the vector’s start point.
Export to
cone – – – yes
cylinder – – – yes
polygon – – – yes
rectangle – – – yes
sphere – – – yes
Some tools used to manipulate primitives (e.g., Grow and Shrink, Edit Numerically) apply to all primitives,
while other tools are type specific (e.g., Project Points > Onto Reference Objects, Edit Polylines > Split). Note that
these editing operations cannot be performed on dependent primitives.
On choosing this command, the dialog box shown in Figure 14.1 is displayed and an
interactive editing mode is begun. While in this mode, only standard rotations and
translations can be performed in the 3D scene.
Three items in the dialog box are not included within the tab:
Primitive name
A text box that displays the name of the selected primitive.
Apply
A button that confirms the Data point editing and transfers the changes to the
application. The selected primitive is replaced by the displayed primitive. This
operation can be undone. The button is only available when at least one change
has been made in the dialog box.
Close
A button that closes the dialog box. Any unsaved changes are lost.
A primitive is displayed in the 3D scene using the current settings in the dialog box. Any
changes made to the Data points tab are immediately applied to the displayed
primitive. The label of changed dialog box items is displayed in red. Only when the
Apply button is pressed are changes made to the primitive.
The Data points tab allows excluding/including Data points which are used to
compute a primitive. After each operation, current fit statistics are updated and a
corresponding primitive is displayed in the 3D scene. The tab features a list area
followed by an information area. One item is offered to configure the list contents:
Figure 14.1 The dialog box used to edit the measured data points of primitives.
Deviation
Two option buttons, Signed and Unsigned, allow displaying, respectively, signed
or unsigned deviation values in the points list.
The list area provides information for each measured Data point used to fit the selected
primitive. The list can be sorted by clicking the header of any column in the list. The
following columns are offered:
Points can be selected based on their deviation using standard Windows selection
methods and excluded from or included in the points used to fit the primitive. Use
the check box for one selected point or the shortcut menu, shown in Figure 14.1, for
a multiple point selection. The Ignore command performs an exclusion while the Use
command performs an inclusion.
Excluded points are removed from the list of points for the fitting operation and the
fit is recalculated. Excluded points are shaded. If, as a result of excluding points, there
remains an insufficient number of Data points, the fitting algorithm will not be
performed and a warning icon ( ) appears next to the Apply button – place the
pointer over the warning symbol to read the warning message. As the primitive
cannot be computed, it is not displayed in the 3D scene.
When the check box is selected, those points are included in the list of points for the
fitting operation and the fit is recalculated.
Each time one or more Data points are included or excluded, the fitting is adjusted
and the result is displayed in the 3D scene. The Deviation for each point as well as
the information in the Fit statistics group box are updated automatically.
x/y/z – Three columns that display, respectively, the x, y, and z point coordinates.
A button following the list area offers an operation that applies to a single selected
Data point:
Go to
Orients the device using the coordinates of the selected Data point. If the device
is not connected, a connexion is attempted prior to orienting the device. This
operation is also offered on the shortcut menu of a point selected in the list area
(Go to). Both the button and the command are only offered if the selected device
supports the operation.
The area at the bottom of the tab provides two information areas:
Fit statistics
A group box that displays fit result statistics, presented in two columns. The
Current column presents statistics for the last fit. The Initial column presents
statistics for the last fit, prior to opening the editing tool. The statistics include: the
Number of points used for the fit, the Mean and the Standard deviation of the
fitting error, and the RMS error.
Fit parameters
A group box that displays the fitting parameters used when the primitive was last
computed:
Fit type
A text box that displays the type of fitting algorithm used (i.e., Best-fit,
Min, Max fitting methods). See Chapter 13 Feature Primitives for more
information on fitting methods.
Note that when editing fitted Data points on a primitive created using
the Best-fit fit type with the Reject outliers option, the fit type will
automatically be set to not reject outliers to ensure that only excluded
points are eliminated.
Reject outliers
A text box that indicates whether the outliers were rejected or not when
fitting primitives using the Best-fit fit type. It displays On (%) or Off. Note
that this parameter is left empty for primitives fitted using the Min and
Max fit types.
Note that trimmed primitives edited numerically are automatically made untrimmed.
For more information on trimmed primitives, see Section 13.1.2 Trimmed primitives.
Note that when Point, Center, Origin, or Apex coordinates are required, they can be
provided by manually entering the (x, y, z) coordinates, or by dragging center-point-
based primitives and dropping them over the x, the y, or the z text box. Similarly, when
Orientation or Normal coordinates are required, they can be provided by manually
entering the (i, j, k) coordinates, or by dragging direction-based primitives and
dropping them over the i, the j, or the k text box.
The Measure > Feature Primitives > Edit Numerically > Point command on the submenu
allows editing the geometric properties of a point selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.2 is displayed that
allows editing a selected point. The point’s Name and its x, y, z coordinates can be
modified. When a geometric property is modified, the related label is displayed in red
and the Revert button is enabled.
The Revert button puts the original point properties back in the editing window. The
Apply button applies the modifications to the selected point and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Vector command allows editing the
geometric properties of a vector selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.3 is displayed that
allows editing a selected vector. The vector’s Name, Origin, Orientation, and Length
can be modified. When a geometric property is modified, the related label is displayed
in red and the Revert button is enabled.
The Revert button puts the original object properties back in the editing window. The
Apply button applies the modifications to the selected vector and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Plane command allows editing the
geometric properties of a plane selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.4 is displayed that
allows editing a selected plane. The plane’s Name, and either the Point and Normal, or
the A, B, C, D coefficients of the plane equation can be modified. When a geometric
property is modified, the related label is displayed in red and the Revert button is
enabled.
The Rotate about vector group box allows rotating a plane about a selected vector.
The rotation is performed by specifying a rotation angle in degrees in the Angle in
degrees text box, and pressing the Rotate button.
The Translate along normal group box allows translating a plane along the direction
of its normal vector. To perform the translation, specify a translation value in the
Distance text box and press the Translate button.
The Revert button puts the original object properties back in the editing window. The
Apply button applies the modifications to the selected plane and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Circle command allows editing the
geometric properties of a circle selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.5 is displayed, to edit a
selected circle. The circle’s Name, Center, Orientation, and Radius can be modified.
When a geometric property is modified, the related label is displayed in red, and the
Revert button is enabled.
The Revert button puts the original object properties back in the editing window. The
Apply button applies the modifications to the selected circle and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Rectangle command allows editing
the geometric properties of a rectangle selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.6 (a) is displayed that
allows editing a selected rectangle. The rectangle’s Name, Center, Length orientation,
Axis orientation, Length, Width, and Corner radius can be modified. When a
geometric property is modified, the related label is displayed in red and the Revert
button is enabled.
(a)
The Revert button returns the original object properties to the editing window. The
Apply button applies the modifications to the selected rectangle and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Polygon command allows editing
the geometric properties of a polygon selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.7 is displayed, to edit a
selected polygon. For a rectangular polygon, its Name, Center, Vertex direction, Axis
orientation, Length, Width, and Corner radius can be modified.
For a regular polygon, its Name, Center, Vertex direction, Axis orientation, Diameter,
and # sides can be modified. When a geometric property is modified, the related label
is displayed in red and the Revert button is enabled.
The Revert button returns the original object properties to the editing window. The
Apply button applies the modifications to the selected polygon and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Cylinder command allows editing
the geometric properties of a cylinder selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.8 is displayed, to edit a
selected cylinder. The cylinder’s Name, Origin, Orientation, Radius, and Height can
be modified. When a geometric property is modified, the related label is displayed in
red and the Revert button is enabled.
The Revert button puts the original object properties back in the editing window. The
Apply button applies the modifications to the selected cylinder and updates the 3D
scene. The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Cone command allows editing the
geometric properties of a cone selected in the tree view.
On choosing the command, the dialog box shown in Figure 14.9 is displayed, to edit a
selected cone. The cone’s Name, Apex, Orientation, Slope (degrees), Distance from
apex, and Height can be modified. When a geometric property is modified, the related
label is displayed in red and the Revert button is enabled.
The Revert button puts the original object properties back in the editing window. The
Apply button applies the modifications to the selected cone and updates the 3D scene.
The Close button dismisses the dialog box.
The Measure > Feature Primitives > Edit Numerically > Sphere command allows editing
the geometric properties of a sphere selected in the tree view.
On choosing the command, a dialog box, shown in Figure 14.10 is displayed, to edit a
selected sphere. The sphere’s Name, Center, and Radius can be modified. When a
geometric property is modified, the related label is displayed in red and the Revert
button is enabled.
Figure 14.11 The dialog box used to grow and shrink primitives.
The Revert button returns the original object properties to the editing window. The
Apply button applies the modifications to the selected sphere and updates the 3D
scene. The Close button dismisses the dialog box.
Specify, in the Grow text box or in the Shrink text box, the length by which to extend
or to extract the axis of selected axial primitives, or the offset that would be applied to
the trim curves of selected planes.
The Grow and the Shrink text boxes each have their own Apply button that allows
applying their operation to the selected primitives. The Close button dismisses the
dialog box.
Figure 14.12 The dialog box used to translate primitives along their axis.
Only the extended, retracted, or offset primitive is used for display or comparison
purposes. See Figure 14.14 for an example of shrinking a cylinder.
Note that trimmed primitives edited using the Grow and Shrink tool are automatically
made untrimmed. For more information on trimmed primitives, see Section 13.1.2
Trimmed primitives.
This tool is useful for creating primitives on a Reference object, and then offsetting
these primitives using the offset of the Reference object.
When projecting onto Reference objects with virtual surfaces, the effective virtual
surface is considered. For complete information, see Section 23.6.4.1 Reference objects
and virtual surfaces.
Note that the selected primitives are edited by these projection operations and that no
new primitives are created.
The Measure > Feature Primitives > Project Points submenu offers the following two
commands that allow projecting selected points onto selected Reference objects. Note
that the selected points are edited by these projection operations and that no new
points are created.
Projection direction
A group label that allows specifying the direction in which the selected
points are to be projected onto the Reference objects. It offers the
following options:
Along X
An option button that specifies projecting the points along the
standard X axis onto the surface of the Reference objects.
Along Y
An option button that specifies projecting the points along the
standard Y axis onto the surface of the Reference objects.
Along Z
An option button that specifies projecting the points along the
standard Z axis onto the surface of the Reference objects.
Press the Apply button to perform the projection, and press the Close button to
dismiss the dialog box.
Figure 14.13 The dialog box used to specify how points will be projected onto Reference objects.
The Measure > Feature Primitives > Project Points submenu offers several operations that
allow projecting selected points onto primitives or their axis.
Onto Vector
Projects the selected points onto a selected vector that is extended to infinity.
Onto Plane
Projects the selected points onto the surface of a selected plane that is extended
to infinity.
Onto Circle
Projects the selected points onto the selected circle’s circumference.
Onto Rectangle
Projects the selected points onto the selected rectangle’s circumference.
Onto Polygon
Projects the selected points onto the selected polygon’s circumference.
Onto Cylinder
Projects the selected points onto the surface of a selected cylinder that is
extended to infinity.
Onto Cone
Projects the selected points onto the surface of a selected cone. If a point is above
the apex of the cone, it is projected onto the cone surface that is extended to
infinity. If the point is below the cone apex, it is projected onto the cone apex.
Onto Sphere
Projects the selected points onto a selected sphere.
Note that the selected primitives are edited as a result of the projection operations; no
new primitives are created.
Note that the selected vectors are edited by the projection operation and that no new
vectors are created.
3. Internal contours may then be created in the same way, right-clicking each time
after having closed a contour.
Only the trimmed area of a plane is used for display, comparison, or automatic fitting
purposes. See Figure 14.14 for an example.
Figure 14.14 (a) The original plane and cylinder primitives. (b) The plane after cropping and the
cylinder after shrinking.
(a) (b)
On choosing the command, the dialog box shown in Figure 14.15 is displayed, which
allows the extraction of an accurate symmetry plane. The Maximum search distance is
used to match the selected polygonal object to a mirrored copy of it, in order to
determine the optimal symmetry plane. Computations are launched by pressing the
Start button. After computations have been completed, the selected plane is modified
Figure 14.15 The dialog box that is displayed when adjusting a symmetry plane.
and will contain the accurate symmetry plane. Press the Close button to dismiss the
dialog box.
The Measure > Feature Primitives > Edit Polylines > Project onto Plane command, and the
corresponding button on the Polylines toolbar, allow projecting polylines onto a
selected plane.
Note that the selected polylines are edited by the projection operation and that no new
polylines are created.
The Measure > Feature Primitives > Edit Polylines > Extend command, and the
corresponding button on the Polylines toolbar, allow extending visible polylines. Note
that a Data object must be visible in the 3D scene.
1. Move the pointer over a polyline – the closer end vertex is automatically
highlighted.
Figure 14.16 The dialog box used to specify options when extrapolating polylines.
2. When the desired end vertex is highlighted, click, and a line is drawn from the end
vertex to the picking tool.
Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
4. Middle-click to finish the current extension and stay in the current mode.
The Measure > Feature Primitives > Edit Polylines > Extrapolate command, and the
corresponding button on the Polylines toolbar, allow extrapolating visible polylines.
On choosing the command, the dialog box shown in Figure 14.16 is displayed to specify
the type of extrapolation: Linear, or Parallel to selected plane. The latter choice is only
available when a plane primitive is selected in the tree view.
An interactive mode is enabled that allows extending visible polylines. Use the mode as
follows:
1. Move the pointer over a polyline. The closer end vertex is automatically highlighted.
2. Extrapolate the polyline by clicking an end vertex, holding down the left mouse
button, and dragging the mouse to a new location.
3. When the left mouse button is released, a new endpoint is added to the polyline.
5. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Insert Vertices command, and the
corresponding button on the Polylines toolbar, allow adding vertices to visible
polylines.
On choosing the command, an interactive mode is enabled that allows inserting new
vertices by clicking over polylines. Use the mode as follows:
3. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Delete Vertices command, and the
corresponding button on the Polylines toolbar, allow deleting the vertices of visible
polylines.
2. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Pick and Place Vertices command, and
the corresponding button on the Polylines toolbar, allow dragging the vertices of
visible polylines. It is possible to constrain the drag operation by selecting a plane
primitive before choosing the command.
On choosing the command, an interactive mode is enabled. Use the mode as follows:
2. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Join command, and the
corresponding button on the Polylines toolbar, allow joining the endpoints of open
polylines.
On choosing the command, an interactive mode is enabled that allows joining the
endpoints of visible polylines. Use the mode as follows:
2. Click the desired end vertex, and do the same for a second end vertex.
If the vertices belong to the same open polyline, it becomes a closed polyline.
If the end vertices belong to two different polylines, they are joined by a linear
segment and form one polyline.
3. The polyline that contained the second picked vertex is removed from the tree view.
4. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Close command, and the
corresponding button on the Polylines toolbar, allow closing selected open polylines
by joining their first and last vertices with a linear segment.
The Measure > Feature Primitives > Edit Polylines > Open command, and the
corresponding button on the Polylines toolbar, allow opening visible closed polylines.
On choosing the command, an interactive mode is enabled. Use the mode as follows:
3. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Cut Segments command, and the
corresponding button on the Polylines toolbar, allow removing sections of visible
polylines by cutting them twice.
2.1 Click once to indicate the beginning of the section to remove and click a
second time to indicate the end of the section to remove.
The section will be deleted and end vertices may be created at the cut
locations. The original open polyline will become two open polylines,
unless the removed section includes an end vertex.
3.2 Since the cuts define two exclusive sections on a polyline, move the
pointer over the section to remove – the considered section is
highlighted. Click to remove the highlighted section.
Figure 14.17 The dialog box that is displayed when magnetizing the endpoints of open polylines.
4. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Split command, and the
corresponding button on the Polylines toolbar, allow splitting visible polylines.
Two end vertices are created at the split location. If the split polyline was closed, it
becomes open, and if it was open, it becomes two open polylines.
3. Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
The Measure > Feature Primitives > Edit Polylines > Magnetize Endpoints command, and
the corresponding button on the Polylines toolbar, allow magnetizing the endpoints of
selected open polylines.
On choosing the command, the dialog box shown in Figure 14.17 is displayed that
allows specifying a Maximum search distance. A recommended value is displayed in
Figure 14.18 The dialog box used to specify options when fitting polylines.
the text box which may be edited. On pressing the OK button, endpoints within this
distance are displaced to a common location using linear interpolation and
magnetized. No new vertices are created.
The Measure > Feature Primitives > Edit Polylines > Fit command, and the corresponding
button on the Polylines toolbar, allow fitting selected polylines to visible Data or
Reference objects in the 3D scene.
On choosing the command, the dialog box shown in Figure 14.18 is displayed to
optionally optimize the polylines, and then fit them to nonignored, visible Data and/or
Reference objects in the 3D scene. It offers the following items:
Optimize polyline
A check box, selected by default, that enables the group box of the same name
that allows optimizing the polylines prior to the fitting operation. Two items are
offered:
Sampling step
A combo box that specifies a step used to create new vertices at the
beginning of the optimization process. Enter a value, greater than 0, that
is applied to all polylines, or accept the default value, Automatic, which
assures a sufficient number of vertices for each polyline.
Reduction tolerance
A combo box that specifies a tolerance used to remove vertices at the
end of the optimization process. Enter a value that is applied to all
Figure 14.19 The dialog box that is displayed when reducing polylines (a) and when resampling
polylines (b).
(a) (b)
New vertices are created along the polylines at Sampling step intervals.
Vertices within the Max snap distance from an object are projected onto the object.
Vertices are then removed from the polylines such that removing any vertex results
in a new linear segment joining its neighbors, and that the removed vertex is within
the Reduction tolerance distance from the new segment.
For each existing vertex, a search is performed for points on objects within the Max
snap distance.
If points are found, a plane is fitted to the points, and the vertex is snapped onto the
plane.
Note that fitting uses the points of the Data objects, which means that in the case of
a polygonal Data object, the vertices are used and not the triangles.
To launch the operation, press the OK button. Press the Close button to dismiss the
dialog box.
The Measure > Feature Primitives > Edit Polylines > Reduce command, and the
corresponding button on the Polylines toolbar, allow reducing selected polylines.
On choosing the command, the dialog box shown to the left in Figure 14.19is displayed
that allows specifying a 3D reduction Tolerance. A value based on the average length
of the selected polylines is displayed in the text box and can be edited. On pressing the
Figure 14.20 The dialog box that is displayed when smoothing polylines.
OK button, vertices are removed from the polylines, such that removing any vertex
results in a new linear segment joining its neighbors, and that the removed vertex is
within the Tolerance distance from the new segment.
The Measure > Feature Primitives > Edit Polylines > Resample command, and the
corresponding button on the Polylines toolbar, allow resampling selected polylines.
On choosing the command, the dialog box shown to the right in Figure 14.19 is
displayed to specify a Sampling step. On pressing the OK button, selected polylines
are resampled and vertices created at each sampling step interval. The shape of the
polylines may change.
The Measure > Feature Primitives > Edit Polylines > Smooth command, and the
corresponding button on the Polylines toolbar, allow smoothing selected polylines.
On choosing the command, a dialog box shown in Figure 14.20 is displayed that
features a Smoothing factor slider, set at a factor of 0.5. The smoothing factor ranges
from 0 to 1, where 0 indicates no smoothing and 1 indicates maximum smoothing. As
the slider is moved, the exact smoothing factor is updated in the text box to the right of
the slider, as is the rendering in the 3D scene. Smoothing increases the number of
vertices in the polylines. On pressing the OK button, the smoothing is applied to the
selected polylines.
The Measure > Feature Primitives > Edit Polylines > Invert Direction command, and the
corresponding button on the Polylines toolbar, allow inverting the direction of selected
polylines.
2. Choose the Measure > Feature Primitives > Compare Feature Primitives command.
A preview of the report is displayed. Press the Close button to dismiss the preview.
A new report item is automatically created under the Items subbranch of the Reports
branch of the tree view. The contents of the report depends on the type of primitives
being compared. By default, the first two sections of the report item describe the
properties of both primitives. The last section contains the primitive-to-primitive
comparison results.
Note that once a feature code is assigned to a primitive, it can be edited on the Survey
tab of the object’s property sheet (see Section 13.7.0.3 Viewing the feature code for
more information).
14.12.1 Managing the list of feature codes in the IMSurvey Options dialog
box
Feature codes are managed using the Feature Codes page of the IMSurvey Options
dialog box. To access this page, choose Tools > Options, open the Feature Primitives
branch, and click Feature Codes. For complete information, see Section 34.6.6 Feature
code options.
Feature codes and their attributes can be assigned to selected primitives. The selected
primitives are renamed to the feature code name and an incremented integer; the
number makes the object name unique.
Figure 14.21 In (a), the dialog box used to assign a feature code to selected primitives. In (b), the
dialog box used to select primitives based on their feature code.
(a) (b)
To perform the operation, select primitives in the tree view and choose the Measure >
Feature Primitives > Assign Feature Code command. The dialog box shown in Figure
14.21 (a) is displayed. Make a choice in the Feature code list box and press the Apply
button. Press the Close button to dismiss the dialog box.
To edit a primitive’s DXF layer information, select it in the tree view and choose Edit >
Object Properties. Its property sheet is displayed. Choose the Survey tab and specify
values in the Level name text box and/or the Comment text box.
Feature codes may be assigned to all primitives, and objects may then be selected
based on their feature code. Choose the Select > Feature Primitives > From Feature Code
command. The dialog box shown in Figure 14.21 (b) is displayed. Choose a feature code
in the Feature code list box and press the OK button. All primitives in the tree view
having the same feature code will be selected. Note that this selection does not
deselect currently selected objects in the tree view.
Under revision: This section describes V11 operation(s). It will be soon updated for the
V12.1 operation(s). Updated documentation will be available to users in the upcoming
major and intermediate releases of PolyWorks 12.1. For summary information on this topic,
consult the document “What’s New in IMSurvey”, available from the Help menu of the
PolyWorks/IMSurvey module. For immediate information on this subject, please contact
your technical support personnel.
The automatic fitting method is only available for independent primitives. Dependent
primitives are automatically computed as follows:
The basic independent ancestor primitives that have been used to directly or
indirectly define each dependent primitive are identified. The Dependencies tab of
the property sheet of dependent primitives provides the sequence of geometric
primitive-based operations that lead to the creation of a dependent primitive.
Aligning
Cross-sections are saved to the Cross-Sections branch of the tree view. Most operations related to cross-
sections are available on the Measure > Cross-Sections submenu (or through the Cross-Sections toolbar).
Cross-section results are displayed using a color map, and reports may be created containing result statistics.
How to create cross-sections (nominal and measured components), which allow calculating a
deviation. A brief description of how the creation and the extraction parameters allow obtaining
precise Data-to-Reference deviation results is also provided.
How to manipulate cross-sections to position and configure them differently (see Section 15.7
Using the property sheet of cross-sections).
15.1 Introduction
Cross-sections can be used for a variety of purposes. With pre-aligned Reference and
Data objects, cross-sections can be used to compare Reference to Data objects along a
given plane. For a comparison scenario, there is a compensation mechanism that allows
the construction of Reference to Data cross-sections whose 2D deviation truly reflects
3D deviations. A cross-section object consists in a set of polylines that result from the
intersection of a plane and nonignored Data and Reference objects.
In the case of measurements involving Reference objects with virtual surfaces, the
effective virtual surface is considered. For complete information, see Section 23.6.4.1
Reference objects and virtual surfaces.
The sections that follow explain how to create cross-sections with nominal and
measured components and obtain 2D deviations between them.
A cross-section is composed of one child for each sliced Reference object and each
sliced Data object. The name of child Reference cross-sections includes the name of the
Reference object sliced, and the name of child Data cross-sections includes the name of
the Data object sliced. See Figure 15.1 for an example.
Creating cross-sections is done using a structured contextual dialog box that allows
following a standard procedure. See the creation methods offered in the subsections
that follow.
Note that cross-sections may be imported directly from another project (i.e., IMInspect
project, IMSurvey project, IMEdit project). See Section 6.6 Importing objects from
projects for more information.
To create cross-sections using the top-down, contextual creation dialog box, proceed
as follows:
Figure 15.1 Cross-sections are saved to the Cross-Sections branch of the tree view. The name of
the child cross-sections refer to the Reference object or the Data object from which
they were obtained.
1. Choose the Measure > Cross-Sections > Create command, or press the appropriate
button (shown to the right) on the Cross-Sections toolbar. The Create Cross-Sections
dialog box, shown in Figure 15.2, is displayed.
2. Specify a name in the Name text box, or accept the default name cross-section n
(where n is an automatically incremented integer). The default name for this type of
object can be changed (see Section 24.3.11 Default name options).
3. Choose a creation method in the Method list box, and specify the related items in
the different sections of the dialog box. Seven creation methods are available:
The sections mentioned above describe the items offered in the Create Cross-
Sections dialog box that are specific to each creation method.
4. In the Options section, specify the cross-section component(s) to extract when the
cross-sections are created (not available when using the From Polylines method).
Two options are offered, which are described below.
When using the Along Curve creation method, additional options are offered, as
explained in Section 15.2.1.1.2 Creating cross-sections along a curve.
The Preview button presents the temporary slicing planes created using the
specified parameter values. For each creation process, the parameter values may be
changed and a new preview may be applied.
All cross-sections are bounded by a blue rectangle representing the slicing planes.
Section 15.5.1 Editing measurement zones as part of the creation process explains
how this measurement zone can be edited interactively.
6. Press the Create/Confirm button to compute and add real cross-sections to the
Cross-Sections branch of the tree view. Depending on the specifications made, each
cross-section may be constituted of nominal and/or measured cross-section
components derived by sectioning Reference and/or Data objects. Note the
following:
When a slicing plane does not slice a Reference or a Data object, an empty cross-
section is created.
Note that when a cross-section is created and its plane is parallel to one of the standard
axis pairs, the automatic naming method adds the plane’s equation to the name. For
example, cross-section 1 (x=248), or cross-section 1 (y=10).
When the Along Standard Axis creation method is chosen, the dialog box is
configured as shown in Figure 15.3. This method allows creating cross-sections
perpendicular to a specified standard axis. In the following table, cross-sections are
created using this method, either in an individual mode (single cross-section) or in a
multiple mode (multiple cross-sections). The slicing direction is also indicated.
This subsection explains the options specific to the Along Standard Axis creation
method. For information concerning the procedure for creating cross-sections as well
as the options generic to all creation methods, see Section 15.2.1.1 Using the Create
Cross-Sections dialog box.
Once the Along Standard Axis creation method is chosen, the following items are
offered in the Axis section:
X
An option button, selected by default, that specifies creating the cross-section
along the X axis.
Y
An option button that specifies creating the cross-section along the Y axis.
Z
An option button that specifies creating the cross-section along the Z axis.
Individual
An option button, selected by default, that allows creating a single cross-section.
When this option is selected (see Figure 15.3 (a)), the Position section indicates
the chosen axis and offers a text box to specify a coordinate along the axis - specify
a value and press the ENTER key. It also offers a button to make the specification
interactively:
Anchor Point
A button that enables an interactive mode that allows picking the
location along the axis where the cross-section will be created. For
information on the interactive mode, see below.
An infinite slicing plane intersects the available Reference and Data objects. A
measurement zone is displayed having the dimensions of the objects’ bounding
box. It will be used to extract the nominal and measured cross-section
components.
Multiple
An option button that specifies creating multiple cross-sections that are equally
spaced within a range or over the whole objects. When this option is selected (see
Figure 15.3 (b)), the Position section offers the following items:
Sampling step
A text box that specifies the distance between each cross-section. The
default value is 300 mm.
Range
A group box that offers options to specify the zone within which cross-
sections will be created. It offers the following items:
Figure 15.3 The dialog box configured to create individual or multiple cross-sections along a
standard axis.
(a) (b)
Individual
Multiple
When the check box is cleared, the following items are offered to
define a range along the specified axis:
Start point
A text box that allows specifying the start point coordinate
for the range. The default value is 0.0.
End point
A text box that allows specifying the end point coordinate
for the range. The default value is 0.0.
Note that the start and end points can also be anchored in
the 3D scene using the Anchor Range button.
Anchor Range
A button that enables an interactive mode that allows
picking two points that define the zone where cross-
sections will be created. For information on the interactive
mode, see below.
Seed point
A text box that allows specifying the point from which the
slicing will start. The first cross-section will pass through a
plane located at the seed point. The whole objects will be
sliced, following the value specified in the Sampling step
text box.
Anchor Point
A button that enables an interactive mode that allows
picking the location from which the slicing will start. For
information on the interactive mode, see below.
To use the interactive mode to anchor the slicing plane(s) where the nominal and
measured cross-section components will be extracted:
If desired, use the SPACEBAR to temporarily exit the picking mode and perform
rotations/translations in the 3D scene.
Anchor one or more points to create the slicing plane(s). There are some
particularities, according to the selected mode:
Multiple mode with the Slice whole objects parameter selected: Pick
on a visible Data object (polygonal model or point cloud with normal
information) or Reference object to specify the location where the first
slicing plane will be created. The other ones are created on both sides of
this slicing plane, following the value specified in the Sampling step
text box.
Multiple mode with Slice whole objects parameter cleared: Pick a first
point on a visible Data object (polygonal model or point cloud with
normal information) or Reference object. When dragging the pointer, a
line is displayed to represent the slicing range. Click the second point
when the range is correctly defined. Slicing planes are created in this
range, following the value specified in the Sampling step text box.
When the Along Curve creation method is chosen, the dialog box is configured as
shown in Figure 15.4. This method allows creating cross-sections perpendicular to a
curve. It involves specifying the type of curve to use, and then specifying where the
cross-sections are to be created along the curve. In the following table, cross-sections
are created using this method, either in an individual mode (single cross-section) or in a
multiple mode (multiple cross-sections). The slicing direction is also indicated.
This subsection explains the options specific to the Along Curve creation method. For
information concerning the procedure for creating cross-sections as well as the options
generic to all creation methods, see Section 15.2.1.1 Using the Create Cross-Sections
dialog box.
Once the Along Curve creation method is chosen, the following items are offered in
the Curve section:
Figure 15.4 The dialog box configured to create individual or multiple cross-sections along a
curve.
(a) (b)
Multiple
Individual
From polyline
An option button that specifies that cross-sections will be anchored along an
existing polyline or one that will be picked. When selected, it makes available a list
box to choose an existing open polyline as well as a button that offers an
interactive mode that allows picking a polyline from which a guiding curve is
automatically created:
Anchor
A button that enables an interactive mode that allows creating a polyline
that will serve as a guiding curve. Click in the 3D scene to define the
curve:
Curve segments are drawn between each pair of green curve points.
Individual
An option button, selected by default, that allows creating a single cross-section.
When this option is selected (see Figure 15.4 (a)), the Position section offers the
following item:
XY
An option button, selected by default, that specifies using the XY
plane.
YZ
An option button that specifies using the YZ plane.
ZX
An option button that specifies using the ZX plane.
Anchor Point
A button that enables an interactive mode that allows picking locations
on reference object curves, or on a curve derived from a polyline, which
creates perpendicular slicing planes passing through each picked point.
Multiple
An option button that specifies creating multiple cross-sections along whole
curves or a range along a curve. When this mode is selected and From reference
object curves is selected in the Curve section of the dialog box (see Figure
15.4 (b)), the Mode section also offers the following item:
Range
A group box that offers options to specify the zone within which cross-
sections will be created. Once an option is selected, the anchoring mode
is enabled. See below for information on the anchoring mode.
– Whole Curve
A button that enables the creation of cross-sections along the
whole curves. The button is selected by default.
– Partial Curve
A button that enables the creation of cross-sections based on a
part of the curve.
When Multiple is selected, the Position section offers the following item:
Sampling step
A text box that allows specifying the spacing between perpendicular
slicing planes along a curve. The default value is 300 mm.
Measurement zone
A group box that allows specifying the dimensions of the measurement zone. This
zone defines the 3D limits of the slicing process. It is represented by a blue
rectangle with red corners. The dimensions of the measurement zone are defined
in the following text boxes:
Height
A text box that allows specifying the height of the measurement zone.
The default value is 15000 mm.
Width
A text box that allows specifying the width of the measurement zone.
The default value is 30000 mm.
Figure 15.5 Anchoring a polyline without (a) and with (b) the discontinuity angle option.
Note that the measurement zone can be edited directly in the 3D scene. See
Section 15.5 Editing the measurement zone of a cross-section.
Discontinuity angle
A check box that allows specifying an angle between two consecutive
segments. If the angle is greater than the specified angle, the point
common to the two segments is discontinuous (see Figure 15.5). By
default, the check box is cleared. When selected, an adjacent text box is
available to specify an angle. The default value is 30 degrees.
Place the pointer near the curve derived from a polyline or near a reference
object curve.
The pointer position is automatically tracked on the curve and an outline of the
measurement zone is drawn. The measurement zone’s dimensions are specified
in the Height and Width text boxes of the Measurement zone group box, in the
Options section of the dialog box.
When the At intersection with plane item is selected and an intersecting plane
has been specified, points can only be anchored at the intersection of the
polyline or reference object curve and the specified plane.
If desired, use the SPACEBAR to temporarily exit the picking mode and perform
rotations/translations in the 3D scene.
When using the Multiple mode and the range is Whole Curve: Slicing
planes can be anchored for more than one curve at a time by left-
clicking the curves while pressing the CTRL key.
A selected curve can also be deselected by pressing the CTRL key while
left-clicking it.
When using the Multiple mode and the range is Partial Curve: A
second left-click is required to define the range. If the curve is closed, a
third left-click is required to choose which side of the curve to use.
Middle-click to remove the last anchored point.
When the Radial creation method is chosen, the dialog box is configured as shown in
Figure 15.6. The process for creating cross-sections around a specified axis involves
specifying an axial primitive, and then specifying where the cross-sections are to be
created on the object. In the following table, cross-sections are created using the
Radial method, either in an individual mode (single cross-section) or in a multiple
mode (multiple cross-sections).
This subsection explains the options specific to the Radial creation method. For
information concerning the procedure for creating cross-sections as well as the options
Figure 15.6 The dialog box configured to create cross-sections in a radial fashion, using an
angular step.
(a) (b)
Individual
Multiple
generic to all creation methods, see Section 15.2.1.1 Using the Create Cross-Sections
dialog box.
Once the Radial creation method is chosen, the following items are offered in the
Rotation axis section:
Axial primitive
A list box that allows specifying the axial primitive that defines the rotation axis.
This list box contains all of the direction-based primitives in the project, except
planes. When an axial primitive is specified in the list box, the Anchor Point button
is enabled in the dialog box. See below for information on the anchoring mode.
Individual
An option button, selected by default, that allows creating a single cross-section.
When this option is selected (see Figure 15.6 (a)), the Position section offers a text
box for each axis:
x
A text box that enables specifying the coordinate on the X axis. The
default value is 0.0.
y
A text box that enables specifying the coordinate on the Y axis. The
default value is 0.0.
z
A text box that enables specifying the coordinate on the Z axis. The
default value is 0.0.
Note that the x, y, and z coordinates can also be anchored in the 3D scene using
the Anchor Point button. You can also drag a point or a center-point-based
primitive over one of the text boxes.
Anchor Point
A button that enables an interactive mode that allows anchoring the
position of the slicing plane. The slicing plane passes through the axis of
the specified primitive and the anchored point. For information on the
interactive mode, see below.
Multiple
An option button that specifies creating multiple cross-sections. When this option
is selected (see Figure 15.6 (b)), the Position section offers the following items:
Angular step
A text box that specifies the constant angle in degrees between each
cross-section. Valid values are greater than 0 and less than 360. The
default value is 10 degrees.
Range
A group box that offers options to specify the total arc distance along
which cross-sections will be created. It offers the following items:
When the check box is cleared, the following items are offered for
each axis to define a range:
Start point
A text box that allows specifying the x, y, and z start point
coordinates for the range. The default value of each text
box is 0.0.
End point
A text box that allows specifying the x, y, and z end point
coordinates for the range. The default value of each text
box is 0.0.
Note that the start and end points can also be anchored in
the 3D scene using the Anchor Range button.
Anchor Range
A button that enables an interactive mode that allows
picking two points used to define the zone where cross-
sections will be created. For information on the interactive
mode, see below.
When the check box is selected, the following item is offered for
each axis:
Seed point
A text box that allows specifying the point from which the
slicing will start. The first cross-section will pass through a
plane located at the seed point. The whole objects will be
sliced, following the value specified in the Angular step
text box.
Anchor Point
A button that enables an interactive mode that allows
picking the location from which the slicing will start. For
information on the interactive mode, see below.
To use the interactive mode for anchoring the slicing plane(s) where the nominal and
measured cross-section components will be extracted:
Use the SPACEBAR to temporarily exit the picking mode and perform rotations/
translations in the 3D scene.
Anchor one or more points to create the slicing plane(s). There are some
particularities, according to the selected mode:
Multiple mode with Slice whole objects parameter cleared: Pick a first point
on a visible Data object (polygonal model or point cloud with normal
information) or Reference object. When dragging the pointer, an arc is
displayed to represent the slicing range. Click the second point when the
range is correctly defined. Slicing planes are created in this range, following
the value specified in the Angular step text box.
When the Anchor creation method is chosen, the dialog box is configured as shown in
Figure 15.7. The process for anchoring cross-sections involves picking its position in an
orthogonal view of the 3D scene. In the following table, cross-sections are created
using the Anchor method, either in an individual mode (single cross-section) or in a
multiple mode (multiple cross-sections).
This subsection explains the options specific to the Anchor creation method. For
information concerning the procedure for creating cross-sections as well as the options
generic to all creation methods, see Section 15.2.1.1 Using the Create Cross-Sections
dialog box.
Once the Anchor creation method is chosen, the following items are offered in the
Mode section:
Figure 15.7 The dialog box configured to anchor individual or multiple cross-sections.
(a) (b)
Individual
Multiple
Individual
An option button, selected by default, that allows creating a single cross-section.
When this option is selected (see Figure 15.7 (a)), the Position section offers the
following item:
Anchor Line
A button that enables an interactive mode to define a slicing plane by
anchoring two points in an orthogonal view of the 3D scene. For
information on the interactive mode, see below.
Multiple
An option button that specifies creating multiple cross-sections. When this option
is selected (see Figure 15.7 (b)), the Position section offers the following items:
Sampling step
A text box that specifies the distance between each cross-section. The
default value is 300 mm.
To use the interactive mode for anchoring the slicing plane(s) where the nominal and
measured cross-section components will be extracted:
Left-click an element that provide orientation information, such as a Data point with
a normal vector, a polygon, or a CAD surface.
If desired, use the SPACEBAR to temporarily exit the picking mode and perform
rotations/translations in the 3D scene.
When creating multiple cross-sections, a third point must be clicked to define the
range, i.e., the total distance along which cross-sections will be created, at intervals
specified in the Sampling step text box. The set of parallel slicing planes is then
displayed.
When the Along Custom Vector creation method is chosen, the dialog box is
configured as shown in Figure 15.8. The process for creating cross-sections
perpendicular to a specified vector involves specifying a vector, and then specifying
where the cross-sections are to be created in an orthogonal view of the 3D scene,
following the direction specified by the vector.
In the following table, cross-sections are created using the Along Custom Vector
method, either in an individual mode (single cross-section) or in a multiple mode
(multiple cross-sections). The slicing direction is also indicated.
This subsection explains the options specific to the Along Custom Vector creation
method. For information concerning the procedure for creating cross-sections as well
as the options generic to all creation methods, see Section 15.2.1.1 Using the Create
Cross-Sections dialog box.
Once the Along Custom Vector creation method is chosen, the following items are
offered in the Vector section:
i
A text box that enables specifying the i component of the vector. The default value
is 0.0.
j
A text box that enables specifying the j component of the vector. The default value
is 0.0.
k
A text box that enables specifying the k component of the vector. The default
value is 1.0.
Note that values for the direction vector may also be specified by dragging a
direction-based primitive from the tree view over any one of the text boxes.
Individual
An option button, selected by default, that allows creating a single cross-section.
When this option is selected (see Figure 15.8 (a)), the Position section allows
specifying the position of the cross-section on the vector:
x
A text box that enables specifying the coordinate on the X axis. The
default value is 0.0.
y
A text box that enables specifying the coordinate on the Y axis. The
default value is 0.0.
z
A text box that enables specifying the coordinate on the Z axis. The
default value is 0.0.
The position can also be specified in the 3D scene by dragging a point or a center-
point-based primitive over one of the text boxes, or by using the following button:
Anchor Point
A button that enables an interactive mode that allows picking the
location where the cross-section will be created. For information on the
interactive mode, see below.
A slicing plane is displayed at this location. It will be used to extract the nominal
and measured cross-section components.
Multiple
An option button that specifies creating multiple cross-sections. When this option
is selected (see Figure 15.8 (b)), the Position section offers the following items:
Figure 15.8 The dialog box configured to create cross-sections along a custom vector.
(a) (b)
Individual
Multiple
Sampling step
A text box that specifies the distance between each cross-section. The
default value is 300 mm.
Range
A group box that specifies a zone along the vector within which cross-
sections will be created. It offers the following items:
When the check box is cleared, the following items are offered to
define a range along the custom vector:
Start point
A text box that allows specifying the x, y, and z start point
coordinates of the range. The default value of each text box
is 0.0.
End point
A text box that allows specifying the x, y, and z end point
coordinates of the range. The default value of each text box
is 0.0.
Anchor Range
A button that enables an interactive mode that allows
picking two points used to define the range. For
information on the interactive mode, see below.
Seed point
A text box that allows specifying the point from which the
slicing will start. The first cross-section will be obtained
from a plane perpendicular to the custom vector and that
passes through the seed point. The whole objects will be
sliced, following the value specified in the Sampling step
text box.
Anchor Point
A button that enables an interactive mode that allows
picking the location from which the slicing will start. For
information on the interactive mode, see below.
To use the interactive mode for anchoring the slicing plane(s) where the nominal and
measured cross-section components will be extracted:
Figure 15.9 The creation dialog box configured to create cross-sections from planes.
Use the SPACEBAR to temporarily exit the picking mode and perform rotations/
translations in the 3D scene.
Anchor one or more points to create the slicing plane(s). There are some
particularities, according to the selected mode:
Multiple mode with Slice whole objects parameter cleared: Pick a first point
on a visible Data object (polygonal model or point cloud with normal
information) or Reference object. When dragging the pointer, a line is
displayed to represent the slicing range. Click the second point when the
range is correctly defined. Slicing planes are created in this range, following
the value specified in the Angular step text box.
When the From Planes creation method is chosen, the dialog box is configured as
shown in Figure 15.9. This method allows creating cross-sections using selected planes.
Figure 15.10 The creation dialog box configured to create cross-sections from polylines.
Note that the procedure for creating cross-sections as well as the options offered for
the From Planes creation method are explained in Section 15.2.1.1 Using the Create
Cross-Sections dialog box.
When a preview is displayed, a blue measurement zone is displayed for each selected
plane, which can be edited . For information on how this measurement zone can be
edited interactively, see Section 15.5.1 Editing measurement zones as part of the
creation process.
When the From Polylines creation method is chosen, the dialog box is configured as
shown in Figure 15.10. This method allows creating cross-sections by converting
selected planar polylines to cross-sections with measured components.
This method is useful for inspecting parts described by cross-section curves. The curves
should first be imported as polylines using the From File feature creation method. See
Section 13.4 Creating primitives from files for more information.
Note that the procedure for creating cross-sections is explained in Section 15.2.1.1
Using the Create Cross-Sections dialog box.
When a preview is displayed, planes obtained from the planar polylines appear. They
are not used in the creation process.
Once the Create/Confirm button is pressed, the real cross-sections are computed and
added to the Cross-Sections branch of the tree view. Each cross-section is constituted
of a measured cross-section component. To obtain the nominal cross-section
component, see Section 15.3 Obtaining the nominal component of cross-sections.
On selecting the cross-section in the tree view, and then using one of the following
methods:
The Custom creation method regroups creation methods that are other than Extract.
For example, the measured components of cross-sections can be obtained by
converting polylines to cross-sections. This is described in Section 15.2.1.1.7 Creating
cross-sections from polylines.
On creation: When the Extract measured component check box is selected. The
options used are located on the Cross-Sections > Extract Measured page of the
IMSurvey Options dialog box.
Using the property sheet to specify the Extract method, and then giving the command to
extract the measured component of selected objects:
On setting the Method list box on the Measurement tab of the cross-section
property sheet to Extract, then configuring the offered options obtained from
the Cross-Sections page of the IMSurvey Options dialog box and finally
pressing the Apply button to confirm the values.
On selecting the cross-section in the tree view, and then using one of the
following methods:
The options used are obtained from the Cross-Sections page of the IMSurvey Options
dialog box if the method is not set to Extract on the object’s properties sheet, and if it is
the options used are the ones on the properties sheet.
The Cross-Sections > Extract Measured page of the IMSurvey Options dialog box,
shown in Figure 15.12, offers options for the extraction of measured cross-section
components. Note that once a cross-section is created, these options can be viewed
and modified under the Measurement tab of the property sheet of the cross-section.
The presentation in the property sheet is slightly different from the one in the IMSurvey
Options dialog box, but the options are exactly the same.
Sub-method
A list box that allows specifying a sub-method. Choose from Standard and
Compensate for 3D Deviation. The default value is Standard.
and Data child cross-sections) truly reflect 3D deviations between the Reference
object and the Data objects. Compensation is recommended if the purpose of
creating cross-sections is to measure the deviation of Data objects from Reference
objects. Otherwise, 2D deviations can be artificially higher compared to 3D
deviations if the slicing planes are not perpendicular to the Reference object
surface. For a compensated Data child cross-section, every vertex has a 2D
deviation to a Reference child cross-section that reflects a 3D deviation computed
between Reference object surfaces and Data points. For a measured component
to be obtained using 3D compensation, the nominal component must already
exist.
Data objects
A list box that allows specifying the Data objects to use by default when obtaining
the measured component by extraction. Choose from Surface (i.e., all nonignored
surface-type Data objects within the measurement zone) and Specific (i.e., specify
either pre-extraction in a list box or at extraction by the objects used on creation).
The default value is Surface.
Point clouds
A group label that offers a distance parameter that controls the sectioning
algorithm for point cloud Data objects:
Gap filling
A check box, cleared by default, that enables filling gaps in the extracted cross-
section (see Figure 15.13 (b)) using the following specifications:
Max distance
A text box that allows specifying the maximum gap length to fit along
the cross-section. The default value is 4.0 mm.
Sampling step
A group label that allows specifying the sampling step, which determines
the length of cross-section segments used to fill gaps, and which should
be similar to the point density or the mesh triangle edge length:
Automatic
An option button, selected by default, that specifies determining
the sampling step automatically.
Custom
An option button that allows specifying a sampling step. Specify
a value in the adjacent text box. The default value is 0.50 mm.
Figure 15.13 The effects of smoothing (a) and gap filling (b) on Data cross-sections.
(a)
(b)
The Standard sub-method section offers the following options for the Standard sub-
method:
Point clouds
A group label that offers parameters used when extracting on point cloud surface
Data objects.
Sampling step
A text box that specifies a point-to-point distance on the best-fit cross-
section. This value should be larger than the standard deviation of the
Data points, typically at least 3 times larger. When the value is larger,
noise in the Data points is better smoothed. The default value is 200 mm.
Smoothing (%)
A check box, cleared by default, that enables applying smoothing to Data
cross-section. The check box is cleared by default. When selected, a
smoothing factor can be specified as a percentage in the adjacent text
box. The default value is 50%. Smoothing allows reducing the effect of
noise in point cloud Data objects, which produces more accurate cross-
sections.
The Measure > Extract Measured command allows measuring deviations from the
measured cross-section component child to the nominal cross-section component
child, and generating color maps.
When measuring deviations, each vertex on a Data cross-section is considered. For each
vertex, the deviation is the distance to the closest point on the closest Reference cross-
section segment. When the vertex is above the Reference cross-section, the deviation is
positive, and when it is below the Reference cross-section, the deviation is negative.
The color map is created using the range of positive and negative deviations. Each
vertex is colored using its deviation, and the segment that joins any two vertices on a
Data cross-section has a color determined by the deviation of its two bounding
vertices.
The Cross-Sections page of the IMSurvey Options dialog box, shown in Figure 15.14,
offers general options for cross-sections.
The Default nominal component extraction parameters section offers the following
option:
Reference objects
A list box that allows specifying the Reference objects to use by default when
obtaining the nominal component by extraction. Choose from All (i.e., all
Reference objects) and Specific (i.e., all currently used Reference objects, and
allows specifying specific Reference objects in the property sheet). The default
value is All.
The Default deviation calculation parameters section offers the following options:
Max distance
A text box that specifies the maximum distance to use to calculate the measured-
to-nominal deviation. Points on measured cross-section components beyond the
distance are not measured. Valid values are greater than 0. The default value is
4 mm.
Offset
A check box that enables specifying a maximum angle in degrees between the
normal vector of a vertex on a cross-section child belonging to the measured
component and the normal vector of the closest point on the child cross-section
belonging to the nominal component that is within the Max distance value.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Max angle
A check box that enables specifying a maximum angle in degrees between the
normal vector of a vertex on a cross-section child belonging to the measured
component and the normal vector of the closest point on the child cross-section
belonging to the nominal component that is within the Max distance value.
This angle eliminates from the measurement results the vertices that have an
orientation incompatible with the matched location on the normal component.
Valid values range from 0 to 180. By default, the check box is selected and the
value in the text box is 45 degrees.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
Note that Section 15.10 Setting options for cross-sections in the IMSurvey Options
dialog box explains the options that allow viewing the comparison results.
Under revision: This section describes V11 operation(s). It will be soon updated for the
V12.1 operation(s). Updated documentation will be available to users in the upcoming
major and intermediate releases of PolyWorks 12.1. For summary information on this topic,
consult the document “What’s New in IMSurvey”, available from the Help menu of the
PolyWorks/IMSurvey module. For immediate information on this subject, please contact
your technical support personnel.
After cross-sections have been created, they become independent of the Data and
Reference objects used for their creation. Furthermore, each cross-section retains the
equation of its creation plane, which is necessary for any updating.
When a cross-section is updated, its existing children are deleted. Then, the 3D scene is
resliced using its creation plane, generating a new child cross-section for each sliced
Data/Reference object. The progress of the updating process is indicated by the status
bar. Note that when cross-sections are updated, any color map resulting from a
previous comparison operation is lost.
Cross-sections can also be updated manually using the Measure > Extract Measured
command.
When cross-sections are updated manually, a dialog box is displayed offering to match
Data objects to Reference objects. See Section 15.4.5.3 Matching Data objects to
Reference objects for more information.
Cross-sections may be automatically updated when the Auto-update list box on the
Cross-Section tab of a cross-section’s property sheet is set to Always or to On
Measuring and certain operations are performed. Those operations are the following:
When the Auto-update list box is set to Always, cross-sections are automatically
updated when any one of the operations listed previously occurs.
Figure 15.15 The dialog box used to match each Data object to a specific Reference object.
When cross-sections are updated manually, the dialog box shown to the left in Figure
15.15 is displayed, offering the following item:
If selected, the dialog box shown to the right in Figure 15.15 is displayed. Each
Data object is matched to a single Reference object chosen in the Matched
reference list by pressing the Next button, or the Done button when matching
the last unmatched Data object. Pressing the Done button dismisses the dialog
box and launches the operation.
Press the OK button to update the cross-sections, or press the Cancel button to end the
operation.
Measurement zones may be edited by changing their size, position, and orientation in
order to obtain better profiles. Note that the measurement zone always stays in its
initial plane. The editing may be done at creation time or as post-processing.
When in the editing mode, the measurement zone is bounded by a thick contour with
red handles at its corners. Editing is done using these borders and handles. Note that
standard mouse-based rotations/translations of the 3D scene can be performed.
The width of the measurement zone is determined when interactively creating a cross-
section, for example by anchoring points in the 3D scene. With some cross-section
creation methods, the width of the measurement zone is influenced by the height of
the bounding box of the 3D scene. The height is influenced by the depth of the
bounding box of the 3D scene, which includes all nonignored objects.
When temporary slicing planes are created, they are bounded by a rectangle, as shown
in Figure 15.16. Before cross-sections are computed, these measurement zones can be
edited interactively as follows:
Editing Instructions
Note that temporary slicing planes created as part of one same operation all undergo
the same editing, and that their measurement zones all have the same size, relative
position, and relative orientation.
After a cross-section has been created, its measurement zone can be modified by
displaying its property sheet and clicking the Cross-section tab. The measurement
zone’s height, width, center point, and height vector can then be directly modified by
way of the tab’s items.
Alternately, the Edit button of the Cross-section tab displays the measurement zone
with a thick contour and enables the mouse-based editing operations described in the
previous subsection.
cross-section, make it visible. If the Cross-Section Navigator tool is activated when the
editing mode is entered, it overlays the viewing mode. As a result, it is only possible to
view one measurement zone at a time, the currently selected one. While in the editing
mode, press the Undo button on the Standard toolbar to undo consecutive editing
operations. Press the ESC key to exit the measurement zone editing mode.
Once created, cross-sections are added to the Cross-Sections branch in the tree view
with their nominal and measured components (see Figure 15.17). If a cross-section is
hidden, its components are hidden as well.
The Select submenu of a Data or a Reference object’s shortcut menu in the tree view
offers a command that allows selecting cross-section children:
Figure 15.17 Cross-sections are saved to the Cross-Sections branch of the tree view with their
nominal and measured components.
The Edit > Delete submenu of a cross-section object’s shortcut menu, in the tree view,
offers a command that applies to measured components:
Measured Components
Deletes the measured component of the selected cross-sections, even the ignored
ones. Consequently, the measured children that make up each measured
component are deleted.
When a child cross-section is selected, a property sheet is displayed, shown to the right
in Figure 15.18, that allows:
Viewing and editing the Drawing type (see Section 24.3.9 Cross-section display
options) and Line width. The Line width may be set to Default (uses the value of the
Line width list box on the Display page of the IMSurvey Options dialog box) or to a
value between 1 and 5.
Viewing the Source object, which is the object that the cross-section slices. When a
child cross-section slices multiple objects, the name of the object at the source of the
cross-section is used.
Press the Apply button to transfer the new values to the application. The Close button
dismisses the dialog box. Section 15.4.5 Updating cross-sections explains how to
update cross-sections following changes made on their property sheet.
When a parent cross-section is selected, a property sheet is displayed, shown to the left
in Figure 15.18, that allows modifying the name and the color of the cross-section, as
well as viewing the layer to which the object belongs. Additional object properties are
offered by way of several tabs.
The Cross-section tab allows viewing the mathematical parameters of the slicing
plane. In addition, the dimensions of the measurement zone, which determines the
location where the cross-section is created, may be viewed and edited. For more
information, see Section 15.5 Editing the measurement zone of a cross-section.
The Annotation tab allows customizing the contents of an object’s annotation. For
complete information, see Section 22.2.3 Customizing the contents of an annotation.
The Display tab controls the display in the 3D scene. It offers the items that follow.
Figure 15.18 In (a), the property sheet for a parent cross-section. In (b), the property sheet for a
child cross-section.
(a) (b)
The Measurement tab allows viewing and modifying the creation parameters that
allow obtaining the measured component.
Method
A list box that specifies the method used to obtain the measured component of
the cross-section. The possible values are: Extract and Custom (i.e., created by
converting a polyline), and Undefined (no measured component has yet been
extracted).
Sub-method
A list box that allows specifying a sub-method.
The Extract method offers the Standard and the Compensate for 3D Deviation
sub-methods. The default value is Standard.
When the measurement method is Extract, the parameters are discussed in Section
15.4 Obtaining the measured component of cross-sections.
A mode is offered that allows displaying a cross-sectional view of the 3D scene and
creating a cross-section based on that view. To launch the mode, choose the View >
Section View command. This mode is documented in Section 9.5.2 Creating and
manipulating cross-sectional views.
The IMSurvey Options dialog box is accessed by choosing the Tools > Options
command.
A table report item for selected cross-sections may be generated under the Items
subbranch of the Reports branch of the tree view after measurement operations. Table
report items are fully configurable. For complete information on table report items, see
Section 20.2 Creating table report items.
Export
To export Section
format
The chapter also explains how to measure point-to-object and point-to-point distances.
The Report > Create Tables > From Objects operation allows creating a report from
selected Measurements in the Items subbranch of the Reports branch of the tree view.
While Measurements can be reported, they cannot be exported to a specific format,
such as text file.
Note that in the case of Measurements involving Reference objects with virtual
surfaces, the effective virtual surface is considered. For complete information, see
Section 23.6.4.1 Reference objects and virtual surfaces.
The Measure > Interactive Measurements > Basic command displays the dialog box
shown in Figure 16.1 that allows interactively measuring angles, distances, lengths and
radii. The dialog box’s items and measurement methods are explained in the
subsections that follow.
The dialog box can also be accessed by pressing the Basic Measurements button on the
Main Objects toolbar.
Points can be picked on Data and Reference objects, primitives, and cross-sections.
When a click occurs on a polygonal object, a CAD Reference object, or a cross-section,
the closest vertex is picked if the SHIFT key is down, or a point is interpolated
underneath the pointer if the SHIFT key is up.
A point can be picked on the display of a previously picked radius. The center of the
radius is obtained, and the picked point is placed at those coordinates. Performing
radius measurements is described in Section 16.1.1.3.2 Measuring radii.
The Create Basic Measurements dialog box offers three buttons that allow:
Picking a first set of points that define a line and then measuring point-to-line
distances.
Picking a first set of points used to fit a circle and then measuring point-to-circle
distances.
Note that when picking points, a pick on a picked radius obtains the center of the
Radius object as a picked point.
(a) 3D distance between (b) Distance along the X axis (c) Distance along the Y axis
points A and B. between points A and B. between points A and B.
A A A
B B B
For each point, the point-to-line distance is immediately displayed and saved as a
Measurement object in the tree view. If the point is not vis-à-vis the line, the line is
automatically extended to accommodate the display of the measured result.
Figure 16.3 Interactively measuring point-to-line distances. To the left, pick at least two points (A
and B). The line is best-fitted and drawn. To the right, pick a point, (C). The point-to-
line distance is automatically displayed.
B B
A A
The Create Basic Measurements dialog box offers three buttons that allow measuring
angles, lengths, and radii.
Figure 16.4 Interactively measuring point-to-circle distances. To the left, pick three or more
points. A circle is best-fitted and drawn. To the right, pick points. The point-to-circle
distance is automatically displayed.
1. Press the Angle button. The interactive Measure Angle mode is enabled.
As soon as a minimum of two points has been picked, a second line is best-fitted.
The angle between the two lines is displayed.
(a) Pick a first set of points (b) Pick a second set of points
defining a line defining a line. The angle is displayed.
1. Press the Radius button. The interactive Measure Radius mode is enabled.
2. Define a circle:
Figure 16.6 Interactively measuring radii. Pick a set of points defining a circle. As soon as a
minimum of three points has been picked, a circle is best-fitted and displayed along
with its radius. Right-click to keep the measurement.
3. Repeat if desired.
1. Press the Length button. The interactive Measure Length mode is enabled.
2. Pick two points on a connected section of the object (i.e., polyline, cross-section). If
the object consists of a closed contour, pick a third point to select the portion of the
contour to measure.
The chordal length between the picked locations is measured and displayed, and is
saved as a Measurement object in the tree view.
The Create Basic Measurements dialog box offers the Constrain distances along axis
check box that enables a group box of the same name (see Figure 16.1). When the
Constrain distances along axis check box is cleared, the distance is measured in 3D.
When Constrain distances along axis is selected, it makes available a list box that
allows setting a distance measurement constraint for point-to-point, point-to-line, and
point-to-circle measurements (see Section 16.1.1.2 Interactively measuring distances).
These methods use the current settings of the Constrain distances along axis group
box when a new measurement is performed. The list box offers the following items:
Figure 16.8 The Constrain distances along axis group box configured to define a custom vector.
i/j/k
Text boxes that define a constraining vector. Enter manually the i, the j, and
the k coordinates, or drag an axial primitive over any one of the text boxes.
Anchor Line
A button that enables an interactive mode that allows picking two screen
locations defining a measurement direction.
From Primitive
A button that converts a direction-based primitive into a measurement
direction.
Pick N Points
A button that enables an interactive mode that allows picking locations in
the 3D scene that are used to fit the measurement direction. Use the mode
as follows:
The Create Basic Measurements dialog box offers the Project onto plane check box
that enables a group box of the same name (see Figure 16.8) that allows projecting all
picked points onto a plane, in order to perform 2D measurements.
When the check box is selected, a list box is available that specifies a plane onto which
all points are projected prior to being considered by an angle, distance, or radius
measurement operation. Choose a standard plane (i.e., XY, YZ, ZX), a plane, or a cross-
section in the project. It also offers the Make 2D view check box that enables
transforming the viewpoint such that the projection plane is parallel to the viewing
screen.
The picked points are projected on the plane or standard cross-section selected as the
projection plane.
Angles and distances can be measured on long-range scans whose North corresponds
to the positive Y axis, with the results expressed in surveying terms.
The Measure > Interactive Measurements > Survey command displays the dialog box
shown in Figure 16.9 that allows measuring angles and distances. The dialog box’s
items and measurement methods are explained in the subsections that follow.
The dialog box can also be accessed by pressing the Survey Measurements button on
the Main Objects toolbar.
The Survey Measurements group box allows measuring angles and distances as
follows:
1. Set the desired measurements in the Angles group box (Azimuth, Bearing, and
Vertical) and/or the Distances group box (Horizontal, Vertical, and Slope). Their
labels are displayed in red to indicate changes that have not yet been applied.
2. Press the Pick 2 Points button. The labels are now displayed in black indicating
current values. An interactive mode that allows picking pairs of points is enabled.
Click to pick a point. The order in which the points are picked is important for the
azimuth angle and bearing angle measurements; see Figure 16.10 for an example.
Measurements specified in the Angles and Distances group boxes are calculated
and displayed. Each measurement is displayed in a different color and saved as a
Measurement object in the tree view.
1. Set the desired measurements in the Angles and/or the Distances group boxes.
Their labels are displayed in red to indicate unapplied changes.
2. Press the Apply Settings button to apply the changes; the labels are now displayed
in black indicating the current values.
See Figure 16.11 (a) for an example of the three possible angle measurements. See
Figure 16.11 (b) for an example of the three possible distance measurements. Note that
each measurement type is abbreviated in its annotation.
Figure 16.10 The order of the picked points is important in survey measurements. The azimuth and
bearing angles, AA and BA respectively, measured in these two examples use the
same points, but picked in an opposite order.
2nd 2nd
1st 1st
1st
1st
2nd
2nd
The Edit Measurements button enables an interactive picking mode that allows
picking and dragging parts of a Measurement display. Configuring the display is
explained in Section 16.1.4 Displaying measured values.
Proceed as follows:
Figure 16.11 In (a), an example of the three angle measurements, and in (b), the three distance
measurements for surveying applications.
1. Press the Edit Measurements button to launch the interactive Edit Measurements
mode.
On entering the mode, all nonrelevant object annotations are temporarily hidden.
2. Left-click and hold the mouse button on a part of a measurement display to drag it.
Parts of a Length Measurement display cannot be dragged.
3. Left-click and hold the mouse button on an annotation to drag it. Note the
following:
5. Click the Diameter button next to a radius annotation to switch between Diameter
display and Radius display.
All Measurements are displayed in the 3D scene. As shown in Figure 16.12, there are
specific drawings for each type of measurement.
The Display options section of the Create Basic Measurements and the Create Survey
Measurements dialog boxes allows controlling the display of a measured value in the
3D scene. The section offers the following items:
Display contents
A list box that controls the display of a measured value in the 3D scene.
Measurement annotations are composed of an index number followed by a colon
(:), the first letter of the type of measurement, and a measured value (e.g., 6 : D
22.343). The list box offers four display options: Deviation Only (displays the
measurement deviation value; for basic measurements only), Index Only (displays
the objects index number), Index and Value (displays the index number and the
measured dimension), and Value Only (displays only the measured dimension).
Figure 16.12 Display of drawing types for angle, distance, length, and radius measurements.
3D text
An option button, selected by default, that specifies displaying
measurement content items as 3D text. When the text cannot be
displayed because of its size, an annotation is automatically created to
display it.
Annotation
An option button that specifies displaying measurement content items
as annotations.
Horizontal
An option button, selected by default, that specifies displaying the
annotations horizontally.
Same as measurement
An option button that specifies displaying the annotations in the
measurement direction.
Radius
An option button that specifies displaying the circle radius.
Diameter
An option button that specifies displaying the circle diameter.
Apply
A button that transfers the values to the application.
The Last measurement is always specified in the text box at the top of the Create Basic
Measurements dialog box. Once a basic measurement has been performed, the string
will change to one of the following, specifying the type of measurement performed:
Last measured distance, Last measured angle, Last measured length, and Last
measured radius.
The properties of a Measurement object can be viewed by selecting it and choosing the
Edit > Object Properties command, or by double-clicking it in the tree view.
The property sheet provides Name, Type, and Color properties as well as the
measured value of each Measurement; see Figure 16.13 for an example.
The property sheet for basic Measurements also offers a Use nominal value group box
that allows comparing a measured value to a nominal value. Specify a Nominal
measurement value and press the Apply button. The deviation will automatically be
calculated in the Deviation text box.
Press the Apply button to transfer any changes to the application. Press the Close
button to dismiss the dialog box.
Reporting
Figure 16.13 The property sheet of an angle measurement (a), and the one for a survey
measurement (b).
(a) (b)
On choosing the command, the dialog box shown in Figure 17.14 is displayed. It offers
the following items:
Direction
A list box that specifies a distance computation method to use when measuring
between points and a reference surface, or points and the boundaries of Reference
objects. Choose from the following:
Shortest to Boundary – For each measured Data point, the closest point on
a Reference object’s boundary trim curve or a primitive’s surface or curve (for
curve-based primitives) is found and the total point-to-curve distance is
computed.
Normal to Boundary – For each compared Data point, the closest point on
a Reference object’s boundary trim curve or a primitive’s surface or curve (for
curve-based primitives) is found, and then only the normal component of
the distance is retained, based on the surface normal vector at the closest
point. This type of distance is signed. If positive, the point is above the
surface, otherwise it is below the surface.
Tangent to Boundary – For each compared Data point, the closest point on
a Reference object’s boundary trim curve or a primitive’s surface or curve (for
curve-based primitives) is found, and then only the tangent component of
the distance is retained, based on the surface’s tangent plane at the closest
point. This type of distance is signed. If positive, the point is outside the
surface, otherwise it is within the surface.
The Parameters section offers the following items for certain measurement methods.
Axis
A list box, offered for the Along Axis measurement direction method, that allows
specifying an axis along which to measure deviations. Choose from the standard
axes (i.e., +X, -X, +Y, -Y, +Z, -Z), (Custom Vector), and available axial primitives. The
default value is +X. When (Custom Vector) is chosen, the following items are
displayed to allow defining an axis:
i
A text box that allows specifying the i coordinate of the axis. The default
value is 1.0.
j
A text box that allows specifying the j coordinate of the axis. The default
value is 0.0.
k
A text box that allows specifying the k coordinate of the axis. The default
value is 0.0.
Ignore – Ignores the Data points. When a Data object is larger than the
Reference object, or misaligned, this choice allows restricting the
measurement to the portion of the Data object located over the Reference
surface. The default value is Ignore.
This item is only offered for the Shortest measurement direction method.
Offset
A check box that enables specifying a value to be used to virtually offset the
Reference objects or primitives (with respect to their in-space orientation). A
positive offset would then result in smaller positive deviation values, as if the offset
value was subtracted from the measurement results prior to visualizing and
reporting them.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Pick points by clicking. If necessary, a point is interpolated on the surface. Press the
SHIFT key while clicking to pick the nearest existing point.
The minimum distance between each picked point and the selected objects is
computed. A tabular report preview is displayed as well. See Figure 17.15 for an
example.
If desired, press the SPACEBAR to temporarily exit the mode and rotate/translate the
3D scene.
The object selection can be changed in the tree view, and the picking may continue.
Measurements to the selected objects are displayed and appear in the report as well.
The tabular report is automatically closed and saved under the Items subbranch of
the Reports branch of the tree view.
The results are displayed in the 3D scene and written to a tabular report. The on-screen
results are displayed using the Point-to-Object Measurement color; see Section 24.3.3
Interface color display options for more information on editing interface colors.
Figure 17.15 Points are picked interactively on a Reference object, and the distance between the
points and the selected object, circle 1, are displayed in the 3D scene (a), along with a
preview of the report contents (b).
(a)
(b)
When a primitive’s in-space orientation is internal, a Data point inside will result in a
positive distance value, and a Data point outside will result in a negative distance
value.
When a primitive’s in-space orientation is external, a Data point outside will result in
a positive distance value, and a Data point inside will result in a negative distance
value.
Pick points by clicking on objects or object elements. When clicking over a surface, a
point may be interpolated on the surface. To pick the nearest existing point while
clicking, press the SHIFT key.
After each pair of picked points, the 3D distance between the two points is
computed and displayed in the 3D scene, as shown in Figure 17.16 (a). While points
are picked, a tabular report preview is built on the screen, as shown in Figure 17.16
(b).
Middle-click to remove the previously picked point pair from the report.
The tabular report is automatically closed and saved under the Items subbranch of
the Reports branch of the tree view.
The on-screen results are displayed using the default Point-to-Object Measurement
color; see Section 24.3.3 Interface color display options for more information on editing
interface colors.
Reporting
Figure 17.16 Two points are picked interactively, and the distance between the two is displayed in
the 3D scene (a), along with a preview of the tabular report contents (b).
(a)
(b)
18.1 Introduction
The Measure > Volume command allows measuring volumes between Data objects and
a reference plane, or between Data objects.
It is possible to specify a reference plane and a contour from which volumes are
measured.
On choosing the command, the Measure Volume dialog box, shown in Figure 18.2,
appears.
2. Specify a volume measurement method in the Method list box. Choose from:
Data to Plane – Measures the volume between the specified Reference plane
and the nonignored Data objects, within a delimited area (Contour).
3. Specify the parameters for the method. See Section 18.3 Specifying parameters.
If a parameter value is changed in the dialog box, press the Preview button again to
update the preview. See Figure 18.1 for an example of a volume measurement
between Data objects.
When no preview has been displayed, press the Measure button to perform the
volume measurement operation.
When a preview has been displayed, press the Confirm button to confirm the
volume measurement.
Figure 18.1 A volume measurement between two Data objects. Material in green is the positive
difference in volume, while material in red is the negative difference in volume.
Reference plane
A list box that allows specifying the plane used to define the orientation with
which volume measurements are computed. Choose a standard plane (i.e., XY, YZ,
ZX) or an existing plane primitive. The default value is XY.
The volume is measured perpendicularly, from the plane to the first intersected
data point or polygon. When measuring, undercut data is not considered. The
plane orientation therefore directly affects the measurement results, as shown in
Figure 18.3.
Contour
A list box that allows specifying a primitive that, once projected on the specified
Reference plane, defines the volume measurement contour. Only the data points
or polygon vertices within the contour are considered for the volume. Choose
from an existing polyline or curve-based primitives. The default value is the first
available primitive.
Direction
A list box that allows specifying the measurement direction with respect to the
Reference plane. A volume can be measured on either side of the plane. Choose
from Above Plane (side normal to the plane), Below Plane (side opposite to the
plane normal), or Both Sides. The default value is Above Plane.
Sampling step
A text box that specifies the step used to measure the volume. Valid values are
greater than 0.0. The default value is 1.0 mm.
A grid is created on the reference plane, using the specified sampling step value.
Each grid square is extended towards the Data object forming a column. The sum
of the volume of each column results in the volume measurement. A smaller
sampling step value provides a more precise volume measurement. However,
when measuring a volume on a point cloud Data object, the sampling step value
Figure 18.3 The reference plane defines the orientation of the volume measurement. An
inappropriate orientation provides inaccurate volume measurements for both the
(a) Data to Plane and (b) Data to Data volume measurement methods.
(a) Data to Plane volume measurement method
Plane
Undercut data
not measured
Data 1 Data 2
Data 1
No volume Volume
difference difference
measured between the
between the two Data
two Data objects
objects
Data 2
Plane
must be greater than the average distance between data points, otherwise voids
are created between each column resulting in inaccurate results.
Fill holes
A check box that specifies automatically filling holes on the Data objects when
computing the volume measurement. By default, the check box is selected. When
selected, it makes available the following item:
Figure 18.4 The volume measurement when (a) considering and (b) ignoring Data point normal
information.
(a) Consider Data point normals (b) Ignore Data point normals
A
B1
A1 B
volume volume
Reference plane
Grid square Grid square
Each Data point is projected onto the reference plane to determine to which grid
square it belongs. For each Data point within a grid square, a point is computed at
the intersection of the vector starting at the center of the grid square and the
plane passing through the Data point and having the Data point normal. The point
closest to the reference plane along the vector is considered for the volume
measurement. See Figure 18.4 (a) for an example.
If the check box is cleared, the Data point closest to the reference plane is
considered for the volume measurement. See Figure 18.4 (b) for an example.
Positive volume
An uneditable text box that indicates the positive volume result. The result varies
depending on the specified measurement method (see Figure 18.5). Note the
following:
When the Data to Plane method is specified, the text box indicates the
volume value obtained on the side normal to the specified plane.
Figure 18.5 The resulting positive and negative volumes when measuring (a) a Data object to
plane, and (b) a Data object to a Data object.
Data object
Reference plane
Contour
Above plane
Reference plane
Second Data object
Below plane
Reference Data object
Contour
Positive value
Negative value
When the Data to Data method is specified, the text box contains the value
of the volume, where the data is further from the specified plane than the
reference Data object.
Negative volume
An uneditable text box that indicates the negative volume result. The result varies
depending on the specified measurement method (see Figure 18.5). Note the
following:
When the Data to Plane method is specified, the text box indicates the
volume value obtained on the side opposite to the plane normal.
When the Data to Data method is specified, the text box contains the value
of the volume, where the data is closer to the specified plane than the
reference Data object.
Total volume
An uneditable text box that indicates the sum of the positive and the negative
volume measurement results.
Signed volume
An uneditable text box that indicates the signed measurement value of the
difference between the positive volume and the negative volume.
Measurement results can be viewed as colors mapped on the Data points, colors mapped on the Reference
objects and primitives, or colored vectors attached to an object that point toward related Data points. An
advanced color scale editor allows the customization of the colors for a variety of purposes. Objects that do
not participate in the color map are displayed using a neutral color (e.g., No Result color).
The visualization of deviations is possible only when the Color Map object color mode is specified. When
Data objects are measured to other objects (e.g., Data or Reference objects, or primitives), the object color
mode is automatically set to Color Map.
To permanently save the changes made to the color map display options, save the project.
Figure 19.1 The Color scale tab controls the way deviations are converted to colors. Three
methods of converting deviations to colors are offered.
After having edited color scale parameters, press the Apply button to make the
modifications effective. The Close button dismisses the dialog box.
Several methods are provided to convert measured values to colors. The current
method is displayed using the color scale displayed to the right of the Color scale tab.
The Conversion to colors list box offers several methods. By default, the Use Object
Tolerances mode is chosen.
The Auto range method allows determining a color scale range automatically, or using
specified minimum and maximum values.
The Auto range method makes the Range limits group box, shown in Figure 19.1,
available. It offers options to configure the range limits to use for the color scale:
Automatic
An option, selected by default, that specifies calculating the range limits
automatically, based on the current maximum and minimum deviations. A color
scale is automatically created ranging from the minimum to the maximum
deviations.
Custom
An option that specifies setting specific range limits, using the following items that
are made available:
Max value
A text box that allows specifying the maximum value to use for the color
scale. The default value is the current maximum deviation. The Max
value must be greater than the Min value.
Min value
A text box that allows specifying the minimum value to use for the color
scale. The default value is the current minimum deviation. The Min value
must be less than the Max value.
The Use Customized Scale method enables the complete color scale editing
functionalities offered by the color scale editor, which is accessed by pressing the Edit
button. New color scales may be created to meet specific objectives. In this mode, six
preset color scale limits are used to define initial color scale areas. The color scale editor
is presented in Section 19.1.7 Using the color scale editor.
The Use Object Tolerances method displays results in relation to the tolerances of the
objects in play. The individual tolerances of each object and CAD surface are used.
Consequently, the color scale is not graduated, since each object and CAD surface can
have its own tolerance – only the boundaries of the tolerance ranges are indicated. This
mode is useful when performing pass/fail inspection on a CAD model object whose
tolerances have been previously defined.
The ranges used to generate deviation maps for the Use Object Tolerances color-
conversion method are specified in the tolerance templates, and applied to the
Reference objects or primitives and/or CAD model surfaces selected for measurement
to the data. For more information on tolerances, see Section 23.2.1 Editing the
tolerances of Reference objects.
The Scale type list box is used to specify the current color scale. A number of standard
color scales are offered. Color scales can be customized. By default, the Rainbow scale
type is selected in the list box.
The Symmetrical check box enables modifying the color scale so that the negative
part of the color scale is identical, from the minimum to the maximum values, to the
positive part of the color scale. Changes made to this option are immediately applied to
the color scale displayed to the right on the Color scale tab. The check box is cleared by
default.
The Color scale tab offers two items used to specify the display of color scale
graduations:
Font size
A text box that specifies the font size of color scale graduations. The default value
is 9 points.
The dialog box shown to the left in Figure 19.1 is displayed to specify the name of
the new scale.
As the color scale name is also used in a file name, certain characters cannot be used
in the name (*, “, ”, ?, /, \, <, and >), and the name is not case sensitive.
3. Press the Add button to continue, or press the Cancel button to end the operation.
A new color scale, derived from the current color scale, is automatically created in the
user’s personal color scale directory. This scale can be edited using the color scale
editor. It can also be deleted.
While a standard (STD) color scale cannot be deleted, a customized color scale (USR)
derived from a standard color scale can be deleted. After deletion of a customized color
scale, the color scale name remains available in the Scale type list box and refers to the
original standard color scale.
To edit the current color scale, press the Edit button on the Color scale tab, or click the
color scale to the right of the tab. The color scale editor, shown to the left in Figure 19.2,
is displayed.
The color scales can use up to 240 colors. The Number of free colors is shown at the
top of the dialog box.
Note that when mapping the deviation using the enhanced coloring method, a
maximum of 25 colors is allowed for the color scale (See Section 19.2.2 Mapping the
deviation on points and surfaces).
Figure 19.2 The color scale editor allows configuring each segment of the color scale. A segment
lies between two gray limit cursors, or a limit cursor and the end of the color scale. The
information currently displayed in the dialog box pertains to the selected segment.
Top
color Currently selected
segment
5 colors
Bottom
color
Limit cursor
When the Conversion to colors list box is set to Use Customized Scale, the color
scale’s limits are used to define the different segments of the color scale. The color scale
has six predefined limits: Positive max, Positive high, Positive low, Negative low,
Negative high, and Negative max. Each limit is represented by a gray cursor (see
Figure 19.3 (a)).
To configure the color scale to specific requirements, right-click over a cursor to display
the Limit Value dialog box. Modify the cursor value in the Limit value text box and then
press the OK button. The Cancel button ends the operation.
The editor’s Delete button allows reducing the number of segments in the Use
Customized Scale mode to the minimum of two. Deleting segments is discussed in
Section 19.1.7.6 Deleting a color segment.
Figure 19.3 When the color scale is set to the Use Custom Scale color conversion method, the
color scale editor allows modifying the value of the limit related to each segment. For
all color conversion methods and scale types, limit cursors can be moved, added, or
deleted, and the segments’ number and range of colors can be modified. Information
displayed in the dialog box pertains to the selected segment, if any.
(a)
(b)
Limit cursor
When the Conversion to colors list box is set to Use Customized Scale or Auto
Range, the comparison values outside the maximum positive and maximum negative
values are represented by the No Comparison color. The color is light gray by default.
The color can be edited; for more information, see Section 24.3.3 Interface color display
options.
A limit cursor’s position can be modified by picking it using the left mouse button and
dragging the cursor to a new position.
A color scale segment is the area of a color scale enclosed within two limit cursors, or
within a cursor and one of the color scale’s extremities. Within a color segment,
deviations are mapped linearly to colors. To edit a color segment in the color scale, click
over the segment. The Segment group box of the color scale editor is then updated to
display the properties of the currently selected segment. Each color segment is
represented by the following properties:
A Numbering scheme.
From a Bottom and a Top color, the Number of colors in the HSV color space is
automatically interpolated. When the color segment is made of a single color, only the
Bottom color is active.
The Top and Bottom colors are mapped as little squares in the color hexagon. They
may be edited in two ways:
Drag the sliders to the right of the Top and Bottom labels to specify the hue and
saturation properties of these colors.
Click the color box that is available for each item that allows specifying a precise
color (e.g., numerically). If a color specification is made in this way, the slider
mentioned in the preceding bullet is made unavailable.
To change the number of segment colors, enter a new value in the Number of colors
text box, and then press the ENTER key. The first and last segments of the color scale
can only use one color; the exception is when Scale type is set to Auto Range.
To change the numbering of the current segment, choose from the items offered in
the Numbering list box:
Use Step – Samples the segment at every increment specified in the Step text
box that is now available, and writes a number at each sampled location.
Figure 19.4 There are three ways of numbering any segment, with the exception of the first and
the last segments. The table to the right gives information on the numbering used for
three different segments of the displayed color scale shown below. The values
currently displayed in the Segment group box of the dialog box refer to the selected
segment, which also is the first segment with an arrow pointing to the table.
Number of
Numbering scheme/
colors/
segment
segment
4 Automatic
5 At Discontinuities
A color segment can be subdivided by selecting the color segment and then pressing
the Split button. A new segment is then created on top of the current segment. A new
smaller cursor is also created. This small cursor can be dragged.
To define a precise value for the cursor when the Conversion to colors list box is set to
Use Customized Scale, right-click to display the Limit Value dialog box, enter a value in
the Limit value text box, and then press the OK button (see Figure 19.3 (b)).
A color segment resulting from the subdivision of one of the main segments can be
deleted by selecting it and pressing the editor’s Delete button.
The Save button saves the edited color scale in the user’s personal color scale directory.
The Apply & Close button saves the edited color scale and dismisses the color scale
editor.
Measuring
After having edited the display parameters, press the Apply button to make these
modifications effective. The Close button dismisses the dialog box. To permanently
save the changes made to the color map display options, save the project.
A global option is offered for the Color map tab that enables/disables all of the other
items offered on the tab:
This option is automatically selected when a data color map is created or is made
active.
Deviation vectors can be displayed in the 3D scene. These vectors always start from the
Reference surface location that has been matched to a Data point by the measurement
process (see Figure 19.6). The correspondence between colors and deviations is
determined by the current color scale. The Deviation vectors group box of the Color
map tab controls the display of deviation vectors, and offers four items:
Deviation vectors
A check box, cleared by default, that enables displaying deviation vectors in the
3D scene. When selected, it makes available a group box of the same name that
offers the following items:
Proportional vectors
An option button, selected by default, that specifies that the length of all
rendered deviation vectors is proportional to the true deviation vectors
joining the Reference object or primitive to the measured Data points.
The direction of the displayed vectors is also the same as the true
deviation vectors’ direction.
Unit vectors
An option button that specifies that vectors of unit length are rendered.
Where the vectors point depends on the measurement direction:
Figure 19.5 The Color map tab offers display options for the color map .
Scaling
A text box that specifies a factor by which to scale the displayed vectors.
The default value is 1.
Press the Apply button or the ENTER key to transfer any changes to the application.
The Color map tab options control the mapping of deviations or values on Data points
and/or Reference objects or primitives. It contains the following items:
Figure 19.6 Deviation vectors join a Reference object to Data points. Here, proportional vectors
are used and the measurement direction is Shortest Distance.
Colored points
An option button that specifies displaying deviations by point for both
point cloud and polygonal Data objects. See Figure 19.7 (a).
Colored triangles
An option button, selected by default, that specifies that deviations are
displayed by polygon for polygonal Data objects (see Figure 19.7 (b)). In
the case of point cloud Data objects, deviations are displayed by point.
Figure 19.7 The mapping of deviations on the Data points belonging to measured polygonal
Data objects, displaying Colored points (a), Colored triangles (b), Enhanced coloring
(c), and Enhanced coloring with the Show contours option (d). In this example, the
conversion-to-color method for the color scale is set to Use Object Tolerances.
(a) (b)
(c) (d)
Enhanced coloring
An option button that specifies that the color information may be
displayed at a greater resolution than the objects’ triangles. When
necessary, triangle surfaces are subdivided to display color information
more accurately, thus providing a better approximation of the deviation
data on the map (see Figure 19.7 (c)). This option only applies to
polygonal Data objects.
Show contours
A check box that enables specifying that the boundaries between
the colored zones be determined more precisely for data object
color map contour generation (see Figure 19.7 (d)). The check box
is selected by default.
Polyline primitives can be generated from the Data Error Contours. For
more information, see Section 13.5.6.8.1 Creating polylines from data
error contours.
Note that the point size can be modified using the Point size list box offered by
the Object Display Options menu button on the 3D Scene toolbar.
Colored points
An option button, selected by default, that specifies that the deviations
are mapped as colored points onto the reference surface.
Colored triangles
An option button that specifies that each triangle of the Reference
surface is drawn using the color corresponding to the largest deviation
mapped on the triangle.
Note that the point size can be modified using the Point size list box offered by
the Object Display Options menu button on the 3D Scene toolbar.
The color map in the 3D Scene is rendered with a higher resolution when the
Colored points option is selected than when the Colored triangles option is
selected.
Shaded map
A check box that enables the shading and the illumination of the Data object color
map and the Reference object/primitive color map by light sources. The check box
is selected by default.
These report items can be included in reports generated in external document formats including Excel,
HTML, Word, or text formats (see Section 20.9 Generating reports in external document formats), and in
formatted reports (see Chapter 21 Creating Formatted Reports and Layouts).
This chapter explains how to create and visualize report items, and how to edit their appearance and
content.
Automatically
• Select report items and choose the Report > Create Auto-Formatted Report
command.
Manually
• Choose the Report > Create Formatted Report command and use the EZLayout tool
to create a formatted report that allows placing text, images, and report items and
saving a formatted report. A layout file can be generated from a formatted report
and used as a template to manually or automatically generate other formatted
reports.
Note: A formatted report contains the original report items so that their content (e.g.,
tabular reports) can be modified to add/remove fields of information at a later date.
formatted reports can be exported to PDF and HTML formats. Text field report items
cannot be used in formatted reports.
Formatted reports and layouts are described in Chapter 21 Creating Formatted
Reports and Layouts.
20.2.1 Introduction
When an operation is performed that can produce a table report item, all values for
individual information items (e.g., object name, mean, standard deviation) are
computed and kept within the table report item’s internal data structure.
Table templates are used to define a list of information items calculated for a type of
table report item. A template editor allows ignoring certain fields, changing their
relative order, and sorting lists and filtering results if the table produces a list of
information. Each table type has one or more standard table templates, and new ones
can be defined. One of those templates is the default template, used when creating
new table report items.
In addition, creation options are used to specify formatting information. Note that once
a table report item is created, these elements become properties of the table report
item and can be customized using its property sheet.
The followingoperations on the Report > Create Tables submenu generate one or more
new table report items under the Items subbranch of the Reports branch of the tree
view. As a general rule, the object name is created using the name of the related table
type.
From Objects
Creates reports for the selected objects. The type of each object is automatically
detected and the related report template is used to create report items. For certain
objects of the same type, only one global report is created, and for other objects
of the same type, a report is created for each object. See the table that follows.
Cross-sections
One global report for all same-
Measurements (Measurements branch)
type selected objects
Coordinate systems
Data alignments
A report item for each selected
Data color maps
object
Feature primitives
From All Color Map Point Annotations of Active Data Color Map
Creates a single report table from the color map point annotations of the active
data color map.
Global transformation
An option that specifies creating report
tables from the objects’ global
transformation matrices only.
Last transformation
An option that specifies creating report tables from the objects’ last
transformation matrices only. This option only applies to Data objects.
Both
An option, selected by default, that specifies producing reports from the
objects’ global transformation matrices and, for Data objects, the last
transformation matrices as well.
Press the Create button to launch the operation, or the Cancel button to end the
operation. Report tables have the name Matrix (Global or Last) - object_name.
To preview a table report item, open the Items subbranch of the Reports branch of the
tree view and double-click the report object. Table report items are assigned the
icon. See Figure 20.1 for an example of a table report item generated by a cross-section
measurement operation.
Default properties are assigned to table reports on creation. They control the
formatting to use and include formatting for titles and cells. They are offered on the
Report > Tables page of the IMSurvey Options dialog box. For complete information,
see Section 24.8.2 Table report options. To access the IMSurvey Options dialog box,
choose the Tools > Options command.
When an operation is performed that can produce a table report item, all values for the
information items for that table type are computed and kept within the table’s internal
data structure.
Table templates are used to define a list of information items that are calculated for a
type of table report item. Each table type has one or more standard table templates –
there are standard table templates for all operations that result in the creation of a
tabular report. Standard table templates can be edited and new table templates can be
defined. Each table type has a default table template that is used when creating new
table report items.
Table templates are completely configurable. A template editor allows ignoring certain
information items, changing their relative order, and sorting lists and filtering results if
the table produces a list of information.
20.2.5.1 Editing table templates with the IMSurvey Options dialog box
The Templates page of the IMSurvey Options dialog box allows creating and
modifying templates for table report items; for complete information, see Section
24.8.2.1 Table template options. To access the page, choose the Tools > Options
command to display the options dialog box and click, in order, Reports, then Tables,
then Templates.
On creation, a table report item of a table type contains the following information:
Values for all of the information items offered by templates for that table type. This
information is stored in a table report item’s internal structure. All of the information
contained in the default template. This information is available on the property
sheet’s Report item tab. It can be viewed and customized.
The item’s creation options. This information is available through the property
sheet’s Format tab. It can be viewed and customized.
To access a report item’s property sheet, open the Items subbranch of the Reports
branch of the tree view, click the item representing the table, and choose the Edit >
Object Properties command. The property sheet for tables is displayed (see to the left in
Figure 20.2). Any changes made may be transferred to the application by pressing the
Apply button.
The Report item tab allows specifying the update properties and the contents for the
table report item (i.e., the status of information items, and sort rules and filter rules if
any). See Figure 20.2. For more information on the Automatic project update, see
Section 3.1 Automatic project update. The top section of the tab contains the following
update items:
Updatable
A check box, available only for updatable table report items, that enables updating
the table report item. When selected, it makes available the following items to
configure the update operation:
Coordinate system
A list box that allows editing the coordinate system to which the table report item
is linked for update purposes. Choose from (Active) and any other available
coordinate system. When (Active) is selected, table report items are updated
when the coordinate system is changed. Note the following:
The property sheet of data alignment table report items displays the
Coordinate system item as a view-only text box.
Data alignment
A list box that allows editing the data alignments to which the table report item is
linked for update purposes.
When there is only one alignment group, the Data alignment list box offers to
choose from the (Active) data alignment and any other available data alignment.
When there is more than one alignment group, the Data alignments list box
offers to choose from Active or Specific. When set to Specific, the dialog box
offers a list with the following columns:
Alignment Group
A column that lists the name of each alignment group. The name is not
editable.
Data Alignment
A column that lists, for each alignment group, a list box that allows
selecting a data alignment to which the table report item is linked.
For all alignment groups the reported data alignment is part of, the table
report item is always linked to the data alignment for which the table was
generated. For other alignment groups, the table report item is linked to the
alignment that was active for the group when the data alignment table
report item was created.
On the property sheet of data alignment table report items, the Data
alignment text box is set to specific and is not editable. The Alignment
Group and the Data Alignment columns are not editable as well.
The Contents section of the Report item tab allows specifying the contents for the
table report item (i.e., the status of information items, and sort rules and filter rules if
any). It contains three items:
Edit
A button that displays the dialog box shown to the top right in Figure 20.2. It
allows editing the current content specification for the table report item. This
includes changing the status of selected information items using the Use and
Ignore buttons, and changing the order of selected information items using the
dialog’s Up arrow and Down arrow buttons. A preview window is displayed as
well that displays the report type with respect to the current content specification
- it allows visualizing the editing, and can be closed by pressing the Close button.
When the dialog box offers the Sort and Filter tabs, sorting rules and filter rules
can be edited, created, and deleted. For information on sort rules, see Section
24.8.2.1.3 Adding sorting rules. For information on filter rules, see Section
24.8.2.1.4 Adding filter rules.
Assign Template
A button that allows assigning a new template definition to the table report item.
On pressing the button, the second dialog box shown to the right in Figure 20.2 is
displayed. It offers a list of templates for the type of table report item. Choose a
template and press the OK button. The template definition is copied to the table
report item’s properties.
Publish
A button that allows creating a user template for that type of table report item
from the table report item’s current content definition. The Add Template dialog
box, shown in the middle of Figure 20.2, is displayed. Specify a value in the Name
text box and press the Add button. The name must not contain characters that are
considered invalid in file names, and must not be the same as the name of an
existing template for the same table type.
The Format tab allows specifying title and cell formats. It offers the items that follow.
The Title check box, when cleared, disables the display of the table title as well as its
export to external formats. When selected, it enables the display of the table title as
well as its export to external formats. In addition, it makes available a group box that
offers the following items to customize the appearance of table titles:
Alignment
A list box that specifies the text alignment within table cells. Choose from Left,
Center, or Right.
Font
A list box that specifies the font type.
Size
A list box that specifies the font size. A series of values are offered between 6 and
72.
Bold
A check box that enables this aspect of the font style.
Italic
A check box that enables this aspect of the font style.
Underline
A check box that enables this aspect of the font style.
The Cell format group box offers the following items to customize the appearance of
the cell contents:
Alignment
A list box that specifies the text alignment within table cells. Choose from Left,
Center, or Right.
Font
A list box that specifies the font type.
Size
A list box that specifies the font size.
The Caption tab contains an area that allows specifying a table caption. It offers one
item:
Caption
A text area that specifies a caption. Captions are not displayed in a table report
item preview. Note that when a table report item is included in a formatted report,
its caption is not transferred to the formatted report.
A button located at the bottom of the dialog box allows previewing the table report:
Preview
A button that displays a preview of the table report using the current properties.
To see the table with the changes made to the Table tab, press the Apply button.
Note that caption text is not displayed in preview mode. To close the table report
preview, press the Close button.
Most snapshots are saved with project view information (see Section 9.7.4 Viewing
project views for detailed information on project views). This information is used when
performing update and restore operations (see Section 20.3.6 Restoring a project view
from a snapshot report item for more information).
Note that snapshots imported from a file (see Section 20.3.2.4 Creating a snapshot from
an existing image file), as well as snapshots taken in certain interactive modes (e.g., 1
Point Pair alignment, Edit measured Data Points) do not have this information.
Default properties are assigned to snapshot report items on creation. They are offered
on the Reports > Snapshots page of the IMSurvey Options dialog box. For complete
information, see Section 24.8.1 Snapshot report options. To access the IMSurvey
Options dialog box, choose the Tools > Options command.
The Report > Create Snapshots submenu offers commands that allow creating
snapshots of the 3D scene.
The Report > Create Snapshots > Capture 3D Scene command takes a snapshot of the
contents of the entire 3D scene and adds it to the Items subbranch of the Reports
branch of the tree view.
The Report > Create Snapshots > Capture 3D Scene Region command allows capturing
snapshots of a section of the 3D scene. On choosing this command, a white capture
frame appears in the 3D scene and the dialog box, shown in Figure 20.3, is displayed
offering the following items:
Figure 20.3 The dialog box used to capture a snapshot of a 3D scene region.
Top
A text box that specifies the number of pixels from the top 3D Scene pane
border where the capture region will be positioned. Specify a value
greater than or equal to 0.
Left
A text box that specifies the number of pixels from the left 3D Scene pane
border where the capture region will be positioned. Specify a value
greater than or equal to 0.
Height
A text box that specifies the height of the capture region, in pixels.
Width
A text box that specifies the width of the capture region, in pixels.
Maximize
A button that maximizes the capture region over the entire 3D scene.
The size and location of the 3D scene region can also be edited manually:
Left-click a region corner to simultaneously drag the height and the width.
The last specified location and dimension of the 3D scene region will be specified the
next time the Capture 3D Scene Region command is chosen.
In the 3D scene region capturing mode, 3D scene manipulations are possible as long
as the region frame is not clicked.
Press the Capture button to capture a snapshot of the 3D scene region. The snapshot
report item is automatically added to the Items subbranch of the Reports branch of the
tree view.
The Report > Create Snapshots > Capture All Cross-Sections command creates snapshots
of nonignored cross-sections. Note that hidden cross-sections appear in the resulting
snapshots.
On choosing the command, cross-sections are displayed one by one in the Object
Navigator mode, in 2D view, and a snapshot is taken of each cross-sectional view. The
new snapshot report items are created under the Items subbranch of the Reports
branch of the tree view.
The Report > Create Snapshots > From File command allows creating snapshots from
external image files.
On choosing the command, an image browser is displayed. Specify a File name and
location, and choose an image format in the Files of type list box. Choose from:
Microsoft’s Bitmap Files (.bmp), JPEG Files (.jpg, .jpeg), SGI Files (.rgb), and TIFF
Files (.tif). Press the Open button to launch the operation. The external image file is
read and added to the Items subbranch of the Reports branch of the tree view. Press
the Cancel button to end the operation.
Note that snapshots created from file do not contain 3D scene information. As a result,
update or restore operations cannot be performed using these snapshots (see Section
20.3.6 Restoring a project view from a snapshot report item).
Double-click a snapshot report item under the Items subbranch of the Reports branch
of the tree view opens the snapshot image in the default image viewer.
The Report > Edit Snapshot command enables an interactive mode that allows editing a
selected snapshot. On choosing this command, the snapshot’s original project view is
automatically restored, the snapshot is displayed in the in the 3D scene, and a white
capture frame appears. When editing a snapshot of a cross-section, the snapshot is
displayed in the Object navigator mode in 2D view. The dialog box shown in Figure 20.4
is also displayed, to allow modifying the snapshot’s 3D Scene region (pixels) (see
Section 20.3.2.2 Taking snapshots of a 3D scene region), and the Snapshot size (see
Section 20.3.1 Setting related options). While editing a snapshot, it is possible to select
elements interactively using the Select > Elements > Interactively command.
Once the required parameter values have been specified, press the Recapture button.
The snapshot is edited using the newly specified region and size and project view
object visibility options.
Once the operation is complete, the 3D scene is not restored to its previous state (see
Section 20.3.6 Restoring a project view from a snapshot report item for more
information on restoring the project view).
The Report > Assign Current Color Scale to Snapshot command allows assigning a color
scale to selected snapshots with project view information. For more information on
project views, see Section 9.7.4 Viewing project views. On choosing this command, the
current color scale is automatically applied to the selected snapshots.
Note that if the Automatic project update mode is deactivated, a manual update
operation is launched to update the snapshots using the newly assigned color scale.
For more information on automatic project updates, see Section 3.1 Automatic project
update.
A selected snapshot’s project view can be restored using the View > Restore Project View
from Snapshot command. On choosing this command, the selected snapshot’s project
view information is automatically restored (see Section 9.7.4 Viewing project views). If
the snapshot was captured in the Object Navigator mode or the 2D Vector Graphic
mode, the mode is activated as well. Note that the restore operation also considers the
selected snapshot’s Update & restore options (see Section 20.3.1 Setting related
options for more information).
Export operations are offered on the File > Export submenu. Exporting snapshot report
items is described in Section 25.16.4 Exporting snapshot report items.
The properties of a snapshot can be viewed by selecting the object and choosing the
Edit > Object Properties command. The properties of snapshots are presented on two
tabs.
The top section of the Report item tab, shown in Figure 20.5 (a), allows specifying
update options. For more information on the Automatic project update mode, see
Section 3.1 Automatic project update. It offers the following items:
(a)
(b)
Updatable
A check box, available only for updatable snapshot report items, that enables
updating the snapshot report item. By default, the check box is selected. When
selected, it makes available the following list boxes:
Coordinate system
A list box that allows editing the coordinate system to which the snapshot report
item is linked for update purposes. Choose from (Active) and any other available
coordinate system. When Active is selected and the Automatic project update
mode is active, snapshot report items are updated when the coordinate system is
changed.
Data alignment
A list box that allows editing the data alignments to which the snapshot report
item is linked for update purpose.
When there is only one alignment group, the Data alignment list box offers to
choose from the (Active) data alignment and any other available data alignment.
When there are more than one alignment groups, the Data alignments list box
offers to choose from Active or Specific. When set to Specific, the dialog box
offers a list with the following columns:
Alignment Group
A column that lists the name of each alignment group. The name is not
editable.
Data Alignment
A column that lists, for each alignment group, a list box allowing to select
a data alignment to which the snapshot report item is linked.
The Size section indicates the snapshot’s current Height (pixels) and Width (pixels).
The Object visibility section offers items that allow editing the visibility status of
objects when restoring a project view (see Section 20.3.6 Restoring a project view from
a snapshot report item).
The Data objects list box controls which Data objects are visible in the snapshot. Valid
values are: Surface (all surface Data objects), Boundary (all boundary Data objects), All
(all Data objects), Captured Objects (only the Data objects that were were visible when
the snapshot was captured and all their elements), and Captured Elements (only the
Data objects that were visible when the snapshot was captured and their visible
elements).
Press the Edit button to edit the snapshot. The dialog box shown in Figure 20.4 is
displayed. It allows modifying the dimension of the 3D Scene region captured by the
snapshot (see Section 20.3.2.2 Taking snapshots of a 3D scene region for more
information), and the Snapshot size (see Section 20.3.1 Setting related options for
more information). Press the Recapture button to update the snapshot.
Press the Preview button to display a preview of the snapshot image in the Windows
Photo Viewer.
Press the Apply button to transfer the changes to the application. Press the Close
button to exit the dialog box.
The Word/Excel/HTML export tab, shown in Figure 20.5 (b), allows applying the
following changes to the snapshot’s properties when exporting the snapshots to Word,
Excel, or HTML.
Sets the image alignment in the inspection reports using the Alignment list box,
which offers three items: Left, Center, and Right.
Sets the scaling factor to grow or shrink images during an export to Excel, HTML, or
Word by way of the Scaling group box.
When the Scaling check box is cleared, the original snapshot dimensions are
preserved.
When the Scaling check box is selected, the Height (%) and Width (%) text
boxes are made available. They allow entering two coefficients that multiply the
snapshot’s current height and width.
Pie chart objects are created under the Items subbranch of the Reports branch of the
tree view. Their name is based on the chosen menu item (e.g., Pie Chart - Cross-
Sections).
Pie charts can be viewed in the pie chart viewer, exported to Microsoft Excel, and
included in formatted reports.
Choose a command on the Report > Create Pie Charts submenu to generate a pie chart
from the active Data color map or from selected measurement objects that contribute
to a color map. Selected measurement objects (e.g., cross-sections) must be visible and
must contribute to a color map (i.e., have calculated deviations) to generate pie charts.
Note that Color map must be selected in the display options of an object category for
objects in that category to contribute to a color map.
A pie chart is shown in Figure 20.6. A pie chart always represents one type of
measurement, in this example 3D deviations stored in a data color map created by the
Measure > Deviation of Data Objects > From Reference Object Surfaces operation. Note
the following:
The associated color scale is divided into ranges, and each slice of the pie chart
corresponds to a range, with the color of the range.
The relative size of the slice depends on the number of values that fall into the range.
Annotations can be displayed for each slice indicating the range and the percentage
of points in that range.
Selected cross-sections result in only one pie chart as only the largest deviation,
positive or negative, is used for each.
The following commands on the Report > Create Pie Charts submenu allow creating pie
charts:
From Cross-Sections
Creates a pie chart from the largest deviation of the selected cross-sections.
Figure 20.6 The pie chart viewer. Each annotation describes the percentage of values that are
found in the displayed range. The size of each slice represents the relative importance
of the percentage value.
To view a pie chart, double-click a pie chart object under the Items subbranch of the
Reports branch, or click the Preview button on the Report pie chart tab of a pie chart’s
property sheet. The pie chart viewer, shown in Figure 20.6, is displayed. It features a
display area preceded by the following items:
Show annotations
A check box that enables displaying an annotation for each slice of the pie chart.
An annotation may display a range of the color map within which the related
value(s) are located, if the color map is displayed with numerical values, and a
percentage which represents the number of values in the range with respect to
the total number of values. By default, the check box is selected.
Snapshot
A button that allows saving a snapshot of the display area to the Items subbranch
of the Reports branch of the tree view.
It is possible to rotate the pie chart in the display area using the mouse. The pie chart
remains centered and the annotations may change their positioning in the display area.
To dismiss the viewer, press the Close button on the title bar.
The property sheet for pie charts, shown in Figure 20.7, offers a Report pie chart tab
that features a Preview button. Pressing the button displays the pie chart viewer. See
Section 20.4.2 Viewing pie charts for more information.
Note that Section 24.4.3 Annotation template options offers detailed information on
editing annotation templates.
Selected pie chart report items can be exported directly to Microsoft Excel as native
Excel pie charts.
Export operations are offered on the File > Export submenu. Exporting to Excel is
described in Section 25.16 Exporting report items.
A text field object can be used as a section title in a generated report. It may also be
displayed within an annotation and be attached to a 3D location, which is useful for
documenting a snapshot of the 3D scene.
There are two commands that allow creating a text field object. Choose the Report >
Create Text Field command or choose the Tools > Annotations > Create > Text Annotation
command. The dialog box shown in Figure 20.8 is displayed. It offers an area for
entering text, up to 32,767 characters. The current number of characters is displayed on
the title bar. The dialog box also offers the following items:
Annotation
A check box that enables displaying the text field within an annotation.
Attach
Enables an interactive mode that allows attaching visible text field annotations to
picked 3D locations. Valid 3D locations are Data and Reference objects, primitives,
and cross-sections. To facilitate the picking, annotations of other object types are
hidden. In this mode:
If desired, press the SPACEBAR to temporarily exit the mode and perform
translations/rotations.
The mode can be exited without performing the attachment by pressing the ESC
key, or is exited automatically once a location is picked. Launching this mode
closes the creation dialog box. The attachment point is retained in the object’s
properties. The button is only available when the Annotation check box is
selected.
Figure 20.8 The dialog box used to create text field objects.
Attached
A check box that controls the display of the attachment line. It is only available
once the object’s annotation has been attached to a location.
Press the OK button to create the object with the current specifications, or the Cancel
button to ignore the specifications, resulting in an empty object. When a text field
object is created, certain creation properties are assigned to the object; for more
information, see Section 20.5.3 Specifying text field options in the IMSurvey Options
dialog box. The annotation background color is determined by the Text Field color
specification; for more information, see Section 24.4.1 Annotation appearance options.
New text field objects are added to the Items subbranch of the Reports branch of the
tree view.
To see/edit the contents of a text field object, open the Items subbranch of the Reports
branch of the tree view and double-click the item representing the text field. A dialog
box like the one in Figure 20.8 is displayed. The editing operations are the same as the
creation operations, explained in Section 20.5.1 Creating a text field object.
20.5.3 Specifying text field options in the IMSurvey Options dialog box
Options for text field objects are specified by way of the Text Fields subpage of the
Reports page of the IMSurvey Options dialog box; for complete information, see
Section 24.8 Report options. To access the page, choose the Tools > Options command
and click Reports. The options specify how the text will look when it is included in a
generated report in an external document format.
The property sheet allows customizing a text field object. Open the Items subbranch of
the Reports branch of the tree view, select the item representing the text field, and
choose the Edit > Object Properties command. The property sheet, shown in Figure 20.9,
is displayed.
In the Report text field tab, specify text properties for display in an exported report
format through the Text properties group box:
Specify the text alignment, font, and size, using the Alignment, Font, and Size list
boxes.
Specify the font style using the Bold, Italic, and Underline check boxes.
Edit the Attached property that controls the display of the attachment line. If the
object’s annotation was not attached, this item is made unavailable.
Control the display in the 3D scene using the Annotation check box.
Press the Apply button to transfer the changes to the application. Press the Close
button to dismiss the dialog box.
It is possible to remove or change a text field annotation’s attachment point. For more
information, see Section 22.2.6 Attaching text annotations to 3D locations.
In the 2D Vector Graphic mode, the 2D Vector View Background - Bottom and the 2D
Vector View Background - Top colors are used for the background color, which are set
to white by default. For more information concerning interface colors, see Section
24.3.3 Interface color display options.
The Report > 2D Vector Graphic submenu offers commands that allow capturing the 3D
scene, as well as a submenu with commands that allow exporting 2D vector graphic
report items to various standard formats.
The Report > Create 2D Vector Graphic command takes a vectorial scene snapshot and
saves it to the Items subbranch of the Reports branch of the tree view.
Export operations are offered on the File > Export submenu. Exporting 2D vector
graphics is described in Section 25.16.6 Exporting 2D vector graphics.
2D vector graphic report items have a property sheet that features a Report 2D vector
graphic tab that contains no items.
Create the video report object by specifying parameters that control the taking of
snapshots and the generation of an animated scene.
Export the completed video report to an .avi or an .exe (with the IMMedia viewer
included) file format.
View the animated report with a viewer; the IMMedia viewer is recommended as it
has functions adapted to the display of annotations.
Note that once the first step in the process is completed, and the video object is
created, individual scenes may be added to, and subsequently edited in, the video
report at any time.
As a result of this process, a video object will be created under the Items subbranch of
the Reports branch of the tree view, with scene children; each scene may have text
caption and audio comment children (see Figure 20.10). This chapter presents all of the
tools necessary to construct an animated report.
20.7.1 Introduction
Scenes are the main objects that constitute a video report. For each scene, the 3D scene
must first be set by making visible selected objects, such as Reference and Data objects,
primitives, annotations, and data color maps. Then, the scene-creation mode is invoked
in which mouse-based rotation and translation operations can be performed. Note that
some menu/object operations may cancel this mode, while others are refused. While it
is possible to hide objects or change the visibility of 3D objects between poses, this has
absolutely no effect on the scene – only the last pose’s characteristics are used to
generate the complete scene. As well, any annotation text in the 3D scene will only be
visible when viewing the video report with the IMMedia video player.
Figure 20.10 Here is a video object with three scene children. Scene 1 has an audio comment child
and a text caption child.
keyframe, the objects are manipulated in the 3D scene and a second pose is taken. For
example, consider Figure 20.11. The user making the video report proceeds as follows:
1. Make visible the desired object in the lower right corner of the 3D scene pane.
4. Displace and rotate the object in the 3D scene, and record the second pose –
KeyFrame2.
5. Repeat this step until all the key frames for the current scene have been recorded.
6. Individual key frames may then be edited by changing their position with respect to
the other key frames, or by deleting them.
A scene is generated by creating all the individual images that will comprise the
animated scene. The first key frame pose will show in the 3D scene for the duration of
KeyFrame1. A smooth animation is then created for the duration time of Interval1 by
generating images linking the pose in KeyFrame1 to the pose in KeyFrame2, at a rate of
x frames per second (specified by the user). This applies to each key frame and interval,
resulting in an animated scene. A scene object is added to the parent video object in
the Items subbranch of the Reports branch of the tree view.
Audio comments or text captions may then be added to a group of key frames within a
scene.
Figure 20.11 Scene elements. The durations shown are the default values.
Entering the scene-creation mode to create the first scene – note that this dialog box
can be closed and the first scene created later. When creating the first scene at this
time, the 3D scene must first be arranged by making visible the objects that will be
the focus of the first scene, before beginning the video report creation process. See
Section 20.8.1 Creating a scene for complete information on creating scenes.
To begin the video report creation process, choose the Report > Create Video Report
command. The dialog box shown in Figure 20.12 is displayed, to specify parameters
used to record key frames and generate scenes:
Resolution (WxH)
A list box that specifies the width and height of the real recording and playback
window. When creating scenes, the OpenGL window is automatically set to the
specified size in order to take real size snapshots. If the user changes the size of the
OpenGL window during the scene creation, generated snapshots will be scaled to
fit to the final AVI resolution. The default value is 320x200.
OK
A button that assigns the parameters in the dialog box to the video report.
Cancel
A button that ends the video creation process.
Note that once the OK button has been pressed, the parameters are assigned to the
new video report object, and they cannot be modified later.
After pressing the OK button, the Key Framer dialog box shown in Figure 20.13 is
displayed for the creation of the first scene. To dismiss the dialog box, press the Cancel
button; a video object appears under the Items subbranch of the Reports branch of the
tree view. Or, proceed to create a scene (see Section 20.8.1 Creating a scene), after
which the video object will be created with a scene child after the generation of the
first scene.
In preparation for the creation of a scene, the desired objects and annotations in the 3D
scene must be made visible.
Then, the scene creation mode is invoked by first selecting the video object under the
Items subbranch of the Reports branch of the tree view, and then choosing the
Report > Edit Video Report > Create Scene command. The dialog box shown in Figure
20.13 is displayed containing the following items:
Scene name
A text box that specifies the name of the scene object that will be displayed in the
tree view.
Grab Pose
A button that grabs the current pose of the 3D scene and displays the Add Key
Frame dialog box, shown in Figure 20.14 (a), that offers the following items:
Figure 20.13 The dialog box used to create and edit the key frames and intervals that make up a
scene.
Take a snapshot
List of key
frames and
intervals
Editing buttons
Generate the
animation
Name
The name of the key frame, which can be edited. A default name is
proposed that represents the type of operation performed in the 3D
scene (e.g., Rotation, Zoom in, Translation along XY plane).
Duration
A text box that specifies the number of milliseconds (ms) for which the
key frame will show during viewing. The default time is 1000 ms.
OK
A button that permits the creation of the key frame.
Cancel
A button that ends the creation of the key frame.
If the key frame being created is not the first key frame, the Add Interval dialog box
shown in Figure 20.14 (b) also is displayed, containing the following four items:
Name
The name of the interval, which can be edited. A default name is
proposed.
Figure 20.14 The dialog boxes used to add key frames and intervals.
(a) (b)
OK
A button that permits the creation of the interval.
Cancel
A button that ends the creation of the interval.
The key frame is inserted in the list of key frames and intervals at the position
indicated in the list box immediately below the Grab Pose button. Choose from:
Insert at End (default), Insert at Selection, or Replace Selection. The interval is
inserted immediately before the key frame.
Edit
A button that displays the editing dialog box used to change the name or the
duration of the selected key frame, or interval.
Delete
A button that deletes the selected key frame and its preceding interval (if there is
one). If the scene contains audio comments and/or text captions, a warning
window is displayed and explains that they will be deleted on continuing. Press
the Yes button to delete the key frame and all audio comments and/or text
captions in the scene, or press the No button to cancel the operation.
Move Up
A button that swaps the selected key frame in the list with the key frame that
immediately precedes it.
Move Down
A button that swaps the selected key frame in the list with the key frame that
immediately follows it.
Generate Preview
A button that is similar to the Generate Scene button, except that the scene is not
saved and no object is created in the tree view. It allows quickly visualizing what
the scene currently looks like.
Generate Scene
A button that launches the generation of a scene. A series of snapshots is taken
using the poses the user grabbed (i.e., the key frames), interpolating movement
between poses. The number of snapshots taken between poses depends on the
values specified for the interval, and the Frames per second parameters of the
video report (see Figure 20.12).
Once the scene has been generated, the Preview button on the property sheet of
scenes and the Preview command (main and shortcut menus) display the preview
of the scene.
1. Position the objects in the 3D scene in the desired position using mouse-based
operations.
In the dialog box that is displayed, specify a Name and a Duration for the Key
Frame, or accept the proposed default values, and then press the OK button. If this
is not the first key frame, a second dialog box is displayed that allows specifying a
Name and a Duration for the interval, or accept the proposed default values by
pressing the OK button.
5. Finally, generate the scene by pressing the Generate Scene button, or cancel all
changes made and close the dialog box by pressing the Cancel button.
An animation is created from the key frames and intervals. Then the dialog box will
close, and a scene object will appear under the parent video object under the Items
subbranch of the Reports branch of the tree view.
To edit a scene, select the scene object under the Items subbranch of the Reports
branch of the tree view, and then choose the Report > Edit Video Report > Edit Scene
command. The dialog box shown in Figure 20.13 is displayed.
See Section 20.8.1 Creating a scene for detailed information on how to use the dialog
box.
An audio comment is first assigned to one or more consecutive key frames of a selected
scene, and then either recorded live or imported from an existing audio file. An audio
comment may be added to any key frame to which an audio comment has not yet been
assigned.
To add an audio comment to a scene, first select the scene under the Items subbranch
of the Reports branch of the tree view. Then, choose the Report > Edit Video Report >
Add Audio Comment command, which displays the dialog box shown in Figure 20.15
that contains the following items:
Name
A text box that specifies the name of the audio comment object that will be
displayed under the Items subbranch of the Reports branch of the tree view.
Record/OK
The Record button starts recording the audio comment. The Stop button allows
ending the recording.
If From File is specified, the Record button becomes the OK button. When
pressed, the OK button saves the audio file as an audio comment object to the
Figure 20.15 The dialog box used to add audio comments to a scene.
Items subbranch of the Reports branch of the tree view, under the selected scene
object, and dismisses the dialog box.
From File
A button that opens a file browser to select a prerecorded audio comment in the
form of a .WAV file. Specify a file name and location. Press the Open button to read
the file or the Cancel button to end the operation.
Cancel/Stop
The Cancel button ends the operation.
This button becomes the Stop button when the Record button is pressed.
Pressing the Stop button ends the audio recording, and saves it as an audio
comment object under the Items subbranch of the Reports branch of the tree
view, under the selected scene object, and dismisses the dialog box.
If the audio comment is longer in milliseconds than the time between the two
boundary key frames, the last image of the interval preceding the ending key frame will
be displayed until the audio comment is finished.
An audio comment cannot be edited; instead the existing audio comment must be
deleted, and a new audio comment created to replace it.
To see the properties of an audio comment, select it in the tree view and choose the
Edit > Object Properties command. The property sheet shown in Figure 20.16 is
displayed, offering the following items on the Audio comment tab:
Duration (ms)
A text field that displays the length of the audio comment in milliseconds (ms).
Figure 20.17 The dialog box used to add text captions to a scene.
A text caption is first assigned to one or more consecutive key frames of a selected
scene, and then typed in a dialog box. A text caption can be added to key frames to
which no text caption has already been assigned.
To add a text caption to a scene, first select the scene object under the Items subbranch
of the Reports branch of the tree view. Then, choose the Report > Edit Video Report >
Add Text Caption command, which displays the dialog box shown in Figure 20.17 that
contains the following items:
Name
A text box that specifies the name of the text caption that will be displayed under
the Items subbranch of the Reports branch of the tree view.
Caption
A text box that specifies the text of the text caption that will be displayed in the
caption area of the animated report viewer.
Add
A button that creates a new text caption. A text caption object is added to the
Items subbranch of the Reports branch of the tree view under the selected scene.
Cancel
A button that ends the creation of the text caption.
To edit a text caption, double-click it under the Items subbranch of the Reports branch
of the tree view, which displays the property sheet shown in Figure 20.18, and edit the
contents of the Text text box. When finished, press the Apply button.
To see the properties of a text caption, select it in the tree view and choose the Edit >
Object Properties command. The property sheet shown in Figure 20.18 is displayed,
offering the following items on the Text caption tab:
Text
A text box that species the text of the text caption.
To preview a video report, a scene or an audio comment, first select the object under
the Items subbranch of the Reports branch of the tree view. Then, choose the Report >
Edit Video Report > Preview command.
In the case of a video report or a scene, a viewing window will be displayed and play
the video report or the scene repeatedly; press the OK button to dismiss the dialog box.
An audio comment will be played by the computer’s sound card.
The property sheet for video report items, shown in Figure 20.19, displays descriptive,
global information on the Report video tab:
# of audio comments
A text box that displays the total number of audio comments in the video.
# of text captions
A text box that displays the total number of text captions in the video.
# of frames
A text box that displays the total number of key frames in the video.
Duration (ms)
A text box that displays the total duration of the video in milliseconds (ms).
Preview
A button that opens a window that plays a preview of the video report item. Press
the window’s OK button to dismiss it.
The property sheet for scenes, shown in Figure 20.20, displays descriptive, global
information for the scene on the Scene tab:
# of audio comments
A text box that displays the total number of audio comments in the scene.
# of text captions
A text box that displays the total number of text captions in the scene.
# of frames
A text box that displays the total number of key frames in the scene.
Duration (ms)
A text box that displays the total duration of the scene in milliseconds (ms).
Preview
A button that opens a window that plays a preview of the scene. Press the
window’s OK button to dismiss it.
Videos can be exported to the AVI and the EXE file formats. Export operations are
offered on the File > Export submenu. Exporting videos is described in Section 25.16.5
Exporting video reports.
To view a video report saved with the IMMedia viewer (see Figure 20.21), double-click
the .exe file. The IMMedia viewer is displayed, with the video report ready to play. The
playing of an animated report is controlled with buttons (see Figure 20.21), menu
choices (see Figure 20.22), and shortcuts (see Section 20.8.8.3 IMMedia shortcuts). We
recommended the IMMedia viewer as it can display annotations.
Menu bar
Played time /
total time
Annotations in a video report are closed initially, and appear as solid colors without text
during the viewing of a key frame (see Figure 20.21). In addition, annotations do not
show during intervals when IMMedia plays generated images. To view annotations:
2. Advance to the desired key frame by pressing the LEFT or RIGHT ARROW buttons.
3. Place the pointer over the annotation, the pointer icon changes to a hand, and its
text is displayed in the viewer. Displace the pointer from the annotation and its text
is no longer displayed.
4. To view the annotations one at a time, use the TAB key. Pressing the TAB key once
opens an annotation, and pressing the TAB key again closes the current annotation
display and displays the text of the next closed annotation.
5. To view all annotations at once, choose the Annotation > Open All command. All
annotations open, displaying their text, and they are detached from their object
(can be moved outside the viewer to another location on the screen). To close the
annotations before continuing the animation, choose the Annotation > Close All
command. If the Play button is pressed, the annotations will remain displayed on
the computer screen, detached from their object.
Once an annotation is displayed, it may be made detached from the object by double-
clicking it. The annotation may then be dragged to another part of the screen and left
there, while the animation plays. To close a detached annotation, right-click it and
choose the Close command on the shortcut menu that is displayed.
To continue the animation, press the Play button or press the SPACEBAR.
Select the desired key frame by pausing the IMMedia viewer (SPACEBAR) and
advancing to the desired key frame (LEFT or RIGHT arrow). Then, choose the Window >
Snapshot command. A browser is displayed. Specify the file name in the File name
combo box and press the Save button. The snapshot is saved as a bitmap file. Note that
if any annotations are visible, they are not included in the snapshot.
Key Action
A report document in external document format may contain certain report items as
well as a header and a footer.
This section first presents the header and the footer, and then explains how to export
selected objects to external document formats.
A report document may contain the following items found under the Items subbranch
of the Reports branch of the tree view:
Report
2D Vector
A vectorial screen snapshot.
Graphic
Other
Use the Preview and Change buttons to preview and/or change the Logo that
appears in the header.
Select the Workspace name and Project name check boxes, to include that
information on the report title page of a report document in an external format.
Select the Date and Time check boxes, to include the date and time at which the
report is created on the title page of a report document in an external format.
To transfer any changes to the application, press the Apply button. The customized
header is preserved by choosing the Tools > Save User Configuration command.
A document footer Report Item is automatically generated in all surveying projects and
can be customized to meet your needs. To customize the report footer, open the Items
subbranch of the Reports branch of the tree view, select the Footer object, and choose
the Edit > Object Properties command. The property sheet shown in Figure 20.24 is
displayed, offering a Report footer tab.
Select the Page count, Date, and/or Time check boxes, in the Additional footer
info group box, to include that information on each page of a report document in
external format.
Add a text entry by selecting the More notes check box and typing text in the More
notes group box.
To transfer any changes to the application, press the Apply button. Press the Close
button to close the dialog box. The customized footer is preserved by choosing the
Tools > Save User Configuration command.
20.9.4 Changing the order of the items under the Items branch
The order that items appear in the Items branch is the order in which they will appear in
the generated report. There are two ways to change the order of an item under the
Items branch:
Select an item and right-click, point Edit, and click Move Up or Move Down on the
shortcut menu to move the item, respectively, before the preceding item or after the
following item in the branch.
Or,
Prior to exporting Report Items, the items to be exported may be selected in the Items
subbranch of the Reports branch of the tree view. If, however, no items are selected, all
Report Items that meet the criteria of the export operation will be exported.
Export operations are offered on the File > Export submenu. Exporting Report Items to
external document formats is described in Section 25.16 Exporting report items.
The EZLayout tool allows creating formatted reports, saving these reports, whether they are to be produced
once or repeatedly, and then manually or automatically producing similar reports based on the original
reports (or layout files saved from them for those that need to be generated regularly or at specific intervals).
A report can contain fixed items, such as the company name and logo, and variable items that act like
predefined containers, such as an empty cross-section comparison report. A formatted report contains
copies of IMSurvey report items which can be put in place of variable items (i.e., the results of a cross-section
measurement).
Formatted reports are saved under the Formatted Reports subbranch of the Reports branch of the tree view.
A formatted report can also be saved to disk as a layout file (.ezl) and a data folder, and used as a template to
be shared and to create similar formatted reports and layouts. Note that formatted reports can be printed or
exported to HTML or PDF format, or as images.
In this chapter, formatted reports will often be referred to as just reports. Information report items in an
IMSurvey project (e.g., a table, a snapshot, a 2D vector graphic) will be referred to as IMSurvey report items.
A distinction is made between zones that contain static or fixed information and
dynamic or variable information.
Zones that contain static information (e.g., an imported bitmap image such as a
company logo, imported text like the company name, graphical elements such as
connectors (i.e., lines with or without arrows), curves, polylines, ellipses, rectangles and
rounded rectangles which can be used in graphics and workflow depictions) are called
fixed items. Note that static text, text that is not meant to be modified by a user who will
be generating a report, can be added to several of the fixed items.
Zones that contain dynamic information (e.g., a report snapshot or a comparison table
that can be updated in the project, and is updated in the report too) get their content
from report items in the IMSurvey project. Since their content changes with the data in
the report item, they are called variable items. The exception is the variable text field
item that gets its information from the user who enters it manually (e.g., a dynamic text
area where an engineer can type a conclusion based on the inspection results).
A formatted report page or background can contain the following types of items:
A curved line.
Curve
(b)
Image
(b) Snapshot IMSurvey report items.
(c)
(c) Pie chart IMSurvey report items.
Assigning report items to containers can be done by macro command, which allows
automatically creating formatted reports.
Once the formatted report is complete, it can be saved in several formats and printed.
Several formatted reports can be opened at once in the EZLayout tool, each one on
a separate tab, but can only be viewed one at a time. The one being viewed is referred
to as the active formatted report.
The report contains the contents of the IMSurvey project report items that were
dragged directly into it or onto the variable containers. When accessing the report
saved to an IMSurvey project some time later, it will still contain all of its content even
if the original IMSurvey report items (e.g., 2D vector graphics, snapshots) have been
deleted.
A formatted report can be opened in the IMSurvey and IMView modules as part of an
IMSurvey project. It cannot be viewed otherwise, except in an exported format (e.g.,
PDF).
A formatted report always contains at least one page, and may contain one or more
backgrounds.
Several layouts can be opened at once in the EZLayout tool, each one on a separate
tab, but can only be viewed one at a time. The one being viewed is referred to as the
active layout.
Items can be copied between several layouts that are open at the same time in the
EZLayout tool.
Layouts are external files to be used as templates to allows users to quickly create
formatted reports.
By default, an empty report can be created with only one background and one page,
but an unlimited number of backgrounds and pages can be added.
Each formatted report has one or more special pages called backgrounds. The
contents of the background associated to a page are always visible in the active area
underneath the active page. A background can contain items common to several
pages or specific to a section or a page, such as company logos and header and
footer content, to which the appropriate pages are associated.
On creation, each item is represented by an object placed below its page in the tree
view in the report structure or the layout structure each object type has its own
unique name in the report or layout and an icon representing its content.
Items that are fixed are completely defined in the formatted report/layout. They
appear within a layout page or background as they do on a formatted report page or
background.
Items that are variable are defined in a layout page or background, but need to
receive content from an IMSurveyproject report item (i.e., pie chart, table, snapshot,
or 2D vector graphic) in a formatted report. In the case of a variable text field,
information is input by the user when creating the formatted report.
Items of the table type have their own templates that can be edited to dictate what
of the data copied into it will be displayed and in what order. A table is automatically
split vertically if longer than a single page and/or can be duplicated to show different
columns in each copy and the different parts can be placed on a sequence of pages.
The EZLayout tool offers operations to align and distribute items, and control the size
of selected items, as well as operations that allow grouping and specifying item
stacking order.
The EZLayout tool offers varied properties that allow specifying the appearance of
items and font properties for text field items.
Finally, note that macro commands can make use of an existing layout file to create
formatted reports by assigning IMSurvey report items to their corresponding variable
items in a layout. Items are identified by their unique name within a layout or a
formatted report. For the same reason, formatted reports within a survey project must
have unique names.
The EZLayout tool is shown in Figure 21.1. It features an active area where the
formatted report’s active page or background is shown with the items it already
contains, and where new items can be added. The active page or background area
includes the margins that are part of the Page Setup definition (see Section 21.2.3
Specifying the page setup). The margins are identified by a dotted rectangle on the
borders of the active page or background displayed in the active area.
The EZLayout tool also offers three panes (see Section 21.1.2 Using the three docking
panes for more information):
One of them, the Page View pane, is docked to the left of the active area by default.
The Page View pane shows thumbnails of the formatted report pages. The page in
bold is the report page being displayed in the active area, the active page.
Figure 21.1 The EZLayout pane in default configuration with an empty formatted report.
EZLayout
Standard toolbar
Thumbnail view of
report pages
The Background View pane shows thumbnails of the report backgrounds, each one
identified by a different color. The background in bold is the background being
displayed in the active area, the active background. The Background View pane is
hidden by default.
The Report Structure pane shows the contents of the formatted report, including the
backgrounds, and all other pages; the page or background in bold is the active one,
which is shown in the active area. The order of items under a page branch represents
their “stacking order” – the first item is the one on the bottom and the last item is the
one on the top. If the stacking order is changed (see Section 21.2.17 Arranging
items), the order of the items under the page branch and in the active area will
change accordingly.
Note that when an EZL layout file is opened in the EZLayout pane, the Report
Structure pane is replaced by the Layout Structure pane, which provides similar
functions and commands.
The Report Structure pane or the Layout Structure pane is hidden by default.
Additionally, the IMSurvey tree view shows the report objects, under the Items
subbranch of the Reports branch, and the formatted reports contained in the current
project. The valid report objects (i.e., 2D vector graphics, pie charts, snapshots, and
tables) can be dragged in the active area to be inserted into a formatted report. For
more information, see Section 21.2.10.2 Adding variable items to a page or a
background.
Figure 21.2 A formatted report. The first background, entitled Title_sheet_background, which is
displayed at the top of the Report Structure tree view, has two items (logo and
inspected piece serial number), and one item on Page 1 (document title).
Thumbnail view of
backgrounds
Thumbnail view of
pages
Figure 21.2 shows a formatted report being created in EZLayout. Note that all three
panes are displayed to the left of the active area: Report Structure, Background View,
and Page View. In the Report Structure pane, each item (container) is shown on the
background or page where it has been placed and has a unique name. In this example,
Report 1 is the active formatted report. It can be helpful to rename the items in the
Report Structure pane to describe the contents of the item. For example, image 1 could
be renamed company logo. Keep in mind that each item must have a unique name.
Figure 21.3 shows the active area with a new active formatted report – Report 2 created
using the layout from Report 1. Notice that the variable items are displayed in gray to
indicate that they do not have any content. To complete the formatted report, provide
the missing variable information by typing text in the variable text field (text field 4)
and dragging the report item that contains the desired data from the Items branch in
Figure 21.3 Report 2 has been created from a layout. It has containers that have no content. To
complete the report, drag an IMSurveyreport item to the empty table item and type
text in the empty variable text item.
the IMSurvey tree view over the same-type item (container) on the page (see table 1).
Creating a formatted report using the backgrounds is both quick and easy, but requires
that the IMSurvey report items (e.g., tables, pie charts, snapshots, 2D vector graphics)
that contain the information to add to the empty variable items in the formatted report
exist (see Chapter 20 Creating Report Items and Exporting Reports for more
information on creating report items). When the formatted report is complete, it can be
used to create a layout file that can be shared with others to create formatted reports
from surveying projects.
Double-clicking a formatted report in the IMSurvey tree view opens it in the EZLayout
pane, from where it can be viewed, edited, printed, or exported.
The three panes of the EZLayout tool are accessible through the View menu (see
Section 21.1.3 Overview of the EZLayout menu items for more information), by
selecting it in the list available through the pane’s caption menu button , or by right-
clicking over the title bar of one of the panes (see Section 4.3.1 Customizing the
docking panes of the PolyWorks Reference Guide for more information on
manipulating panes).
By default, the Page View pane is docked to the left of the active area, while the Report
Structure/Layout Structure pane and the Background View pane are hidden. Figure
21.1 shows the EZLayout tool in its default configuration.
Figure 21.2 shows the EZLayout tool with the three docking panes displayed on the left
of the active area.
General comments:
To close an active pane, to allow more of another pane’s items to be displayed for
example, deselect it in the list available through the pane’s caption menu button ,
or press the Close button on the title bar. The borders of a pane may also dragged
to change the space provided for the display of its items. See Section 4.3.1
Customizing the docking panes of the PolyWorks Reference Guide for more
information on manipulating panes.
To make a page active, click it in the Page View pane. To make a background active,
click it in the Background View pane.
To make a page or a background active, click it. The number/name of the active
page/background is displayed in bold in the Report Structure pane or Layout
Structure pane’s tree view, as well as in the active Page View pane or Background
View pane. The active page or background contour has a thick outline. The active
page/background is also displayed in the active area.
To delete one or more pages or backgrounds, select them and press the DELETE key,
or choose the Edit > Delete command. A deleted item may be recovered by choosing
the Edit > Undo command.
To move one or more items from one page or background to another, make the page
or background where the desired items are located active in the active area, and then
drag the items from the active area to the desired page or background in the Page
View or Background View pane.
All branches and objects in the Report Structure or Layout Structure tree view
docking pane offer a shortcut menu that is displayed by right-clicking a branch or
object.
EZLayout main
menu bar
To make a page or background active, right-click over the page or background, and
then click Activate on the shortcut menu, or double-click the object.
To center the viewing area on one item, double-click it or select it and choose the
View > Center on Item command. The page or background to which the item belongs
will be activated if necessary.
To delete one or more items, select them in the active area or in the tree view and
press the DELETE key, or choose the Edit > Delete command. A deleted item may be
recovered by choosing the Edit > Undo command.
The EZLayout tool has its own main menu bar, shown in Figure 21.4. The table that
follows provides a description of the main menus:
Menu Description
Create, open, save, and export formatted reports and layout files,
File view and edit formatted reports or layout properties, and print
formatted reports.
View Zoom in and out and center the active area on a selected item.
Select all the items in the active page, invert the selection, or select
Select
none.
Undo and redo operations, edit items (e.g., delete, cut & paste)
Edit
selected in one of the EZLayout panes.
Create pages, create and edit backgrounds, view and edit report
Page
pages or background properties.
Menu Description
Navigate through the list of the open formatted reports and layout
Window
files and control the activation status of the three docking panes.
File Edit operations Item alignment and Text item edition tools
operations stack tools
The Standard toolbar offered by the EZLayout tool, shown in Figure 21.5, offers several
buttons that provide shortcuts to operations. The buttons to the right-hand side are
only available when editing text. As a general rule, a button is only available when the
operation it represents is possible in the current context.
Note that the Standard toolbar can be repositioned anywhere within the EZLayout
pane and can be hidden, but cannot be customized (see Section 4.3.2 Customizing
toolbars, menus, options, and macro scripts of the PolyWorks Reference Guide for more
information on manipulating toolbars).
The Creation toolbar offered by the EZLayout tool, and shown in Figure 21.6, offers
several buttons that provide shortcuts to fixed report item creation operations.
Figure 21.6 The Creation toolbar from the EZLayout pane to create fixed report items and the
commands on the Create submenu of the Item menu to create the fixed report items
and variable text fields.
Curve
Fixed text Polyline Rounded
field rectangle
Note that the Creation toolbar can be repositioned anywhere in the EZLayout pane and
can be hidden, but cannot be customized (see Section 4.3.2 Customizing toolbars,
menus, options, and macro scripts of the PolyWorks Reference Guide for more
information on manipulating toolbars).
The table that follows provides information on zooming and scrolling in the active area:
• use the Zoom combo box on the main toolbar (see Figure
21.5)
zoom in/out
• CTRL + and CTRL -
• CTRL + mouse wheel
A formatted report is constructed using the existing report objects of the current
IMSurvey project. If the project does not contain the IMSurvey report items (i.e., only 2D
vector graphic, pie chart, snapshot, or table) to include in a formatted report, they must
be created. Note that report items can alternately serve as definitions used to create
same-type items, and that the information they contain may not be the information
that will eventually be used in the report. For complete information on creating
IMSurvey report items, see Chapter 20 Creating Report Items and Exporting Reports.
Constructing a formatted report also involves structuring its information and its visual
organization. It may be a report that is produced once, or a report on which multiple
reports that are to be produced at an interval will be based.
To generate several reports where only the results vary, an external EZL layout file can
be saved from the original report and used as a template. Layout files can also be
created and saved independently, and used later to create formatted reports. See
Section 21.4 Creating layout files for more information.
Manually – IMSurvey report items are dragged and dropped manually from the
IMSurvey tree view to the page or background displayed in the active area. A layout
file may be specified. The report is built manually by dragging and positioning report
items on individual backgrounds and pages, by associating appropriate
backgrounds to pages and by adding the desired fixed items. See the details in
Section 21.2.1 Creating a formatted report.
Formatted reports and report items are managed using the tools available for the tree
view.
To create a formatted report manually, choose the Report > Create Formatted Report
command. The dialog box shown in Figure 21.7 is displayed, offering the following
items:
Name
A text box that specifies the name of the new formatted report, which can be
edited. A default name report <number>, where <number> represents the number
of the report, is provided.
Method
A group box that offers methods that can be used to create a formatted report:
Report layout
A check box that enables a list box that allows specifying the layout file to use. The
check box is cleared by default. When the check box is cleared, the report is
created with one empty background and one empty page.
When the Report Layout check box is selected, a layout file may be selected in the
adjacent list box or the Browse button may be pressed to specify a layout file
outside the current layout folder. A file browser is displayed to specify the layout
file. Layout files have the .ezl extension. A default layout file named default.ezl is
available. It has two backgrounds, Title Background and Report Background, and a
page, Page 1, which contain the InnovMetric and PolyWorks logos, text items with
report codes and report fields, and finally one blank page, Page 2.
The Report Layout check box state and the last layout file selected to create the
formatted report are saved in the user configuration and become the new defaults
for subsequently creating reports manually or automatically.
The state of the check box is saved in the user configuration and becomes the new
default.
Press the Create button to continue, or press the Close button to dismiss the dialog
box. When continuing, the EZLayout interface, shown in Figure 21.1, is displayed. If a
layout file is chosen in the Report layout list, it is used as a template to create the
report which opens in the EZLayout tool. When the Show Report Properties on
creation check box is selected, the Report Properties dialog box is displayed, allowing
the edition of the properties of the newly created formatted report.
The Report Properties dialog box offers tools and options to edit the number of the first
page, to create or delete user-defined fields, and enter values in standard fields and
user-defined fields.
User-defined fields specified in a layout file selected to create a formatted report are
added (see Section 21.4.6 Specifying the layout properties). They are copied into the
report at the time it is created, can be edited from the report properties, and they apply
only to the report.
On the creation of a report, when the Show Report Properties on creation check box
was selected in the Create Formatted Report dialog box, the Report Properties dialog
box is automatically displayed, which allows editing the properties of the newly created
formatted report.
The Report Properties dialog box can also be displayed independently after the
creation of the formatted report. To open it, choose the File > Report Properties
command on the EZLayout tool. The dialog box shown in Figure 21.8 is displayed.
Name
A view-only text box that displays the name of the formatted report. The name of
a formatted report can be changed from the formatted report property sheet. See
Section 7.6 Using object property sheets for more information.
Updatable
A view-only text box that indicates whether the formatted report is updatable or
not. Possible values are: Yes and No. The default value is Yes. This information can
be changed from the formatted report property sheet. See Section 7.6 Using
object property sheets for more information.
Figure 21.8 The dialog box used to specify formatted report properties.
number of the report is -1, the second page number is 0, the third page number is
1, and so on.
Using a negative value for the first page number allows giving the number 1 to the
first page of actual report content. A page number report code can be placed only
on the pages where the report content is displayed, and the preceding pages can
be left without numbering, for example. For more information on report codes,
see Section 21.2.10.1 Adding fixed items to a page or a background.
The dialog box also offers a list of the standard and user-defined fields used to
automate the capture of information pertaining to the formatted report. This
information is available in reports through fixed and variable text field items and for
macro scripting use.
Values can be specified for standard fields. The following standard fields are available:
Field Code
Title $_REPORT_TITLE
Author $_REPORT_AUTHOR
All standard field codes for the report properties are identified by the $_REPORT prefix.
Figure 21.9 The dialog box used to specify formatted report properties with values added to
standard fields.
To enter a value in a standard field, select it in the list, and enter the desired value in the
Value column, as shown in Figure 21.9.
For more information on inserting standard fields into fixed and variable text field
items, see Section 21.2.10 Adding items to a page or a background.
The list also allows creating and editing user-defined fields for which values can be
specified.
All user-defined field codes for the report properties are identified by the
$_REPORT_CUSTOM prefix. The remaining of the code of each user-defined field is
composed of the name of the field, with underscored spaces between words (e.g.,
$_REPORT_CUSTOM_MY_USER_DEFINED_FIELD). For more information on inserting
user-defined fields in fixed and variable text field items, see Section 21.2.10 Adding
items to a page or a background.
To add a user-defined field to the list, press the Add button . Once the new user-
defined field is added to the list, enter a unique name in the Property column, as
shown in Figure 21.9. Note that the dollar sign ($) must not be used in a user-defined
field name, and the field cannot be empty. To enter a value in a user-defined field, click
it in the list, and type in the desired value in the Value column.
To remove one or multiple user-defined fields selected in the list, press the Remove
button .
Press the Apply button to transfer the user-defined fields and the configured values to
the formatted report, and the Close button to dismiss the dialog box.
Note that the codes of all the standard and user-defined fields that are inserted in text
field items are displayed on backgrounds and on layout pages. On report pages, their
values are displayed, except when editing the text. Then, the codes are displayed.
Standard and user-defined fields without values are not displayed on report pages.
The Page Setup dialog box offers options to specify the units, the paper size and the
margins of formatted report or layout backgrounds and pages. The page setup is used
to specify the report or layout page format that define the working surface and the
margins in the active area, when printing a report, or when exporting it to an external
format.
Choose the File > Page Setup command. The dialog box shown in Figure 21.10 is
displayed. offering the following items:
Units
A list box that specifies the units displayed in the Page Setup dialog box, as well as
the units used when specifying the border properties of images and text fields.
Choose from: Millimeters, Centimeters, and Inches. The default value is
Millimeters.
Paper
A group box that allows specifying a page definition that corresponds to the paper
size to use for constructing, printing, or exporting purposes. A predefined format
may be chosen in the Format list box (see Figure 21.10) and values are assigned to
the Width and Height text boxes. Or, new Width and Height values may be
entered, and the Format will automatically be set to User-defined.
Margins
A group box that offers four text boxes that allow specifying, in order, the Left,
Right, Top, and Bottom margins. The default value in all four text boxes is
12.70 mm. The Left and Right margins are always the horizontal margins
regardless of the page orientation. The margin values are used for report item
positioning, or report printing or exporting purposes. The margins are displayed
in the active area of the EZLayout tool. They are indicated by a dotted line
delimiting the area of the page where report items should be placed, so they may
be positioned accurately and appropriate blank margins are left on the pages.
Some report items may be placed outside the margins, or even outside pages or
backgrounds. As long as they are located within the printing device’s minimum
values, they will get printed. Report items such as the company logo, report title,
page number, page count, and report date, are often placed outside the margins.
Figure 21.10 The dialog box used to specify the page setup for a report.
Note that the margins should be equal to or greater than the printing device’s
minimum printing margin values, otherwise all the report items or the parts of
items on the report pages located outside the printing margins will not get
printed.
Press the Apply button to transfer the values to the application and make them the
new defaults, and the Close button to dismiss the dialog box.
Note that modifications to parameters in the Page Setup dialog box can be undone
once it has been closed. Chose the Edit > Undo command. The parameters are then
restored to their last previously configured values. However, they are not reset to the
original IMSurvey page setup default values.
Note also that when the page size of a formatted report or a layout file is changed in the
Page Setup dialog box, the items on the pages and backgrounds are repositioned
following specific rules. See Section 21.2.8 Background and page item repositioning
rules for more information.
To add a background to a formatted report, choose the Insert > Background command.
The Background Edition mode is automatically enabled and a new background is
created. Add as many backgrounds as desired. The new background is displayed in the
active area and is the active background. It is added at the end of the list of existing
backgrounds in the Report Structure/Layout Structure pane and in the Background
View pane.
A background can be renamed and each background must have a unique name within
a formatted report. Backgrounds have the Background <number> predefined name,
where <number> represents the background’s number.
To insert an empty background, right-click the background that comes just before
the desired location for the new background in the Background View pane, and
choose Insert from the shortcut menu. The new background has the same
orientation as the background that precedes it. A new color is assigned to the new
background.
To rename a background, right-click it in the active area, and choose Properties on the
shortcut menu; edit the contents of the Name field in the Background Properties
dialog box.
Alternately, right-click a background in the tree view from the Report Structure/
Layout Structure pane, and click Rename on the shortcut menu; edit the name and
click outside the name to transfer the changes to the application.
To change the order of a background in the tree view, from the Report Structure/
Layout Structure pane, drag it on another background; it will be placed before or
after the targeted background in the tree. Note that a background cannot be
dragged on a page.
Note that multiple backgrounds can be selected, copied, pasted, duplicated, deleted, or
reordered at once.
Figure 21.11 The dialog box used to specify the properties of backgrounds.
IMSurvey report items can be added to, moved on, or deleted from a background. See
Section 21.2.10 Adding items to a page or a background for more information.
Note that a background can be associated to a page from the page properties. See
Section 21.2.7 Specifying the properties of pages for more information.
To specify the properties of a background, first make it the active background in the
active area. See Section 21.2.9 Making a page or a background active for more
information. To specify the properties of several backgrounds at once, select the
desired backgrounds in the Background View pane.
The Properties command allows specifying the properties of the active background. The
Properties command from the shortcut menu that is displayed by right-clicking
selected backgrounds in the Background View pane, allows specifying at once the
properties of multiple selected backgrounds. On choosing this command, the dialog
box shown in Figure 21.11 is displayed, offering the following items:
Name
A text box that specifies the name of the background. The default name is
Background <number>, where <number> represents the background number. The
name of the background can be modified.
Color
A list box that specifies the color identifying the background in the Background
View pane and of the background associated to each page in the Page View pane.
Modify the color by clicking the color box and clicking a color in the list that is
displayed.
Orientation
A group box that offers options to configure the orientation of the background. It
contains the following items:
Portrait
An option button that specifies a portrait, or vertical, orientation for the
background. The option button is selected by default.
Landscape
An option button that specifies a landscape, or horizontal, orientation for
the background.
Note that if several backgrounds are selected in the Background View pane, only
the orientation can be configured and applied to all the selected backgrounds.
The name and the color of each background in a report is unique and cannot be
modified in this context.
Note that when the orientation of the background is different than the orientation
specified for the pages it is associated to, the background items are repositioned
on the pages following specific rules. See Section 21.2.8 Background and page
item repositioning rules for more information.
Press the Apply button to transfer the values to the selected background, and the
Close button to dismiss the dialog box.
To add a page to a formatted report or a layout, choose the Create command. Repeat as
many times as desired. The new page is displayed in the active area and is the active
page. It is added at the end of the list of existing pages in the Page View pane and in the
Report Structure/Layout Structure pane.
To edit a page in a formatted report, click it in the Page View pane to make it the active
page in the active area (see Section 21.2.9 Making a page or a background active).
Pages have the Page <number> predefined name, where <number> represents the
page number. Page numbering can be set from the Report properties by configuring
the first page number (see Section 21.2.2 Specifying the report properties).
To change the order of a page in the Page View pane, drag it above or below an
existing page; it will be placed before or after the targeted page in the Page View
pane and in the tree view in the Report Structure/Layout Structure pane. The same
operation can be performed in the Report Structure/Layout Structure pane, by
dragging the page on another page.
To insert a page, right-click the page that comes just before the desired location for
the new page in the Page View pane, and choose Insert from the shortcut menu. The
new page has the same orientation and background as the page that comes before.
Figure 21.12 The dialog box used to specify the properties of report pages.
To copy and paste a page, right-click the page to copy in the Page View pane, and
choose Copy from the shortcut menu. Then, right-click the page that comes just
before the desired location for the new page, and choose Paste from the shortcut
menu. The new page has the same orientation, background, and items as the copied
page.
To duplicate a page, right-click the desired page in the Page View pane, and choose
Duplicate from the shortcut menu. The new page has the same orientation,
background, and items as the duplicated page.
To delete a page, right-click it in the Page View pane and select Delete from the
shortcut menu. Note that a formatted report or layout must contain at least one
page.
Note that multiple pages selected in the Page View pane can be moved, copied and
pasted, duplicated, or deleted at once.
IMSurvey report items can be added to, moved on, or deleted from a page. See Section
21.2.10 Adding items to a page or a background for more information.
Note that the background associated to a page can be changed from the page
properties. See Section 21.2.7 Specifying the properties of pages for more information.
To specify the properties of a page, make it the active page in the active area. See
Section 21.2.9 Making a page or a background active for more information. To specify
the properties of several pages at once, select the desired pages in the Page View pane.
The Properties command allows specifying the properties of the active page. The
Properties command from the shortcut menu that is displayed by right-clicking
selected pages in the Page View pane, allows specifying at once the properties of
multiple selected pages. On choosing this command, the dialog box shown in Figure
21.12 is displayed, offering the following items:
Orientation
A group box that offers options to configure the orientation of a page. It contains
the following items:
Portrait
An option button that specifies a portrait, or vertical, orientation for the
page. The option button is selected by default.
Landscape
An option button that specifies a landscape, or horizontal, orientation for
the page.
The last orientation specified to create, copy, or duplicate a page is saved in the
user configuration and becomes the new configured orientation for subsequently
creating pages.
Note that when the orientation of the page and the background associated to it
are different, the background items are repositioned on the page following
specific rules. See Section 21.2.8 Background and page item repositioning rules for
more information.
Background
A list box that specifies the background to use for the page. Choose from the list
of backgrounds available for the formatted report.
Press the Apply button to transfer the values to the selected page, and the Close
button to dismiss the dialog box.
Note that if several pages are selected in the Page View pane, the properties can be
configured and applied at once to all the selected pages.
Note also that pages have only a default name, Page <number>, where <number>
represents the page number. There is no name property for pages, and the page name
cannot be modified. However, page numbering can be modified from the report
properties by changing the first page number (see Section 21.2.2 Specifying the report
properties).
When the page size of a formatted report or a layout is changed in the Page Setup
dialog box (see Section 21.2.3 Specifying the page setup), or when the orientation of a
page or a background is changed from its properties, the background and/or page
items are repositioned on the surface according to specific rules. When the orientation
of a page and of the background associated to it are different, the background’s items
are repositioned on the page according to the same rules.
Examples of the rules applied to item center to surface border distances and item
center to surface center distances are provided in Figure 21.13.
Figure 21.13 An item is repositioned on a page or background when the page or background size
or orientation is modified. When the item’s center is located on the surface’s vertical
or horizontal first or last quarter, the item’s center to surface border distance is
maintained. When the item’s center is located on the surface’s vertical or horizontal
middle-half, the item’s center to surface center distance is maintained.
The following background and page item relocation rules are applied:
When the center of an item is in the left-side quarter and/or top quarter of a page or
background surface, the distance between the left and/or top surface border and the
item’s center is maintained.
When the center of an item is in the right-side quarter and/or bottom quarter of a
page or background surface, the distance between the right and/or bottom surface
border and the item’s center is maintained.
When the center of an item is in the vertical and/or horizontal middle-half of a page
or background surface, the distance between the page or background vertical and/
or horizontal surface center and the item’s center is maintained.
If the formatted report has more than one background and/or page, make them active
and display them in the active area in several ways:
Click the desired page or background in the Page View pane or Background View
pane.
When an active page is displayed in the active area, choose the Edit Background
command Page to make the background associated to the page active.
In the Page View pane or Background View pane, use the UP ARROW and DOWN
ARROW keys to cycle through the pages or backgrounds.
The backgrounds and pages in a formatted report can contain as many fixed or variable
report items as are needed.
The margins displayed in the active area help in placing report items appropriately.
Some report items may be placed outside the margins or outside of the page or
background altogether. The parts of them that are located within the minimum values
of the printing device will be printed. Although report items placed entirely outside a
page or background are available from the formatted report or layout, they do not get
printed.
When placing a table item on a page, if the page surface cannot hold the entire height
of the table, as many pages as are needed to accommodate the table vertically are
added to the formatted report. The items from the background associated to the first
page are also displayed on the additional pages created to accommodate the table.
Each continuation of the table added to a report is identified on each additional page in
the Report Structure pane/Layout Structure pane with a suffix and a number, part
<number>, where <number> represents the number of the table part, that are added
to the name of the table item to indicate that it is being continued.
It may be useful to use the Zoom combo box on the Standard toolbar or the View >
Zoom In and View > Zoom Out commands in order to see the limits of the current page
and if a dragged item fits entirely on it.
To add fixed items to a page or a background, make it active, click the Insert menu, and
choose from: the Image From File command, the Shapes submenu, or the Text Field
submenu. Alternatively, right-click over the page or background in the active area, and
choose one of the items on the Create submenu.
The image may be resized by dragging the handles of the image. How the resizing
is done is determined by the properties of the image (see Section 21.2.11
Properties of items in a formatted report or a layout for more information). The
image file itself is copied into the formatted report. It is part of the report when it
is saved to the IMSurvey project or exported to disk.
The Insert > Shapes submenu allows inserting the following shapes:
Connector
Activates the connector creation mode. Click and drag the pointer on the active
area, as shown in Figure 21.15, to anchor and determine the direction and length
of a connector object on the active page or background. A connector of
predefined length oriented at a 45-degree angle can also be created by clicking
the active area. The connector is created under the corresponding Report
Structure or Layout Structure pane tree view branch.
To exit connector edition mode, click outside the item box of the connector.
To change the connector’s line width and color, or to add or remove arrows
at the connector ends, make sure the page or background where it is located
is active (see Section 21.2.9 Making a page or a background active), select it
in the active area, choose the Edit > Item Properties command, or right-click
the connector, and then click Properties on the shortcut menu. The Item
Properties dialog box is displayed, enabling modifying the properties of the
connector. For more information, see Section 21.2.11.4 The properties of
connectors.
Curve
Activates the curve creation mode. Click the active area to specify each anchor
point, as shown in Figure 21.16 (a), and determine the direction and length or
shape of a curve object on the active page or background.
Open or closed curve objects can be created. Right-click after creating the last
anchor point to complete the creation of an open curve (see Figure 21.16 (a)). An
open curve is created with a border and a transparent fill. A closed curve must
have at least three anchor points. To create a closed curve, create the last anchor
point of the curve over the first anchor point (see Figure 21.16 (b)). A closed curve
is created with a border and a fill.
The curve is created under the corresponding Report Structure pane or Layout
Structure pane tree view branch.
On creation, the curve is automatically in edition mode in the active area, which
allows editing the curve:
To resize the curve, use the handles on its item box (see Figure 21.16 (c)).
To enter curve shape edition mode, double-click inside the item box to
display the orange anchor points (see Figure 21.16 (d)). Then, edit the shape
of the curve. To move an anchor point, drag it. To change the orientation and
the shape of the curve, click an anchor point to display its reshape handles
(see Figure 21.16 (f )). Then, drag one of the reshape handles. Note that the
reshape handles of an anchor point are independent, which allows giving
Figure 21.16 An open curve being added to the active area (a). A closed and filled curve (b). A curve
in edition mode (c). A curve in shape edition mode with anchor point being moved
(d). A closed curve with a transparent fill (e). A curve in shape edition mode with
displayed reshape handles (f) and (g).
the curve different directions with any angle on each side of the anchor
point (see Figure 21.16 (g)).
To exit curve shape edition mode, click elsewhere than a reshape handle.
To exit curve edition mode, click outside the item box of the curve.
To re-enter the curve edition mode, click inside the curve item box.
To change a curve’s line width and color, or fill transparency and color, make
sure the page or background where it is located is active, select it in the
active area, choose the Edit > Item Properties command, or right-click the
curve, and then click Properties on the shortcut menu. The Item Properties
dialog box is displayed, to modify the properties of the curve. For more
information, see Section 21.2.11.5 The properties of curves and polylines.
Ellipse/Rectangle/Rounded Rectangle
Activates the ellipse/rectangle/rounded rectangle creation mode. Click and drag
the pointer on the active area, as shown in Figure 21.17 (a), to anchor and
determine the height and width of the object on the active page or background.
In addition, an object of predefined height and width can be created by clicking
the active area (see Figure 21.17 (b)). An object is created with a border and a fill.
Figure 21.17 An ellipse, a rectangle, or a rounded rectangle being added to the active area (a). A
predefined width and height ellipse (circle), rectangle (square), or rounded rectangle
(rounded square) (b). An ellipse, a rectangle, or a rounded rectangle in text edition
mode (c) with available shortcut menu and submenus (d).
(d)
Figure 21.18 An open polyline being added to the active area (a). A closed and filled polyline (b). A
closed polyline with a transparent fill (c). A polyline in edition mode (d). A polyline in
shape edition mode with anchor point being moved (e).
(d) (e)
To resize the ellipse, rectangle, or rounded rectangle, use the handles on its
item box.
The ellipse, rectangle, and rounded rectangle items are also fixed text fields.
To enter text edition mode, select the item and either double-click within
the item box (see Figure 21.17 (c)) or right-click, point Text Field and click Edit
Text. Text edition mode allows entering text in the text field. The commands
and functions described previously related to editing fixed text fields are
available (see Figure 21.17 (d)).
Polyline
Activates the polyline creation mode. Click the active area to specify each anchor
point, as shown in Figure 21.18 (a), and determine the direction and length or
shape of a polyline object on the active page or background.
Open or closed polyline objects can be created. Right-click after creating the last
anchor point to complete the creation of an open polyline (see Figure 21.18 (a)).
An open polyline is created with a border and a transparent fill. A closed polyline
must have at least three anchor points. To create a closed polyline, create the last
anchor point over the first anchor point of the polyline (see Figure 21.18 (b)). A
closed polyline is created filled.
The polyline is created under the corresponding Report Structure pane or Layout
Structure pane tree view branch.
On creation, the polyline is automatically in edition mode in the active area, which
allows editing it (see Figure 21.18):
To resize the polyline, use the handles on its item box (see Figure 21.18 (d)).
To enter polyline shape edition mode, double-click inside the item box to
display its orange anchor points (see Figure 21.18 (e)). To move an anchor
point, drag it.
To exit polyline shape edition mode, click elsewhere than a reshape handle.
To exit polyline edition mode, click outside the item box of the polyline.
To re-enter the polyline edition mode, click inside the item box of the
polyline.
To move the polyline, make sure it is not in edition mode or in shape edition
mode, and then drag it.
To change a polyline’s line width and color, or fill transparency and color,
make sure the page or background where it is located is active (see Section
21.2.9 Making a page or a background active), select it in the active area,
choose the Edit > Item Properties command, or right-click the polyline, and
then click Properties on the shortcut menu. The Item Properties dialog box is
displayed, to modify the properties of the polyline. For more information,
see Section 21.2.11.5 The properties of curves and polylines.
Text Field
A submenu that allows inserting text fields. Choose from: Fixed and Variable. For
more information on Variable text fields, see Section 21.2.10.2 Adding variable
items to a page or a background. Choosing the Fixed command displays an item
box, shown in Figure 21.19 (a). Move it by moving the pointer. Click the active area
to anchor it on the active page or background. A text field object is created under
the corresponding Report Structure pane or Layout Structure pane tree view
branch. The text edition mode is automatically entered, which allows entering text
in the text field, as shown in Figure 21.19 (b).
To resize the text field, the text edition mode must first be exited by clicking
outside the item box. Then, select the text field in the active area, and use the
reshape handles to resize it, as shown in Figure 21.19 (c).
Figure 21.19 A fixed text field report item being added to the active area (a), with resize handles
displayed (b), and in text edition mode with available shortcut menu and submenus
(c).
(a)
(b)
(c)
To return to text edition mode, select the text field and either double-click within
the item box or right-click, point Text Field and click Edit Text.
In text edition mode, text may be entered and edited. Right-click to access a
shortcut menu that offers the following items:
Align Paragraph
A shortcut submenu that offers three items that allow controlling the alignment of
the paragraph under the pointer within the text field: Left, Center, and Right.
Insert
A shortcut submenu, shown in Figure 21.19 (b), that offers items that allow
inserting report codes, including those of standard and user-defined report fields,
in the fixed text field at the position of the pointer.
Note that when the text field is on a background, on a layout page, or on a report
page and the text field is in text edition mode, standard and user-defined field
codes are displayed. When the text field is on a report page and is not in text
edition mode, the text of the specific values entered for standard and user-defined
field codes is displayed. When the text field is in text edition mode, the codes are
displayed.
Page Number
Inserts a code ($_PAGE) that displays the current page number.
Page Count
Inserts a code ($_PAGE_COUNT) that displays the number of pages in the report.
The Insert > Report Properties shortcut submenu, shown in Figure 21.19 (b), offers
commands that allow inserting standard and user-defined report field codes in the text
field for the report properties, at the position of the pointer (note that all standard field
codes for the report properties are identified by the $_REPORT prefix):
Title
Inserts a code ($_REPORT_TITLE) that displays the value of the field.
Author
Inserts a code ($_REPORT_AUTHOR) that displays the value of the field.
Long Date
Inserts a code ($_REPORT_LONG_DATE) that displays the date the report was
created, using the long format specified in the Windows Region and Language
Options (e.g., day, month & date, year).
Short Date
Inserts a code ($_REPORT_SHORT_DATE) that displays the date the report was
created, using the short format specified in the Windows Region and Language
Options (e.g., mm/dd/yyyy).
Time
Inserts a code ($_REPORT_TIME) that displays the time when the report was
created, using the format specified in the Windows Region and Language Options.
User-defined fields
User-defined report field codes can be inserted in text fields from the Report
Properties submenu, below the standard fields listed previously. User-defined
report field codes can be created to automate the capture of additional
personalized information pertaining to the formatted report, which is not already
available through standard fields. Specific values for standard and user-defined
field codes can also be specified. For more information, see Section 21.2.2
Specifying the report properties.
The Insert > Project Properties shortcut submenu, shown in Figure 21.19 (b), offers
commands that allow inserting standard and user-defined report field codes in the text
field for the project properties, at the position of the pointer (note that all standard field
codes for the project properties, except the code for the workspace name, are
identified by the $_PROJECT prefix):
Workspace Name
Inserts a code ($_WORKSPACE) that displays the name of the workspace.
Project Name
Inserts a code ($_PROJECT) that displays the name of the project.
Organization
Inserts a code ($_PROJECT_ORGANIZATION) that displays the value of the field.
Part Number
Inserts a code ($_PROJECT_PART_NO) that displays the value of the field.
Part Name
Inserts a code ($_PROJECT_PART) that displays the value of the field.
User-defined fields
User-defined report field codes can be inserted in text fields from the Project
Properties submenu, below the standard fields listed previously. User-defined
report field codes can be created to automate the capture of additional
personalized information pertaining to the formatted report, which is not already
available through standard fields. Specific values for standard and user-defined
field codes can also be specified. For more information, see Section 3.2
Customizing the module.
Note that all user-defined field codes are identified by the $_PROJECT_CUSTOM
prefix. The remaining of the code of each user-defined field is composed of the
name of the field, with underscored spaces between words (e.g.,
$_PROJECT_CUSTOM_MY_USER_DEFINED_FIELD).
The Insert > Piece Properties shortcut submenu, shown in Figure 21.19 (c), offers
commands that allow inserting standard and user-defined report field codes in the text
field for the piece properties, at the position of the pointer (note that all standard field
codes for the piece properties are identified by the $_PIECE prefix):
Piece Name
Inserts a code ($_PIECE) that displays the name of the piece.
Long Date
Inserts a code ($_PIECE_LONG_DATE) that displays the date the piece was created,
using the long format specified in the Windows Region and Language Options
(e.g., day, month & date, year).
Short Date
Inserts a code ($_PIECE_SHORT_DATE) that displays the date the piece was
created, using the short format specified in the Windows Region and Language
Options (e.g., mm/dd/yyyy).
Time
Inserts a code ($_PIECE_TIME) that displays the time when the piece was created,
using the format specified in the Windows Region and Language Options.
Serial Number
Inserts a code ($_PIECE_SERIAL_NO) that displays the value of the field.
Operator
Inserts a code ($_PIECE_OPERATOR) that displays the value of the field.
E-mail address
Inserts a code ($_PIECE_E-MAIL) that displays the value of the field.
Figure 21.20 The dialog box used to specify font properties for a text field.
Device
Inserts a code ($_PIECE_DEVICE) that displays the value of the field.
User-defined fields
User-defined report field codes are available to be inserted in text fields from the
Piece Properties submenu, below the standard fields listed previously. User-defined
report field codes can be created to automate the capture of additional
personalized information pertaining to the formatted report, which is not already
available through standard fields. Specific values for standard and user-defined
field codes can also be specified. For more information, see Section 3.2
Customizing the module.
The Font Properties shortcut command displays the dialog box shown in Figure 21.20
that allows specifying font properties for selected text or new text in the text field. The
following font properties may be specified: Font, Size, Character set, Style, Position,
and Text color. A Text background that is Transparent or Opaque may also be
specified; if Opaque is chosen, specify the color by clicking over the area adjacent to
the Opaque label and making specifications in the dialog box that is displayed. Press
the OK button to apply the changes, or press the Cancel button to dismiss the dialog
box, cancelling any changes made.
Variable items consist of three image-based items (i.e., 2D vector graphic, pie chart,
snapshot), a table-based item (i.e., table), a text field item. There are two creation
mechanisms, one for text fields and one for the other variable items:
To create a variable text field, make the desired page or background active and either
choose the Insert > Text Field > Variable command, or right-click over the page in the
active area, point Create, and then choose the Text Field (Variable) command. Editing
a variable text field is the same as editing a fixed text field. For more information, see
Section 21.2.10.1 Adding fixed items to a page or a background.
To create a variable item other than a text field (i.e., 2D vector graphics, pie charts,
snapshots, and tables), report items must already exist. For complete information on
creating report items, see Chapter 20 Creating Report Items and Exporting Reports.
Make the desired page or background active in the layout or formatted report and
drag a report item from the IMSurvey tree view onto the active page or background
in the active area. On a layout page or layout background, a same-type container
(e.g., snapshot) is created but the data (content) is not copied. On a formatted report
page or background, the data of the report item is copied and the information is
displayed. Variable report items in a formatted report also act as same-type
containers.
Note that for a table item, when some of its rows exceed below the border of a page
where it is placed, one or more additional pages are automatically created in the
formatted report to accept the additional rows. To display columns that exceed the
width of a page or a background, the same table can be placed on several pages or
backgrounds, and the content of the table can be edited on each page or
background from contents options found in the table properties to display only the
desired columns on each page. See Section 21.2.11.6 The properties of tables for
more information.
An item box indicates the size and the position of the new item. Items can be resized by
dragging any handle; how the resizing is done is determined by the properties of the
item (see Section 21.2.11 Properties of items in a formatted report or a layout for more
information).
IMPORTANT: Certain tables may vary in size depending on the context (e.g., a larger
number of points specified for the font). In this case, the space reserved for this item,
shown by its contour, must be large enough to accommodate the actual size of the
table.
Note that when dragging a snapshot report item onto a layout, the following
properties of the snapshot are not used by EZLayout: Alignment, Size, and Caption.
When dragging a table report item onto a layout, the following properties of the table
are not used by EZLayout: Auto-format and Caption.
Items in a formatted report or a layout can be put into four categories: text fields, which
includes shape items with a text field (i.e., ellipses, rectangles, rounded rectangles),
shape items without a text field (i.e., connectors, curves, polylines), image-based items
(images, 2D vector graphics, pie charts, and snapshots), and tables.
The properties of items selected in the active page or background can be viewed. To
proceed, select the items in the active area and either choose the Item > Properties
command, or right-click over the selection and click Properties on the shortcut menu. A
property sheet is displayed – the properties for each category of item is shown in Figure
21.21. If the selection includes items of different categories, the property sheet will
include a tab for each category of item (see the example in Figure 21.21 (e)). The
property sheet is a quick way of applying properties to more than one item on the
active page or background.
21.2.11.1 The properties of text fields, ellipses, rectangles, and rounded rectangles
Text field, ellipse, rectangle, and rounded rectangle items, although they have different
names and vary in their shapes, are of the same type, and all share the same properties.
The properties of text field items or shape items are found under the Text fields/
Ellipses/Rectangles/Rounded rectangles tab, shown in Figure 21.21 (a):
Text
A group box that allows modifying the properties of the text:
Alignment
A list box that specifies the horizontal alignment of the text within its text
field. Choose from: Left, Right, and Center. The default value is Left.
Font
A button that displays the Font Properties dialog box, shown in Figure
21.20, that allows specifying font properties for text in the text field (see
Section 21.2.10.1 Adding fixed items to a page or a background for more
information).
Border
A check box that enables applying a border to the selected item and makes
available a group box containing the following parameters:
Width
A list box that specifies the border width. Choose from one of the four
different border widths offered.
Figure 21.21 Item properties for text fields (a), images (b), connectors (c), curves or polylines (d),
and tables (e). Note that the dialog box in (e) contains a tab for each type of selected
item.
(a) (d)
Line/Border width
list box
(e)
(b)
(c)
Spacing to content
A text box that specifies the spacing value between the border and the
content. The units used are those specified in the Page Setup dialog box
(see Section 21.2.3 Specifying the page setup).
Color
A button that specifies the border line color. Modify the line color by
clicking the color box and clicking a color in the list that is displayed.
Fill
A group box that enables applying a fill transparency and color to the selected
item. It contains the following items:
Transparency
A slider that specifies the opacity or transparency of the fill. Values range
from opaque on the left end of the slider through transparent on the
right end. For a text field, the default value is transparent. For an ellipse,
a rectangle or a rounded rectangle, the default value is opaque.
Color
A button that specifies the fill color. Modify the fill color by clicking the
color box and clicking a color in the list that is displayed.
Note that when multiple same type text field or shape items are selected, the
corresponding tab from the Item Properties dialog box is named Text fields, Ellipses,
Rectangles, or Rounded rectangles. When multiple type text items of different types
are selected, a text field, an ellipse, a rectangle, and a rounded rectangle for example,
the corresponding tab from the Item Properties dialog box is named Shapes and text,
as shown in Figure 21.21 (e).
The properties of image-based items are found under the Images tab, shown in Figure
21.21 (b):
Figure 21.22 The dialog box used to edit the properties of images of the 2D vector graphic type
showing the True size (2D vector graphic) check box unique to images of this type.
Border width
list box
cannot be reduced to a size smaller than the largest true size 2D vector graphic
item.
The Make Same Size command does not work on a single or a multiple item
selection that includes a true size 2D vector graphic, except when the 2D vector
graphic is the first one selected and serves as the reference for the redimensioning.
The True size (2D vector graphic) check box is displayed only in 2D vector
graphics image properties.
For more information on 2D vector graphic IMSurvey report items, see Section
20.6 Creating 2D vector graphic report items.
Note that the Keep height/width ratio check box has no effect on a 2D vector
graphic item when the True size (2D vector graphic) check box is selected.
Horizontal alignment
A list box that specifies the horizontal alignment of the image within its item box.
Choose from: Left, Horizontal Center, and Right. The default value is Horizontal
Center. This dialog box item is only available when the Keep height/width ratio
check box is selected.
Vertical alignment
A list box that specifies the vertical alignment of the image within its item box.
Choose from: Top, Vertical Center, and Bottom. The default value is Vertical
Center. This dialog box item is only available when the Keep height/width ratio
check box is selected.
Border
A check box that enables applying a border to the selected item and makes
available a group box containing the following parameters:
Width
A list box that specifies the border width. Choose from one of the four
different border widths offered.
Spacing to content
A text box that specifies the spacing value between the border and the
content. The units used are those specified in the Page Setup dialog box
(see Section 21.2.3 Specifying the page setup).
The properties of variable image-based items (i.e., snapshots) are found under the
Report item tab. For detailed information on the properties of snapshot report items,
see Section 1.1.8.1 The Report item tab.
The properties of connector items are found under the Connectors tab shown in
Figure 21.21 (c):
Width
A list box that specifies the connector line width. Choose from one of the four
different line widths offered.
Color
A button that specifies the connector line color. Modify the line color by clicking
the color box and clicking a color in the list that is displayed.
The properties of curve and polyline items are found under the Curves or Polylines
tab, shown in Figure 21.21 (d):
Border
A check box that enables applying a border to the selected item and makes
available a group box containing the following parameters:
Width
A list box that specifies the border width. Choose from one of the four
different border widths offered.
Color
A button that specifies the border line color. Modify the line color by
clicking the color box and clicking a color in the list that is displayed.
The Border check box is selected by default. Note that for open curve and polyline
items, the border properties are used to specify the item’s line width and color.
Fill
A group box that enables applying a fill transparency and color to the selected
item. It contains the following items:
Transparency
A slider that specifies the opacity or transparency of the fill. Values range
from opaque on the left end of the slider through transparent on the
right end. For open curve and polyline items, the default value is
transparent. For closed curve and polyline items, the default value is
opaque.
Color
A button that specifies the fill color. Modify the fill color by clicking the
color box and clicking a color in the list that is displayed.
Note that when multiple same type curve or polyline items are selected, the
corresponding tab from the Item Properties dialog box is named Curves or Polylines.
When multiple mixed type curve and polyline items are selected, the corresponding
tab from the Item Properties dialog box is named Curves/Polylines, as shown in Figure
21.21 (e).
The properties of table items are found under the Tables tab, shown in Figure 21.21 (e).
Three parameters control the behavior of the item within its item box:
Text layout
A list box that specifies how the text flows in the table cells when the
Maximum column width check box is selected. Choose from:
Overwrite – Specifies that the text that does not fit in the table cell
space is to flow over the cell immediately to its right. Note that the
text overwrites other cells only until the right end of the table row is
reached.
Truncate – Specifies that the portion of text that does not fit in the
table cell space is to be hidden.
Note that when the text is longer than the specified maximum column width
value, the text alignment configuration specified in the Title and Cell Format
dialog box is not used. Instead, the text is aligned to the left to allow the most text
to be displayed in the cell. For example, a text that is right-aligned and should be
truncated to the left will be left-aligned and truncated to the right.
Shrink to fit
A check box that enables the table to shrink when the item box is made smaller
than the size of the table. As a result, the table is made smaller but the entire table
is visible. When the check box is cleared and the item box is made smaller than the
table, the table size does not change. As a result, only the visible part of the table
is displayed. The check box is selected by default.
Figure 21.23 The dialog box used to edit title and cell formats.
Horizontal alignment
A list box that specifies the horizontal alignment of the table within its item box.
Choose from: Left, Horizontal Center, and Right. The default value is Horizontal
Center. These properties only apply when the item box is larger than the table.
Vertical alignment
A list box that specifies the vertical alignment of the table within its item box.
Choose from: Top, Vertical Center, and Bottom. The default value is Vertical
Center. These properties only apply when the item box is longer than the table.
A button allows editing the format of the table’s title and cells:
The Title check box, that enables a group box of the same name, allows specifying
the Alignment, Font, and Size by way of list boxes, and specifying attributes,
Bold, Italic, and/or Underline, through check boxes. Note that when the Title
check box is cleared, no title is displayed.
When the surface of a page cannot hold the entire height of a table, as many pages
as needed are added to the formatted report to accommodate the table vertically.
The Cell format group box, that enables a group box of the same name, allows
specifying the Alignment, Font, and Size by way of list boxes, and specifying the
Figure 21.24 The dialog box that is displayed to edit the current content specification for a table
item.
number of digits after the point displayed for numerical values in the Number of
digits after point text box. The default value is 3. It also offers the Use tolerance
colors check box. Several comparison and measurement reports may include
pass/fail tolerance-based results. This check box may be selected to display
colored table cells: green indicates that the result is within the Low tolerance limit
value, red indicates that the result is higher than the High tolerance limit value,
and yellow indicates that the result is greater than the Low tolerance limit value
and less than or equal to the High tolerance limit value. The tolerance colors are
configurable through the IMSurvey Options dialog box. For more information, see
Section 24.3.3 Interface color display options. Press the Apply button to transfer
the changes to the application and the Close button to dismiss the dialog box.
The Contents group box allows editing the report item’s current content specification
(i.e., the used information items, the order of display, sort orders, and filters). This gives
control over the appearance of the Item. Note that table IMSurvey report items always
contain all of the possible information items, and that the Tables tab in the property
sheet allows choosing to display only certain of them. For example, the table’s contents
can be edited individually to display the desired columns on a page or background.
Two buttons allow editing the item’s (container’s) content specifications:
Edit
A button that displays an Edit Table Contents dialog box like the one shown in
Figure 21.24. It allows editing the current content specification for the table report
item. This includes changing the status of selected information items using the
Use and Ignore buttons, and changing the order of selected information items
Figure 21.25 The dialog box that allows assigning a template to a table item.
using the dialog’s Up arrow and Down arrow buttons. When the dialog box offers
the Sort and Filter tabs, sorting rules and filter rules can be edited, created, and
deleted. Any changes made to the list are automatically reflected in the display of
the item in the active area. Note that information items preceded by the letter H
belong to the table header and those preceded by the letter R belong to the table
results. Press the Save button to save changes made to the current content
specification, or press the Cancel button to dismiss the dialog box without saving
any changes.
For complete information on editing table IMSurvey report items, see Section
20.2.5 Managing table templates.
Assign Template
A button that displays the Assign Template dialog box, shown in Figure 21.25, that
lists the available templates for the type of tabular report container. Select a
template in the Templates list and press the OK button. The template configures
the item’s current content specification.
Publish
A button that displays the Add Template dialog box that allows creating a new
user template for that type of table object from the item’s current content
specification. Specify a name using characters that are valid in file names in the
Name text box and press the Add button, or press the Cancel button to end the
operation.
For more information on table templates, see Section 20.2 Creating table report items.
The Item > Create > Creation Options command allows configuring the item creation
options for text field items and table items. On choosing this command, the dialog box
shown in Figure 21.26 is displayed, offering the following items:
Text fields
A section that offers alignment and font properties used by all new text field items
created in the formatted report or layout:
Alignment
A list box that specifies the horizontal alignment of the text within text
field items. Choose from: Left, Right, and Center.
Font
A button that displays a dialog box, shown in Figure 21.20, that allows
specifying font properties for the text in the text field items (see Section
21.2.10.1 Adding fixed items to a page or a background for more
information).
Tables
A section that offers maximum column width and text layout used by all new table
items created in the formatted report:
Text layout
A list box that specifies how the text flows in the table cells when the
Maximum column width check box is selected. Choose from:
Overwrite – Specifies that the text that does not fit in the table cell
space is to flow over the cell immediately to its right. Note that the
text overwrites other cells only until the right end of the table row is
reached.
Truncate – Specifies that the portion of text that does not fit in the
table cell space is to be hidden.
Figure 21.26 The dialog box that allows configuring the item creation options.
Note that when the text is longer than the specified maximum column
width value, the text alignment configuration specified from the Title
and Cell Format dialog box is not used. Instead, the text is aligned to the
left to allow the most text to be displayed in the cell. For example, a text
that is right-aligned and should be truncated to the left will be left-
aligned and truncated to the right.
To view an item, select it in the Report Structure/Layout Structure pane and choose the
View > Center on Item command. Alternately, an item may be double-clicked in the tree
view – the item’s page is made active and the item is centered in the view.
The active area can be zoomed. See Section 21.1.6 Manipulating the active area for
more information.
To select items, first make the page or background active (see Section 21.2.9 Making a
page or a background active). Then, click the desired item in the active area. The
selected item is highlighted in the active area and in the Report Structure/Layout
Structure pane if it is displayed. If the item on the page comes from a background, the
item can only be selected and edited on the background.
Individual items may also be selected in the active area or in the tree view of the Report
Structure/Layout Structure pane by clicking over them with the CTRL key held down.
The item box of each selected item is displayed as a dotted line, and a selection box is
drawn that encompasses all of the selected items. Note that clicking over a selected
item with the CTRL held down deselects the item. Clicking over items in the active area
with the SHIFT key held down also allows selecting multiple items, while clicking over
items in the tree view with the SHIFT key held down allows selecting a range of items.
The CTRL and SHIFT keys may be used in combination to preserve the current selection
and switch the selection status of clicked items.
An easy way to select all of the items in the active area is to use a selection rectangle.
Drag the pointer over the desired items, and the items that are completely within the
selection rectangle are selected.
The Select menu also offers commands that allow selecting items on the active page or
background:
All Items
Selects all of the items on the active page or background. Each individual item is
selected and a selection box is drawn that encompasses them all.
Invert
Inverts the current selection of items on the active page or background.
None
Deselects all of the items on the active page or background.
Editing operations are found under the Edit menu. Four standard editing operations are
available:
Cut
Removes the selected items from the active page or background and copies them
to the clipboard. They may be pasted to any page using the Paste command
(description follows).
Copy
Copies the selected items to the clipboard. They may be pasted to any page or
background using the Paste command (description follows).
Paste
Copies the contents of the clipboard to the active page or background. The items
appear under the pointer. Move the pointer to the desired location and click to
anchor the items on the page. Fixed items and variable items are entirely added
(i.e., container, properties, and content) to the active formatted report page or
background. On an active layout background or layout page, fixed items are
entirely added, while for variable items, the container and its properties, but not
its content, are added.
Delete
Deletes the items that are selected in the active page or background. They can be
recovered by choosing the Edit > Undo command.
Specific key-based editing operations are available when editing text fields. They are
described in the table that follows (note that the + symbol means that the keys must be
pressed at the same time):
Operations used to arrange the position/size of items are found on the Item menu,
shown in Figure 21.27. Three submenus offer operations that allow arranging items:
Align on Page
The selected items can be aligned horizontally to the Left, Horizontal Center, or
Right of the page or background to which they belong, and vertically to the Top,
Vertical Center, or Bottom of the same page or background. Note that for
alignment purposes, any table item that flows vertically onto another page or
pages belongs to the page on which it first appears, even if most of the item
resides on the following page.
Distribute
Items can be positioned so that they have an equal amount of spacing between
them (i.e., distribute them). They can be distributed horizontally or vertically. The
Horizontally submenu offers four menu items that can be used to achieve a
Figure 21.27 The Item menu with the commands to arrange items.
horizontal distribution. The first three specify the characteristic used to obtain the
equal spacing: Left Sides, Centers, or Right Sides. The last item, Spacing,
guarantees an equal spacing between the items. The Vertically submenu offers
four menu items that can be used to achieve a vertical distribution. The first three
specify the characteristic used to obtain the equal spacing: Tops, Centers, or
Bottoms. The last item, Spacing, guarantees an equal spacing between the items.
When Spacing is specified, EZLayout moves all items except the ones at each
extremity.
One submenu offers operations that allow making selected items the same size or
dimension:
Note that the Make Same Size command does not work for true size 2D vector
graphic image report items. See Section 21.2.11.2 The properties of images for
more information.
Bring to Front
Puts the selected items in front of the other items.
Send to Back
Puts the selected items behind the other items. Note that background items from
the background associated to a page always remain behind the page’s items.
Two operations allow grouping and ungrouping items. When several items are
grouped, they can be edited and arranged as a single item. The operations are:
Group
Groups the selected items of the active page or background. They are removed
from beneath their page or background branch and replaced by one group item.
Items that are on the background associated to a page cannot be grouped with
items that are on the page. Text field items that are grouped can be edited
individually by double-clicking. Table items cannot be included in a group. Note
that a group can also be grouped with other selected items into a new group.
Ungroup
Undoes the grouping of the selected groups in the active page or background. The
items/groups in the selected groups all become individual items/groups and
appear under the active page or background branch. The selected group items are
removed from the page or background branch.
The Image submenu offers an operation that applies only to image and snapshot items:
Crop
Enables an interactive mode that allows cropping a selected image. A cropping
frame appears over the selected image (see Figure 21.28 (a)). Drag an image crop
handle on any side of the frame to move the frame’s borders. Drag an image crop
handle on any corner of the frame to crop both the height and the width of the
frame at once. Click outside the image to confirm the image cropping. Only the
part of the image inside the cropped region is still displayed (see Figure 21.28 (b)).
Note that the original image is not altered by this operation. Select the cropped
image and choose the Crop command again. The original image appears with the
cropped frame (see Figure 21.28 (c)).
The Text Field submenu offers an operation that applies only to text field items:
Edit Text
Enables the edition of the selected text field item.
The Table submenu offers an operation that applies only to table items:
Figure 21.28 Cropping images in EZLayout. (a) The cropping frame with image crop handles
appears. (b) The cropped portion of the image remains in the active area. (c) When
cropping a cropped image, the last cropping frame appears over the entire original
image.
(a)
(b)
(c)
The Edit > Update items command allows updating selected items.
The Edit > Snapshot command enables an interactive mode that allows editing a
selected snapshot image. On choosing this command, the snapshot’s original project
view is automatically restored and the original white capture frame appears in the 3D
scene. The Edit Snapshot dialog box, shown in Figure 21.29, also is displayed, allowing
to modify the snapshot’s 3D Scene region (pixels) (see Section 20.3.2.2 Taking
snapshots of a 3D scene region), and the Snapshot size (see Section 20.3.1 Setting
related options).
Once the required parameter values have been specified, press the Recapture button.
The snapshot is edited using the newly specified region and size and project view
object visibility options.
Once the operation is complete, the 3D scene is not restored to its previous state (see
Section 21.2.20 Restoring a project view from a snapshot for more information on
restoring the project view).
Updating an image in EZLayout does not affect the snapshot report item under the
Items subbranch of the Reports branch of the IMSurvey tree view. Press the Cancel
button to exit the interactive mode.
A selected snapshot’s project view can be restored using the Tools > Restore Project View
from Snapshot command. On choosing the command, the selected snapshot’s project
view information is automatically restored. (See Section 9.7.4 Viewing project views for
more information on project views.) If the image was captured in the Object Navigator
mode or the 2D Vector mode, the mode is activated as well. Note that the restore
operation also considers the selected snapshot’s Update & restore options (see
Section 20.3.1 Setting related options for more information).
The current color scale can be assigned automatically to snapshots with project view
information.
Choose the Edit > Assign Current Color Scale to Snapshot > All command to assign the
current color scale to all snapshots.
Choose the Edit > Assign Current Color Scale to Snapshot > Selected command to assign
the current color scale to the selected snapshots.
Note that if the Automatic project update mode is deactivated, a manual update
operation is launched to update the snapshots using the newly assigned color scale.
For more information on automatic project updates, see Section 3.1 Automatic project
update.
For more information on project views, see Section 9.7.4 Viewing project views.
To move one or more items, select them and drag them to a new location.
Items in the active area can be moved on the active page or background surface. Items
that are located on a background associated to a page (see Section 21.2.11 Properties
of items in a formatted report or a layout) must be moved on the background, as they
cannot be selected from the page.
Items can be moved between the active area and pages or backgrounds in the Page
View or Background View pane.
When a selection contains more than one item, the displacement or resizing of the
items may be limited by the properties of one item.
The variable items placed on a formatted report’s pages or backgrounds contain the
item’s information and appear as real pie charts, 2D vector graphics, tables, or
snapshots, and also act as containers. The variable items placed in a layout’s pages or
backgrounds are only containers.
The contents of a formatted report can be organized based on a layout that acts as a
template, with the variable items containing information. Information is provided to
variable items in the context of the active formatted report by dragging a report item
from the IMSurvey tree view onto the same-type item on a formatted report’s page.
When a report item is dragged and dropped onto a same-type item in a formatted
report page or background, the contour of the variable item is displayed in red and the
box representing the report item is no longer displayed, and the information is read
into the variable item and appears as a real pie chart, 2D vector graphic, and so on.
When a report item is dragged and dropped onto a same-type item in a layout page or
background, it is added and does not replace the other container.
If a layout does not contain a variable item required in a formatted report, or is missing
a fixed item, new items may be added to the layout (see Section 21.2.10 Adding items
to a page or a background, Section 21.2.10.1 Adding fixed items to a page or a
background, and Section 21.2.10.2 Adding variable items to a page or a background).
Note that the new items will not appear in existing formatted reports that use the
layout, only in new formatted reports created using the updated layout as a template.
To copy the contents of a different report item to a variable item in a formatted report,
drag the report item over the same-type variable item on a page. The report item’s
contents will be copied into the formatted report and associated with the variable item,
replacing its previous content.
To save a formatted report to the IMSurvey project, choose the File > Save command.
The IMSurvey project must also be saved to ultimately save the changes made to the
formatted reports.
To print a formatted report, make it active (see Section 21.2.29 Making a formatted
report active), choose the File > Print command. In the dialog box that is displayed,
select a printer, and then press the Print button. Or press the Cancel button to cancel
the operation.
Each report page is printed in the portrait or landscape orientation specified in its page
properties.
Note a paper size that is different from the one specified in the Page Setup dialog box
(see Section 21.2.3 Specifying the page setup) may be specified to the printer device. In
this case, if the paper size is smaller than the one specified in the dialog box, a portion
of each report page may not get printed.
Best results are achieved when printing at 600 dpi and using a paper size that is the
same as the one specified in the Page Setup.
Make a formatted report active and choose one of the operations (description follows)
on the File > Export > Formatted Report submenu. These commands are also available
from the IMSurvey tree view, by right-clicking one or more reports listed under the
Formatted Reports subbranch of the Reports branch, or on the module’s File > Export >
Formatted Report submenu.
The File > Export > Formatted Report > HTML File command allows exporting a formatted
report to HTML format. On choosing this command, a browser is displayed to specify a
file name and location. The browser also offers the Image properties group box to
specify the image Height (pixels) and Width (pixels). Press the Save button to launch
the export operation, or the Cancel button to cancel the operation. The formatted
report is saved to HTML format.
The File > Export > Formatted Report > Image Files command allows exporting a
formatted report to an external image format. On choosing this command, a browser is
displayed that allows specifying a file name and location. The image format can be
specified in the Save as type list box. The browser also allows setting the JPEG quality
and offers the Image properties group box to specify the image Height (pixels) and
Width (pixels). Press the Save button to launch the export operation, or the Cancel
button to cancel the operation. Each page of the formatted report, including an
associated background, is saved as a separate image. The images all have the same
name to which a sequential number is added.
The File > Export > Formatted Report > PDF File command allows exporting a formatted
report to PDF format either using the Adobe Acrobat (and not Adobe Reader) on your
workstation, or using simple PDF creation. On choosing this command, a browser is
displayed. Specify a file name and location. If Abobe Acrobat is not detected on your
workstation, the browser also offers two parameters: Resolution (DPI) with a default
value of 300 and JPEG quality with a default value of 90. Press the Save button to
launch the conversion to PDF or the Cancel button to end the operation. When
converting to PDF:
Figure 21.30 The dialog box used to convert a formatted report to PDF format when a workstation
has Adobe Acrobat.
Once the conversion is complete, the PDF file opens in your Adobe Reader.
Right-click the one or more desired formatted reports under the Formatted Reports
subbranch of the Reports branch of tree view, and click Edit; each report will open in
a different tab in the EZLayout pane.
Select the File > Open > Report command. The Open Formatted Report dialog box,
shown in Figure 21.31, opens. From the Reports list, select the desired formatted
reports. Press the Open button to open the reports and close the dialog box, or press
the Close button to dismiss the dialog box.
To edit a formatted report, first open the desired formatted report, make it the active
report, and assign different IMSurvey report items to variable items in the backgrounds
and pages.
Figure 21.31 The dialog box used to select one or more reports to open in the EZLayout pane.
When more than one report and/or layout is open within the EZLayout tool, it is
possible to copy items from one formatted report and paste them in another report or
layout.
Note that when the EZLayout pane is hidden with open formatted reports, the open
reports are neither closed nor saved. As long as IMSurvey is open, already open reports
are redisplayed with newly opened reports the next time the EZLayout tool is opened.
On exiting IMSurvey, a message prompts the user to save any open reports. A
formatted report must be saved to record the changes made to it (see Section 21.2.25
Saving formatted reports).
If the IMSurvey project has more than one formatted report open in the EZLayout pane,
a formatted report can be made active in several ways:
Click the tab of the desired formatted report at the bottom-left of the EZLayout pane.
To create an auto-formatted report, select the IMSurvey report items to include in your
report, under the Items subbranch of the Reports branch of the tree view. If no item is
selected, all IMSurvey report items that meet the criteria of the report creation
operation will be used (i.e., all report items other than the header, the footer, a video, or
a text field). Then, choose the Report > Create Auto-Formatted Report command. The
dialog box shown inFigure 21.32 is displayed, offering the following items:
Name
A text box that specifies the name of the new auto-formatted report; the name can
be edited. The default name report <number>, where <number> represents an
incremented integer, is proposed.
Method
A section that offers options related to creating a formatted report. It contains the
following items:
Report layout
A check box that enables a list box that allows specifying the layout file to use to
create the auto-formatted report. The check box is cleared by default. When the
check box is cleared, the report is created with one empty background and pages
that contain only the IMSurvey report items selected to be included in the auto-
formatted report.
Select an EZL layout file in the adjacent list box, or press the Browse button to
specify a layout file outside the current layout folder. A file browser is displayed to
specify the EZL (EZLayout) file. A default layout file named default.ezl is available.
It contains two backgrounds (Title Background and Report Background) and a page
(Page 1) which contain the InnovMetric and PolyWorks logos, text items with
report codes and report fields, and finally at least one blank page (Page 2) to hold
the IMSurvey report items selected to be included in the auto-formatted report.
Additional pages can be created if more space is needed for the selected report
items.
The Report Layout check box state and the last layout file selected to create the
auto-formatted report are saved in the IMSurvey configuration and become the
new defaults for subsequently creating reports manually or automatically.
Creation options
A section that enables specifying additional image and table item options used to
generate the auto-formatted report. It offers the following items:
Image size
A list box that specifies the size of the image report items added in the
formatted report. Choose from: Full Page, 1/2 Page (each image can
only be as high as half of the page height or width, allowing a maximum
of two images to be placed on a page), and 1/4 Page (each image can
only be as high as a half of the page height and width, allowing a
maximum of four images to be placed on a page). The default value is 1/
2 Page.
Press the Create button to continue or the Close button to dismiss the dialog box.
When continuing, the EZLayout interface is displayed. A layout file chosen in the
Report layout list is used as a template to define the report which opens in EZLayout.
When the Show Report Properties on creation check box is selected, the Report
Properties dialog box is displayed, to allow editing the properties of the newly created
formatted report.
When a layout file is selected in the Report layout list of the Create Formatted
Report dialog box, the automatically generated formatted report is created using the
layout file as a template. This allows specifying several pages with fixed items, such
as a title page for example, which are placed before the automatically generated
pages that contain the selected report items.
The automatically generated pages are created from the default blank page of an
empty formatted report or from the last page of the specified layout file. Each
generated page has the same orientation (Portrait or Landscape) and the same
background that is specified in the formatted report’s default blank page or in the
last page of the layout file.
If the last page of the layout file contains no items, that page is used to generate the
report pages that contain the IMSurvey report items selected to be included the
auto-formatted report.
Note that the Header and the Footer items are only used when exporting IMSurvey
report items to an external format (Microsoft Excel and Microsoft Word, HTML, or text
file). See Section 20.9 Generating reports in external document formats for more
information.
A default layout file, named default.ezl, can be selected as a template when creating
formatted reports manually or automatically.
The default.ezl layout file has two backgrounds (Title Background and Report
Background) and a page (Page 1) which contain InnovMetric and PolyWorks logos, text
items with report codes and report fields, and finally one blank page (Page 2).
Additional layout files can be created and used as formatted report templates,
according to your organization’s specific needs.
Creating a layout consists in specifying a layout file name and a location, copying the
report item objects to create same-type containers, and then adding other items in
the one or more backgrounds and pages to complete the layout file that can be used
as a formatted report template. See Section 21.4.1 Creating a new layout for more
information.
Once saved, a layout file can then be selected and used as a template for a formatted
report at the time it is created. A layout file can also be opened and edited in the
EZLayout tool.
To create a new layout file, choose the File > New > Layout command. The new layout is
created with one empty background and one empty page, the page is displayed in the
active area, and the layout is displayed in the EZLayout pane under the name
untitled.ezl, as shown in Figure 21.33, until it is saved for the first time. See Section 21.4.2
Saving a layout file for more information.
The layout file’s first page number can be edited, and custom fields can be added from
the layout property sheet. See Section 21.4.6 Specifying the layout properties for more
information.
The layout file is edited using the same tools as for creating and editing formatted
reports. See Section 21.2 Creating formatted reports for more information.
EZLayout
Standard toolbar
Thumbnail view of
layout pages
To save the layout file, choose the File > Save command. When saving the layout file for
the first time, the Save Layout dialog box is displayed, as shown in Figure 21.34, that
allows specifying a location and file name.
The Favorite paths list box allows to select a path to a layout folder where the layout
file can be saved. Choose from: Workspace Layouts, User Layouts, or Last User-
Defined.
A file with a EZL extension is created in the specified location. A folder with the same
file name followed by “_Files” may be created at the same time. The folder contains the
content of the fixed items in the layout file.
Once the layout file has been saved, it can be associated to formatted reports at the
time they are created, and it can be shared with others. For more information on
sharing an external layout file, see Section 21.5 Using formatted reports in an
automated inspection process.
The backgrounds, the pages and the disposition of report items of a formatted report
can be saved as an external file. This allows using the layout file as a template by
selecting it when creating other formatted reports.The layout file can also be selected
when automatically creating a formatted report (see Section 21.2.29 Making a
formatted report active).
To save a formatted report as an external layout file, first open it (see Section 21.2.28
Opening/editing existing formatted reports) or make it the active report in the
EZLayout pane (see Section 21.2.29 Making a formatted report active).
Choose the File > Save As Layout command to create the layout file. Alternately, right-
click the formatted report under the Formatted Reports subbranch of the Reports
branch of the IMSurvey tree view, and click Save As Layout on the shortcut menu.
To save a layout file under another name as a basis for another layout or to rename it,
first open it (see Section 21.4.4 Opening/editing an existing layout) or make it the active
layout in the EZLayout pane (see Section 21.4.5 Making a layout active), and then
choose the File > Save As command.
The Save Layout dialog box is displayed to specify a location and file name, as shown in
Figure 21.34. The Favorite paths list box allows to select a path to a folder where the
layout file can be saved. Choose from: Workspace Layouts, User Layouts, or Last
User-Defined.
A file with a EZL extension is created in the specified location. A folder with the same
file name followed by “_Files” may be created at the same time. The folder contains the
content of the fixed items in the layout file.
See Figure 21.35 for an example of a formatted report saved as a layout file.
Note that saving a layout file under another name is the safest method to use to
rename it. In the process, if a folder of the same name exists, its content is duplicated
and its name is changed to match the one of the EZL file.
Figure 21.35 The EZLayout pane with a layout file saved from a formatted report.
Thumbnail view of
backgrounds
Thumbnail view of
pages
Once the layout file has been saved, it can be used as a template to create same-type
formatted reports and it can be shared with others. For more information on sharing an
external layout file, see Section 21.5 Using formatted reports in an automated
inspection process.
To open an existing layout file for editing, select the File > Open > Layout command in
the EZLayout pane. The Open Layout dialog box opens, as shown in Figure 21.36.
Select the desired layout file. The Favorite paths list box allows to select a path to a
folder where the layout file may be found. Choose from: Workspace Layouts, User
Layouts, System Layouts, or Last User-Defined. The System Layouts folder contains
the default layout file, which is named default.ezl.
Note that the default.ezl layout file can be opened, but not modified. Changes can be
made with the EZLayout tool. However, when attempting to close or save it, a message
prompts saving it under another name.
Layout files are identified by the .ezl extension in the names displayed in the tabs in the
lower left of the EZLayout pane.
The layout file is edited using the same tools used to create and edit formatted reports.
See Section 21.2 Creating formatted reports for more information. The layout file must
be saved after the modifications are completed (see Section 21.4.2 Saving a layout file).
When more than one EZLayout tool is open, it is possible to copy items from one layout
and paste them in another layout or formatted report.
Note that changes made to the layout file are not reflected in the existing formatted
reports that are based on the layout. The changes apply to the formatted reports that
will use the updated layout file as a template at the time they are created.
If the IMSurvey project has more than one open layout file, to make one active, click the
tab of the desired layout at the bottom left of the EZLayout pane’s active area.
Layout files are identified by the .ezl extension in the names displayed in the tabs.
The Layout Properties dialog box offers tools and options to edit the number of the first
page, to view standard fields, and to create or delete user-defined fields. When creating
a formatted report from a layout, fields specified in the layout are added to the report.
Adding, editing, or removing fields from the layout properties do not affect those from
the project or piece properties. For more information, see Section 3.2 Customizing the
module.
The Layout Properties dialog box is similar to the Report Properties dialog box, except
no values can be set for standard and user-defined fields. For this reason, the list has
only a Property column.
Standard field values, user-defined fields, and user-defined field values can be added
later to formatted reports from the Report properties (see Section 21.2.2 Specifying the
report properties).
To display the Layout Properties dialog box, choose the File > Layout Properties
command on the EZLayout pane. The dialog box shown in Figure 21.37 is displayed. It
offers the following items:
Name
A view-only text box that displays the name of the layout file. When a layout is
created, the default name is untitled.ezl. The name of the layout file is specified
when it is saved for the first time. For more information, see Section 21.4.2 Saving
a layout file.
The dialog box also offers a list of the standard and user-defined fields used to
automate the capture of information pertaining to formatted reports based on the
layout. The fields are available in the layout through fixed and variable text field items.
Values can be specified for standard fields in the report properties of the formatted
reports that use the layout file as a template. For more information, see Section 21.2.2
Specifying the report properties.
Field Code
Title $_REPORT_TITLE
Author $_REPORT_AUTHOR
All standard field codes for the report properties are identified by the $_REPORT prefix.
The list also allows creating and editing user-defined fields to automate the capture of
additional personalized information pertaining to formatted reports based on the
layout. User-defined fields are available in layouts through fixed and variable text field
items.
Values can be entered for user-defined fields in the report properties of the formatted
reports that use the layout file as a template. For more information, see Section 21.2.2
Specifying the report properties.
All user-defined field codes for the report properties are identified by the
$_REPORT_CUSTOM prefix. The remaining of the code of each user-defined field is
composed of the name of the field, with underscored spaces between words (e.g.,
$_REPORT_CUSTOM_MY_USER_DEFINED_FIELD). For more information on inserting
user-defined fields in fixed and variable text field items, see Section 21.2.10 Adding
items to a page or a background.
To add a user-defined field to the list, press the Add button . Once the new user-
defined field is added to the list, enter a unique name in the Property column, as
shown in Figure 21.38. The dollar sign ($) must not be used in a user-defined field
name, and the field cannot be empty.
Figure 21.38 Adding a user-defined field in the list of the Layout Properties dialog box. The name
of the field is entered in the Property column.
To remove one or multiple user-defined fields selected in the list, press the Remove
button .
Press the Apply button to transfer the layout values to the layout file, and the Close
button to dismiss the dialog box.
Standard and user-defined fields that are inserted in text field items are displayed as
codes on backgrounds and on layout pages. For more information on inserting
standard or user-defined fields to fixed or variable text field items, see Section 21.2.10
Adding items to a page or a background.
An EZL layout file can be shared with other IMSurvey users so formatted reports can be
produced based on a common template. When a folder with the same name as the EZL
file followed by “_Files” exists in the same location, it contains the content of the fixed
items and information for variable items, such as Table template configuration, in the
layout file.
Both the EZL file and the folder of the same name must be provided to other users and
be located in a single folder on their computer.
Figure 21.39 An example of macro commands that, for a specified formatted report, assign
existing IMSurvey report items to variable layout items.
The EZL file and its associated folder can be renamed at once by saving the EZL file
under another name. For details, see Section 21.4.3 Saving a formatted report or a
layout as a layout file.
The layout file and the associated folder must not be renamed using standard Windows
procedures. For more information, see Section 21.4.8 Renaming a layout file.
A layout is an external file. The layout name displayed in the tab from the EZLayout
pane is the layout file’s name, which has the .ezl extension.
A layout file may be associated to a folder with the same file name followed by “_Files”.
The folder contains the content of the fixed items and information for variable items,
such as Table template configuration, in the layout file. For this reason, the layout file
and the associated folder must not be renamed using standard Windows procedures.
The recommended and safe method to use to rename a layout and its associated folder
is to save it under another name. For more information, see Section 21.4.3 Saving a
formatted report or a layout as a layout file.
The Macro Script Editor can be left open while using IMSurvey. Most operations (not
those performed using EZLayout) take the form of a command which appears in the
Command History pane. For complete information on using the Macro Script Editor
and the Macro Script Control Language, choose the Help > Reference Guides > Macro
Script s command.
Updatable
A check box that allows specifying whether the report is set to updatable or not.
By default, reports are updatable. New formatted reports can be made updatable/
nonupdatable by selecting/clearing the Updatable check box on the Default
formatted report update parameters section of the Reports page of the
IMSurvey Options dialog box. For more information, see Section 3.1.2 Automatic
project updating.
Shorter subjects are included in this chapter, while more elaborate subjects, like editing Reference and Data
objects, managing pieces and customizing module options are contained within their own chapter. These
include:
Multiple coordinate systems are useful for users who need to work in a specific frame of
reference for the purpose of visualizing and reporting information. When activating a
different coordinate system, no transformation is applied to objects. It follows that the
Global and Last matrices of Data and Reference objects do not change, and neither do
their data alignments. Furthermore, the 3D scene is not displaced.
Objects imported into a project can be imported into the active or the world
coordinate system. The desired behavior can be specified using the Import into
coordinate system option; for more information, see Section 24.2 Project options.
When the Automatic project update option is selected and an object used to create
the coordinate system is edited, the coordinate system is automatically updated.
22.1.1 Introduction
Each new project uses the world coordinate system. It cannot be deleted or renamed.
New coordinate systems can be created. They can be renamed. And, they can be
deleted, unless they are linked to a data alignment or a data color map.
Only one coordinate system can be active at a time. Users may view and report
information in the active coordinate system.
Coordinate systems are represented in the 3D scene as an origin and three axes. The
active coordinate system is displayed using red, green, and blue for the X, Y, and Z axes
respectively. Coordinate systems that are not active are displayed in gray. The world
coordinate system has a slightly different display – a gray cube is shown at its origin.
See Figure 22.1.
All objects, regardless of their status, are represented in the new coordinate system.
Figure 22.1 (a) An active coordinate system. (b) An inactive coordinate system. (c) Both
coordinate systems are displayed.
The following object properties are expressed in the active coordinate system: the
numerical values of x, y, z locations and i, j, k orientations.
The default values, for example in the object creation dialog boxes, do not change.
The bounding box of the 3D scene is recalculated. This may influence the creation of
certain primitives, like a plane primitive created numerically, or certain dependent
primitives that are created using the bounding box.
To create a coordinate system, choose the Tools > Coordinate Systems > Create
command. The dialog box shown in Figure 22.2 is displayed. The dialog box is
configured according to the specified creation method. Use the dialog box as follows:
1. Specify a name in the Name text box, or accept the default name coord sys
<number>, where <number> is an automatically incremented integer for
coordinate systems.
2. Choose a creation method in the Method list box. Two methods are offered:
A preview of the final result is displayed as soon as the specified parameters allow it.
The preview is larger than a created coordinate system to make it easy to see, and it
is updated with any new/edited information.
Figure 22.2 The dialog box configured to create coordinate systems numerically.
If a preview cannot be generated using the current information, the Create button
is made unavailable. If the problem is due to a user specification, a warning symbol
appears beside the Create button with a descriptive tooltip.
4. Specify options in the Options section, which offers the following item:
New coordinate systems are created under the Coordinate Systems branch in the
tree view. If the Set as the active coordinate system option is selected, it becomes
the active coordinate system.
Origin
A section used to specify the origin of the coordinate system. It offers the following
items:
x, y, x
Text boxes that allow specifying the three coordinates of the origin. Enter
values manually. A center-point-based primitive, or a feature containing
only one center-point-based primitive, may be dragged over this area to
provide a value. The default value is zero for each text box.
Axes
A section used to specify two axes. It offers the following items:
First axis
A list box that allows specifying the first axis. It offers the standard axes:
+X, -X, +Y, -Y, +Z, -Z. The default value is +Z.
i, j, k
Text boxes that allow specifying the three coordinates of the orientation
of the first axis. Enter values manually. An axial primitive, or a feature
containing only one axial primitive, may be dragged over this area to
provide a value.
Second axis
A list box that allows specifying the second axis. It offers the same
standard axes as the previous list box, without the axis specified for the
previous item. The default value is +X.
i, j, k
Text boxes that allow specifying the three coordinates of the orientation
of the second axis. Enter values manually. An axial primitive, or a feature
containing only one axial primitive, may be dragged over this area to
provide a value. The default value is zero for each text box.
The From Translation and Rotation method allows specifying a coordinate system by
specifying a numerical transformation of the active coordinate system using a
Figure 22.3 The dialog box configured to create coordinate systems from a translation and a
rotation applied to the active coordinate system.
translation and/or a rotation. When this method is specified, the dialog box is
configured as shown in Figure 22.3. Specify the items that follow. Note that all
coordinates are defined in the active coordinate system.
Translation
A group box that offers x, y, z text boxes to specify a translation. The default values
are 0.0 mm, 0.0 mm, and 0.0 mm.
Rotation
A group box that allows specifying up to three rotations in degrees in the specified
sequence. The sequence is specified by choosing a standard axis in the first, or the
first and the second, list boxes. The rotation values, in degrees, are specified in the
adjacent text boxes. The default value for each rotation is 0.0 degrees.
To activate a coordinate system, right-click it in the tree view to display a shortcut menu
and click Activate. The active coordinate system is displayed in bold.
To display the property sheet of a coordinate system, select the object and choose the
Edit > Object Properties command. The property sheet shown in Figure 22.4 is displayed.
The Coordinate system tab contains the geometrical properties of the object and, when
appropriate, the objects used to create the coordinate system. The information on the
tab cannot be edited.
Origin
A group box that allows specifying the origin of the coordinate system by means
of the following items:
x
The x coordinate of the origin.
y
The y coordinate of the origin.
z
The z coordinate of the origin.
X axis
A group box that allows specifying the coordinates of the X axis of the coordinate
system by means of the following items:
i
The i coordinate of the X axis.
j
The j coordinate of the X axis.
k
The k coordinate of the X axis.
Y axis
A group box that allows specifying the coordinates of the Y axis of the coordinate
system by means of the following items:
i
The i coordinate of the Y axis.
j
The j coordinate of the Y axis.
k
The k coordinate of the Y axis.
Z axis
A group box that allows specifying the coordinates of the Z axis of the coordinate
system by means of the following items:
i
The i coordinate of the Z axis.
j
The j coordinate of the Z axis.
k
The k coordinate of the Z axis.
Source objects
A list area that contains the names of the object(s) used to create the coordinate
system (i.e., another coordinate system). This area is not displayed when the
creation method is Numerically.
This information is used to update the coordinate system: When an object used to
create the coordinate system is edited, the coordinate system is updated.
Figure 22.5 Examples of types of screen annotations. Each one has an annotation template that
controls the information that is displayed on creation. If desired, the contents of each
individual annotation can be customized.
Picked coordinate
annotation
Object annotation
Items common to all property sheets are described in Section 7.6 Using object property
sheets.
22.2 Annotations
For most 3D objects, an annotation attached to the object can be displayed containing
information about the object, such as its name or its geometric properties. Annotations
are also available for picked coordinates and errors/values. Annotations allow
producing screen snapshots that are rich in information. This section presents all of the
tools related to annotations.
22.2.1 Overview
Annotations are 2D boxes that are usually attached to 3D locations and that display text
information, as shown in Figure 22.5. There are annotations for all objects that can be
displayed in the 3D scene.
It is also possible to pick point coordinates on specific objects and pick errors or values
on error color maps. The picked information is represented by annotations that can be
viewed and used to create reports, hidden, and deleted.
Annotations are configurable. The information items to display on creation, and in what
order the items appear, is specified using annotation templates. All of the same-type
objects that use a specific annotation template display the same information. In
addition, it is possible to customize the annotation display for a particular object
through the Annotation tab of its property sheet. This is also true for the annotations
of picked error/value coordinates. In this case, as they are not objects, it is necessary to
ALT+right-click the annotation in the 3D scene and click Annotation Contents on the
shortcut menu to customize its contents.
Note that a wide range of options are offered that allow specifying the appearance and
positioning of annotations, as well as the use of error flags in annotations. Annotations
can also dragged using a special mode to facilitate taking snapshots of the 3D scene.
Finally, it is possible to hide and restore all annotations, and to hide annotations
interactively by clicking in the 3D scene.
Templates are used to control the information items that are available for each type of
annotation (e.g., cross-section). There are standard annotation templates for all objects
displayed in the 3D scene, as well as for picked coordinates and errors/values. New
annotation templates can be created for specific objects. If there are two or more
templates for a type of annotation, then one is designated as the default template. The
default template defines the contents of annotations of that type on creation.
Annotation templates are configurable. The display status of the information items and
the order in which they appear can be modified using a template editor.
22.2.2.1 Creating and editing annotation templates with the IMSurvey Options
dialog box
The Templates page of the IMSurvey Options dialog box allows creating and editing
annotation templates and specifying the default annotation template; for complete
information, see Section 24.4.3 Annotation template options. To access the page,
choose the Tools > Options command to display the options dialog box, click
Annotations, and then click Templates.
Figure 22.6 An object’s annotation can be edited through the Annotation tab of its property
sheet.
The content of an object’s annotation can be customized using the Annotation tab of
the object’s property sheet (see Figure 22.6).
The Annotation tab’s Contents group box offers items that allow customizing an
object’s annotation. The active option button indicates if the annotation contents are
currently controlled by an annotation Template or whether they are Object specific.
On creation, the Template option is selected, and the template name is (Default),
which represents the default template at any given moment for that annotation type.
To edit the annotation contents, specify another annotation template in the Template
list box and press the Apply button.
Or, press the Edit button. The definition of the template shown in the Template list box
is copied to the object’s properties, the Object specific option button is selected, and a
list editor (described in Section 24.4.3 Annotation template options) is displayed,
showing those properties. To use and ignore information items for display, select
information items and use the Use and Ignore buttons. The order of information items
in the list can be changed by selecting them and using the Up arrow and Down arrow
buttons to the right of the dialog box. The current properties can be transferred to the
default template for that annotation type by selecting the Set as default check box.
Changes are saved by pressing the Save button. The editor closes, and the Publish
button becomes available. It allows saving the current annotation properties as a new
template for that annotation type. On pressing the button, a dialog box is displayed.
Specify a Name for the template (only use characters that are valid in a file name) and
press the Add button.
Note that when a template is used to control annotation contents, it removes any
object properties related to annotation content.
Customizing color map point annotations is done using menu items accessed by
ALT+right-clicking the annotation in the Default operation mode (see Figure 22.7):
The Annotation Template command displays the Assign Template dialog box that
allows choosing a different annotation template, or reverting to the default
annotation template for the annotation type. Make a choice in the Templates list
and press the OK button, or press the Cancel button to end the operation.
Picking points in the 3D scene and displaying their (x, y, z) coordinates and/or
intensity/color information. These points have coordinate annotations (see Figure
22.8).
Picking Data points on a color map and displaying the deviations or values
computed by a measurement method. See Figure 22.9. Such picked points have
color map point annotations.
Creating Text Field report objects and displaying them within text annotations.
This section presents tools related to three types of annotations. The tools are offered
on the Tools > Annotations > Create submenu.
Certain deviation measurement operations (e.g., From Reference Object Surface, From
Feature Primitives) show results using a high-resolution color map overlaid on the
measured objects, with a related color scale.
The Tools > Annotations > Create > Color Map Point Annotations command enables an
interactive mode that allows obtaining the measured value for individual Data points
by clicking over a color map. Results are displayed in color map point annotations.
The measure associated with Data points can be obtained by clicking Data objects,
cross-sections, and Reference objects overlaid with a color map (see Section 19.1
Controlling the correspondence between deviations and colors). For polygonal Data
objects and cross-sections, the closest vertex or point is found. For Reference objects,
Data points overlaid on top of the Reference object are automatically found.
An annotation is automatically displayed for each picked Data point. By default, the
annotation template is configured to only show the measured value associated with
the Data point. The annotations are colored using the color of the measured value on
the color scale. The name of the corresponding annotation templates are Color Map
Point (“type of operation”). Note that if the alignment of a Data or a Reference object
used in the operation changes, the annotations are dimmed and the deviation values
are removed.
If the annotation positioning mode is set to Fixed (see Section 24.4.2 Annotation
positioning options), an annotation-dragging mode is automatically entered that
allows moving the annotation to a desired position. Click to exit the dragging mode,
leaving the annotation at its current position.
Note that if the pointer hovers over a pickable area for more than half a second, a
temporary annotation appears on the screen. Left-click to create a real annotation. If
the pointer is moved, the temporary annotation disappears.
Figure 22.9 Examples of color map point annotations picked on a color map.
The Tools > Annotations > Create > Coordinate Annotations command enables the
interactive coordinate picking mode. The mode that allows picking points by clicking
Data and Reference objects, primitives, and cross-sections. For polygonal Data objects,
Reference objects, and cross-sections, clicking with the SHIFT key up interpolates a
point underneath the pointer, while clicking with the SHIFT key pressed finds the
closest vertex.
If the pointer hovers over a pickable area for more than half a second, a temporary
annotation appears on the screen. Left-click to create a real annotation; if the pointer is
moved, the temporary annotation disappears.
An annotation is automatically displayed for every picked 3D location. By default, the (x,
y, z) coordinates of the picked point are displayed. Two standard annotation templates
are also available to display the luminance (intensity) and RGB colors, in addition to the
point coordinates. The name of the annotation type to edit is Picked Coordinates.
If the annotation positioning mode is set to Fixed (see Section 24.4.2 Annotation
positioning options), an annotation-dragging mode is automatically entered that
allows moving the annotation to a desired position. Click to exit the dragging mode,
leaving the annotation at its current position.
Creating a text annotation involves creating a Text Field report item, configuring it to
display within a text annotation and, optionally, creating an attachment point for the
annotation. To create a text annotation, choose the Tools > Annotations > Create > Text
Annotations command.
For information on this operation, see Section 20.5.1 Creating a text field object. For
information on attaching a text annotation, see Section 22.2.6 Attaching text
annotations to 3D locations.
When objects are created, their annotation is automatically attached to the object at a
default location. The annotations of cross-sections are always attached to the
measured component, if available. When the measured component is hidden, they are
attached to the nominal component.
When objects are created, their annotation is automatically attached to the object at a
default location. Certain modification or transformation operations can change the
location of the attachment points of primitives, and cross-sections:
For other types of Reference or Data objects, when an element is hidden, the
attachment point is projected onto the closest point.
Text annotations are 2D boxes containing user-defined text from a Text Field object. For
information on Text Field objects, see Section 20.5 Creating, visualizing, and
customizing text field objects. An unattached text annotation remains at a fixed
location and is ignored by the automatic annotation positioning modes (see Section
24.4.2 Annotation positioning options). The Tools > Annotations > Attach Text
Annotation command allows attaching text annotations to 3D locations by picking
attachment points.
Select a text annotation by clicking it. It is displayed in red. Deselect a text annotation
by clicking away from it.
To pick the closest vertex, or the closest point on a child cross-section, press
SHIFT and middle-click.
When picking on curve-based primitives, the picked point is projected onto its
perimeter.
The interactive mode is enabled by choosing the Tools > Annotations > Drag command,
by pressing the Drag Annotations button (shown to the right) of the 3D scene toolbar,
or, when in the default mode, by holding down the ALT key while clicking on an
annotation. The automatic positioning of annotations, if enabled, is disabled during
this process. It will be reactivated after the dragging and editing mode is exited and the
3D scene is moved.
In the interactive mode, the pointer changes to a selecting hand with an annotation
(see in the right margin) to allow picking annotations. The interactive mode functions
as follows:
Use the SPACEBAR to temporarily exit the mode and perform rotations/translations
in the 3D scene.
Annotation label
Attachment line
Attachment point
Multiple selection: Keep the CTRL key down and left-click – previously picked
annotations remain selected, and the selection status of the annotation
underneath the pointer is switched.
When the pointer is over a selected annotation, the pointer changes to a hand with
direction arrows (see in the right margin) to allow dragging the selected annotation
to a new location.
A preview of the annotation label and attachment line is highlighted until the left
mouse button is released.
Place the pointer over an attachment point (the pointer will change to a picking hand
as shown in the right margin).
Left-click and move the attachment point by holding down the left mouse button,
and dragging the mouse to a new location.
A preview of the attachment line and point is highlighted until the left mouse button
is released.
When an annotation is selected but the pointer is not over its label or its attachment
point, the pointer changes to a pencil with an annotation (see in the right margin).
Clockwise: Middle-click.
Exit this mode by right-clicking or pressing the ESC key (if the mode was entered by
choosing the Drag command) or by releasing the ALT key.
When the annotation positioning mode (see Section 24.4.2 Annotation positioning
options) is set to Close to Border, or is set to Close to Object and its Automatic
repositioning option is selected, annotations are automatically repositioned with
changes in the 3D scene.
When the annotation positioning mode is set to Close to Object and its Automatic
repositioning option is not selected, annotation positions are calculated on creation
and are not updated with changes in the 3D scene. In this case, two commands on the
Tools > Annotations > Optimize Position submenu allow refreshing the current
annotation positioning of all or selected annotations:
All
Refreshes the current annotation positioning of all annotations.
Selected
Refreshes the current annotation positioning of selected annotations.
When the annotation positioning mode is set to Fixed (see Section 24.4.2
Annotation positioning options), annotation positions can only be changed by
dragging (see Section 22.2.7 Dragging annotations in the 3D scene).
The display status of an object annotation can be visualized as the Annotation check
box in the object’s property sheet. The display of annotations whose display status is
activated can be affected as follows:
Annotations for which the 3D attachment point is located outside of the 3D scene
may not displayed. This behavior is controlled by the Hide annotations when
attachment point is hidden annotation option.
The display status of annotations, whether they are currently displayed or not, can be
modified by operations on the View, Hide, and Hide Interactively submenus of the View
menu. In fact, the display status can be set to On (visible) or Off (hidden) for individual
annotations, for types of annotations, or for all annotations. Furthermore, the display
status of an object annotation can be visualized as the Annotation check box in the
object’s property sheet.
The Show annotation for new objects item specifies the display status of annotations
for newly created objects. For more information, see Section 24.4 Annotation options.
Several operations on the Report > Create Tables submenu allow generating a tabular
report object, under the Items subbranch of the Reports branch of the tree view, from
picked color map point and coordinate annotations. For more information, see Section
20.2.2 Creating tables.
Several options are available for annotations. They allow controlling the appearance
and positioning of annotations, creating and editing annotation templates, and more.
Options are also offered for annotations that make use of error flags (i.e., annotations of
picked errors). All of the options are documented in the subsections that follow.
Annotation options are located on the Annotations page, and its subpages, of the
IMSurvey Options dialog box. For complete information, see Section 24.4 Annotation
options. To access the pages, choose the Tools > Options command. The IMSurvey
Options dialog box is displayed. Click Annotations in the tree view.
To troubleshoot project updating, choose the Tools > Troubleshoot Project Update
command, or click the icon (shown to the right) located at the right end section of the
status bar (see Section 4.5 The status bar). Alternatively, click the icon’s menu button
and select the Troubleshoot Project Update command. The Troubleshoot Project Update
dialog box shown in Figure 22.11 is displayed.
The Troubleshoot Project Update dialog box may contain lists of objects with different
update status. For each list, objects are listed in the order that they appear in the tree
view. When no objects are in error, have a warning, or are out-of-date, the dialog box
informs that all objects are up-to-date. The view-only content of the dialog box
depends on the context and is modified in real time.
Name
A column that displays the name of each incompatible object, preceded by its
icon. This column is displayed by default.
The Out-of-date objects section is displayed when at least one object is out-of-date.
This section offers a list with the following column:
Name
A column that displays the name of each out-of-date object, preceded by its icon.
This column is displayed by default.
The Objects in error section is displayed when at least one object could not be
updated. This section offers a list with the following columns:
Name
A column that displays the name of each object in error. This column is displayed
by default.
Message
A column that displays the reason why the object could not be updated. This
column is displayed by default.
The Objects with warnings section is displayed when at least one object has a
warning. An object has a warning when it could not be updated because at least one of
the objects it depends on is in error. This section offers a list with the following
columns:
Name
A column that displays the name of each object having a warning. This column is
displayed by default.
Message
A column that displays the description of the warning followed by the name of the
objects causing the warning, which are located one level backwards and may, in
turn, have a warning or be in error. This column is displayed by default.
Note that the display and the content of the lists can be modified:
The list of each section can be sorted by clicking the Name column header.
The width of each column can be determined by dragging its right separator.
For the Objects in error and Objects with warnings sections, columns can be
moved within the table by dragging and dropping their header to a new location.
Press the Close button to dismiss the Troubleshoot Project Update dialog box.
Depending on the specifications made, the object update states may also be displayed
on the object icons in the tree view (see Section 3.1 Automatic project update and
Section 4.6.8 Visualizing the status of certain objects).
22.6 Commands
The Commands menu offers the following commands:
Command History
Displays the Command History pane which displays the commands invoked by
the user.
Start Recording
Starts the recording of commands invoked by the user.
Stop Recording
Stops the recording of invoked commands.
The last three commands are also found on the Tools menu of the Macro Script Editor.
For complete information on the Command History pane, the Macro Script Editor tool,
and the scripting language, see the Macro Script Reference Guide. It is offered on the
Macro Script Editor’s Help menu and the module’s Help > Reference Guides submenu.
For complete information on the Macro Script Editor tool and the scripting language,
see the Macro Script Reference Guide. It is offered on the Macro Script Editor’s Help
menu and the module’s Help > Reference Guides submenu.
Manufacturing
Loads the Manufacturing system visual layout.
Surveying
Loads the Surveying system visual layout.
All Applications
Loads the All Applications system visual layout.
Note that new system visual layouts can be added by either saving or copying a visual
layout to the visual_layout subdirectory of the PolyWorks installation directory. This
customized system visual layout then appears at the end of the system visual layouts
list available under the Tools > Visual Layouts submenu of the corresponding module.
The submenu also offers the following commands that allow performing operations on
existing visual layouts:
Load
Loads a visual layout from an external file.
For more information, see Section 4.2.4 Loading a visual layout of the PolyWorks
Reference Guide.
Save
Saves a visual layout to an external file.
For more information, see Section 4.2.3 Saving a visual layout of the PolyWorks
Reference Guide.
Backups
Loads a backed up visual layout file from a list of layout files. A layout file is
identified by the date and hour it was backed up.
For more information, see Section 4.2.1 Understanding the visual layout
mechanism of the PolyWorks Reference Guide.
For more information, see Section 4.2.6 Importing macro scripts from visual
layouts of the PolyWorks Reference Guide.
Customize
Starts the visual layout customization mode.
Customizing toolbars, menu bars, menu item shortcuts, options, and macro scripts is
done using a module’s Customize Visual Layout dialog box, shown in Figure 22.12. For
complete information, see Section 4.3 Customizing an application’s visual layout of the
PolyWorks Reference Guide.
The Customize Visual Layout dialog box offers the following tabs:
Toolbars
A tab that offers the list of toolbars available in the application. It allows showing
and hiding toolbars, as well as creating, renaming, and deleting custom toolbars.
It also offers the Reset button to reset the selected toolbars to their initial state.
Commands
A tab that lists all the of the commands in the application. Choose a main menu
command or a toolbar in the Categories list box, and all of the available
commands for the selected category appear in the Commands list box. To add a
command to a toolbar or menu, select it in the Commands list box and drag in on
the desired toolbar or menu.
Keyboard
A tab that allows assigning a keyboard shortcut to any command available in the
application.
Options
A tab that offers allows locking the docking windows, setting the size of toolbar
buttons, and defining the screen tips and animation type.
Macro Scripts
A tab that allows managing the macro scripts in the current visual layout and
assigning them to a toolbar or menu.
On choosing this command, a message window is displayed stating that the current
user configuration will be erased. Press the OK button to continue the operation or the
Cancel button to end the operation. When continuing, the current configuration is
saved to a file which becomes the new default configuration for the user when starting
another instance of that application.
Options
Opens the IMSurvey Options dialog box. It offers options for the entire module,
some of which should be specified before using the module as they configure
operations performed on object import, determine the use of wizards, and more.
These options are documented in Chapter 24 Setting Options.
Exporting
23.1 Introduction
Reference objects are the nominal objects to which the Data objects are measured. A
Reference object is typically a CAD model, but it can be an original scan of an object
that has been triangulated, like a bridge or a dam, that future scans of the object (i.e.,
Data objects) will be compared to when inspecting structures over time.
A surveying project can have an unlimited number of Data and Reference objects.
There are two categories of Reference objects. The table that follows presents each
category of Reference object:
Figure 23.1 IMSurvey offers two sets of tolerance limits. In this example, points A and B fail the
distance tolerance tests for the Reference surface, while the other points pass.
The Tools menu and its Reference Objects submenu offer several commands that allow
editing Reference objects and their selected elements. For information on selecting
object elements, see Chapter 8 Selecting Objects and Elements.
A tolerance can be defined for each Reference surface and primitive. Tolerances can be
globally attributed to Reference objects. In addition, a different tolerance can be
defined for each surface of a CAD model.
Tolerances are useful for performing pass/fail inspection. When a point is no farther
from the surface than a given tolerance value, the point “passes” the tolerance test. If
the point is farther from the surface than the same tolerance value, the point “fails” the
tolerance test. For more convenience, there are two sets of tolerance limits: Positive
high and Negative high limits, and Positive low and Negative low limits (see Figure
23.1).
Tolerance templates are used to manage tolerances. Default tolerance templates are
used to attribute a tolerance to new Reference objects and primitives on creation.
Custom templates can be created and used to quickly attribute a tolerance to created
objects.
The Tolerances > Templates page of the IMSurvey Options dialog box offers tolerance
template management. For complete information, see Section 24.10.1 Tolerance
template options. To access the IMSurvey Options dialog box, choose the Tools >
Options command.
23.2.1.2 Editing the tolerances of Reference objects, primitives, and CAD surfaces
Tolerances for Reference objects and primitives can also be directly edited in a dialog
box using the shortcut menu based on an object selection in the tree view. When a
single CAD Reference object is selected, the dialog box also allows editing selected
surfaces of that object.
The Tools > Reference Objects > Tolerances command displays a tool that allows viewing
the tolerances in a project assigned to nonignored Reference objects and primitives,
and individual CAD surfaces. The tool allows modifying a tolerance, which immediately
affects all of the objects that use that tolerance. It also allows creating new tolerances. A
selected tolerance can be assigned to selected Reference objects and primitives, or
CAD surfaces.
On choosing this command, the Edit Reference/Primitive Tolerances dialog box shown
o the left in Figure 23.2 is displayed. A tolerance-editing mode is activated as well.
While in this mode, most menu and toolbar items are unavailable. Available
functionalities include object and element selection, object visibility, and snapshot
creation.
The dialog box’s list area displays the tolerances in the project used by the nonignored
objects, and their CAD surfaces. Each tolerance has a color generated for it and two sets
of tolerance limits: High+ and High-, and Low+ and Low-. The list is sorted on the
High+ column. Note that if the project is empty, or does not contain any of the objects/
elements that have tolerances, the list area is empty. Press the Close button to dismiss
the dialog box.
In addition, all visible Reference objects and primitives, and CAD surfaces are colored in
the 3D scene, using the color associated with their tolerance. Objects that do not have a
tolerance (e.g., Data objects) are colored gray.
Figure 23.2 To the left, the dialog box used to view the tolerances in the current project assigned
to nonignored Reference objects and primitives, as well as individual CAD surfaces. In
this mode, visible objects/CAD surfaces are displayed using a color associated with
their tolerance. Objects that do not have a tolerance (e.g., Data objects) are displayed
in gray.
Individual tolerance limit values can be changed by clicking the cell and editing the
value. Note that an auto-correction occurs when a value is entered that interferes
with another value. For example, if the new High+ value is less the Low+ value, the
same value is assigned to Low+.
Changing one or more values immediately affects all of those objects that use that
tolerance. The automatic color (first column) assignation can be changed temporarily
by clicking an existing color and choosing a color in the list that appears. The new color
is not conserved when the dialog box is closed.
The buttons at the bottom of the list area allow creating new tolerances and assigning a
selected tolerance to selected Reference objects or primitives, or to selected CAD
surfaces. They are described in the table that follows.
Add
Adds a new tolerance to the list. Tolerance limits are assigned values taken
from the Object Default tolerance template.
Right-clicking a list row displays a shortcut menu. It contains the same operations as
offered by the three buttons described previously, as well as two additional operations:
Remove Unassigned
Deletes duplicate or unassigned tolerances from the list, and may reassign colors
to remaining tolerances. These actions are the same that are taken when the
dialog box is closed and then re-opened. This command has been assigned to the
F5 function key.
Tolerance Templates
Displays the existing tolerance templates. Choose one in the list and its values are
assigned to the tolerance that corresponds to the clicked row.
Tolerances can be edited for same-type objects by selecting them in the tree view and
right-clicking. On the shortcut menu for Reference objects, choose the Edit > Tolerance
command. On the shortcut menu for primitives, choose the Edit > Tolerance command.
The dialog box shown in Figure 23.3 is displayed. When a single object is selected, the
dialog box contains the tolerance of that object. In the case of a multiple selection,
values only appear if they are identical for all selected objects.
To use the values from the Object Default tolerance template, press the Reset
button.
To use values from any tolerance template, right-click over a text box and choose a
tolerance template in the list that is displayed.
Press the OK button to apply the values and dismiss the dialog box, or press the Cancel
button to end the operation.
Figure 23.3 (a) The dialog box used to edit tolerances for selected polygonal Reference objects or
selected Primitives. (b) The dialog box for selected CAD Reference objects.
(a) (b)
Note that in the case of a single, selected CAD Reference object, the dialog box offers a
Edit CAD Surface Tolerances button, shown to the right in Figure 23.3, that allows
editing the tolerance assigned to selected CAD surfaces. When pressed, and changes
have been made in the dialog box, a message window queries the user to save the
changes. Press Yes to save the changes, No to not save the changes, or Cancel to return
to the Tolerance dialog box. When the Yes or the No button is pressed, the Edit
Reference/primitive Tolerances dialog box is displayed, to allow assigning a tolerance
to selected CAD surfaces. For complete information, see Section 23.2.1.2.1 Editing and
viewing tolerances globally.
The colors used to render the results of tolerance-based operations can be configured
on the Tolerances page of the IMSurvey Options dialog box. These result colors are
used for the generation of report items. For complete information, see Section 24.10
Tolerance options. To access the IMSurvey Options dialog box, choose the Tools >
Options command.
A Reference object can be replaced by a new one to update an existing project with a
new CAD model revision.
To replace a Reference object in the current piece, choose the Tools > Reference Objects
> Replace command. The browser shown in Figure 23.4 is displayed. Locate the file in
the Replace CAD Reference Object browser, then press the Options button to specify
import options if desired. Press the Open button to perform the replacement
operation. Press the Cancel button to cancel the operation.
For more information on import parameters for polygonal models, point clouds, or CAD
models, see Section 6.4 Importing polygonal models, Section 6.3 Importing point
clouds and Section 6.5 Importing CAD models.
A different file format can be used when replacing the Reference Object.
Only one Reference object can be replaced by another one during the replacement
operation.
Once the new Reference object replaces the previous one, all objects referring to the
previous Reference object are automatically relinked to the new one, except when they
are linked to specific Reference object elements. For more information, see Section
23.2.2.1 Updating objects linked to the replaced Reference object.
All Reference object properties are maintained after the replacement, except the
following:
The name is changed for the name of the new Reference object.
When the surfaces of a CAD Reference object do not have the same tolerance, the
tolerances are not maintained. When all the surfaces have the same tolerance, the
tolerance is maintained.
Original units are reinitialized when reading the new Reference object.
Most objects linked to a replaced Reference object can be updated. They include the
following:
That use the Fit within Tolerance Zone method (Between Two Reference
Objects using the Upper object and Lower object specifications).
All objects bound to the previous Reference object by way of a transformation group.
All report items (i.e., tables, snapshots) linked to the previous Reference object.
Some links are not kept mainly because they are linked to specific elements, and the
new Reference object may have a different number of elements. These links include the
following:
Coordinate and color map point annotations picked on the Reference object are lost.
To invert the orientation of visible CAD surfaces based on the current view in the 3D
scene, choose the Tools > Reference Objects > Correct Inverted CAD Surfaces command.
The key to using the tool is to first make desired objects visible, and then to orient the
objects in the 3D scene such that expected front-facing CAD surfaces are visible, and
that CAD surfaces with a back-facing orientation to be corrected can be seen (i.e., at
least one CAD surface belonging to an island has to be visible).
Figure 23.5 An example of the view-based Correct Inverted CAD Surfaces operation.
(a) Before – the ring around the cylinder has (b) After – the ring’s orientation
an incorrect orientation (is back-facing) has been inverted (is front-facing)
On choosing the command, for each island, if the visible area of its back-facing surfaces
is greater than the visible area of its front-facing surfaces, then all surfaces belonging to
that island will be inverted. For an example, see Figure 23.5.
The Tools > Reference Objects > Invert Element Orientation command allows inverting the
orientation of selected elements of Reference objects (i.e., triangles and CAD surfaces).
The Tools > Reference Objects > Restore CAD Surface Orientation operation allows
restoring the CAD surface orientation of selected CAD Reference objects to the same
state they were in on import. This operation also applies to any currently deleted CAD
surfaces.
If, on choosing the command, no CAD Reference objects are selected, the operation is
applied to all CAD Reference objects in the piece.
The Tools > Reference Objects > Convert to Data Objects operation transfers selected
Reference objects to the Data branch of the tree view as surface Data objects. Objects
must consist of polygons, or be able to be converted to polygons (e.g., CAD Reference
objects).
The converted object keeps the same name and visibility status. Converting an object
in this manner does not change the layer with which the object is associated.
Data objects are either point cloud or polygonal objects. The elements of these objects
are, respectively, Data points or polygon vertices. Polygon vertices always have point
normal information.
Point cloud Data objects are composed of Data points which may, or may not, have
point normals. If the import process offers the choice, always activate the option that
results in point normals, as they are useful in many operations.
Polygonal Data objects are composed of polygons, which means that they have a
surface, which can provide information on the object anywhere on the object. Some
operations take into account the surface, and other operations only need to process
the vertices.
A Data object can be replaced to update an existing piece with a new dataset of the
same piece, captured at a different time or using a different device.
Once the new point cloud or polygonal model replaces the previous one, all objects
referring to the previous Data object are automatically relinked to the new one, except
when they are linked to specific Data object elements. For more information, see
Section 23.3.1.2 Updating objects linked to the replaced Data object.
In the subsections that follow, the new Data object, or the selected elements, may be
referred to as the source Data object, and the Data object to replace may be referred to
as the destination Data object.
Figure 23.6 Examples of the dialog box used to replace a Data object configured for the From
Elements method (a), and for the From File method (b).
(a) (b)
The replacement tool uses a structured, contextual dialog box. Use the dialog box as
follows:
1. Choose the Tools > Data Objects > Replace command. The Replace Data Object
dialog box shown in Figure 23.6 is displayed.
Data object
A list box that allows selecting the Data object to replace. Only nonignored surface
Data objects or nonignored boundary Data objects can be replaced. Selected
nonignored Surface or boundary Data objects are listed. If no used Surface or
boundary Data objects are selected in the tree view, all of them are listed.
3. Choose a method in the Method list box. The following choices are offered:
From Elements – Allows replacing a Data object with selected elements; this
method is presented in Section 23.3.1.1.1 Using the From Elements method.
From File – Allows replacing a Data object with the content of a file; this method
is presented in Section 23.3.1.1.2 Using the From File method.
The default method is From File, unless elements are selected in the 3D scene. Then,
the default method is From Elements.
4. Press the OK button to launch the replacement operation. Press the Cancel button
to dismiss the dialog box.
All Data object properties are maintained after the replacement, except the following:
The name is changed for the name of the new Data object.
Original units are reinitialized when reading the new Data object.
For selected elements of a polygonal model structure, points colors and textures are
not copied during the replacement operation.
The From Elements method uses a selection of Data points in the 3D scene. In the case
of point cloud Data objects, the selection can only provide points. In the case of a
polygonal Data objects, as their data structure is polygonal, the selection can provide
points or triangles, depending on the Data object to replace.
When the From Elements method is selected, the dialog box displays the Parameters
section, as shown in Figure 23.6 (a), with the following items:
Elements
A group label that offers options used to specify whether the selected elements of
the source Data objects are copied or moved:
Copy
An option button that allows copying elements from the source Data
objects to the destination Data object (i.e., the Data object to replace).
Once the elements are copied, the source Data objects still contain those
elements. By default, this option is selected.
Move
An option button that allows moving elements from the source Data
objects to the destination Data object (i.e., the Data object to replace).
Once the elements are moved, the source Data objects no longer contain
those elements.
Data points selected on point cloud Data objects or polygonal Data objects can be
used to replace a point cloud Data object. However, only Data points selected on
polygonal Data objects can be used to provide triangles to replace a polygonal Data
object.
When the selected elements consist of Data points selected on both point cloud and
polygonal Data objects, the replacement operation uses only the points or the triangles
that correspond to the structure of the destination Data object.
Figure 23.7 The dialog box used to specify whether or not the selected elements used for the
replacement should be transformed using the active data alignment of the Data
object to replace.
Press the Replace button to launch the replacement operation, then press the Close
button to dismiss the dialog box.
When the source Data object is not in the same alignment group as the destination
Data object, a dialog box is displayed, as shown in Figure 23.7. The Alignment group
section of the Replacement Parameters dialog box offers the following option:
Press the OK button to launch the replacement operation, or press the Cancel
button to dismiss the dialog box.
When the From File method is selected, press the Browse button. The browser shown
in Figure 23.8 (a) is displayed. A different file format can be used when replacing the
Data object. A surface Data object cannot replace a boundary Data object, and vice-
versa. Only one Data object can be replaced by another one during the replacement
operation.
Once the replacement file is located, press the Options button to specify import
options if desired, then press the Open button, or press the Cancel button to cancel
the operation. On pressing the Open button, the Replacement Parameters dialog box is
displayed, as shown in Figure 23.8 (b) and (c). For more information on import
parameters for polygonal models or point clouds, see Section 6.4 Importing polygonal
models, and Section 6.3 Importing point clouds.
Figure 23.8 In (a), an example of the browser used to replace a polygonal Data object. In (b), the
dialog box used to specify replacement parameters configured for the From File
method, for a polygonal Data object, and in (c) for a point cloud Data object.
a)
(b) (c)
Most objects linked to a replaced Data object can be updated. They include the
following:
All objects bound to the previous Data object by way of a transformation group.
Figure 23.9 The dialog box used to specify replacement parameters configured for the From File
method, for a polygonal Data object (a), and for a point cloud Data object (b).
(a) (b)
All report items (i.e., tables, snapshots) that were linked to the previous Data object.
Some links are not kept mainly because they are linked to specific elements, and the
new Data object may have a different number of elements. These links include the
following:
Primitives fit to selected elements; this does not include the Extract method. The
primitives lose their measured points.
The Tools > Data Objects >Wrap Meshes around Data Objects operation allows wrapping
a polygonal mesh onto selected point cloud Data objects. Wrapping is a process by
which a triangulation can be best-fitted to a set of points by subdividing triangles and
moving their vertices in 3D space. The wrapping process considers all points from the
point cloud Data objects. In addition, a preview mode is offered that uses a selection of
Data points. This mode allows optimizing certain parameters on a small area, before
applying the operation to selected Data objects.
This operation offers the following complementary options: outlier rejection, noise
reduction, and Data point subsampling. On choosing the command, the Wrap Mesh
dialog box shown in Figure 23.10 is displayed. It offers the following items:
Reject outliers
A check box, cleared by default, that enables rejecting outlier points. When
selected, a group box is made available that offers parameters used to reject
outlier points:
Figure 23.10 The dialog box used to wrap a polygonal mesh onto point cloud Data objects.
Reduce noise
A check box, cleared by default, that enables noise reduction. When selected, a
group box is made available that offers a parameter that controls the noise
reduction:
Tolerance
A text box that allows specifying the maximum distance by which a point
can be moved with respect to its original position. The larger the value,
the smoother the resulting surface is. Valid values are greater than 0. The
default value is 1.0 mm.
Curvature-based subsampling
A check box, cleared by default, that enables curvature-based subsampling of the
Data points. When selected, a group box is made available that offers a parameter
that controls the subsampling:
Percentage
A text box that allows specifying the percentage of the current number
of Data points as the target to achieve. In this case, points are deleted
based on surface curvature until the number of points in the selected
point cloud Data objects is equal to the target number of points. Valid
values range from 5.0% (i.e., target is 5% of the points) to 100.0% (i.e.,
target is 100% of the points). The default value is 50.0%.
Wrap mesh
A group box that offers a parameter related to the polygonal mesh:
Preview
A button that offers a preview of the triangulation operation on a selection of Data
points (i.e., three points or more). On pressing this button, the specified
parameters are applied to the selected Data points and the resulting mesh is
displayed in the 3D scene. For each creation process, the parameter values may be
changed and a new preview may be applied.
The Apply button launches the operation. The specified parameters are applied in the
order in which they appear in the dialog box to the selected point cloud Data objects.
Once the triangulation is complete, a new polygonal Data object is added to the tree
view for each selected object, with a name composed as follows: <object_name> -
mesh-.
The Tools > Data Objects > Triangulate Data Points command displays the dialog box
shown to the left in Figure 23.11 to configure creating a polygonal mesh from selected
Data points and a plane. Polylines may also be preselected, which will be used as break
lines by the triangulation algorithm. The triangulating procedure is as follows:
Figure 23.11 The dialog boxes used when triangulating selected Data points.
3. Choose the Tools > Data Objects > Triangulate Data Points command, which displays
the Triangulate Point Cloud dialog box.
The plane can be XY, YZ, ZX, or an existing plane. When a plane is selected, the 3D
scene is automatically rotated such that the triangulation plane is parallel to the
computer screen.
5. To have selected polylines used as break lines during the meshing process, select
Include selected polylines.
The points are first projected onto the selected plane. Then, they are triangulated
using a 2D Delaunay triangulation method, using polylines as break lines if so
specified. The potential 3D mesh is then displayed with all possible triangles.
7. The dialog box shown to the right in Figure 23.11 is displayed. It allows interactively
specifying an appropriate Max edge length used to delete impossible triangles.
Different values may be entered in the Max edge length text box to see the effect
– as soon as a new value is entered, a new mesh is automatically triangulated and
displayed.
A new polygonal Data object that corresponds to the new mesh, with the name
mesh <number>, where <number> is an automatically incremented integer, is
created in the tree view.
Figure 23.12 The dialog box used to triangulate terrain Data points.
The Tools > Data Objects > Triangulate Terrain Data Points command allows creating a
DTM surface for each visible point cloud Data object. On choosing this command, the
dialog box shown in Figure 23.12 is displayed, offering the following items:
DTM Surface
A group box that offers one parameter used to define the DTM surface:
Once the specifications have been made, press the OK button to launch the operation
or press the Cancel button to end the operation. When the OK button is pressed, a
polygonal Data object is created for each visible point cloud Data object. Each new
Data object has the name of its original point cloud Data object followed by the -DTM
surface- suffix.
The Tools > Data Objects > Extract Data Object Normals command allows extracting the
normals of selected point cloud Data objects using the surfaces of available Reference
objects. On choosing this command, the dialog box shown in Figure 23.13 is displayed.
It offers the following item:
Press the Apply button to launch the operation, and press the Close button to dismiss
the dialog box.
Figure 23.13 The dialog box used to extract Data object normals.
The operation proceeds to extract the normals of all points of the Data objects, even for
those points that had normals prior to performing the operation. Only the normals of
the deleted points of the selected Data objects are not recalculated.
If a Data object had no normals before the operation, its icon changes and its Ignore
points without normals property is selected.
If a Data object had normals before the operation, no changes are made to its icon or
to its Ignore points without normals property.
If no normals are found for a Data object, no changes of any kind are made to the Data
object. The Data object still has the same point normals, if any, that existed before the
operation.
The Tools > Data Objects > Offset Data Objects command offers two methods that allow
offsetting selected Data objects. On choosing the command, the dialog box shown in
Figure 23.14 is displayed.
To offset Data objects using the normals of their Data points, proceed as follows:
2. Choose the Tools > Data Objects > Offset Data Objects command, which displays the
Offset Data Objects dialog box.
4. Under the Offset directions group label, select Use data point normal vectors.
Data points of selected Data objects will be offset along the direction of their normal
vectors.
The operation is only applied to points for which normal vectors have been
computed. After the operation, the Ignore points without normal vectors check
box is automatically selected on the property sheet of the selected Data objects.
To offset Data objects using the normals found on Reference objects, proceed as
follows:
3. Choose the Tools > Data Objects > Offset Data Objects command, which displays the
Offset Data Objects dialog box.
5. Under the Offset directions group label, select Use reference objects. Data points
of selected Data objects will be offset along the direction of the normal vectors of
matched points on the Reference objects.
6. Enter a value greater than 0 in the Max distance text box of the Offset directions
group label. The default value is 4 mm.
This value is used to match each Data point to the Reference objects. The normal
vector of the matched Reference point is then used to determine the offset direction
of the Data point. Points farther than the Max distance from the Reference objects
are not offset.
Point cloud Data objects may need to be subsampled when the data is too dense. The
Tools> Data Objects > Subsample command displays the Subsample dialog box shown
in Figure 23.15 that offers random, uniform, and curvature-based subsampling
methods for selected, visible point cloud Data objects or Data points. The dialog box
contains the following items:
Subsample
A list box that specifies what is to be subsampled. Two choices are offered:
Selected Data Points belonging to one or more point cloud Data object, or
Selected Objects.
Type
A list box that controls the type of subsampling. When Type is set to Random, a
Percentage of the current number of points as the target to achieve must be
specified. The default value is 50.00. In this case, points are randomly deleted until
the number of points in the selected point cloud Data objects is equal to the target
number of points. For example, if 10% is specified, the resulting point cloud Data
object will only have 10 percent the number of points as the original point cloud
Data object.
When Type is set to Uniform, a Step must be specified; the default value is
1.0 mm. In this case, the selected point cloud Data objects are sampled with the
goal of generating uniformly sampled point cloud Data objects in which the point-
to-point spacing is equal to the Step.
Data objects is equal to the target number of points. The specified Percentage
value must be between 5.0 and 100.0. The default value is 50.00.
Percentage/Step
A text box that is labeled Percentage if Type is set to Random or Curvature-
based, or Step if Type is set to Uniform. See the preceding item for the
description of each.
It also offers an Advanced button that gives access to the following item:
Press the Apply button to launch the operation, and the Close button to dismiss the
dialog box.
Subsampling may be undone by choosing the Edit > Recover Deleted Elements
command. For more information, see Section 7.4 Recovering deleted elements.
The Tools > Data Objects > New Probing Session operation allows using a new probing
session for future point acquisitions.
It is possible to specify what parts of a huge Data object should be in memory for
processing by using the Manage Huge Data Objects dialog box, shown in Figure 23.16.
It can be opened by choosing the Tools > Data Objects > Manage Huge Data Objects
command.
When the dialog box is displayed, the grid cells are displayed using coarse images built
from the cell points and viewed from the top (z direction). The Point display options
group box in the dialog box offers two cell display methods: Colored, which is only
available if the Data points have color information, and Shaded without color.
Grid cells are shown in red or green. Red means that the cell points are not in physical
memory, while green means that the cell points are currently in physical memory. Click
any cell to edit its memory status, or drag a selection rectangle to edit grid cells that
belong even partially to the selection. The effect on the status of the grid cells is
determined by the value in the Selection effect list box: Mark (the status of cells is set
to On), Toggle (the status of cells is switched), or Unmark (the status of cells is set to
Off ). The Resulting action status label reads Load in memory to indicate the current
operation. At this stage, changes are not effective.
In the upper left corner of a cell, the number of megabytes of physical memory needed
by the cell data points is displayed; as the display only permits one point after the
decimal, the smallest value that can be displayed is 0.1 MB. In the System memory
group box of the dialog box, the available physical memory (RAM) is monitored as the
memory status of grid cells is switched. Two items are updated with each switch:
Available RAM, and Increase (decrease) usage by.
See Figure 23.17 for an example of the display when in the Manage Huge Data Objects
mode. The mouse may be used to translate or to zoom the 3D scene, but rotations are
not permitted.
The huge data manager also allows marking/unmarking grid cells – a big X is displayed
when a cell is marked. While marking does not affect any processes, it may help keep
track of what parts of the huge Data object have been processed. Mark/unmark a
processed cell by pressing the SHIFT key and clicking, or mark/unmark several cells by
pressing and holding down the SHIFT key and dragging a selection rectangle. The
effect is determined by the value in the Selection effect list box: Mark (add an X),
Unmark (removes X), or Toggle (switch the current state). The Resulting action status
label reads Mark as processed to indicate the current operation.
In the tree view, a point cloud Data object is created for each grid cell. It’s name is
composed as follows: <name_imported_object> (<grid_cell>) (e.g., scan1a.pif (1,1)). All
of the point clouds corresponding to one imported object are automatically placed in
one object group. Each point cloud has a locked (padlock on icon) status, and initially
an ignored status as well (a No sign on the icon). While the ignored status changes
when the cell corresponding to the point cloud is switched to use, the locked status is
permanent as point clouds created from grid cells cannot be transformed. Note that the
Figure 23.17 Managing a huge Data object consists in deciding which grid cells are to be in
memory and, optionally, marking grid cells with an X to keep track of which cells have
been processed (e.g., taking measurements).
Edit > Ignore > Object and the Edit > Use > Object commands do not apply to point
clouds created from grid cells.
To make the changes to the load/unload status of the grid cells effective, press the
Apply button. The green cells that became red are removed from memory, and the red
cells that became green are read from disk.
It is possible to display the grid cell structure in the 3D scene, along with other visible
tree view objects, including huge Data objects, by way of the Huge data grid option on
the 3D Scene page of the IMSurvey Options dialog box. For more information, see
Section 24.3.1 3D Scene display options.
The Tools > Data Objects > Convert to Reference Objects operation transfers selected Data
objects to the Reference branch of the tree view. Objects must consist of polygons.
The converted object keeps the same name and visibility status. Converting an object
in this manner does not change the layer with which the object is associated.
For more information on controlling the display, see Chapter 9 Controlling the Display.
The Reference/Data subpage of the Display page of the IMSurvey Options dialog box
offers options to control the display of Data objects and Reference objects. For
complete information, see Section 24.3.6 Reference and Data object display options.
The transparency of polygonal Data and Reference objects is controlled with the
Transparency slider, found in the object’s property sheet. When the slider is in the
rightmost position, the object is opaque. Moving the slider to the left makes the
object’s surface progressively more transparent. Press the Apply button to transfer the
change to the application. Transparency is rendered only in the Static display mode.
An object’s property sheet (see Figure 23.22) can be displayed in the following ways:
Select the object in the tree view and choose the Edit > Object Properties command.
The property sheet features a Display tab, shown in Figure 23.22, that offers several
items.
The Static and Dynamic group boxes offer the same two items:
Drawing type
List boxes that offer drawing types. Typical values include Flat, Point, Smooth,
Wireframe, or Bounding Box, in addition to to Curve and Flat + Curve. When the
Curve drawing type is used, the boundary curves are rendered. If the Flat+Curve
type is used, surfaces are drawn using flat shading and the boundary curves are
superimposed on the flat-shaded surfaces.
The drawing type can always be set to Default. An object displayed using the
Default drawing type is drawn using its category’s default drawing type. Chapter
9 Controlling the Display describes the default rendering properties of each
category of object. Default rendering properties are useful to globally control
object rendering. When a default rendering property of an object category is
modified, then all objects of the same category whose drawing type is set to
Default will be modified as well.
Subsampling
Combo boxes that offer subsampling factors. Choose from: Default, 1/1, 1/4, 1/
16, or 1/64, or enter a number next to the characters 1/ to define a custom
subsampling factor.
Color mode
A group label that allows determining the color to use to display the surfaces of
CAD Reference objects. Two options are offered:
Object
An option button that specifies that the object is rendered using the
object’s color.
By CAD layer
An option button that specifies that each CAD surface is rendered using
the color of its CAD layer.
Transparency
A slider that controls the transparency of polygonal Data objects, and Reference
objects. The more the slider is to the right, the more the object is transparent. By
default, the slider is at the None position. For more information, see Section 23.5.2
Controlling the transparency of polygonal Data and Reference objects.
The Reference tab, shown in Figure 23.19, contains the following items related to
Reference objects:
Data structure
A text box that displays the Reference object type. Possible values are: IMAlign
Project, Polygonal Model, and CAD Model.
Nb of points
A text box that displays the number of points of the object that are used. This
number does not include deleted points (which can be recovered).
Nb of triangles
A text box that displays the number of triangles of the object that are used. This
number does not include deleted triangles (which can be recovered).
Nb of surfaces
A text box that displays, for a CAD-based Reference object, the current number of
CAD surfaces. This number does not include deleted CAD surfaces (which can be
recovered).
Source in workspace
A text box that displays the name of the object, visible in the tree view of the
workspace, that serves as the source for the object in the project.
When the import operation of a Reference object uses an object in the tree view
of the workspace where the project resides (i.e., an IMAlign project), or results in
the creation of an object in the workspace tree view, a link is created between the
source object in the project and the corresponding object in the workspace.
Modifying the source object (e.g., IMAlign project) would result in a change in the
Tessellated surfaces
An option button, selected by default, that specifies using tesselated
surfaces (i.e., polygonal representation) when inspecting a part with
Tessellation tolerance
A text box that allows specifying a value that represents the
maximum chordal deviation between an imported CAD surface
and its polygonal representation. Valid values are greater than
zero. The default value is 0.01 mm.
Note that an automatic loop removal algorithm is applied that gets rid of
self-intersections, which are the result of self-intersecting trim curves,
and ensures the proper tessellation of CAD surfaces.
NURBS surfaces
An option button that specifies using NURBS surfaces for computations.
This option is appropriate for very large and detailed CAD models (i.e.,10
meters or more) which would take too long to tessellate, or in the context
of high-accuracy requirements (e.g., in the range of a few microns). CAD
model import time is accelerated, and the accuracy of mathematical
operations applied to CAD Reference objects is in the sub-micron range.
The following items are offered:
Tessellation tolerance
A text box that allows specifying a tolerance value used to
tessellate CAD models for display purposes as well as to
accelerate mathematical operations on NURBS surfaces. The
default value is 0.5 mm.
If the topology is obtained from the native CAD model, the text box is empty as the
value is unknown. Otherwise, the value on the CAD Models page of the IMSurvey
options is used. A different value can be specified; in this case, the current
topology is discarded, and a stitching operation is applied to the entire model.
Note that this parameter can be edited only if the original CAD model was kept
after import. For more information, see the Keep original models for restitching
option in Section 24.5.1 CAD model options.
Since all scaling operations apply only to the original dimensions of the object,
and not the current dimensions which may be the result of a previous scaling
operation, the value displayed gives the real scaling applied to the object. For
complete information on scaling objects, see Section 7.5.4 Scaling 3D objects.
Original units
A text box that displays the original units of the object. These units were read in
the original file on import or determined on import using the Unknown Units
Wizard. This wizard is described in relation with the General page of the IMSurvey
Options dialog box; for more information, see Section 24.1 General options.
Units factor
The factor applied to an object’s original units to convert the object to the project’s
units of length. For more information on the Length option of the Units section,
see the General page of the IMSurvey Options dialog box.
The Virtual surface section offers items that allow specifying a virtual surface. For
complete information on virtual surfaces, see Section 23.6.4.1 Reference objects and
virtual surfaces.
The Annotation tab allows customizing the contents of an object’s annotation. For
complete information, see Section 22.2.3 Customizing the contents of an annotation.
The Matrix tab, shown in Figure 23.20, displays information concerning the object’s
transformation matrix. The Global transformation table displays the rigid
transformation between the Reference object’s original position and the Reference
object’s active alignment. The matrix can be used to align objects in the current project,
and may be exported using commands on the File > Export > Reference/Data Object
Matrix submenu.
The Reference tab of the property sheet of Reference objects offers the Virtual
surface section that allows specifying a virtual surface. Two types of virtual surfaces
can be specified, depending on the type of Reference object. An offset (positive or
negative) can be specified for a solid or a surface model, and a thickness can be
specified for surface models only (the resulting surface is referred to as the virtual
thickness).
In the case of a thickness-type virtual surface, the user may specify using the virtual
surface, the original surface, or both. This usage specification is referred to as the
effective virtual surface.
The virtual surface has no display in the 3D scene. However, the boundaries of the
virtual surface created on a CAD Reference object are displayed in the 3D scene when
the Static display mode of the object is set to Flat+Curve (see Section 9.1 Setting the
display modes of 3D objects for more information on Static display modes).
Virtual surface
A check box that enables a group box of the same name that offers the Type list
box that specifies the type of virtual surface to specify (the table that follows
provides an illustrated description of each type):
Offset – A virtual surface type for solid and surface models that simulates an
offset for the Reference object surface. It makes available the Offset text box
to specify an offset value. The offset surface is normal to the Reference
object surface. The offset sign refers to the orientation of a Reference
surface. A positive offset value creates a virtual surface above the original
surface, while a negative offset value creates a virtual surface below the
original surface. Only the offset surface is used for calculations on the
Reference object.
Original
Makes only the original Reference object surface effective. The
offset surface is ignored. Selected by default.
Virtual
Sets the virtual surface as the effective surface. Any point picked on
the original surface will automatically be located on the virtual
surface, at the specified thickness value. Any point picked on the
back face of the Reference object will automatically be located on
the virtual surface, at the specified thickness value.
Both
Sets both the original and the virtual surfaces as the effective
surfaces. Any point picked on the front face of the original surface
will remain on the original surface. Any point picked on the back
side of the original surface will be located on the virtual surface, at
the specified thickness value.
The table that follows illustrates the functional differences between offset and
thickness virtual surfaces of Reference objects:
Thickness
Location: below original surface
Original surface
Normal: opposite original surface
+ thickness value
Effective surface(s):
• Original Virtual surface
• Virtual
• Both
The following operations take into account the virtual surface, when it is selected:
Picking and anchoring operations are performed on the effective virtual surface(s).
Cross-sections can be created on the virtual surface. When a Thickness type virtual
surface is used with Effective surface(s) set to Both, both surfaces are sliced.
The Select > Data Points > Using Reference Object Surfaces selection operation
considers the effective virtual surface(s).
Basic measurement operations Measure > Interactive Measurements > Basic and
survey measurement operations Measure > Interactive Measurements > Survey are
performed on the effective virtual surface(s).
A best-fit alignment to a Reference object surface takes the virtual surface into
account. Note that when the Virtual surface (Thickness type) is set for a Reference
object and Effective surface(s) is set to Both, the Offset parameter in the Best-fit
Data Objects dialog box cannot be selected.
Figure 23.21 The property sheet for a CAD layer of a CAD Reference object.
The property sheet of a CAD layer, shown in Figure 23.21, offers a CAD layer tab that
contains one item, the Nb of surfaces text box that displays the number of CAD
surfaces contained within the layer. The text box is view only.
An object’s property sheet (see Figure 23.22) can be displayed in the following ways:
Select the object in the tree view and choose the Edit > Object Properties command.
The property sheet of Data objects features a Display tab, shown in Figure 23.22, that
offers the items that follow:
The Static and Dynamic group boxes offer the same two items:
Drawing type
List boxes that offer drawing types. Typical values include Flat, Point, Smooth,
Wireframe, or Bounding Box. If several categories of objects are selected, then
only the drawing types common to all selected objects are offered.
The drawing type can always be set to Default. An object displayed using the
Default drawing type is drawn using its category’s default drawing type. Chapter
9 Controlling the Display describes the default rendering properties of each
category of object. Default rendering properties are useful to globally control
object rendering. When a default rendering property of an object category is
modified, then all objects of the same category whose drawing type is set to
Default will be modified as well.
Subsampling
Combo boxes that offer subsampling factors. Choose from: Default, 1/1, 1/4, 1/
16, or 1/64, or enter a number next to the characters 1/ to define a custom
subsampling factor.
Disable shading
A check box that enables disabling shading for Data objects composed of points
and normal vectors.
Transparency
A slider that controls the transparency of polygonal Data objects. The more the
slider is to the right, the more the object is transparent. By default, the slider is at
the None position. For more information, see Section 23.5.2 Controlling the
transparency of polygonal Data and Reference objects.
The Data tab, shown in Figure 23.23, contains items related to Data objects:
Figure 23.23 The property sheet for an IMAlign project imported as a Data object.
Data structure
A text box that displays the structure (i.e., source) of the Data object, which is in
fact a subcategory of the type of Data object. For example, polygonal models are
a subcategory of surface Data objects. Possible values are: IMAlign Project, Point
Cloud, and Polygonal Model.
Normals
A text box that specifies whether the Data object has normal information. Possible
values are Yes and No.
Nb of points
A text box that displays the number of points of the object that are used. This
number does not include deleted points (which can be recovered). In the case of
Data objects consisting of points and normal vectors, it does not include points
without normals if the Ignore points without normals check box (see text that
follows) is selected.
Nb of triangles
A text box that displays, for polygonal Data objects, the number of triangles of the
object that are used. This number does not include deleted triangles (which can
be recovered).
Alignment group
An uneditable text box that displays the alignment group to which the Data object
is linked.
This property is useful in the context of using more than one Reference object and
more than one Data object for one of the operations mentioned above. For
example, a data color map is used to measure deviations between two assembled
Reference objects (ref1 and ref2) and two corresponding Data objects (data1 and
data2). Using the property sheet, data1 could specify ref1 as its linked Reference
object, and data2 could specify ref2 as its linked Reference object. The data color
map operation, where all four objects are specified, would then calculate
deviations from data1 to ref1 and from data2 to ref2, instead of using both
Reference objects for each Data object.
Source in workspace
A text box that displays the name of the object, in the workspace, that serves as
the source for the object.
IMSurvey import operations for Data objects either add the source object to the
project where it is encapsulated, or add the object to the workspace, if it is not
already there, and keep a link between the source object in the project and the
corresponding object in the workspace. In this case, modifying the source object
(e.g., IMAlign project) would result in a change in the corresponding Data object
in the IMSurvey project. When a link is made, this item is offered on the property
sheet.
The check box is selected by default when importing IMAlign projects that
contains composite images. In all other cases, it is cleared by default.
Scaling may be a result of the Edit > Scale Objects operation, or the Align > Feature-
Based > Center Points alignment operation (with the scaling option). When it is the
latter, the scaling factor is not changed by Automatic Project Update operations.
However, if the alignment is remeasured within a Play Inspection operation, a new
scaling factor is calculated as the temperature may have changed within the new
piece. For complete information on scaling objects, see Section 7.5.4 Scaling 3D
objects.
Original units
A text box that displays the original units of the object. These units were read in
the original file on import or determined on import using the Unknown Units
Wizard. This wizard is described in relation with the General page of the IMSurvey
Options dialog box; for more information, see Section 24.1 General options.
Units factor
The factor applied to an object’s original units to convert the object to the project’s
units of length. For more information on the Length option of the Units section,
see the General page of the IMSurvey Options dialog box.
The Matrix tab, shown in Figure 23.20, displays information concerning the object’s
two transformation matrices:
Global transformation
A table that displays the rigid transformation between the Data object’s original
position and the Data object’s active alignment.
Last transformation
A table that displays the last alignment transformation computed by the
application.
Both matrices can be used to align objects in the current project (see Section 10.8
Transforming objects using a matrix). They may also be exported to external files, and
re-imported and used in other PolyWorks modules for alignment purposes.
The Measurement tab, shown in Figure 23.25, displays information concerning the
method used to create the Data object. It offers the following item:
Creation method
A text box that displays the method used to create the object. Each type of Data
object has one or more possible creation methods.
Surface Data objects have the following creation methods: Import Point
Cloud, Import Polygonal Model, and Custom (see below for information
on the Custom method).
Boundary Data objects have the following creation methods: Import Point
Cloud and Custom (see below for information on the Custom method).
The Custom creation method is specified when the Data object was created using
a method other than the ones listed above.
The Annotation tab allows customizing the contents of an object’s annotation. For
complete information, see Section 22.2.3 Customizing the contents of an annotation.
OBJECTS
ELEMENTS
Primitives
All of the module options are conveniently located in the IMSurvey Options dialog box, which is accessed by
choosing the Tools > Options command.
The options are organized as follows: general, project, display related, and object specific. Any changes
made to options, and applied by pressing the dialog box’s OK or Apply buttons, only affect that instance of
the module. To save applied option specifications to the user configuration, choose the Tools > Save User
Configuration command. The options are all documented in this chapter.
Note that information on how to use the options dialog box (i.e., apply changes, interpret error messages) is
provided in Section 5.2 Using a module’s Options dialog box of the PolyWorks Reference Guide.
The Units section offers an option related to the units of measurement for a project:
Length
A list box that specifies the units of length measurement for a project. Choose
from: Microns, Millimeters, Centimeters, Meters, Inches, Feet, and US Survey
Feet. The default value is Millimeters.
When the length specification is changed and the project already contains
objects, all objects are converted to be defined in the new measurement units.
This may be a long operation. Note that it is not possible to change measurement
units if the project contains an object imported as a huge Data object.
The Imported files section offers options related to the import process.
Unknown units
A group label that offers the following options when importing files (i.e.,
polygonal model and point cloud files) that do not have unit information. Once
imported, all files must be expressed in the same unit of length as the instance of
the module associated with the project (i.e., working units).
Specify at import
An option button, selected by default, that allows specifying object units
on import for those files that do not contain unit information.
When the option button is selected and a file with unknown units is
imported, parameters are offered in an import dialog box to allow
specifying the units for the files. The parameters are presented in Section
6.3.1.1.1 Object units (importing point clouds) and Section 6.4.1.1.1
Object units (importing polygonal models).
The Browsers section offers an option for file and directory browsers:
Working directory
A check box that enables specifying a directory to which a browser initially refers
when it is displayed. When the check box is selected, a path may be entered
manually in the adjacent text box, or entered interactively by pressing the
adjacent browse button and specifying a path. When the check box is cleared, the
working directory is the last directory used. The check box is cleared by default.
Figure 24.2 The Object Selection Wizard explains object selection requirements that have not
been met for an operation, and enables the user to select the missing objects.
The object selection requirement is The requirement has been met. The
displayed in the Requirement group box Continue button becomes available
button is enabled. The Continue button allows resuming the execution of the
invoked operation. The behavior of the dialog box is shown in Figure 24.3. For
more information on selecting elements, see Chapter 8 Selecting Objects and
Elements. The wizard is helpful when performing fitting operations that use
selected elements. The check box is selected by default.
This list box controls using a project’s application settings on loading into
IMSurvey. Choose from Yes, No, and Confirm. The default value is Yes. When
Confirm is specified, a message window is displayed on loading a project asking
to use the project’s configuration. Then, press the Yes button to use the project
configuration or the No button to not use the project configuration. For the new
setting to be made effective, it must be saved to the user configuration (i.e.,
choose the Tools > Save User Configuration command).
Automatic backup
A check box that enables the automatic backup of the project. The check box is
selected by default. It makes available one item:
Delay (minutes)
A text box that specifies the frequency in minutes at which the automatic
backup is performed. Integer values greater than 0 are accepted. The
default value is 30 minutes.
World
An option button that specifies importing objects in the world
coordinate system.
Active
An option button, selected by default, that specifies importing objects in
the active coordinate system.
This option affects almost all of the import operations on the File > Import
submenus. It also applies to object creation methods that consist in obtaining
data from an external file (e.g., create circles from a file).
Color mode
A list box that specifies the type of color information to use to render the surface
geometry of 3D objects. Four choices are offered:
Default Material– Draw objects using the default material color. The
Default Material properties are used to render 3D objects when the color
mode is set to Default Material. For more information on using material
definitions, see Section 5.5 Setting material display options of the PolyWorks
Reference Guide.
Object – Draw each object using its own object color. Object colors are
automatically provided, and can be changed by means of an object’s
property sheet. This is the default value.
The Surface visualization subsection of the Objects section offers options that allow
controlling the rendering of displayed back-facing and front-facing polygons of
Reference objects and polygonal Data objects:
Front face
A list box that specifies the rendering of the front faces of the polygons. Choose
from: As Is (renders front faces using their color information), Dark (renders front
faces using the current definition of the Dark interface color), and None (disables
the rendering of front faces). The default value is As Is.
Back face
A list box that specifies the rendering of the back faces of the polygons. Choose
from: As Is (renders back faces using their color information), Dark (renders back
faces using the current definition of the Dark interface color), and None (disables
the rendering of the back faces). The default value is Dark.
The Display > 3D Scene page of the IMSurvey Options dialog box, shown in Figure
24.6, offers display options for the 3D scene.
Environment mapping
A check box that enables rendering surface-based objects as if they were perfectly
reflective, so that the colors on their surface are those reflected back from the
surroundings. By default, the check box is not selected. When selected, an
adjacent list box offers the following mapping choices: B/W Stripes (maps black
and white stripes onto objects), Gold (maps a golden pattern onto objects), Piano
(maps a concert piano pattern onto objects), Road (maps a road pattern onto
objects), and Silver (maps a silver pattern onto objects). The default value is B/W
Stripes.
Grid
A check box that enables displaying a grid in the 3D scene when the projection
type is set to Orthogonal. The grid is automatically graduated. When the viewing
direction is parallel to a standard view (i.e., +X, -X, +Y, -Y, +Z, -Z), the grid displays
true coordinates, and the message True Grid is displayed in the 3D scene. For all
other viewing directions, the grid is a relative one and should only be used to make
differential measurements, and the message Relative Grid is displayed in the 3D
scene. The check box is cleared by default.
structure is displayed using a coarse representation, along with all the huge Data
objects, even the ones with a hidden visibility status. The check box is cleared by
default.
Pointer coordinates
A check box that enables displaying the approximate (x, y, z) coordinates of the
point under the pointer tip in the 3D scene. Pointer coordinates are only made
visible when the pointer passes over a 3D pixel, and are displayed to the right of
the pointer. The check box is cleared by default.
Bounding box
A check box that enables drawing the project’s bounding box. The check box is
cleared by default.
The current definition of the Bounding Box interface color is used to render the
bounding box. It can be changed through the Interface Colors page of the
IMSurvey Options dialog box.
High-quality transparency
A check box that enables high-quality transparency to be used for the
visualization of polygonal Data and Reference objects. The check box is cleared by
default. Note that the projection mode must be set to Orthogonal; when set to
Perspective, only the standard transparency is available.
3D scene fog
A check box that enables using fog when rendering objects as points or in
wireframe. The check box is selected by default.
Car views
A check box that allows configuring the six standard views (i.e., +X, -X, +Y, -Y, +Z, -
Z) for a standard car. For example, the Z view will be rotated so that the X axis
points up and the Y axis points right (instead of having the X axis point left and the
Y axis point up). The check box is cleared by default.
The Axes section offers options that control the display of axes in the 3D scene:
Bounding box
A check box that enables displaying the X, the Y, and the Z axes, by means of red,
green, and blue lines respectively, having the same dimensions as the project’s
bounding box. The check box is cleared by default.
Labels
A group label that offers items that specify the labels to display at the tips of each
axis:
X-Y-Z
An option button that specifies setting the axis labels to x, y, and z.
Ea-No-El
An option button that specifies setting the axes labels to Ea (Eastern), No
(Northern), and El (Elevation). This option is selected by default.
Orthogonal
An option button that sets the projection type to Orthogonal. This option is
selected by default.
Perspective
An option button that sets the projection type to Perspective and makes
available the Angle text box to specify a viewing angle, which must be larger than
0 and smaller than 180. The default value is 25.0 degrees.
The Display > Tree View page of the IMSurvey Options dialog box, shown in Figure
24.7, offers display options for the tree view.
The Display > Interface Colors page of the IMSurvey Options dialog box, shown in
Figure 24.8, allows modifying the default interface colors.
Colors are presented in a table with two columns: Item and Color. The list can be sorted
by clicking the Item column header. Specify a color by clicking the color for an item and
clicking a color in the list that is displayed. The following colors are editable:
Background - Bottom
Color used to define the color at the bottom of the 3D scene. Set to gray by default.
The color is used, with the corresponding top color, to generate a top-to-bottom
gradient background.
Background - Top
Color used to define the color at the top of the 3D scene. Set to black by default.
The color is used, with the corresponding bottom color, to generate a top-to-
bottom gradient background.
Bounding Box
Color used to render the bounding box. Set to white by default.
Coordinate Annotation
Color used to render picked coordinate annotations. Set to green by default.
Dark
Color used to render back or front faces of polygons, depending on their rendering
status. Set to dark blue by default.
Mark
Color used to render user-generated points. Set to red by default.
Mark (Alternate)
Color used to render system-generated points in an alternate color from user-
generated points. Set to yellow by default.
No Result
Color used to render object elements for which no result is available. It is used
when the color mode is set to Color Map. Set to light gray by default.
Pencil
Color used to render 2D contours generated by the user. Set to yellow by default.
Point-to-Object Measurement
Color used to render the on-screen results of the measurement operations located
on the Measure > Deviations of Data Objects submenu. Set to light green by default.
Preview
Color used to render objects displayed within a preview mode.
Selection
Color used to render selected elements. Set to red by default.
Text Field
Background color for a Textfield object’s annotation. Set to pale yellow by default.
The Display > Lights page of the IMSurvey Options dialog box, shown in Figure 24.9,
offers options related to the lighting in the 3D scene.
The Display > Material page of the IMSurvey Options dialog box, shown in Figure
24.10, offers options related to material.
The Display > Reference/Data page of the IMSurvey Options dialog box, shown in
Figure 24.11, allows specifying the default Static and Dynamic display mode of Data
and Reference objects.
The Default static display and the Default dynamic display sections offer the
following options:
Drawing type
A list box that specifies the default drawing type used to render Reference/Data
objects. Choose from:
Bounding Box – Draws the bounding box of each 3D object (i.e., Reference
and Data objects) instead of rendering the individual objects. Available in
Dynamic display mode only.
The default drawing type in both the Static display mode and in the Dynamic
display mode is Flat+Curve.
Subsampling
A list box that enables specifying the quantity of Reference/Data object elements
to use. Choose from: 1/1 (use all elements), 1/4 (use one in four elements), 1/16
(use one in sixteen elements), and 1/64 (use one in sixty-four elements). The
default value is 1/1.
This item is also offered under the Object Display Options button of the 3D Scene
toolbar.
The Display > Data Color Maps page, shown in Figure 24.12, offers the options that
follow.
The Display > Feature Primitives page of the IMSurvey Options dialog box, shown in
Figure 24.13, allows specifying the default Static and Dynamic display mode of feature
primitives.
List boxes are offered for each object, offering Static and Dynamic drawing types. Note
that the Static display mode for certain objects (i.e., point, polyline, vector) have fixed
values.
Polylines have additional parameters for the Static and the Dynamic display modes:
Arrows
A check box that enables the display of arrows. By default, the check box is
selected for the Static display mode and cleared for the Dynamic display mode.
Vertices
A check box that enables the display of vertices. By default, the check box is
selected for the Static display mode and cleared for the Dynamic display mode.
The Display > Cross-Sections page of the IMSurvey Options dialog box, shown in
Figure 24.14, offers items that allow configuring the display of cross-sections and their
measurement results.
Drawing style
A list box that offers drawing styles. Three choices offer to display only the points
on the cross-sections: Points (Cross), Points (Square), and Points (Triangle). The
last choice offers to draw the cross-section as a line: Polyline. The default value is
Polyline.
Measurement zone
A check box that enables displaying the measurement zone of each cross-section
plane. The check box is cleared by default.
Nominal component
A check box that enables displaying the nominal component of cross-sections. It
is selected by default. When selected, it makes available the following item:
Color mode
A list box that controls the color display of nominal cross-section
component. It offers three choices:
Measured component
A check box that enables displaying the measured component of cross-sections. It
is selected by default. When selected, it makes available the following items:
Color map
A check box that enables cross-sections to contribute to the color scale. A color
map demonstrates graphically the deviations between the nominal and the
measured cross-section components. When selected, it makes the items that
follow available. By default, the check box is selected. If the check box is cleared,
the cross-section children are displayed using their object color.
Deviation vectors
A check box that enables displaying deviation vectors that represent the
measurement results. It is selected by default. When selected, it makes
available the following items:
Proportional
An option button, selected by default, that specifies rendering
deviation vectors using a length proportional to the true
deviation vectors. The vectors join the nominal objects (i.e.,
children of the nominal cross-section components) to the
measured objects (i.e., children of the measured cross-section
components). The direction of the displayed deviation vectors is
also the same as the true deviation vectors’ direction.
Unit
An option button that specifies rendering vectors of unit length.
If the comparison’s error direction is set to one of the Shortest
distance directions, or to Boundary Normal, the vectors always
point in the direction of the surface normal vector. If the
comparison’s error direction is set to Boundary Tangent, the
vectors always point toward the exterior of the closest surface.
For all other types of error directions, the vectors point in the
direction of the error.
Scaling factor
A text box that allows scaling the displayed vectors. Valid values
are positive and greater than 0. Values smaller than one shrink the
vectors, while a value of 1 performs no scaling, and values greater
than one make the vectors longer. The default value is 5.0.
Tolerance curves
A check box that enables the display of negative and positive tolerance
curves. It is cleared by default. When selected, it makes available the
following items:
Color mode
A list box that controls the color display of tolerance curves. It
offers two choices:
Vertex color
A list box that allows changing the displayed color of the cross-sections
while in Color Map viewing mode, which is the default viewing mode
after a measurement operation has been performed. Choose from:
This option has no effect if the Drawing style for cross-sections is set to
Polyline.
Figure 24.15 An example of a cross-section displayed with its color map and min and max
deviations.
Some reports and the annotations of values picked on data color maps can display a
flag (i.e., one or more symbols) that indicates whether the main component (i.e., X, Y, Z)
of the deviation vector points toward or away from the origin of the active coordinate
system, for a total of six possible values. An example of deviations displayed with such
flags is shown in Figure 24.16 (b). The Deviation Direction Flags page of the IMSurvey
Options dialog box, shown in Figure 24.16 (a), allows configuring the flag displayed in
each case. It offers the options that follow.
Figure 24.16 The Deviation Direction Flags page (a), and an example of color map point
annotations displayed with deviation direction flags (b).
(a) (b)
A text box that allows specifying the flag to display when the main
component of the deviation vector is Z and it points away from the origin
of the active coordinate system. The default flag value is U.
The Default Names page of the IMSurvey Options dialog box, shown in Figure 24.17,
allows specifying new default names for objects. It offers a list with the Object Type
and Default Name columns, which is sorted in alphabetical order on the object type.
To edit a default name in the list, click it and enter a new name. Press the ESC key to
undo the current editing. The list may feature a scroll bar to navigate the list.
The Annotations page of the IMSurvey Options dialog box, shown in Figure 24.18,
offers general options that apply to all annotation types:
Align values
A check box that enables aligning values in annotations. When
selected, all of the values are left-aligned using the rightmost
value as a starting point, and numerical values are aligned on
the decimal point. It follows that if a label is quite long, all of the
annotation values will align with this label’s value, making the Unaligned
entire annotation very wide. When the check box is cleared,
values immediately follow their label. By default, the check box
is selected.
Aligned
Show pass/fail markers
A check box that enables the display of pass/fail markers in
annotations. A symbol, O or X, indicates whether a result is,
respectively, a pass or a fail. By default, the check box is cleared.
For information on pass/fail inspection, see Section 2.2.2
Overview of point-to-surface comparison methods.
Tol = 2.0
Show annotations for new objects
A check box that specifies the display status of annotations for newly created
objects. By default, the check box is selected.
Note that this item does not apply to cross-sections – annotations are not shown
for these objects on creation. For more information on displaying annotations for
cross-section, see Section 15.11 Cross-section annotations and table report items.
Font size
A text box that specifies the annotation font size. The value must be greater than
or equal to the minimum font size, which is predetermined for each font, or else
the value is refused. Acceptable values range from 2 to 501 inclusively. The default
value is 8.
The annotation font can be changed through the Display page of the PolyWorks/
Workspace Manager Options dialog box. For more information, see Section 3.5.2.2
Display options in the PolyWorks Reference Guide.
The Annotations > Appearance page of the IMSurvey Options dialog box, shown in
Figure 24.19, specifies how the annotations will be displayed. It offers several sections.
Show border
A check box that enables displaying an annotation border. By default, the check
box is selected.
Corner type
A list box that is available when Show border is selected. It specifies the type of
corner for the annotation border. Choose from: Square or Round. The default
value is Round.
Color mode
A list box that is available when Show border is selected. It specifies the color
mode used to display the annotation border color. Choose from: Black or White
(the border is black or white, depending on the background color of the 3D Scene
pane), Object or Error Color (the border uses the object color, or the error color if
it is available), or User-defined Color (the border uses the color defined by the
option that follows). The default value is Object or Error Color.
A color box is available when Color mode is set to User-defined Color. To choose
a border color, click the color box and click a color in the list that is displayed.
Transparency (%)
A text box that specifies the degree of transparency of the annotation
background. Values range from 0 (no transparency) to 100 (total transparency).
The default value is 22.
Color mode
A list box that specifies the color mode used to display the annotation background
color. Choose from: Black or White (the background is black or white, depending
on the background color of the 3D Scene pane), Object or Error Color (the
background uses the object color, or the error color if it is available), or User-
defined Color (the background uses the color defined by the option that follows).
The default value is Object or Error Color.
A color box is available when Color mode is set to User-defined Color. To choose
an annotation background color, click the color box and click a color in the list that
is displayed.
The Attachment line section offers the following options related to annotation
attachment lines:
Width (pixels)
A text box that specifies the width of the attachment line in pixels. Values range
from 1 to 5. The default value is 2.
Color mode
A list box that specifies the color mode used to display annotation attachment
lines. Choose from: Black or White (the attachment line is black or white,
depending on the background color of the 3D Scene pane), Object or Error Color
(the attachment line uses the object color, or the error color if it is available), or
User-defined Color (the attachment line uses the color defined by the option that
follows). The default value is Object or Error Color.
A color box that is available when Color mode is set to User-defined Color. To
choose an annotation attachment line color, click the color box and click a color in
the list that is displayed.
Color mode
A list box that specifies the color mode used to display the annotation header text
color. Choose from: Black or White (header text is black or white, depending on
the annotation background color), Object or Error Color (header text uses the
object color, or the error color if it is available), or User-defined Color (header text
uses the color defined by the option that follows). The default value is Black or
White.
A color box that is available when Color mode is set to User-defined Color. To
choose an annotation header text color, click the color box and click a color in the
list that is displayed.
Color mode
A list box that specifies the color mode used to display the annotation result text.
Choose from: Black or White (result text is black or white, depending on the
background color of the 3D Scene pane), Object or Error Color (result text uses
the object color, or the error color if it is available), or User-defined Color (result
text uses the color defined by the option that follows). The default value is Black or
White.
A color box that is available when Color mode is set to User-defined Color. Click
the color box to choose a result text color using the Windows color manager
dialog box.
Color mode
A list box that specifies the color mode used to display the result background
color. Choose from: Same as Annotation Background, Object or Error Color (the
result text background uses the object color, or the error color if it is available), or
User-Defined Color (the result text background uses the color defined by the
option that follows). The default value is Object or Error Color.
A color box that is available when Color mode is set to User-Defined Color. To
choose a result background color, click the color box and click a color in the list that
is displayed.
The Annotations > Positioning page of the IMSurvey Options dialog box, shown in
Figure 24.20, allows specifying how object annotations are positioned. Note that this
behavior does not apply to the annotations of coordinate systems or Measurements.
The Positioning mode group label specifies how annotations will be positioned. Three
modes are offered:
Fixed
An option button that specifies that annotations remain at their respective
positions.
Close to border
An option button that specifies that annotations are automatically positioned
along the top, bottom, left, and right boundaries of the 3D Scene pane in a way
that minimizes annotation overlap and the intersection of annotation attachment
lines. The annotation display is automatically recomputed every time the 3D scene
is rotated and translated.
Note that this automatic positioning mode is suspended when in the annotation
dragging mode (see Section 22.2.7 Dragging annotations in the 3D scene).
Close to object
An option button, selected by default, that specifies that annotations are
automatically positioned as close as possible to their related object. The position
is located in the 3D scene and it is recalculated each time the 3D scene is
transformed (see the Automatic repositioning parameter that follows). When
selected, several options are made available:
Avoid intersections
A check box that enables avoiding annotation intersections. When
annotations intersect, only one of them and its attachment line is
displayed. The others will be hidden temporarily. If the scene changes
and the annotations do not intersect anymore, they will be displayed. By
default, the check box is selected.
Maximize density
A check box that is available when Avoid intersections is selected. It
enables fitting a maximum number of annotations on the screen while
respecting the other options when possible. By default, the check box is
cleared.
Automatic repositioning
A check box that enables the automatic repositioning of all or selected
annotations, unless annotation dragging is being performed. By default,
the check box is selected.
Attachment line
A group label that offers three options related to annotation attachment
lines:
Orientation
A list box that specifies the default attachment line orientation.
Choose from: Upper Right (all annotation attachment lines will
Note that this automatic positioning mode is suspended when in the annotation
dragging mode (see Section 22.2.7 Dragging annotations in the 3D scene).
The Annotations > Templates page of the IMSurvey Options dialog box, shown in
Figure 24.21, allows creating and editing annotation templates and specifying the
default annotation template.
Annotation type
A list box that displays all of the types of annotations. Click a type and the
annotation templates associated with it are displayed in the Templates list box.
Templates
A list box that displays the name of the annotation templates for the specified
annotation type. The highlighted template is the default (currently used) template
for the related annotation type. Each template name is preceded by a three-letter
code. STD (standard) precedes default templates provided by the application;
they cannot be deleted. USR (user) precedes customized standard templates or
new templates. And PRJ (project) precedes templates imported as part of a
project configuration that have the same name as a standard or a user template
but a different configuration.
New
A button that specifies creating a new annotation template, using the selected
template as its initial definition. The New Template dialog box is displayed to
specify a name for the template. The name must not contain any characters that
are invalid for file names. Specify a name and press the Add button. The
annotation template editor is displayed (see Section 24.4.3.1 Using the annotation
template editor).
Edit
A button that displays the annotation template editor (see Section 24.4.3.1 Using
the annotation template editor).
Delete
A button that deletes the selected template. Note the following:
Press the OK button to dismiss the dialog box. The currently selected template for each
annotation type becomes the default template for those annotation types. Or, press the
Cancel button to dismiss the dialog box. In this case, the default template designations
do not change – they are the same as they were before opening the dialog box.
The Edit button and the New button display the selected template in the annotation
template editor dialog box, which is shown to the left in Figure 24.22. The editor’s
Contents tab displays all of the information items that are available, and is used to
determine what information items will be displayed by an annotation template and in
what order. The central part of the tab is a list box. An information item is selected by
clicking it. Three buttons allows performing operations on the selected information
item:
Use
A button that specifies including the information item in the annotation. Used
information items move to the top of the list box.
Ignore
A button specifies ignoring (i.e., not including) the information item in the
annotation. Ignored information items are dimmed and are moved below the
used ones.
Edit
A button that displays the dialog box shown to the top right in Figure 24.22 that
allows editing the label that will be used in the annotation to identify the selected
The Up and Down arrows to the right of the list box change a selected information
item’s position in the annotation template.
When an annotation type has only one template, it is the default template. When an
annotation type has more than one template, it is possible to specify the template to
use as the default template. To specify new default templates for annotation types,
proceed as follows:
1. Open the IMSurvey Options dialog box by choosing the Tools > Options command.
3. Click Templates.
5. Highlight the item in the Templates list that is the desired default template.
The dialog box is dismissed and the new default template designations are
transferred to the application. Those annotation types that make use of a default
template for their display will use the current default templates.
The Reference object import section offers options that apply to Reference objects:
When the check box is selected, the initialization occurs on importing the object
into a project, or on opening a project for all Reference objects that require
initialization. If individual pieces contain edited Reference objects, they are
initialized on opening each individual piece. By default, the check box is selected.
When the check box is cleared, the initialization occurs when a first request is
made of the object (e.g., an alignment operation, picking a point on an object).
Note that if a Reference object has been initialized and later it is modified (e.g.,
some of its elements are deleted), it will be reinitialized when the next request is
made of the object.
The Data object import section offers the following options for objects imported as
Data objects:
Alignment group
A group label that allows specifying the alignment group for new objects on
import. It offers the following items:
Confirm at import
A check box that allows confirming or changing the alignment group
options when importing Data objects. When the check box is selected,
related parameters are offered in a dialog box that is displayed, and are
presented in Section 6.3.1.1.3 Alignment group (importing point clouds)
or Section 6.4.1.1.3 Alignment group (importing polygonal models). By
default, the check box is selected.
The Data object replacement section offers the options that follow for the
replacement of a Data object, presented in Section 23.3.1 Replacing a Data object.
Alignment group
A group label that offers the following items:
Confirm at replacement
A check box that enables confirming or changing the Apply
active alignment specification. When the check box is selected,
related parameters, presented in Section 6.3.1.1.3 Alignment
group (importing point clouds) or Section 6.4.1.1.3 Alignment
group (importing polygonal models), are offered in the
Replacement Parameters dialog box that is displayed. By default,
the check box is selected.
The Reference/Data > CAD Models page of the IMSurvey Options dialog box, shown
in Figure 24.23, offers options related to importing CAD models as well as their default
properties.
Number of CPUs
A text box that specifies the number of CPUs to use. Valid values range
from 1 to the number of CPUs of the workstation. The default value is 4,
or the actual number of CPUs of the workstation if that number is smaller
than 4.
If a file could not be opened using parallel processing, an attempt is made to open
the file using a single processor, which may result in a successful import.
Tessellated surfaces
An option button, selected by default, that specifies using tesselated
surfaces (i.e., polygonal representation) when inspecting a part with
respect to its CAD model. This option is appropriate when processing
data points produced by point cloud digitizing devices, or when
inspecting parts that have a size in the range of 0 to 10 meters. Such CAD
models can be tessellated with a small enough tolerance to prevent any
impact on the accuracy of the inspection results. In addition,
Tessellation tolerance
A text box that allows specifying a value that represents the
maximum chordal deviation between an imported CAD surface
and its polygonal representation. Valid values are greater than
zero. The default value is 0.01 mm.
Note that an automatic loop removal algorithm is applied that gets rid of
self-intersections, which are the result of self-intersecting trim curves,
and ensures the proper tessellation of CAD surfaces.
NURBS surfaces
An option button that specifies using NURBS surfaces for computations.
This option is appropriate for very large and detailed CAD models (i.e.,10
meters or more) which would take too long to tessellate, or in the context
of high-accuracy requirements (e.g., in the range of a few microns). CAD
model import time is accelerated, and the accuracy of mathematical
operations applied to CAD Reference objects is in the sub-micron range.
The following items are offered:
Tessellation tolerance
A text box that allows specifying a tolerance value used to
tessellate CAD models for display purposes as well as to
accelerate mathematical operations on NURBS surfaces. The
default value is 0.5 mm.
Confirm at import
A check box that enables accepting or changing the tessellation
tolerance value at import. When the check box is selected, a dialog box is
displayed to specify a tessellation tolerance value. When the check box is
cleared, the value specified in the Tolerance text box is used. By default,
the check box is cleared. The import parameters are presented in Section
6.5.2.1.1 Surfaces used for computations.
Stitching
A group label that offers the following items related to stitching:
Stitching is performed when the native CAD file does not contain any, or
contains only partial, topological information.
Curves
A group label that allows specifying the following values for detecting sharp edge
curves and fillet tangent curves:
The Reference/Data > CAD Models > STEP page of the IMSurvey Options dialog box,
shown in Figure 24.25 offers several options.
The Reference/Data > Point Clouds page of the IMSurvey Options dialog box, shown
in Figure 24.26, offers options used when importing point clouds into a project.
Note that these options apply when importing point clouds using the File > Import >
Point Clouds command. They do not apply when importing point clouds from a project
to another (File > Import > From Project).
The Import section of the Point Clouds page offers the following option:
When selected, an option is offered during the import process to allow specifying
whether the point clouds are imported as Reference objects or Data objects; it is
presented in Section 6.3.1.1.2 Object type. Note that this option is not offered if
none of the selected point cloud formats permit the creation of Reference objects.
The Data objects subsection offers the following options, which are mutually exclusive
(i.e., they cannot be selected at the same time).
Figure 24.27 The Reference/Data > Point Clouds > IMAlign Projects page.
Figure 24.28 The Reference/Data > Point Clouds > Spherical Grids page.
The Reference/Data > Point Clouds > IMAlign Projects page of the IMSurvey Options
dialog box, shown in Figure 24.27, offers import options for IMAlign projects.
The Reference/Data > Point Clouds > Spherical Grids page of the IMSurvey Options
dialog box, shown in Figure 24.28, offers import options for point clouds in the
spherical grid category.
Subsampling factor
A list box that offers subsampling factors to reduce the number of points in the
point cloud. For example, a factor of 1/4 keeps one point in every four. The default
value is 1/1. Note that this subsampling operation is not applied to 3DD and RXP
Riegl files.
Confirm at import
A check box that allows accepting or changing the subsampling factor
value at import. By default, the check box is cleared.
Normal extraction
A group label that offers items related to the extraction of normals:
Max angle
A text box that specifies an angle in degrees used to discard points
captured at a steep angle. Valid values range from 0 to 180. It is
recommended to use an angle of 85 degrees or more. The default value
is 85 degrees.
Note that certain problems may arise when sharing a workspace with external
datasets. For example, if the workspace is sent to a user on another computer, a
dialog box will be displayed on opening the IMSurvey project stating that the
external dataset cannot be found and offering a browser to provide a new path to
the object. As well, if the file loaded as external to the workspace is moved to
another directory on the computer, on opening the IMSurvey project the same
dialog box will be displayed to query a new path for the file.
When compressing a workspace with external files, the user is queried with
regards to adding the external files to the workspace as part of the compression
operation.
Figure 24.29 The Reference/Data > Point Clouds > Unorganized Point Clouds page.
The Reference/Data > Point Clouds > Unorganized Point Clouds page of the
IMSurvey Options dialog box, shown in Figure 24.29, offers import options for point
clouds in the unorganized point cloud category.
Note that certain problems may arise when sharing a workspace with external
datasets. For example, if the workspace is sent to a user on another computer, a
dialog box will be displayed on opening the IMSurvey project stating that the
external dataset cannot be found and offering a browser to provide a new path to
the object. As well, if the file loaded as external to the workspace is moved to
another directory on the computer, on opening the IMSurvey project the same
dialog box will be displayed to query a new path for the file.
When compressing a workspace with external files, the user is queried with
regards to adding the external files to the workspace as part of the compression
operation.
The Reference/Data > Polygonal Models page of the IMSurvey Options dialog box,
shown in Figure 24.30, offers import options for polygonal models.
Reference objects
An option button that specifies that polygonal models are imported as
Reference objects.
Data objects
An option button, selected by default, that specifies that polygonal
models are imported as Data objects.
Confirm at import
A check box that enables confirming the object type specified above on
import. When the check box is selected, related parameters are offered in
a dialog box that is displayed, and are presented in Section 6.4.1.1.2
Object type. By default, the check box is cleared.
Create dependencies
A check box that enables creating dependent primitives when using certain
creation methods. It is selected by default. For more information on creating
dependent primitives, see Section 13.1.1 Dependent primitives.
The IGES files section offers the following options used when importing primitives
from IGES files, organized by entity type:
116
A check box that enables importing 116 entities as points. By default, the check
box is selected.
106 form 3
A check box that enables importing form 3 of 106 entities as vectors. By default,
the check box is selected.
110
A check box that enables importing 110 entities as vectors. By default, the check
box is selected.
108
A check box that enables importing 108 entities as planes. By default, the check
box is selected.
100
A check box that enables importing 100 entities as circles. By default, the check
box is selected.
154
A check box that enables importing 154 entities as cylinders. By default, the check
box is selected.
156
A check box that enables importing 156 entities as cones. By default, the check
box is selected.
158
A check box that enables importing 158 entities as spheres. By default, the check
box is selected.
106 form 12
A check box that enables importing form 12 of 106 entities as polylines. By default,
the check box is selected.
126
A check box that enables importing 126 entities as polylines. By default, the check
box is selected.
The Feature Primitives > Feature Codes page of the IMSurvey Options dialog box,
shown in Figure 24.32, offers options that allow creating and editing a list of feature
codes.
The Feature Codes page contains a list to contain feature code definitions. Two
buttons allow creating feature code:
New
A button that allows creating feature codes manually. On pressing the button, the
dialog box shown in Figure 24.32 (b) is displayed. It offers the following items:
Feature code
A text box that specifies a code that corresponds to the feature. The name
must be unique within the list.
Figure 24.32 At the top, the Feature Primitives > Feature Codes page.
(a)
(b) (c)
Description
A text box that specifies a description of the feature. This information is
optional.
Level name
A text box that specifies a level name. This information is optional.
For MicroStation v8 or DXF export, the level name is used as level or layer
name and consists of a combination of letters and numbers. For
MicroStation v7, the level name should be a number ranging from 1 to
63. Otherwise, it will be interpreted as level 1.
Color
A list box that specifies a color. The following choices are offered:
Automatic (the application chooses the object color) and Custom
(specify a color in the dialog box that is displayed). The default value is
Automatic.
Line width
A list box that specifies a line width. The following choices are offered:
Automatic, and values from 1 to 5. The Automatic choice specifies that
the line width will be the display default line width (see the Line width
item on the Display page of the IMSurvey Options dialog box). The
default value is Automatic.
Line style
A list box that specifies a line style. The following choices are offered:
Automatic (the line will be continuous (style 0)) and eight line styles
numbered 0 to 7. The default value is Automatic.
Note that the choice Automatic also means that the properties of an existing
primitive are not changed when a feature code is assigned to it.
New list items are sorted in the list based on the Feature code.
Press the OK button to create the feature code or the Cancel button to end the
operation.
Import
A button that allows importing a feature code file in CSV format. On pressing the
button, the dialog box shown in Figure 24.32 (c) is displayed. Enter the # lines to
skip at the beginning of the file. The default value is zero. Press the OK button to
continue or the Cancel button to end the operation. On pressing the OK button, a
file browser is displayed to specify the feature code list file. Press the Open button
to launch the operation.
Each line of the file should contain the following fields: feature code, description,
level name, R, G, B, line width, and line style. As the field separator is the comma,
fields themselves cannot contain commas. They cannot contain double quotes
either.
Edit
A button that displays the dialog box shown in Figure 24.32 (b) to edit the selected
entry in the feature code list. All of the items can be edited: Feature code,
Description, Level name, Color, Line width, and Line style. Press the OK button
to edit the feature code or the Cancel button to end the operation.
Delete
A button that deletes the selected entry in the feature code list. A confirmation
window is displayed. Press the OK button to confirm the deletion or the Cancel
button to end the operation.
The Default nominal component extraction parameters section offers the following
option:
Reference objects
A list box that allows specifying the Reference objects to use by default when
obtaining the nominal component by extraction. Choose from All (i.e., all
Reference objects) and Specific (i.e., all currently used Reference objects, and
allows specifying specific Reference objects in the property sheet). The default
value is All.
The Default deviation calculation parameters section offers the following options:
Max distance
A text box that specifies the maximum distance to use to calculate the measured-
to-nominal deviation. Valid values are greater than 0. The default value is 4 mm.
Offset
A check box that enables specifying a maximum angle in degrees between the
normal vector of a vertex on a cross-section child belonging to the measured
component and the normal vector of the closest point on the child cross-section
belonging to the nominal component that is within the Max distance value.
By default, the check box is cleared. When the check box is selected, a text box is
made available to specify a value. Valid values may be positive or negative. The
default value is 0 mm.
Max angle
A check box that enables specifying a maximum angle in degrees between the
normal vector of a vertex on a cross-section child belonging to the measured
component and the normal vector of the closest point on the child cross-section
belonging to the nominal component that is within the Max distance value.
This angle eliminates from the measurement results the vertices that have an
orientation incompatible with the matched location on the normal component.
Valid values range from 0 to 180. By default, the check box is selected and the
value in the text box is 45 degrees.
Deviation sign
A check box that enables specifying a deviation sign to use as a filter for the results.
When selected, an adjacent list box is made available. Choose from Keep Positive
(keep only the positive deviations) and Keep Negative (keep only the negative
deviations). The default value is Keep Positive. By default, the check box is cleared.
Tolerance limits
A check box that enables specifying a tolerance filter based on the tolerance range
where values are located. The tolerance is that of the objects from which
deviations are measured. When selected, an adjacent list box is made available.
Choose from:
Keep beyond HiTol – Keeps points whose deviations are larger than the
high tolerance limit.
Keep between HiTol and LoTol – Keeps points whose deviations lie
between the low and the high tolerance limits.
Keep within LoTol – Keeps points whose deviations are lower than the low
tolerance limit.
The default value is Keep beyond HiTol. By default, the check box is cleared.
The Cross-Sections > Extract Measured page of the IMSurvey Options dialog box,
shown in Figure 24.34, offers options for the extraction of measured cross-section
components. These options are explained in more detail in Section 15.4 Obtaining the
measured component of cross-sections.
Sub-method
A list box that allows specifying a sub-method. Choose from Standard and
Compensate for 3D Deviation. The default value is Standard.
Data objects
A list box that allows specifying the Data objects to use by default when obtaining
the measured component by extraction. Choose from Surface (i.e., all nonignored
surface-type Data objects within the measurement zone) and Specific (i.e., specify
Point clouds
A group label that offers a distance parameter that controls the sectioning
algorithm for point cloud Data objects:
Gap filling
A check box, cleared by default, that enables filling gaps in the extracted cross-
section using the following specifications:
Max distance
A text box that allows specifying the maximum gap length to fit along
the cross-section. The default value is 4.0 mm.
Sampling step
A group label that allows specifying the sampling step, which determines
the length of cross-section segments used to fill gaps, and which should
be similar to the point density or the mesh triangle edge length:
Automatic
An option button, selected by default, that specifies determining
the sampling step automatically.
Custom
An option button that allows specifying a sampling step. Specify
a value in the adjacent text box. The default value is 0.50 mm.
The Standard sub-method section offers the following options for the Standard sub-
method:
Point clouds
A group label that offers parameters used when extracting on point cloud surface
Data objects.
Sampling step
A text box that specifies a point-to-point distance on the best-fit cross-
section. This value should be larger than the standard deviation of the
Data points, typically at least 3 times larger. When the value is larger,
noise in the Data points is better smoothed. The default value is 200 mm.
Smoothing (%)
A check box, cleared by default, that enables applying smoothing to Data
cross-section. The check box is cleared by default. When selected, a
smoothing factor can be specified as a percentage in the adjacent text
box. The default value is 50%. Smoothing allows reducing the effect of
noise in point cloud Data objects, which produces more accurate cross-
sections.
The Default report item update parameters section offers the following options:
Updatable
A check box that enables indicating whether new report items are updatable or
not. By default, report items are updatable.
Coordinate system
A group label that offers options to specify whether new updatable report items
are updated using the active coordinate system or using the specific coordinate
system that was active at creation time.
Data alignments
A group label that offers options to specify whether new updatable report items
are updated with the active data alignments or with specific data alignments that
were active at creation time.
The Default formatted report update parameters section offer the following option:
Updatable
A check box that indicates whether new formatted reports are updatable or not.
By default, formatted reports are updatable.
For more information, see Section 3.1.4 Updating report items and formatted reports.
The Reports > Snapshots page of the IMSurvey Options dialog box, shown in Figure
24.36, offers options that are used to assign properties to newly created snapshot
report items.
The Default capture parameters section allows configuring default snapshot capture
parameters. These options are used when creating snapshots, updating snapshots, and
restoring the project view.
Height (pixels)
An option button that specifies using the height sizing mode. It makes available
an adjacent text box to specify the fixed height of newly created snapshots, in
pixels. The specified value must be greater than, or equal to, 2. The default value is
600 pixels. When this option is selected, the width of the snapshot is automatically
calculated to maintain the height/width ratio of the actual capture zone (3D scene
or 3D scene region).
Width (pixels)
An option button that specifies using the width sizing mode. It makes available
the adjacent text box to specify the fixed width of newly created snapshots, in
pixels. The specified value must be greater than, or equal to, 2. The default value is
800 pixels. When this option is selected, the height of the snapshot is
automatically calculated to maintain the height/width ratio of the actual capture
zone (3D scene or 3D scene region).
Scaling (%)
An option button, selected by default, that enables the adjacent text box used to
specify a scaling factor for newly created snapshots. Any value greater than or
equal to 0.1% can be specified. The default value is 100%. Increasing the scaling
factor also increases the resolution of the created snapshot. The height/width ratio
of the actual capture zone (3D scene or 3D scene region) is always maintained.
When the scaling factor is a value other than 100%, or when the specified height or
width is different than the actual size of the region or 3D Scene, the created snapshot is
resized accordingly. However, 2D elements (e.g., color scale, text, and annotations) and
some 3D elements (e.g., measurement arrows, lines, and points) are not resized.
Similarly, when creating resized snapshots, the annotation positioning will vary
according to the specified annotation positioning mode on the Annotations >
Positioning page of the IMSurvey Options dialog box. Some annotations may
disappear, while others may appear in the snapshot. For more information, see Section
24.4.1 Annotation appearance options. Note the following:
When the annotation positioning mode is set to Fixed, the relative position of
annotations is maintained in the snapshot.
When the annotation positioning mode is set to Close to border or when it is set to
Close to object and the Automatic repositioning option is selected, the position of
annotations is recalculated.
When the annotation positioning mode is set to Close to object, but the Automatic
repositioning option is cleared, the relative position of annotations remains as is.
The Object visibility subsection offers options used when updating and restoring
snapshots of features and cross-sections.
The Children of visible cross-sections section offers options that control the visibility
of child cross-sections whose parents are visible when the snapshot is taken.
Nominal
A list box that allows displaying or not the nominal component of visible cross-
sections. Choose from: Show (component is displayed), Hide (component is
hidden), As Captured (component is displayed or hidden according to its current
status). The default value is As Is.
Measured
A list box that allows displaying or not the measured component of visible cross-
sections. Choose from: Show (component is displayed), Hide (component is
hidden), As Captured (component is displayed or hidden according to its current
status). The default value is As Is.
When all of the cross-section children of a visible parent cross-section are hidden,
the parent cross-section is not displayed.
The Word / Excel / HTML export section offers snapshot export options:
Alignment
A list box that allows specifying the image alignment when exporting snapshots
to Word or HTML. Choose from: Left, Center, and Right. The default value is
Center.
Scaling
A check box that enables growing or shrinking snapshots. When selected, it offers
the Height (%) and Width (%) text boxes, to specify the percentage by which the
snapshot’s height and width will be scaled when exporting to Word, Excel, and
HTML. The maximum height and width scaling value is 500%. The default value for
each text box is 100%.
Note that when a snapshot report item is included in a formatted report, the two items
that specify alignment and scaling in the Word / Excel / HTML export section are not
transferred to the formatted report.
The Reports > Tables page of the IMSurvey Options dialog box, shown in Figure 24.37,
offers options that are used to specify the formatting to use, including the formatting
for titles and cells, for new table reports.
Show title
A check box that enables displaying the title in generated table reports, and on
export to external formats. By default, the check box is selected.
Alignment
A list box that specifies the text alignment within table cells. Choose from Left,
Center, or Right.
Font
A list box that specifies the font type.
Size
A list box that specifies the font size. A series of values are offered between 6 and
72.
Bold
A check box that enables this aspect of the font style.
Italic
A check box that enables this aspect of the font style.
Underline
A check box that enables this aspect of the font style.
Alignment
A list box that specifies the text alignment within table cells. Choose from Left,
Center, or Right.
Font
A list box that specifies the font type.
Size
A list box that specifies the font size.
Table alignment
A list box that allows specifying the alignment of the table in the output format.
Choose from: Left, Center, and Right. The default value is Center.
The Reports > Tables > Templates page of the IMSurvey Options dialog box, shown in
Figure 24.38, offers options that allow editing or creating new templates. It features two
list areas:
Table type
A list area that displays all of the table types.
Templates
A list area that displays the templates for a selected table type. Existing templates
may be edited and new templates may be created based on a selected template.
The list area is also used to designate the default template, which is the template
used by a table on creation to display its contents, by highlighting it and
eventually pressing the OK button.
Three buttons are offered that operate on the selected table template:
New
A button that allows the creation of a new template for a table type. The definition
of the currently selected template will be used by the new template. When
pressed, this button displays a dialog box used to assign a name to the new
template (do not use characters that are invalid in a file name). Specify a value in
the Name text box and press the Add button, or press the Cancel button to end
the operation. The table template editor is displayed to allow template editing.
See Section 24.8.2.1.1 Using the table template editor for information on using this
editor.
Edit
A button that displays the template editor to edit the selected template. Section
24.8.2.1.1 Using the table template editor explains how to use this editor.
If the selected template was a project (PRJ) template, there are two choices on
saving: save the edited template to the project, or add the template to the list of
user templates. If the latter option is chosen, any current user template of the same
name is overwritten.
Delete
A button that deletes the selected template. Note the following:
Note that templates for a same table type all offer the same information items. What
may differ from one template to the next is the subset of used information items and
the sort rules and filter rules that apply to the used information items, if any.
There are two types of template editors. When a table presents a list of elements, the
editor offers three tabs:
The Contents tab is used to specify the information items that will be reported for
each list element, and the order in which they will be reported.
The Sort tab allows creating sorting rules to sort the list elements.
Figure 24.39 The dialog box used to edit a table template. It can come in two formats, with only a
Contents tab or with the three tabs shown above.
Move a selected
information item
up or down
Used information item
appears in the report Report organization:
(label is not grayed out) Horizontal
Vertical
Ignored information item
(label is grayed out)
The Filter tab allows defining rules to include/exclude list elements in/from the
table.
Certain reports do not produce a list. For example, if two planes are being compared,
information can be displayed about each plane as well as information about their
comparison. For such reports, the template editor only offers a Contents tab, as there
are no lists to sort or filter.
The template editor’s Contents tab displays all of the information items that are
available, and is used to determine which ones will be displayed and in what order. The
central part of the tab is a list box. Information items preceded by H (header) belong to
the table header and are only displayed once, and those preceded by R (result) are
computed for each result. Items can be selected by clicking them.
Use
A button that specifies including the selected information item in the table. Used
information items are placed above the ignored information items.
Ignore
A button that specifies ignoring the selected information item. Ignored
information items are dimmed (see Figure 24.39) and placed after the used
information items.
Edit
A button that displays a dialog box that allows editing the label that will be used
in the table to identify a particular information item. Edit the contents of the Field
label text box and press the OK button.
Note that if the information item name is between braces (e.g., {Type
Measurement}), it represents a category of information items of that type, and not
a single information item. In this case, the Edit button displays a dialog box that
allows specifying a suffix that will appear after each information item in that
category; a space character may be inserted before the suffix.
The Up arrow and the Down arrow buttons to the right of the list box change a
selected information item’s position in the table. The two buttons below the arrows
determine whether the table will be arranged horizontally or vertically. In a horizontal
report, a single table is created in which each comparison result is displayed in one row.
In a vertical report, there are as many result sections as there are comparison results.
With respect to reports that generate lists of information, sorting rules can be defined
that will order the results. Existing sorting rules are shown in a list box displayed within
the Sort tab of the template editor, shown in Figure 24.40 (a).
The Add button allows defining an additional new sorting rule, the Edit button allows
modifying a selected sorting rule, and the Delete button allows deleting a selected
sorting rule. The Up arrow and the Down arrow buttons to the right of the list box are
used to move a selected sorting rule up or down in the list box. Results are sorted using
the topmost sorting rule first.
Figure 24.40 (b) shows the dialog box used to create a sorting rule. The Sort by list box
contains the list of information items for the template. The Sort order list box specifies
whether results will be ordered by Ascending or Descending order of the adjacent
item’s values. The Add button allows transferring the sort rule to the application.
The dialog box used to edit a sorting rule is very similar to the one used to create a
sorting rule, the only difference is that the OK button replaces the Add button.
With respect to reports that generate lists of information, filter rules can be defined to
eliminate undesirable results from a report. These filter rules are shown in a list box
displayed within the Filter tab of the template editor, shown in Figure 24.41 (a).
Figure 24.40 In (a), the Sort tab of the Edit Table Template dialog box, showing a sort rule. In (b),
the dialog box used to add a new sort rule.
(a)
Move a selected
sorting rule up
or down
(b)
The Add button defines a new filter rule, the Edit button allows modifying a selected
filter rule, while the Delete button deletes a selected filter rule. The order in which filter
rules are displayed in the list box is not important.
Figure 24.41 (b) shows the dialog box used to create a filter rule:
The leftmost list box determines whether a result is included or excluded depending
on the outcome of the comparison operation.
The second list box contains a list of all information items available for this table type.
The third list box offers a list of conditional operators: <=, <, =, >, and >=.
The fourth item, a combo box, allows choosing or type a value. Note that the
contents of the combo box menu depends on the selected information item.
The Add button allows transferring the filter rule to the application.
Figure 24.41 In (a), the Filter tab of the Edit Table Template dialog box, showing a filter rule. In (b),
the dialog box used to add a new filter rule.
(a)
(b)
Filter rules can be understood as natural human sentences. For example, include all
results for which the standard deviation is smaller than or equal to 10.0 could be
programmed as follows: choose Include in the first list box, choose Standard
Deviation in the second one, choose <= in the third one, and type 10.0 in the combo
box.
The dialog box used to edit a filter rule is very similar to the one used to create a filter
rule, the only difference being the OK button instead of the Add button.
The Reports > Text Fields page of the IMSurvey Options dialog box, shown in Figure
24.42, offers options used to format text field objects.
Alignment
A list box that specifies the text alignment. Choose from Left, Center, Right, or
Justified. The default value is Justified.
Font
A list box that specifies the font type. The default value is Arial.
Size
A list box that specifies the font size. A series of values are offered between 6 and
72. The default value is 10.
Bold
A check box that enables this aspect of the font style. It is cleared by default.
Italic
A check box that enables this aspect of the font style. It is cleared by default.
Underline
A check box that enables this aspect of the font style. It is cleared by default.
Figure 24.44 The Tolerances page, which allows specifying colors to use to report tolerance-based
results.
Symmetrical
A check box, selected by default, that enables using the colors of the standard
traffic light color scale (i.e., green, yellow, red), which is shown in Figure 24.44, for
the positive and the negative tolerance limits. The three positive result colors are
applied to the equivalent negative result color respectively. When the check box is
cleared, the standard rainbow6 color scale is used, offering a different color for
each tolerance limit.
A list area offers a color box for each of three positive and the three negative results:
Out of positive limit, Between low and high positive limits, Within low positive
limit, Within low negative limit, Between low and high negative limits, and Out of
negative limit. To modify a result color, click the color box to the right of the label and
click a color in the list that is displayed. Note the following:
When editing a positive result color in the symmetrical mode, the same color will
automatically be applied to its equivalent negative result color.
When editing a positive color in either color scale, the new color will automatically be
used by the other color scale, when selecting or clearing the Symmetrical check box.
To return to the default colors, press the Reset Colors button. When the Symmetrical
check box is selected, the color scale is reset to the default traffic light colors. When the
Symmetrical check box is cleared, the color scale is reset to the default rainbow6
colors.
To apply the new colors to existing colored report items, the report items must be
regenerated.
Tolerance templates allow defining fixed tolerance values. Default tolerance templates
are used to attribute a tolerance to new Reference objects and primitives and controls
on creation. Other templates can be created and used to quickly attribute a tolerance
to created objects/controls.
The Tolerances > Templates page of the IMSurvey Options dialog box, shown in
Figure 24.45, offers tolerance template management.
The Templates page offers a list area that displays the default and user-created
tolerance templates that are available. Standard templates are preceded by STD, user
templates by USR, and project templates by PRJ. A tolerance template is defined by
tolerance limits:
High+
The positive high tolerance limit for distance or angular measurements. When a
distance to a surface is computed, the positive high tolerance defines a tolerance
above the surface.
Low+
The positive low tolerance limit for distance or angular measurements. When a
distance to a surface is computed, the positive low tolerance defines a tolerance
above the surface.
Low-
The negative low tolerance limit for distance or angular measurements. When a
distance to a surface is computed, the negative low tolerance defines a tolerance
below the surface.
High-
The negative high tolerance limit for distance or angular measurements. When a
distance to a surface is computed, the negative low tolerance defines a tolerance
below the surface.
Name of
tolerance Type of unit Used to attribute a tolerance to new...
template
To edit a template’s tolerance limits, double-click a tolerance limit and enter a new
value.
Two buttons allows creating new templates and deleting existing templates:
New
A button that allows creating a new tolerance template. Specify a name in the
Template name text box of the dialog box that is displayed, then press the OK
button to continue, or press the Cancel button to end the operation. The name
must not contain any characters that are invalid when forming a file name. A new
template is added to the list, with the following default values: 1.0, 1.0, -1.0, -1.0. To
specify tolerance limits for the template, double-click the desired column and
enter a value.
Delete
A button that allows deleting a selected tolerance template. Standard templates
(STD) cannot be deleted. When a project default template (PRJ) is deleted, it is
replaced by the standard (STD) default template from the local personal
configuration.
Press the Apply button to apply the changes to the current project. An edited standard
(STD) template becomes a user (USR) template. When a default template that is part of
a project configuration is edited, a question is displayed to determine whether the
change is to be made to the project only, or also to your local personal configuration,
overwriting any templates of the same name.
Figure 25.1 The file browser used to export objects from projects.
(a) Browse in
open workspaces,
or workspaces in
the PolyWorks
folder
When exporting in a workspace, two shortcuts can be used (see Figure 25.1 (a)) to
quickly locate the workspace where the object will be exported:
Open Workspaces: Contains a shortcut for each workspace that is currently open in
PolyWorks. This shortcut points to a subdirectory (called Open Workspaces) of the
PolyWorks directory.
PolyWorks: Contains the above-mentioned directory (Open Workspaces) and the list
of all workspaces previously saved in the PolyWorks subdirectory.
When relevant, an Options button is offered (see Figure 25.1 (c)). It gives access to a
dialog box with the export options that correspond to the file format specified in the
Save as type list box (see Figure 25.1 (b)).
Browse to the appropriate location, enter a file name, and specify a file format. Then,
press the Save button to launch the export operation, or the Cancel button to end the
operation.
See the following sections for information on the commands used to export objects
from the File > Export menu.
According to the selected file format, the browser window may also display an Options
button, which offers export options. The following subsections explain the
particularities for each supported file format. If export options are available for a
format, it is explained in the appropriate subsection.
To launch the export operation, press the Save button. Otherwise, press the Cancel
button to end the operation.
When an IMAlign project file format is selected, the export command allows exporting
a selected IMAlign project to a workspace. For an IMAlign project to be exported, it
must have conserved its original scaling (i.e., not have been rescaled) and not have
been mirrored.
The new IMAlign project is created by accessing the original IMAlign project, updating
its image transformation matrices using the transformations performed in IMSurvey,
and then exporting that result. Any editing that was done on the IMAlign project in
IMSurvey is not communicated to the new IMAlign project. For example, points that are
ignored or deleted in IMSurvey are not ignored/deleted in the exported IMAlign
project.
Note that if the original IMAlign project was a standalone directory and IMSurvey
cannot find the original IMAlign project directory, or one of its associated files, using
the path recorded when it was loaded into IMSurvey, it will display a directory browser
to specify a different path. If the original IMAlign project is not available, the export
operation cannot be completed.
When a text file format is selected, the export command allows exporting selected
Reference and/or Data objects to a point cloud file written in a text file format.
In the file browser, click the Options button to specify the following options:
Template
A list box that offers context-specific templates used to write text files. For
example, when exporting ASCII point clouds, four standard text file templates are
available: Points Only, Points + Intensities, Points + RGB Colors, and Points +
Vectors.
Scientific notation
A check box that enables the use of scientific notation (e.g., 2.431E002 instead of
243.1). It is cleared by default.
Press the OK button to close the Text File Export Options dialog box.
Note that if several objects are selected to be exported, they will be merged into one
file.
According to the selected file format, the browser window may also display an Options
button, which offers export options. The following subsections explain the
particularities for some file formats and, if applicable, the export options that are
available.
To launch the export operation, press the Save button. Otherwise, press the Cancel
button to end the operation.
Convert units
A check box, only offered for the IGES file type, that allows converting IGES units
to other units. By default the check box is cleared. When selected, the following
item is made available:
Exported units
A list box that specifies the exported units. Choose from: Microns,
Millimeters, Centimeters, Meters, Inches, and Feet. The default value is
Millimeters.
Convert units
A check box, only offered for the IGES file type, that allows converting IGES units
to other units. By default the check box is cleared. When selected, the following
item is made available:
Exported units
A list box that specifies the exported units. Choose from: Microns,
Millimeters, Centimeters, Meters, Inches, and Feet. The default value is
Millimeters.
To launch the export operation, press the Save button. Otherwise, press the Cancel
button to end the operation.
Note that if several objects are selected to be exported, they will be merged into one
file.
Color information
A list box that controls the type of color information that will be mapped on the
Reference object. If set to Error Color, the colored error map is used. If set to Point
Color, the color of the Data points is mapped onto the Reference object.
Texture width
A text box that specifies the width of the exported image that will be mapped onto
the polygonal surface to describe the error map. A larger image will more
accurately describe the error map.
Figure 25.2 The dialog box used to export a Reference object and the current color map to a
texture-mapped polygonal model.
Texture height
A text box that specifies the height of the exported image that will be mapped
onto the polygonal surface to describe the error map. A larger image will more
accurately describe the error map.
Format
A list box that specifies an image file format. Choose from bmp, jpg, rgb, and tif.
Output
A text box that specifies the path and name of the exported file. The ... button to
the right of the text box displays the file browser shown near the bottom in Figure
25.2 to specify an output image file. The browser’s Save as type list box contains
a list of available output formats. Once the specifications are made, press the
browser’s Save button.
The model is exported by pressing the OK button. Press the Cancel button to end the
operation.
Figure 25.3 The browsers used to export color-mapped (a) point cloud Data objects and (b)
polygonal Data objects.
(a)
(b)
Point cloud Data objects are exported as ASCII point clouds with RGB colors using the
file browser shown in Figure 25.3 (a). It offers the following item:
Templates
A button that can be pressed to specify the number of digits after the decimal
point and the use of scientific notation.
Press the Save button to launch the operation or the Cancel button to end the
operation.
The File > Export > Data Points > IGES File command allows exporting selected points,
belonging to Data objects, to a point cloud file written in IGES format.
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Data Points > kubit PTC File command allows exporting all selected
points, belonging to Data objects, to a point cloud file written in kubit PTC format.
The File > Export > Data Points > Text File command allows exporting all selected points
from Data objects to a text file written in ASCII format.
2. The Template list box offers context-sensitive templates that can be used to export
to a text file: Points Only, Points + Intensities, and Points + RGB Colors. The
browser also offers an Templates button that displays a dialog box that allows
configuring the number-writing method.
See Section 5.3.2 Exporting to text files of the PolyWorks Reference Guide for more
information on writing to a text file.
4. Press the Save button to launch the operation, or the Cancel button to end the
operation.
x y z dx dy dz sign
where,
On choosing this command, the dialog box shown in Figure 25.4 is displayed, offering
the following items:
Figure 25.4 The dialog box used to configure the export of Data points and their error vectors to
a text file.
Export options
A group box that offers two export methods, with sign information as an option:
Add sign
A check box that enables adding the sign to the export format. A - or +
sign indicates if the error is negative or positive.
The remaining two dialog box items allow specifying the # of digits after the decimal
point, as well as enabling the use of scientific notation using the Scientific notation
check box.
On pressing the OK button a file browser is displayed. Specify a file name and location,
and press the Save button to launch the export operation.
Figure 25.5 The file browser used to export the global transformation matrix of a Reference or a
Data object. Three export formats are offered.
On launching either operation, a file browser is displayed. The one used to export
global transformation matrices is shown in Figure 25.5. Its Save as type list box offers
three export formats:
Euler Matrix Files – Specifies exporting the matrix to an external ASCII file in
Euler form (i.e., three rotations and three translations).
TRF Matrix Files – Specifies exporting the matrix to an external TRF file.
Press the Save button to launch the operation, or the Cancel button to end the
operation.
Figure 25.6 The browser used to export primitives to a CAiCE FXF file.
The File > Export > Primitives > CAiCE’s FXF File command allows exporting selected
points and polylines to a CAiCE FXF file. On choosing the command, the browser shown
in Figure 25.6 is displayed. Specify a file name and location. The browser also allows
other specifications:
The Point format list box offers two choices: Easting/Northing/Elevation (export
points as x, y, z coordinates) and Northing/Easting/Elevation (swaps the x
coordinate and the y coordinate for each point).
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Primitives > DXF File and File > Export > > Primitives > IGES File
commands allow exporting selected primitives and cross-sections to DXF and IGES
formats. See Section 25.13 Exporting primitives and cross-sections for detailed
information.
2. Choose the correct export operation for the primitive type on the File > Export
submenu. Figure 25.7 shows a typical dialog box used to export primitives to a text
file.
3. Specify in the Template list box of the browser that is displayed the correct template
to use to write the text file. The templates are context-sensitive, and specific to the
selected primitive type. The browser also includes a Templates button that displays
a dialog box that allows configuring the number-writing method.
Please refer to Section 5.3.2 Exporting to text files in the PolyWorks Reference Guide
for more information on writing to a text file.
4. Choose the encoding schemes (ASCII or Unicode) in the Encoding list box.
The File > Export > Points command on the submenu allows exporting selected points
to a text file. On choosing this command, a file browser is displayed. Two context-
sensitive templates are available in the Template list box:
Figure 25.7 A typical browser used to export primitives to a text file. It offers context-sensitive
templates used in writing text files and a choice of encoding schemes.
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Vectors command on the submenu allows exporting selected vectors
to a text file. On choosing this command, a file browser is displayed. Four context-
sensitive templates are available in the Template list box:
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Planes command allows exporting selected planes to a text file. On
choosing this command, a file browser is displayed. Two context-sensitive templates
are available in the Template list box:
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Circles command allows exporting selected circles to a text file. On
choosing this command, a file browser is displayed. Two context-sensitive templates
are available in the Template list box:
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Polylines command allows exporting selected polylines to a text file.
On choosing this command, a file browser is displayed. One context-sensitive template
is available in the Template list box:
Press the Save button to launch the export operation, or the Cancel button to end the
operation.
The File > Export > Primitives and Cross-Sections > DXF File command allows exporting
selected primitives (points and polylines only) and cross-sections to a DXF file. The
AutoCAD R12 format is used. Note that only the visible Reference cross-sections and/or
Data cross-sections of visible cross-sections are exported.
On choosing the command, the file browser shown in Figure 25.8 is displayed. Specify
the file name and location. The browser also offers an item that allows configuring the
export operation:
Export
A list box that offers two export options: Blocks (with Names) – each selected
object has its own block of elements with the object name used as the block name,
and Entities (no Names) – all selected geometric elements are directly exported
as entities, without grouping entities.
Press the Save button to launch the operation. Press the Cancel button to end the
operation.
Note that when Blocks (with Names) is specified, headers are added to the file to
separate and identify the child cross-sections.
Note that primitives can be selected based on their feature code by means of the
Select > Feature Primitives > From Feature Code command.
The File > Export > > Primitives and Cross-Sections > IGES File command allows exporting
selected primitives and cross-sections, as well as their names, to an IGES file. Note that
only the visible Reference cross-sections and/or Data cross-sections of visible cross-
sections are exported.
On choosing the command, the dialog box shown in Figure 25.9 is displayed, offering
the possibility of converting selected cross-sections and polylines to Bezier curves prior
to exporting them to IGES. It features two group boxes:
Figure 25.8 The browser used to export primitives and cross-sections to DXF format.
Tolerance
A text box that specifies a maximum deviation between the input entity
and the curve.
Tolerance
A text box that specifies a maximum deviation between the input entity
and the curve.
Figure 25.9 The dialog box used to configure the export of primitives and cross-sections to IGES
format.
Press the OK button to continue or the Cancel button to end the operation. When
continuing, a file browser is displayed. Proceed as follows:
The Units list box offers export units: cm (centimeter), feet, inch, meter, micron,
and mm (millimeter). The default value is the current unit of length defined for the
project.
Press the Save button to launch the export operation. The Cancel button ends the
operation.
Note that headers are added to the file to separate and identify the child cross-sections.
Each selectable object is exported using the entity type indicated in the table that
follows:
When exporting to ASCII format, a header is added to separate each closed contour of a
cross-section child. For example, if the Data cross-section D IMBlock.pol c-s child 9 is
composed of three closed contours, the three headers would be composed of the
name of the Data cross-section and an incremented integer, starting at 0 (e.g., D
IMBlock.pol c-s child 9 - 0).
The File > Export > Cross-Section Points > Points command allows exporting the points of
selected cross-sections to a text file. Cross-sections are written as sets of ordered points.
On choosing the command, a file browser is displayed. Specify a file name and location.
The browser offers context-sensitive templates in the Template list box. Note that its
Templates button displays a dialog box used to specify the number of digits after the
decimal point, and the use of scientific notation. In the Encoding list box, both the
ASCII and the Unicode encoding scheme are offered. Press the Save button to launch
the operation or the Cancel button to end the operation.
See Section 5.3.2 Exporting to text files in the PolyWorks Reference Guide for more
information on writing to a text file.
The File > Export > Cross-Section Points > Points and Errors command allows exporting
the results of a comparison between the Reference and Data cross-sections. On
choosing the command, the dialog box shown in Figure 25.10 is displayed. The Export
options group box offers two export options, with sign information as an option:
Add sign
A check box that enables adding the sign to the export format. A - or + sign
indicates if the error is, respectively, negative or positive. By default, the check box
is selected.
Scientific notation
A check box that enables using scientific notation.
The OK button displays a file browser and the Cancel button ends the operation. When
the file browser is called, specify the output file name and location and press the Save
button to launch the operation or the Cancel button to end the operation.
Report items may be exported to external documents formats, such as text file, AVI, MS
Excel, HTML, and MS Word. For complete information, see Section 20.9.5 Generating
reports in external document formats using selected Report Items.
Prior to exporting Report Items, the items to be exported may be selected in the Items
subbranch of the Reports branch of the tree view. If, however, no items are selected, all
Figure 25.10 The dialog box used to export points and errors of cross-sections to a text file.
Report Items that meet the criteria of the export operation will be exported. See Figure
25.11 for an example of an export of a report document to Word.
Several export operations are available on the File > Export > Report Items submenu.
The File > Export > Report Items command exports selected header, footer, tabular
report, and text field objects to an external text file. On choosing the command, a file
browser is displayed. Specify a file name and location. The browser’s Encoding list box
allows specifying the ASCII or the Unicode encoding scheme. The Show table borders
check box enables exporting borders for table report items. The report opens in the
default text file reader. Press the Save button to launch the operation or the Cancel
button to end the operation.
The File > Export > Report Items > HTML File command exports all objects, except video
report and pie chart objects, to an external HTML document. On choosing the
command, a file browser is displayed that allows specifying a file name and location.
The browser’s Encoding list box allows specifying the ASCII or the Unicode encoding
scheme. The document opens in your HTML browser. Note that a folder is created with
the name <file_name>_files – it contains exported image files in JPEG format and
exported 2D vector graphic files, if any. Press the Save button to launch the operation
or the Cancel button to end the operation.
The File > Export > Report Items > Excel File (One Item per Page) and File > Export > Report
Items > Excel File (One Page) commands can export header, footer, pie chart, snapshot,
and tabular report objects directly to a Microsoft Excel file. On choosing a command, a
file browser is displayed that allows specifying the file name and location. Excel 97, or a
later version, must be installed on the computer prior to invoking the operation.
Figure 25.11 An example of a report document exported to Microsoft Word. It consists of a header,
a tabular report item, and a footer.
The File > Export > Report Items > Excel (One Item per Page) and File > Export > Report
Items > Excel File (One Page) commands allow exporting header, footer, pie chart,
snapshot, and tabular report objects to Microsoft Excel. On choosing a command, Excel
is launched by IMSurvey, and objects are transferred to it. Save your report items with
Excel. Excel 97, or a later version, must be installed on the computer prior to invoking
the operation.
The File > Export > Report Items > Word (Landscape) and the File > Export > Report Items >
Word (Portrait) commands can export header, footer, snapshot, text field, and tabular
report objects to Microsoft Word. On choosing a command, Word is launched by
IMSurvey, and objects are transferred to it. Save your report items with Word. Word
2000, or a later version, must be installed on the computer prior to invoking the
operation.
To accommodate users that were used to exporting to Word 97 using this command,
two commands have been added to IMSurvey’s macro command language to support
backward compatibility: FILE EXPORT_REPORT WORD97_LANDSCAPE and FILE
EXPORT_REPORT WORD97_PORTRAIT. Note that customized tolerance colors are not
supported when exporting to this version of Word.
The File > Export > Snapshot Report Item command allows exporting a selected
snapshot report item to an external image file.
On choosing the command, an image browser is displayed. Specify a file name and
location, and specify an image format using the Save as type list box. Choose from:
Microsoft’s Bitmap Files (*.bmp), JPEG Files (*.jpg, *.jpeg), SGI Files (*.rgb), TIFF
Files (*.tif), or PNG Files (*.png). Press the Save button to launch the export
operation. Press the Cancel button to end the operation.
The File > Export > Video > AVI File command allows exporting a selected animated
report to a compressed AVI file. On choosing the command, a file browser is displayed.
Specify a file name and location. Press the Save button to launch the operation or the
Cancel button to end the operation.
The File > Export > Video > EXE File command exports a self-extractable executable file
that contains a selected animated report and the IMMedia viewer. On choosing the
command, a file browser is displayed. Specify a file name and location. Executing the
file displays the animated report in the special IMMedia viewer that allows the
visualization of annotations. Press the Save button to launch the operation or the
Cancel button to end the operation.
The File > Export > 2D Vector Graphic command allows exporting a selected 2D vector
graphic report item to standard formats in the current units of length. The formats are
Figure 25.12 In (a), the 3D scene, captured as a 2D vector graphic and exported to PDF format (b)
using the Default size scaling option.
(a)
(b)
offered by the browser’s Save as type list box, and the Options button displays a
dialog box offering export options; offered formats and their export options are
presented in the text that follows. Specify a file name and location and press the Save
button to launch the export operation, or press the Cancel button to close the browser.
An example of 3D scene contents captured as a 2D vector graphic and exported to PDF
format is shown in Figure 25.12.
When the Adobe PDF Files format is chosen in the Save as type list box, the following
export options, shown in Figure 25.13 (a), are offered:
Scaling
A group label that offers scaling options:
Figure 25.13 The options offered when saving a 2D vector graphic to specific formats: (a) Adobe
PDF, (b) Autodesk DXF, (c) HPGL, and (d) SVG.
(a) (b)
(c) (d)
Default size
An option button, selected by default, that specifies using the default
size for the export operation. The report item is fitted to a page that is
roughly 8.5 by 11 inches.
Press the OK button to continue or the Cancel button to dismiss the options dialog
box.
When the Autodesk DXF Files format is chosen in the Save as type list box, the
following export options, shown in Figure 25.13 (b), are offered:
Scaling
A group label that offers scaling options:
Specific size
An option button, selected by default, that allows specifying the export
size as a percentage of the object’s current dimensions. It makes available
the following items:
Height (%)
A text box that specifies the height as a percentage of the object’s
current height. The default value is 100%.
Width (%)
A text box that specifies the width as a percentage of the object’s
current width. The default value is 100%.
Press the OK button to continue or the Cancel button to dismiss the options dialog
box.
When the HPGL Files format is chosen in the Save as type list box, the following
export options, shown in Figure 25.13 (c), are offered:
Scaling
A group label that offers scaling options:
Fit to page
An option button, selected by default, that specifies fitting the report
item to the page defined by the following items:
Format
A list box that specifies a page format. Choose from: Letter, Legal,
and A4. The default value is Letter.
Orientation
A list box that specifies the orientation of the page. Choose from:
Landscape or Portrait. The default value is Portrait.
Press the OK button to continue or the Cancel button to dismiss the options dialog
box.
When the HTML Files format is chosen in the Save as type list box, the following
export option is offered:
Encoding
A list box that offers encoding schemes. Choose from ASCII or Unicode. The
default value is ASCII.
Press the OK button to continue or the Cancel button to dismiss the options dialog
box.
When the SVG Files format is chosen in the Save as type list box, the following export
options, shown in Figure 25.13 (d), are offered:
Scaling
A group label that offers scaling options:
Specific size
An option button, selected by default, that allows specifying a range for
the height and the width values. It makes available the following items:
Height
A text box that specifies the range for the height values. The
default value is 600, which results in a range of 0 to 600.
Width
A text box that specifies the range for the width values. The
default value is 600, which results in a range of 0 to 600.
Press the OK button to continue or the Cancel button to dismiss the options dialog
box.
The File > Export > Audio Comment command allows exporting the selected audio
comment of an animated report to a Wave file. On choosing the command, a file
browser is displayed. Specify a file name and location. Press the Save button to launch
the operation or the Cancel button to end the operation.
The File > Export > Formatted Report > HTML File command allows exporting a formatted
report to HTML format. On choosing this command, a browser is displayed to specify a
file name and location. The browser also offers the Image properties group box to
specify the image Height (pixels) and Width (pixels). Press the Save button to launch
the export operation, or the Cancel button to cancel the operation. The formatted
report is saved to HTML format.
The File > Export > Formatted Report > Image Files command allows exporting a
formatted report to an external image format. On choosing this command, a browser is
displayed that allows specifying a file name and location. The image format can be
specified in the Save as type list box. The browser also allows setting the JPEG quality
and offers the Image properties group box to specify the image Height (pixels) and
Width (pixels). Press the Save button to launch the export operation, or the Cancel
button to cancel the operation. Each page of the formatted report, including an
associated background, is saved as a separate image. The images all have the same
name to which a sequential number is added.
The File > Export > Formatted Report > PDF File command allows exporting a formatted
report to PDF format either using the Adobe Acrobat (and not Adobe Reader) on your
workstation, or using simple PDF creation. On choosing this command, a browser is
displayed. Specify a file name and location. If Abobe Acrobat is not detected on your
workstation, the browser also offers two parameters: Resolution (DPI) with a default
value of 300 and JPEG quality with a default value of 90. Press the Save button to
Figure 25.14 The dialog box used to convert a formatted report to PDF format when a workstation
has Adobe Acrobat.
launch the conversion to PDF or the Cancel button to end the operation. When
converting to PDF:
Once the conversion is complete, the PDF file opens in your Adobe Reader.
For complete information on using the PolyWorks SDK, see the PolyWorks SDK
Reference Guide. It can be accessed from the Help > Reference Guides submenu of the
PolyWorks/Workspace Manager.
Complete information is available in the Macro Script Reference Guide and the HTML
Command Guide. Both are offered on the Help menu of the Macro Script Editor tool.
26.3.1 Recording and editing macros using the Macro Script Editor window
Full macro scripting possibilities are offered through the Macro Script Editor pane,
shown in Figure 26.1. It allows recording, editing, and executing macros, and it comes
with a friendly command completion feature that is useful when editing macros, as well
as a complete HTML help feature that documents each command.
Macro scripts can also be enhanced with the Macro Script Command Language (MSCL),
PolyWorks’ simple but powerful programming language. The MSCL offers conditional
command execution (IF/ENDIF), repeatable operations (WHILE/ENDWHILE), the
possibility of calling other macros, global variables, and more.
Available
Deviation 1. The distance that points differ from each other or the
distance that points differ from the surface model.
2. The difference between 3D coordinates of two points,
generally between as-designed versus as-built.
Drawing Type Specifies the manner in which objects are rendered. Typical
drawing types include flat, point, smooth, wireframe, and
bounding box (Dynamic display mode only).
Free Form Surface Contours that cannot be defined with simple linear or
quadratic mathematical equations. Many natural shapes,
such as the human face, are examples. Synonym: Organic.
Organic Surface Surfaces that reflect natural, free-form shapes and textures.
Ant. prismatic, geometric.
Reference Object A design model, typically digital or the original CAD model
but may be a first or modified first article, used to compare
subsequent manufactured parts against and assess
deviation from standard.
Solid Model A solid model is a surface model (i.e., Reference object) that
is watertight. A solid model is empty or hollow on the inside.
See Surface Model.
Trimmed Primitives Only cones, cylinders, planes and spheres can be created as
trimmed primitives by extraction from Reference object
elements (i.e., triangles or CAD surfaces). This is because
they are the only primitives that can be extracted that do
not completely describe the primitive, but that allow its
extraction.
feature objects H
computing dependent Primitives 435
Features header object in reports 571
constructing 360 help
creating complete reference information 30
by constructing 360 contextual 31
by picking on NURBS 347 help, getting 30
dependent home coordinate system 279
creating 325 HPGL, saving vectorial snapshots to 829
editing 326 HTML, exporting report documents to 827
fit to elements 355
fitting options 357
fitting types 356 I
maximize (selected elements) fitting 355 IGES
minimize (selected elements) fitting 355 containing trimmed NURBS surfaces 107
pick, then fit 355 exporting cross-sections to 822
picking on NURBS 347 exporting data points to 813
primitive creation options 355 exporting primitives to 822
fitting importing Primitives from 339
error statistics 396 importing Reference objects from 107
max distance used for 355 saving the tessellated model 808
maximum angle 359 tesselation timeout 763
Polylines 430 tesselation tolerance 109, 711, 765
Primitives 359 IMMedia viewer 567
selecting the data points used for 159
importing
using a fixed radius 357
IGES files 107
fog 734 polygonal files 101, 102
footer object in reports 571 STEP files 107
front-facing triangles inspection methodology 37
rendering 732 interactive mode wizard 727
selecting 143
interface colors
2D vector view background - bottom 737
G 2D vector view background - top 737
Background - Bottom 737
gauges Background - Top 738
Tree View 36 Boundary Curve 738
geo-referencing 296 Bounding Box 738
getting help 30 Curve in Color Map Mode 739
graphical user interface Dark 738
3D Scene pane 70 Fillet Tangent Curve 739
Dialog Zone pane 72 Huge Data Grid 738
menu bar 58 Internal Curve 739
title bar 58 Magnetized Ctrl Pts 738
Tree View pane 62 Mark 738
grid, viewing in the 3D scene 732 Mark (Alternate) 738
groups of elements, creating and using 131 Pencil 738
growing and shrinking Primitives 418 Picked Coordinates 738
Selection 739
Sharp Edge Curve 739
Snapshot Background - Bottom 739 using to select data object boundary points
Snapshot Background - Top 739 160, 161, 164
Text Field 739
interface colors, default
Pencil 145
O
interface colors, specifying 736 object tree
inverting orientation 689 object states 67
shortcut menus 65
standard Windows-based selecting 63
J-L visual conventions 67
kubit PTC objects
exporting data points to 813 deleting 117
loading files. See importing duplicating 119
importing from IMInspect Projects 110
picking in the 3D scene 140
M properties sheet 124, 706, 716
removing the ignored attribute from 130
Macro Script Control Language 837
selecting 140
Macro Script Editor 72, 837 splitting 124
matrix triangulating 697
global alignment 275 offsets
inverting 276
creating for Data objects 700
last alignment 275
opening
operations, examples of 278
a polygonal model file 101, 102
transforming 276
opening a recent inspection project 79
max distance
opening an existing inspection project 77
for discarding points when fitting 355
orienting surfaces 689
maximum distance, for best-fit alignment 249
measuring
all data points 301, 306 P
angles 484
changing the display 493 panes
data points to Primitives 310 3D Scene 70
for surveying 489 Dialog Zone 72
point-to-line distances 481, 482 Tree View 62
point-to-point distances 481 pass/fail inspection 514
radii 485, 486 PDF, saving vectorial snapshots to 829
survey measurements 489 picking objects in the 3D scene 140
volumes 504 pie charts
menu bar, overview 58 creating 545
mirroring objects 121 exporting to Microsoft Excel 547
MSCL. See the Macro Script Control Language viewing 546
Planes
comparing data points to 314
N constructing 365
creating
NURBS
by anchoring 349
reorienting selected surfaces 689
by constructing 365
selecting connected sets of 146
by offsetting 390
tessellation timeout 763
data points close to a primitive object 164 STEP files, importing 107
data points close to a reference object 149 subsampling
data points used for fitting 159 Data objects 702
deselecting all objects 140 for display 741
deselecting all Primitives 164 undoing 703
front-facing triangles 143 surveying, measuring angles and distances 489
global selection operations 147 SVG, saving vectorial snapshots to 829
groups from selected elements 148 symmetry plane 423
hidden objects 140
inverting the selection status of objects 140
inverting the selection status of Primitives T
164
one element 143 tabular reports
polygonal contours 145 creating and editing templates 531
customizing contents 796
regions 145
surface-based 145 customizing for export 532
volume-based 145 defining sorting methods 797
filtering 797
Selection mode
producing tabular report objects 529
about 143
visualizing 530
selection mode
tessellation timeout 763
entering 42
tessellation tolerance 109, 711, 765
Slots
inverting 120 text annotations
attaching to 3D locations 666
slots
exporting to IGES 822 Text Field objects
creating and displaying 548
snapshots
customizing properties of 550
creating from an image file 539
default properties of 550
creating from the 3D scene 537
editing 549
generating 74
specifying fonts 550
preparing for export 544
visualizing 549
properties of 789
saving to an external image format 225, 540, texture-mapped reference 810
541, 631, 829 tolerance colors 536, 793
visualizing 539 tolerance templates 682, 803
Spheres tolerances
comparing data points to 315 color scale for visualization 513
constructing 387 default values for comparison 682
creating editing the color scale for visualizing 516
by anchoring 351 NURBS objects 514
by constructing 387 templates for 682, 803
numerically 354 transformation groups
editing 417 creating and editing 281
properties of 403 object tree branch 281
specifying a default radius for 357 translating
spheres along the x axis 228
exporting to IGES 822 along the y axis 228
starting IMInspect 25, 34 along the z axis 228
Static display mode 168 tree view
static display mode 168 Objects 62
U
undoing
deletions 119
operations 42
transformations 231
uniform subsampling, for dense point clouds 702
user interface 58
using 3D objects 130
V-Z
Vectors
comparing data points to 315
constructing 387
creating
by anchoring 351
by constructing 387
by offsetting 392
from IGES 339
from text files 341
numerically 354
editing 410
growing and shrinking 418
properties of 403
vectors
exporting to a text file 820
exporting to IGES 822
viewpoint
rotate 90 degrees 226
visualizing
comparison results 40, 511
error mapping 523
error vectors 521
tolerances 513
wizards
interactive mode 727
Word
exporting report objects to 828
Workspace Manager
drop-down menu 58
icon 58
zooming
the PolyZoom window 70
zooming in the 3D scene 230