Skip to content

User manual

Overview

ThorVision is a GUI app designed for seamless control and video capture from USB cameras on the XDAQ AIO. This user manual provides instructions on how to use the features of the application effectively.

graph LR;
    subgraph PC["PC"]
        subgraph CC[Camera Control Software]
            TV(ThorVision)
        end
        subgraph DA[Data Acquisition Software]
            RHX(XDAQ RHX)
            OE(Open Ephys GUI)
        end
    end

    XDAQ(XDAQ AIO)

    subgraph CAMS[Cameras]
        CAM1(Camera 1)
        CAM2(Camera 2)
        CAM3(Camera 3)
        CAM4(Camera 4)
    end

    subgraph XH[X-Headstage]
        x6R1(x6R)
        x6R2(x6R)
        x6R3(x6R)
        x6R4(x6R)
    end

    XDAQ -->|Thunderbolt| PC;
    CAM1 -->|USB| XDAQ;
    CAM2 -->|USB| XDAQ;
    CAM3 -->|USB| XDAQ;
    CAM4 -->|USB| XDAQ;

    x6R1 -->|HDMI| XDAQ;
    x6R2 -->|HDMI| XDAQ;
    x6R3 -->|HDMI| XDAQ;
    x6R4 -->|HDMI| XDAQ;

    click XDAQ "https://www.kontex.io/xdaq" "Go to XDAQ page" _blank
    click RHX "https://github.com/kontex-neuro/Intan-RHX" "Go to XDAQ RHX page" _blank
    click OE "https://open-ephys.org/gui" "Go to Open Ephys GUI page" _blank
    click TV "https://github.com/kontex-neuro/ThorVision" "Go to ThorVision page" _blank

Hardware Requirements

Installation

Panels

"No Camera UI Overview"

1. Camera Status

Display the list and number of currently connected cameras. Select a camera from the list to access its settings in the Camera Specification Panel.

2. Overall Recording Settings & Control

Saving Options: Choose between:

  • Continuous: Record a single, uninterrupted video file for the entire recording session.
  • Split Record: Record multiple video files, each divided into predefined segments (e.g., 5 seconds, 10 seconds).

Record Path: Click ... button to select the folder for saving recordings.

Folder Name: Choose between:

  • Automatically generated: folder name in YYYY-MM-DD_HH-MM-SS format.
  • Custom: Specify a custom folder name.

Note

The default record path:

Windows: C:/Users/<user_name>/Documents/ThorVision/

macOS: /Users/<user_name>/Documents/ThorVision/

3. XDAQ Status

  • Connecting...: is displayed when XDAQ AIO is not yet connected or currently connecting.
  • Connected: is displayed when XDAQ AIO is connected.

The status transition may take some time, please be patient.

4. Camera Specification Panel

Edit camera names, configure the Quality, and Codec in this area.

Camera Feed

"UI Overview"

1. Camera Views

View stream windows under different scales.

2. Live Preview Window

View live streams from cameras on the XDAQ AIO.

3. Information Icon

Click to display live metadata and configured recording settings from cameras on the XDAQ AIO.

Setup Guide

Pre-Launch Checklist

  1. Ensure a Thunderbolt 3.0 (or higher) cable connects the XDAQ AIO and the computer.
  2. Verify that the connectors are firmly seated.
  3. Confirm all cameras are firmly connected to the XDAQ AIO.
  4. Connect a Brainwave simulator to the XDAQ AIO using a 3.5mm jack to BNC wire.
  5. Connect the 3.5mm Jack to the "Pulse" port on the Brainwave simulator.
  6. Connect the BNC to the Digital In port on the front panel of the XDAQ AIO.

Launch Sequence

Follow this exact order:

  1. Power on XDAQ AIO.
  2. Launch Open Ephys GUI or XDAQ-RHX first.
  3. Wait until the chosen application finishes its initialization.
  4. Launch ThorVision.
  5. Allow 1–2 minutes for ThorVision to connect.
  6. If the connection fails, retry the entire launch sequence from the start.

Camera Setup

  1. Once ThorVision connects to the XDAQ AIO, check the camera status panel to confirm all connected cameras are listed. If not, check the cable connections.

    • INFO: Before assigning Quality and Codec, you can still hot-plug cameras to the XDAQ AIO. It may take a few seconds for the XDAQ AIO to recognize a newly connected camera.

    "Camera Setup 1"

  2. On the right panel in ThorVision, assign a unique name, Quality and Codec to the selected camera. Before recording, make sure every camera on the list has both a Quality and a Codec assigned.

Tip

  • If the preview stream doesn't appear within 10 seconds, re-select the same Quality / Codec settings to refresh the view.

  • If the camera-naming function behaves abnormally, restart the ThorVision interface and try again.

IMPORTANT

  • We strongly recommend keeping your Industrial Camera’s resolution at or below Full HD and the frame rate at or below 30 FPS. For Global Shutter Cameras, the frame rate should not exceed 420 FPS. Exceeding these limits may cause lag or dropped frames.

  • Do NOT assign the same name to different cameras. This can cause file overwrites during recording sessions.

  • Do NOT change Quality / Codec once the preview has started. This can cause the camera to freeze.

Camera Setup 2
  1. Select a camera you want to edit.
  2. Assign a unique name.
  3. Configure Quality & Codec.
  1. To view camera activities (e.g., DI triggers), press the Information Icon in each preview window. The DI word will show the channel number when the voltage in a certain Digital In BNC port is pulled to high.
    • INFO: If the timestamp stops renewing or stays at zero during preview or recording, the camera is offline. Repeat the Launch Sequence.
    Camera Setup 3
  2. Check the recording settings (e.g., file interval, saving location, file name), and then press REC.

IMPORTANT

When restarting a recording session, WAIT 5 SECONDS after stopping before pressing the record button again. Do not consecutively press the button more than one time!

Recording Tips

Configure the camera’s recording settings to view the real time camera feed. The same settings will also be applied to video recording.

"Camera Setup 4"

Press the REC button to start recording on all connected cameras simultaneously. The Stop Recording button works the same way. In the pop-up window, you can review the recording specifications. Use unique camera names only.

"Camera Setup 5"

If XDAQ is disconnected, ThorVision will automatically stop recording.

"Camera Setup 6"

You must stop recording before closing the ThorVision app.

"Camera Setup 7"

Golden Rules (TL; DR)

  • Launch Order is Critical: XDAQ AIO >>> OE GUI / RHX >>> ThorVision.
  • Set the Quality / Codec once and never change it during the session.
  • Use unique camera names only.
  • Do not hot-plug cameras while recording.
  • Wait at least 5 seconds after stopping a recording before starting a new one.