Operation Guide

This section mainly introduces common operations of the Viewer software.

Set Camera IP

Percipio Viewer supports modifying the IP address of network cameras to static or dynamic IP addresses. To ensure Percipio Viewer can successfully open the camera, it is recommended to check the camera’s IP address first to ensure it is on the same subnet as the host PC’s IP address.

Prerequisites

  • Before setting a static IP address, ensure 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

  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

Note

After the IP is set successfully, the camera list needs to be manually refreshed for the camera to appear in the list.

Connect/Disconnect Camera

In the camera list, you can connect to a camera by either:

  • Double-clicking its camera list row.

  • Clicking the Connect icon connect-icon.

Connect Camera

Connect Camera

Note

If there is no connect-icon icon next to the camera serial number, it means the camera cannot be connected currently. Click the serial number and check the status in the camera details to troubleshoot the connection issue.

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 will continuously output 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 can be 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

View Depth Value

When the depth view is displayed, you can view the depth value of a single pixel.

Procedure: 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

Adjust Depth Map Rendering Effect

Switch Rendering Color Scheme

When the depth image display is on, you can click call-depth-render on the right side of the image capture area to bring up the depth map rendering area and switch between different color schemes under the “Color Scheme” option.

Switch Rendering Color Scheme

Switch Rendering 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

Adjust Rendering Range

The depth map supports dynamic rendering range adjustment. When the depth image display is on, you can click call-depth-render on the right side of the image capture area to bring up the depth map rendering area.

When the depth value is between the Min (minimum) and Max (maximum), the color gradient is evenly distributed; pixels with depth values less than the minimum are displayed in red, and pixels with depth values greater than the maximum are displayed in purple. By optimizing the color mapping for the target depth interval, the discernibility of depth details can be enhanced.

Specific adjustment methods are as follows:

  • When “Auto Range” is checked, the system automatically determines the maximum and minimum values used for rendering based on the statistical results of the depth map.

  • When “Auto Range” is not checked, you can adjust Min and Max of the rendering depth using the sliders or set them via the input fields.

Adjust Depth Rendering Range

Adjust Depth Rendering Range

Adjustment Example:

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

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

  • Narrowing the range to 1100-1450 mm: As shown in the right image below, color contrast is vivid, and depth differences of the object can be clearly distinguished.

    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 set 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.

    After Adjusting Rendering Range

    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 as follows:

    Checked Storage Object

    Saved Data

    Save Color Image

    Color image (PNG), intrinsic/extrinsic parameters and distortion matrix of the color component (TXT)

    Save Depth Image

    Raw depth image (PNG), rendered depth image (PNG), intrinsic/extrinsic parameters and distortion matrix of the depth component (TXT)

    Save Left/Right Image

    Left image (PNG), Right image (PNG), intrinsic/extrinsic parameters and distortion coefficient matrix of the left component (TXT), intrinsic/extrinsic parameters and distortion matrix of the right component (TXT)

    Save Point Cloud

    Point cloud (PLY or PCD), intrinsic/extrinsic parameters and distortion coefficient matrix of the depth component (TXT)

    Note

    Point Cloud Format Explanation:

    This software supports saving point clouds in PLY format or PCD format. Users can choose based on the format required for subsequent point cloud processing.

    • 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) allow saving customized parameter settings to the camera or to local for different application scenarios. When switching between scenarios, loading the corresponding parameter set enables quick parameter adjustment.

Parameter management functions vary by camera model series. For GM and PMD series cameras, refer to Manage Parameter Set for GM and PMD Series Cameras. For other camera model series, refer to Manage Parameter Set for Other Camera Model Series

View Current Parameter Set

On the Camera Page, the Current Parameter Set field displays the active parameter set information: “Name” Shows the name of the currently active parameter set; “Description” provides explanatory details about the 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 User Configuration dialog, select a user set (user configuration) and enter information in the “Details” field if needed. The final saved user set name will be a combination of “User Set 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 area.

    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 OK.

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 User Configuration dialog, select the target parameter set (user configuration).

    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 area.

    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 OK.

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 in the Startup Parameter Set field.

    Change Startup Parameter Set

    Change Startup Parameter Set

  3. In the popped-up Change Startup Configuration dialog, select the parameter set (user configuration) you want to set for boot loading, then click Confirm.

    Change Startup Configuration

    Change Startup Configuration

  4. The startup parameter set display is now updated.

    Startup Parameter Set Updated

    Startup Parameter Set Updated

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

    Current Parameter Set Updated Display

    Current Parameter Set Updated