Operation Guide

This section introduces common operations in the Viewer software.

Download and Install USB Driver

If you use a USB camera, complete Set Up USB Camera Environment before proceeding with the operations below.

Set Camera IP

Percipio Viewer supports setting a network camera’s IP address to a static IP address or a dynamic IP address (DHCP). Percipio Viewer can open the camera only when the camera IP address and the host PC IP address are on the same subnet.

You can choose either of the following methods to set the camera’s IP address:

  • If the camera is not shown in the Camera List, use Tools > IP Configuration and enter the MAC address printed on the camera label as the physical address.

  • If the camera is shown in the Camera List, but its icon is red and marked “InvalidNetCam”, or its IP address is not on the same subnet as the host PC, select the camera in the camera list and use Modify IP.

Prerequisites

  • Before setting a static IP address, ensure that the host PC’s IP address is on the target subnet.

  • If the camera is currently connected to the software, disconnect it before setting the IP.

Procedure

Method 1: From the menu bar (camera not shown in the camera list)

  1. On the menu bar, select Tools > IP Configuration to open the IP Configuration dialog.

  2. Enter the MAC address printed on the camera label in Mac Address.

  3. Select the camera IP configuration method:

    • Static IP: Enter the “IP Address”, “Mask” (Subnet Mask), and “Gateway”.

    • DHCP: Select “DHCP”. The DHCP server on the network automatically assigns an IP address.

  4. Click Confirm to complete the IP configuration.

Method 2: From the camera list (camera shown but cannot be connected)

  1. On the Camera List page, click refresh-icon to refresh the camera list.

  2. Click the serial number of the target camera to select it.

  3. Click Modify IP to open the Modify IP dialog.

    Modify IP

    Modify IP

  4. Set the camera IP.

    Set as Static IP

    1. Select “Static IP”.

    2. Set “Camera IP”, “Mask” (Subnet Mask), and “Gateway” according to the interface prompts.

    Set as Dynamic IP

    1. Select “DHCP”.

  5. Click Confirm.

    The following Prompt dialog appears, indicating the IP setting was successful.

    IP Set Successfully

    IP Set Successfully

Connect/Disconnect Camera

In the camera list, double-click the camera list row or click connect-icon to connect to the camera.

If there is no connect-icon icon next to the camera serial number, it means the camera cannot be connected currently.

Connect Camera

Connect Camera

Can’t Find Camera?

When the target camera does not appear in the camera list, or the camera cannot be connected, click the Can't find camera? button at the bottom of the camera list to launch the troubleshooting wizard. The wizard guides users through connection issue diagnosis in a question-and-answer format. Users simply select the corresponding options as prompted and click Next to proceed.

After connecting, the interface automatically switches to the Camera Page. Click disconnect-icon at the top of the page to disconnect.

Disconnect

Disconnect from Camera Page

You can also switch back to the Camera List page and click disconnect-icon next to the camera serial number to disconnect.

Disconnect

Disconnect from Camera List Page

Set Capture Mode and Start Capture

The software supports the following capture modes:

  • Max FPS in Streaming Mode.

  • Fixed FPS in Streaming Mode.

  • Hardware Trigger.

  • Software Trigger.

The detailed operation steps are illustrated below.

In this mode, the software continuously outputs enabled data streams at the maximum frame rate allowed by the system.

  1. In the Data Stream field of the Operation Mode page, enable the corresponding data streams, such as “Depth Image” and “Color Image”.

    Enable Data Stream

    Enable Data Stream

  2. Select Capture Mode as “Max FPS in Streaming Mode”.

    Set Capture Mode to "Max FPS in Streaming Mode"

    Set Capture Mode to “Max FPS in Streaming Mode”

  3. Click start-capture in the image capture area to start capturing. Then click color-display and depth-display to turn the color and depth views on/off.

    Start Capturing Images

    Start Capturing Images

  4. Below the color and depth views, you can view the current output frame rate.

    View Output Frame Rate

    View Output Frame Rate

View Data

Switch View

Click the view display buttons in the image capture area to view the corresponding view. Up to two views are displayed simultaneously.

Enable the color data stream, click start-capture, then click color-display above the image capture area to view the color image. Click color-display again to close the color image view.

Color Image

Color Image

Image Registration

When both depth and color data streams are enabled, click align-display above the image capture area to open the image registration settings panel. The panel contains the following two parameters:

  • Direction: Select the registration method between the depth map and the color image.

    • Depth → Color: Align the depth map to the color image coordinate system. The color image retains its original resolution.

    • Color → Depth: Align the color image to the depth map coordinate system. The depth map retains its original resolution.

  • Depth Opacity: Adjust the opacity of the depth map in the overlay display (0%–100%). A higher value makes the depth map more visible; a lower value makes the color image more visible.

Image Registration Settings

Image Registration Settings

View Depth Value

When the depth view is displayed, follow the steps below:

  1. In the Basic Parameters page of the camera parameter configuration area, set the “Analysis Type” of the depth component to “Single Pixel”.

  2. Place the mouse cursor on the depth image to view the pixel coordinates and actual depth value (unit: mm) corresponding to the pixel under the cursor.

View Depth Value

View Depth Value

View Region Flatness / Depth Mean / Fitted Plane Distance

When the depth view is displayed, follow the steps below:

  1. In the Basic Parameters page of the camera parameter configuration area, set the “Analysis Type” of the depth component to “Rectangle Region”.

  2. Drag with the left mouse button on the depth image to select a region of interest (ROI).

  3. The relevant parameters of the ROI are displayed in real time below the depth view, mainly including:

    • Flatness: A smaller value indicates a flatter region.

    • Mean (mm): The average of all depth values in the ROI.

    • Fitted Plane Distance (mm): The depth distance from the camera optical center to the fitted plane of the ROI.

View Rectangular Region Depth Value

View Rectangular Region Depth Value

Adjust Point Cloud Rendering Effect

Switch Point Cloud Color Scheme

When the point cloud view is displayed, the rendering settings area on the right side of the image capture area opens automatically. Under the “Point Cloud Color Scheme” option, select the display color of the point cloud:

  • None: Does not display point cloud colors.

  • Pseudo depth: Displays a pseudo-color point cloud based on depth values.

    Note

    After selecting this option, you can also adjust the “Depth Image Color Scheme” and “Depth Mapping Range” accordingly. Refer to Switch Depth Image Color Scheme and Depth Image Mapping Range for adjustments.

  • Texture: Uses the color image to color the point cloud, displaying a color point cloud.

Switch Point Cloud Color Scheme

Switch Point Cloud Color Scheme

Adjust Depth Map Rendering Effect

Switch Depth Image Color Scheme

When the depth image display is on, the rendering settings area on the right side of the image capture area opens automatically. Switch between different color schemes under the “Depth Image Color Scheme” option.

Switch Depth Image Color Scheme

Switch Depth Image Color Scheme

The software currently supports the following rendering color schemes: Rainbow, Autumn, Turbo. The rendering effect differs when different schemes are selected.

Rainbow

Rainbow

Depth Image Mapping Range

The depth map supports dynamic rendering range adjustment. When the depth image display is on, the rendering settings area on the right side of the image capture area opens automatically. Set the range in the “Depth Mapping Range” area.

Adjust Depth Mapping Range

Adjust Depth Mapping Range

Note

Optimizing the color mapping for the target depth interval improves the visibility of depth details:

  • When the depth value is between Min (minimum) and Max (maximum), the color gradient is evenly distributed.

  • Pixels with depth values lower than the minimum are displayed in red.

  • Pixels with depth values higher than the maximum are displayed in purple.

Specific adjustment methods are below:

  • Auto Range

    • Checked: The system automatically determines the maximum and minimum values used for rendering based on the statistical results of the depth map.

    • Unchecked: You can adjust the rendering depth range with the sliders, or set the maximum and minimum values in the input fields.

  • Hide Out-of-Range Points

    • Checked: Points with depth values outside the current minimum and maximum range are hidden.

    • Unchecked: Points outside the range are still displayed and rendered in the corresponding boundary colors.

Adjustment Example:

When the target object is concentrated in the 600-1100 mm range:

  • Using the default rendering range (0-5000 mm): The color gradient is gentle, making details difficult to distinguish.

  • Narrowing the range to 600-1100 mm: The color contrast is stronger, and the depth differences of the object are clearly discernible.

Before Adjusting Rendering Range

Before Adjusting Rendering Range

After Adjusting Rendering Range

After Adjusting Rendering Range

Adjust Point Cloud View

When the point cloud view is displayed, you can perform the following operations:

  • Zoom: Place the mouse on the point cloud view and scroll the mouse wheel.

  • Rotate: Hold down the left mouse button and drag.

  • Pan: Hold down the right mouse button and drag.

  • Reset: Press the “R” key on the keyboard or click the refresh-icon icon in the lower right corner of the point cloud view to restore the point cloud to its initial position.

    Reset Point Cloud

    Reset Point Cloud

Save Data

Percipio Viewer supports saving image data to the local drive according to the configured save count and capacity limits. Color images, depth images, left images, right images, and point cloud data can be saved simultaneously.

Procedure

  1. Enable the data streams corresponding to the data you want to save.

  2. Click image-save-set to open the Image Save Settings dialog.

  3. In the “Save Path” field, enter a folder path or click open-folder to select a directory for storing data. Then, click Confirm. If the specified path does not exist, the system will automatically create the folder.

    Image Save Settings Dialog

    Image Save Settings Dialog

    If no prompt appears, the path setting was successful. Images will be saved to the target path with the naming convention “Type_Date-Timestamp”.

  4. Set the “Continuous Save Count”, i.e., the number of frames to save.

  5. Set the “Capacity Limit” for the selected folder. Setting it to 0 means there is no limit.

    Note

    The software’s continuous image saving function is subject to two limits: continuous save count and storage capacity limit. Saving will stop immediately when either condition reaches its set value first.

  6. Check the desired storage object(s), supporting single or multiple selections.

    The correspondence between Storage Object Options and Saved Data is below:

    Checked Storage Object

    Saved Data

    Save Color Image

    • Color image (PNG)

    • Color component intrinsic/extrinsic parameters and distortion matrix (TXT)

    Save Depth Image

    • Raw depth image (PNG)

    • Rendered depth image (PNG)

    • Depth component intrinsic/extrinsic parameters and distortion matrix (TXT)

    Save Left/Right Image

    • Left image (PNG)

    • Right image (PNG)

    • Left component intrinsic/extrinsic parameters and distortion matrix (TXT)

    • Right component intrinsic/extrinsic parameters and distortion matrix (TXT)

    Save Point Cloud

    • Point cloud (PLY or PCD, supports color point clouds and setting point cloud units)

    • Depth component intrinsic/extrinsic parameters and distortion matrix (TXT)

    Depth Aligned to Color

    Aligned depth image (depth2texture_depth_xxx.png), aligned color image (depth2texture_texture_xxx.png)

    Color Aligned to Depth

    Aligned color image (texture2depth_texture_xxx.png), aligned depth image (texture2depth_depth_xxx.png)

    Point Cloud Format Explanation

    This software supports saving point clouds in PLY format or PCD format. You can choose the format based on your downstream point cloud processing needs.

    • PLY: Binary format, storing spatial coordinates x, y, z, color r, g, b, etc., for each point in the point cloud.

    • PCD: Binary format, designed for efficient use with the Point Cloud Library (PCL).

  7. Click Confirm.

  8. Click start-capture to start image capture (you can also configure image save settings after the camera has started capturing). Then click save-image. The button will highlight, indicating saving is in progress. If the highlighting disappears, it indicates saving has ended.

Manage Parameter Set

Parameter Sets (User Configurations) let you save customized parameter settings to the camera or to local storage for different scenarios. When scenarios change, loading the corresponding parameter set lets you complete parameter adjustment quickly.

View Current Parameter Set

On the Camera Page, the Current Parameter Set field displays the active parameter set information: “Name” shows the currently active parameter set, and “Description” provides details for that parameter set.

As shown below, the current parameter set name is “0.Standard Accuracy”, and the description is “High Accuracy Mode”.

Current Parameter Set

Current Parameter Set

Save Parameter Set to Camera

Before saving a parameter set, ensure the camera is in a stopped capture state.

Procedure:

  1. Configure camera parameters for a specific scenario.

  2. Enter the Camera Page, click the Save to Camera button in the Current Parameter Set field.

    Save Parameter Set

    Save Parameter Set

  3. In the popped-up Save Parameter Set dialog, select a parameter set and enter information in the “Details” field if needed. The final saved user set name will be a combination of “Order Number + Details”, such as “8.test”.

    Note

    If the “Details” field is left blank, the software will automatically use the default name “Default description” as the details for that user set.

    Save Parameter Set

    Save Parameter Set

  4. Click Confirm.

Save Parameter Set to Local

Before saving a parameter set, ensure the camera is in a stopped capture state.

Procedure:

  1. Adjust camera parameters for a specific scenario.

  2. Enter the Camera Page and click the Export to File button in the Current Parameter Set field.

    Save Parameter Set

    Export to File

  3. In the popped-up Save Parameter Set dialog box, click open-folder to select the target folder and set the file name.

    Save Parameter Set

    Save Parameter Set Dialog Box

  4. Click Confirm.

Load Parameter Set from Camera

Before loading a parameter set, ensure the camera is in a stopped capture state.

Procedure:

  1. Enter the Camera Page, click the Load from Camera button in the Current Parameter Set field.

    Load from Camera

    Load from Camera

  2. In the popped-up Load Parameter Set dialog, select the target parameter set.

    Load Parameter Set

    Load Parameter Set

  3. Click Confirm.

After setup is complete, the current parameter set display is updated, and the camera parameter values are synchronized.

Current Parameter Set Updated Display

Current Parameter Set Updated

Load Parameter Set from Local

Before loading a parameter set, ensure the camera is in a stopped capture state.

Procedure:

  1. Enter the Camera Page and click the Import from File button in the Current Parameter Set field.

    Save Parameter Set

    Import from File

  2. In the popped-up Load Parameter Set dialog box, click open-folder to select the target json file.

    Load Parameter Set

    Load Parameter Set

  3. Click Confirm.

After setup is complete, camera parameter values are synchronized and updated.

Set Startup Parameter Set

Percipio Viewer supports setting the parameter set to be automatically loaded when the camera powers on.

Before setting the startup parameter set, ensure the camera is in a stopped capture state.

  1. Enter the Camera Page. You can view the current startup parameter set in the Startup Parameter Set field.

    Current Startup Parameter Set

    Current Startup Parameter Set

  2. Click the Change button.

    Change Startup Parameter Set

    Change Startup Parameter Set

  3. In the popped-up Change Startup Parameter Set dialog, select the parameter set you want to set for boot loading, then click Confirm.

    Change Startup Configuration

    Change Startup Configuration

    The startup parameter set display is now updated.

    Startup Parameter Set Updated

    Startup Parameter Set Updated

  4. After the camera is powered off and restarted, open it with Viewer. “Current Parameter Set” updates to the configured startup parameter set, and the camera parameters synchronize with the new values.

    Current Parameter Set Updated Display

    Current Parameter Set Updated