Vicon Shogun fundamentals

The following topics provide information about some of the fundamental features that underpin the way Shogun works.

Device synchronization session

When you connect Shogun to a live system of cameras and/or Vicon connectivity devices, a new device synchronization session is created. To identify the current device synchronization session, look in the timebar at the bottom of the Workspace for the value in brackets [ ].

When you first open Shogun, the device synchronization session starts at 1 and the Frame and Seconds that are displayed are relative to the start of that session.

The device synchronization session enables the system to synchronize all devices. A new system session starts when:

• The hardware is rebooted.
• A device is added to the system.
• The frame rate changes.

Live review

When Shogun is live, the pause buffer is a feature that enables data to be stored in memory for live review (see Capture a take). The maximum amount of data that can be stored is controlled by the Pause Buffer Size, which you can configure in the Output section of the Processing panel. The Pause Buffer Size specifies the duration of the pause buffer, and thus the amount of data that is always accessible.

The data types stored in the pause buffer are identical to the data types that are saved when capturing data. This includes data such as centroids in each camera view, object pose, and system performance metrics such as latency. For more information on the data types that are stored in a capture, see Capture a take.

The pause buffer influences the behavior and workflow of multiple aspects of the software including:

• Object creation and manipulation
• Reviewing recent live data
• Graph Plots

Auto save

With Shogun started, its default behavior is to save all settings automatically according to the Auto-save interval setting.

All auto-saved files except preferences and subject view preset files are located in this folder:

C:\Users\Public\Documents\Vicon\Shogun1.#\LastRun\username

Preferences and subject view preset files are located in the following folder so that you can use them in later (or earlier) versions of Shogun:

C:\Users\Public\Documents\Vicon\Shogun1.x\username

As you work within Shogun, files populate into the above folder according to the temporary filenames listed in the following table. When you close Shogun properly, the temporary filenames are converted and saved as normal filenames.

If Shogun terminates abnormally (including closing the process in Task Manager), the temporary filename does not convert to its normal filename and is left present in the LastRun folder.

When you re-launch Shogun, if any of the auto-save files are detected, you are prompted to confirm which files you want to load:

• To load the most recent (auto-saved) settings, click Yes.
  or
• To load settings from the last successfully closed session, click No.

This feature prevents you from losing your settings if Shogun closes abnormally, for example, due to process termination, machine reboot, etc.

To control the auto-save settings:

• From the Settings menu, select Preferences (or press Shift+P) and in User Preferences, go to the General section.
  
  • To disable auto-save, clear Enable auto-save. The default is selected.
  • To change the auto-save interval, enter a value (in seconds) for the Auto-save interval. The default is 60 seconds.