This information is for Vicon Shogun 1.2. For up-to-date help, see the latest Shogun documentation.

Shogun PDFs

After you have loaded your captured data files into Vicon Shogun Post, you can use its diagnostic tools to help you to identify any issues with the data. For more information, see:

See also the Vicon videos:  2 - Shogun Post - MCP Loading and 4 - Shogun Post - Checking Data Quality‌.


Load mocap data files into Shogun Post

  1. To load mocap data files (.mcp that contains everything captured in Shogun Live, or .vdf saved in Shogun Post) you can:

    • Open Windows Explorer, locate the files you saved and drag and drop them into the Shogun Post view pane; or
    • On the the File menu, click Open and locate your files; or
    • In the Data Management panel, locate the required file icon (an .mcp has an orange icon) and double-click it. 
    Although the recommended workflow is to load an .mcp file (processed real-time data), you can instead import an .x2d (raw 2D data), but in this case, you must run reconstruct, label, and occlusion-fixing operations before proceeding with any required cleanup.

    If you chose an .mcp file and if dropped frames are detected, a dialog box informs you of the percentage of dropped frames in the file and asks whether you want to fix them.

    Note

    Shogun Live can record processed real-time data (.mcp files) along with raw 2D camera data (.x2d files). You can use .mcp files as a starting point for processing in Shogun Post. Because the frame rate during real time can vary, .mcp files may contain missing (dropped) frames. When you open an .mcp in Shogun Post, a dialog box prompts you to confirm whether you want to fill in the data for these missing frames. The fixing operation requires an .x2d with the same name as the .mcp file to exist in the same folder.

  2. To automatically fill the dropped frames, click Yes.
    The dropped frames are reconstructed, labeled and solved, smoothly integrating data from the related .x2d file into the existing data.(If you click No, processing is quicker as Shogun Post just interpolates between the dropped frames, but note that no keys are created and you will still need to fix the dropped frames.)

    Tip

    If you click No, but then decide that you want to enable Shogun Post to fix the dropped frames, open the Processing panel and at the top right, in the Operations section, click Fix RT Drops.

Review occlusion fixing

When you import an .mcp file or perform any processing that includes occlusion fixing, your first step is to review it to ensure that it is labeled correctly and that the automatic occlusion fixing worked well.

To review occlusion fixing in Shogun Post, both of the following (default) settings must be selected:

  • In Shogun Live: Before capture, in the General section of the Processing panel, Occlusion Fixing must be selected.


    This normally produces higher quality results, especially during occlusion-heavy moves such as interactions and when a subject is on the edge of the volume. Occlusion fixing is stored as a layer when the .mcp data is recorded.

  • In Shogun Post: Before importing the .mcp file that was captured with Occlusion Fixing selected as described above, in the Preferences dialog box (General > Preferences), on the File Import tab, in the File Format field, select  MCP File and ensure Apply Fixed Markers is selected.

You can then compare the data before and after occlusion fixing in a Perspective view (or any other 3D view) in Post.

Note that, by default, in the Perspective view Show All Clips is selected:

This is necessary to enable you to view data from the backup clip, which contains the data before occlusion fixing, as well as the current (occlusion-fixed) clip.

Important

If required, you can revert back to the raw data after loading the .mcp file into Shogun Post by using the Restore section of the Marker Editing panel.

Note that the occlusion fixing algorithm affects all the markers on a subject. For this reason you should run occlusion fixing only once: either during capture in Shogun Live, or at the end of data processing in Shogun Post.

Before you start your review, ensure you can recognize the various types of data that may be displayed in the Perspective view, as listed in the following table.

Symbol in 3D viewDescriptionData type

Circle

Original labeled markers from the backup clip. Displayed by default if the difference between the position of the original marker and the occlusion-fixed marker is greater than 1 cm.

SphereMarkers without gaps

Sphere with a dot in the centerMarkers that have been occlusion-fixed during a gap

Sphere with a cross in the centerMarkers that have had a gap manually filled

Red sphereMarkers that are missing at the current frame

Wireframe boxConstraint, showing expected location of marker 

If circles are displayed for some markers during some time ranges, it indicates that the marker position was changed by more than 1 cm by occlusion fixing.

In this case, check the position of the occlusion-fixed marker. If it doesn’t look right, the cause is likely to be either a labeling mistake or an occlusion-fixing error. To fix these problems, see Correcting labeling mistakes.

Correcting labeling mistakes

If you notice any swaps, mis-labels or other issues with marker data and the file has already been occlusion fixed, the recommended workflow is to restore the data back to its original state before it was occlusion-fixed.

You can do this on a per subject basis using the Restore section of the Marker Editing panel. Normally, restore the data across the whole take, because occlusion fixing across a range leads to jumps in the data.

The recommended workflow for dealing with problematic occlusion-fixed data is:

  1. From the Current Subject chooser, select the required subject, or if you want to work on everything, select All.
  2. In the Restore section of the Marker Editing panel, with selected subject active, click Restore All Data.
  3. Fix any labeling issues that are present in your data. For more information, see Use the Labeling panel and Fix common labeling issues.
  4. Re-run occlusion fixing from the Processing panel.
  5. Re-run Solve Solving to update the solving skeletons.

Check for swaps and other errors

Important

Before filling gaps, you must find and fix any labeling swaps or errors in your data. Gap-filling in Shogun relies on the data before and after the gaps to predict marker location, so any labeling errors will cause gap-filling to fail.

To identify swaps and other errors, on the time bar, click the Play button to view your data in the Perspective view. For a closer look, slowly scrub through the whole take (drag the current time indicator along the timeline, or for finer control, press the A or S key), carefully checking for any 'popping', unexpected movement or obvious misalignment.

For a more detailed view, use the normal mouse actions to move around the view: drag to rotate the view, right-click and drag to zoom in or out, left- and right-click and drag to pan. If you need to view the image from a different angle, you can use one of the orthogonal views.

Use the View Filters options in the Perspective view to make it easy to recognize any issues. For more information on recognizing and correcting swaps and other errors, see Fix common labeling issues.

Tip

To snap a 3D view camera to selected object(s), press C or click the Snap button in the Perspective view toolbar.

Use video overlay to check accuracy

If your system includes Vicon video cameras, you can check your data accuracy by comparing optical capture data with supported video data. You do this by overlaying the 3D data onto the video (.vvid or .mov) data.

Shogun Post supports the following types of video files:

  • .vvid files captured from Vicon Shogun Live using Vicon Bonita and Vicon Vue cameras
  • .mov files that have been transcoded using Shogun Post or the standalone ViconVideoConverter tool (a command line tool that is installed with Vicon Video Viewer, by default to C:\Program Files\Vicon\ViconVideoViewer).

To overlay 3D data onto video files in Shogun Post:

  1. Ensure that the video files are in the same folder as the required 3D data (.x2d or .mcp) file. If a different path was defined during capture (often an SSD per pair of cameras), use the batch transcoding feature of Shogun Post to ensure the files are moved to the correct location. For more information, see Transcode video files

    Note

    If video files are kept in a different folder from the 3D data files, when you load an . x2d or . mcp file, Shogun Post warns you that the video files cannot be located. To manually specify the video file path, in the Selection panel (or Perspective view) select the video camera, then in the Attributes panel, expand the Video (Offline) section and set its Video_File attribute to the path of the file. This change is saved when you save the scene in Shogun Post .

  2. Open the .x2d or .mcp file (either from the Data Management panel, or click Import on the File menu, or drag and drop the relevant file from Windows Explorer, as described in Load mocap data files into Shogun Post).
    The video files are  automatically loaded.

  3. In the Selection panel, expand the System node and click the required camera.
  4. At the top right of the view pane, click the Change view type button, and then click Cameras.
  5. At the top of the Cameras view, ensure View Settings is selected.
  6. Select the 3D check box.

  7. The video for each supported Vicon video camera is displayed in a 3D overlay.
    Video files are in black and white or color, depending on the type of video camera used.
  8. To see the image plane of the camera corrected for lens distortion, select Distort 3D.

    The 3D overlay should line up with the subject in the Cameras view and the grid should line up with the floor.
    You can zoom and pan the video using normal Cameras view controls.
    You can select or clear the View Settings to control which 3D elements are displayed.

Get an overview with the time bar Issues map

To enable you to identify frames with issues, between the play range (blue vertical) bars on the time bar, two horizontal colored bars are displayed. For each frame:

  • The top bar indicates the percentage of markers that are labeled.
  • As the top bar percentage may include markers that are incorrectly labeled, to help you identify issues further, the lower bar indicates the percentage of markers that have a high solving constraint error (that is, the number of markers whose solving constraint error is considered too large). This can indicate issues like mislabels, swaps, or a poor solve due to an incorrect fill, over filtering, etc.

For both bars, the color varies from yellow to red, depending on the number of markers with issues at each frame. In each bar, the longer the yellow part exists, the longer the issue exists, whereas the more red it turns, the more markers have issues. To show more information about the errors found at a particular frame, hover the mouse pointer over the relevant frame.

Note

The issues map is all red if there is no labeled data in the current scene.

You can use the mouse to work with the time bar as follows:

ToDo this
Show a tooltip that explains the issues that are present at this frameHover the mouse pointer over the frame.
Set the current timeClick on the time bar or drag the current time indicator.
Set the current time (ie select a frame), highlight the markers that are missing labels or have high constraint errors, and snap the camera to themUsing the tooltip as a guide to where to click on the time bar, double-click on it.
Select a time rangeALT+drag. For more information, see Work with time ranges.

After you have gained an overview of your data with the time bar, you can use the Data Health view, the Graph view and/or the Marker Editing and Labeling panels to further identify and correct any issues.

To enhance system performance when working on a scene that contains very large amounts of data, you may want to turn off the Issues map.

To turn the issues map on and off:

Click the Issues map button to the left of the time bar.

To set the issues map to show all issues or only those for a specific subject:

From the Current Subject list at the top of the Shogun Post window, select the required option.

Note that you can snap the 3D view to the selected subject by clicking the Snap 3D view button to the right of the Current Subject list.

Find issues using the Data Health view

The Data Health view enables you to view detailed information about the labeling and gaps in the markers in the current scene. 

To open a Data Health view, in any view pane, click the Change view type button and then select Data Health.

By default, if a Backup clip exists, it is displayed, but if required, you can select a different clip by clicking the arrow on the Display Gaps button. (Clips contain keys for objects in your scene. The clip stores keys only; not markers, bones, or any other objects.)

To display the time ranges for the gaps in the markers on the selected clip as gray rectangles, ensure the Display Gaps button is selected.

To view the labeling for a different subject, from the Current Subject list at the top of the Shogun Post window, select the required name.

Use the marker list on the left of the Data Health view to find the required marker, then follow line along to see the gray rectangles that indicate gaps.

To select the range of a gap, in the Data Health view, double-click the relevant gray rectangle. The following image shows a Data Health view and Perspective view of a gap selected for a marker.

Tip

The Show all markers button shows every single marker in your scene. Select this option only if you need to see all markers because if, for example you have someone standing to one side but wearing a full marker set, you’ll see all their markers listed, as well as the markers for the rest of the action in the volume. Normally, it is more useful to have the Show current subject's markers button selected.

Find issues using the Graph view

In the Graph view, you can see a graphical representation of the X, Y and Z positions, as well as gaps, for selected marker(s). This is useful during gap-filling, as it gives you another way of checking that the gap-filling looks reasonable for the data.

To open a Graph view, in a view pane, click the Change view type button and then select Graph.

To select and fill gaps in a marker:

  1. To keep the Data Health view open as well as a Perspective view, split the screen by clicking one of the three-way split buttons, such as the Three Views Split Left button .
  2. As in the Data Health view, if there are multiple clips in your scene, you can select the required clip by clicking the arrow on the Display Gaps on Specified Clip button .
    To display X, Y and Z values of the selected marker at the current position of the time indicator in the graph, click the Show Display Channels button
  3. In the Perspective view, select the marker. In the Data Health view, double-click a gap to select its range.
     
    The Graph view now displays all the keys for the selected marker.

    As in the Data Health view, any gaps are clearly visible.
  4. Zoom in by right-click and dragging for a clearer view or by using one of the options under the Zoom button .
  5. You can now use the Labeling panel or one of the options from the extended context menu (press CTRL+ALT and right-click in the Graph view pane) as required. 

For further tips on using the Graph view to identify and fix data issues, see Fix common labeling issues.

Work with time ranges

While identifying and fixing issues in your captured data, you will often need to select a particular time range on which to work.

To select and clear time ranges:

  1. On the main time bar, and in the Data Health and Graph views, select a range (ALT+drag).

    Blue triangles that indicate the start and end of a selected range are displayed.



  2. To adjust the start or end of the time range, on the time bar, or in the Data Health view or Graph, hover the mouse pointer over the required arrow and drag it.

    Tip

    You can also update the range handles using hot keys:

    , sets the start handle

    . sets the end handle

    To change these hot keys, on the General menu, click Preferences and then click the Hot Keys tab.

  3. To clear a selected range, ALT+double-click within the range.