PhoXiⓇ Control 1.2 User Manual 05/2021 User Manual for PhoXi Control version 1.2 Document version: 05/2021 All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior written permission of the publisher. Copyright © 2014-2021 by Photoneo s.r.o., Bratislava, Slovakia Photoneo®, PhoXi® Control, PhoXi® 3D Scanner, PhoXi® 3D Scanner Lite, MotionCam-3D, MotionCam 3D are registered trademarks of Photoneo s.r.o. Microsoft, Windows, Windows 7/8/8.1/10, Visual Studio C++ are either the trademarks or registered trademarks of Microsoft Corporation. Linux is a trademark of Linus Torvalds. NVIDIA and CUDA are either trademarks or registered trademarks of NVIDIA Corporation. OpenGL is a trademark of Silicon Graphics, Inc. All other nationally and internationally recognized trademarks and tradenames are hereby recognized. [email protected] PhoXi Control 1.2 - User Manual 1/82 05/2021 About This User Manual This manual is intended for users who want to familiarize themselves with the PhoXi Control software for PhoXi 3D Scanners. PhoXi Control provides both a graphical user interface (GUI) and an application programming interface (API). PhoXi 3D Scanner is a compact yet powerful 3D scanner with unbeatable performance in terms of precision, noise and overall efficiency. It can be used for scanning a wide variety of objects, making it a universal tool for all kinds of industrial applications, mainly automated object manipulation and inspection. The content in this manual is based on PhoXi Control version 1.2. and firmware version > 1.2. of the PhoXi 3D Scanner. Visit our website at www.photoneo.com for the most up-to-date information and documents. Please read this PhoXi Control User Manual before using PhoXi Control. Please read the PhoXi 3D Scanner User Manual first to become familiar with the safety and assembly instructions before using the device. Contact us: Technical support Headquarters: Contact us at [email protected]. Photoneo s.r.o. See the Troubleshooting section at the end of this manual. Plynarenska 1 82109 Bratislava Visit Photoneo support pages at www.photoneo.com/support. Slovakia Orders and inquiries: [email protected] [email protected] PhoXi Control 1.2 - User Manual 2/82 05/2021 Table of Contents Introduction 7 Common Terms 7 Getting Started 8 Computer Requirements 8 Installation 9 Windows 9 Linux 9 Multiple Versions of PhoXi Control 10 Windows 10 Linux 10 Running the Application 11 Disabling GUI or 3D Viewer 11 Command Line Parameters 11 Graphical User Interface 13 Overview 13 Menu 13 Main Menu Items 13 Network Discovery 13 Add Device Via IP 13 Open File Camera 14 Lock GUI 14 Turn Off PhoXi Control 14 Other Menu Items 14 3D Cameras 14 Languages 14 Tools / Options 14 Tools / Marker Patterns 15 Help / Send Logs 15 Help / Send Admin Request 15 Help / About 15 Network Discovery 16 Connecting to the Scanner 17 Device States Overview 17 Relationship Between GUI and API 18 File Cameras 18 Configuring the Scanner Network Settings 18 Network Media 19 Network Topology 19 Network Configuration 20 Checking Computer Network Configuration 21 Network Environment Variable 23 Device Window 23 Main Controls 24 Acquisition Modes - Triggering Scan 24 Scanner Logout 25 [email protected] PhoXi Control 1.2 - User Manual 3/82 05/2021 Saving 3D Scans 25 Understanding the Output Format - Topology of the 3D Scan 26 List of Supported Formats 26 Saving Single Scan Manually 26 Saving Scans Automatically - Recording 26 Saving Options 27 Specifics of File Formats 27 Diagnostic scans 27 Tools 28 Test Speed 28 Firmware Update 28 View 28 Select Frame 29 Settings Pane 29 Scanning Profiles 29 Using a Custom Profile 30 Scanning Parameters 30 Controls 30 Output Structure 31 Viewer Pane 32 3D Viewer 33 Changing the Visualization 33 Frame Information 33 3D Viewer Controls 34 Image Tabs 35 Confidence Map 35 Depth Map 35 Texture 35 Image Tabs Visualisation Controls 36 Image Information 36 Intensity 36 Controls 37 API 37 Introduction 38 Prerequisites 38 API Examples 38 Running the Examples 40 Windows OS 40 Linux OS 41 API and Multiple Versions of PhoXi Control 41 API Modification between Beta Versions and Official Release 41 Compatibility 43 Logs 43 Scanning Guide 44 How to Scan 44 Operation Temperature 44 Factors Affecting the Quality of Scan 44 Assessing the Quality of the Scan 45 Scanning Parameters 46 Capturing Settings 46 Basic 46 [email protected] PhoXi Control 1.2 - User Manual 4/82 05/2021 Advanced 47 Processing Settings 49 Data Cutting 49 Point Cloud Generation 50 Experimental Settings 51 Coordinates Settings 52 Troubleshooting 54 Collecting Log Files 54 Downloading Logs From The Device 54 Device Log Level 55 PhoXi Control Log Files 55 PhoXi Control Log Level 55 PhoXi Control Core Dumps 56 API Log Files 56 API Crash Dumps 56 Troubleshooting Network Connection 57 Cannot connect to the Scanner or scanning time is too long 57 The PhoXi 3D Scanner is not visible in the PhoXi Control on a network with a dynamic IP assignment 58 Bonjour Service cannot be started on Windows 59 Ubuntu does not show IPv4 address - creating Link-Local connection 59 Backward Compatibility 61 PhoXi Control and Device Firmware 61 PhoXi API and PhoXi Control Compatibility 61 Scanning Settings and PRAW Files Compatibility 61 Beta Releases of PhoXi Control 1.2.1 - 1.2.13 61 Changelog 62 Appendix 1 - Marker Space 63 Introduction 63 Marker Space 65 Marker Pattern 65 Marker Space Set Up 67 Calibration 67 Usage 68 Marker Space Advantages and Use 70 Troubleshooting and FAQ 72 Further Details 73 Appendix 2 - External Camera Calibration 75 Introduction 75 Running the Example with Sample Data 75 Calibration 76 Aligned Depth Map Computation 77 Colored Point Cloud Computation 77 Integration of External Camera 77 External Camera 77 Marker Pattern 78 External Camera Implementation 78 Calibration 79 Using Already Saved Data 79 [email protected] PhoXi Control 1.2 - User Manual 5/82 05/2021 Aligned Depth Map Computation 79 Using Already Saved Data 79 Colored Point Cloud Computation 79 Using Already Saved Data 80 [email protected] PhoXi Control 1.2 - User Manual 6/82 05/2021 Introduction The PhoXi Control application enables users to control PhoXi 3D Scanners manually via a GUI or by a computer program using the provided API. The GUI is primarily used to set up the scanning environment, to configure the Scanner parameters and to test the output. In addition, the GUI can also be used as a powerful debugging tool for development with the API because calls to the API trigger the same response in the GUI as the user inputs. After triggering the scan by calling the API method, the application will execute the scan, send it as an output of the call and display it simultaneously on the GUI. The API has been designed to serve as a central platform for the development of custom applications for PhoXi 3D Scanners. To facilitate the development process as well as to reduce computing demands, all computations are performed on the device itself. This user manual will first guide you through the use of the PhoXi Control GUI and the API, and then provide a quick scanning guide with references to further resources. Common Terms Clarification of several terms used in this document. scanner, device General term for the PhoXi 3D Scanner Image sensor The PhoXi 3D Scanners are composed of three main units: projection unit, 2D camera unit, and computation unit. ‘Image sensor’ refers to the CMOS sensor inside the 2D camera unit. 2D camera Refers to the 2D camera unit inside the PhoXi 3D Scanners. [email protected] PhoXi Control 1.2 - User Manual 7/82 05/2021 Getting Started Computer Requirements Please ensure that your computer meets the minimum recommended requirements in order to run PhoXi Control smoothly. Processor: Intel i5 or higher, x64 architecture (Processor performance affects the responsiveness of the application.) Operating system: Only 64 bit platform Windows 7, 10 Ubuntu 14 (will be deprecated, only bug fixes) Ubuntu 16 Ubuntu 18 RAM: Recommended > 8 GB (minimum 2 GB for the application connected to 1 device) HD: Minimum 4 GB free disk space GPU: External graphics card with OpenGL v 2.0 support. PhoXi 3D scanner has a very high-resolution mode producing over 3 million 3D points, therefore the requirements made on the graphical performance of your graphics cards are higher. Old or slow graphics card can reduce the performance of the 3D viewer. To use the API, the following compilers are supported: ■ Windows OS: ⌑ Visual Studio 12 2013 Win64 ⌑ Visual Studio 14 2015 Win64 ■ Ubuntu 14: ⌑ g++ 4.9.4 ■ Ubuntu 16: ⌑ g++ 5.4.0 ■ Ubuntu 18: ⌑ g++ 7.4.0 [email protected] PhoXi Control 1.2 - User Manual 8/82 05/2021 Installation Download the latest version of PhoXi Control: www.photoneo.com/3d-scanning-software/ The installer will prompt you to uninstall any existing version of PhoXi Control. Only one version of PhoXi Control at a time is supported. Windows To install PhoXi Control on Windows, proceed as follows: 1. Double-click the downloaded .exe installation file. 2. Follow the setup wizard and restart the computer if this is your first installation of PhoXi Control. 3. Run PhoXi Control as a standard Windows application. The application automatically starts after the computer startup. Default installation paths: ■ Shortcut folder: C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Photoneo's PhoXi Control ■ Installation folder: C:\Program Files\PhotoneoPhoXiControl ■ Application data folder: %AppData%/roaming/PhotoneoPhoXiControl/ Linux To install PhoXi Control on Ubuntu, proceed as follows: 1.