Inspect3D Documentation: Build CMZs

Overview

To manipulate data in Inspect3D you will need to have created CMZ files. CMZ files contain both pure data and calculated values. If you are familiar with Visual3D, you may already know how to create CMZ files from the Visual3D interface. The Build CMZ feature in Inspect3D is designed to automate the generation of CMZ files so that they do not have to be created one by one.

The Build CMZs feature is accessed through the Load Library dialog.

CMZ Builder

There are four types of inputs that can be used to build a CMZ:

1. CMZ Directory: This should be set to the folder where all of the C3D files that need to be included exist. If the folder contains other folders with C3D files inside, all of them will be included as well. "Browse" opens a file picker dialog to help you find it.
2. Metadata File: The metadata file goes here. "Browse" opens a file picker dialog to help you find it. Expected type is is .csv.
3. MDH File: The model file goes here. "Browse" opens a file picker dialog to help you find it.
4. Scripts: Add scripts here to run them on each C3D file prior to combining them into one CMZ.

The scripts are run in order, so use the arrow buttons on the right to get the order correct. Note: Scripts added here must all have unique names. The "Add Script" button will not allow you to add the same file multiple times.

After correct files have been uploaded, click the "Create CMZs" button. This button combines all the C3D files in the CMZ Directory folder into one CMZ file that Inspect3D can then load as a library. It includes the metadata, applies the model to all the C3D files, and runs the scripts in order. When this button is pressed, the Metadata window will open (if a metadata file has been provided).

Minimum Inputs

The only required files to build a CMZ are:

• Static/calibration files (.c3d)
• Dynamic/motion trials (.c3d)

The static and dynamic trials you want to combine into a CMZ workspace should be located in the same folder. Passing a file path to this folder to the CMZ Builder is the minimum input required to construct a CMZ workspace. If you have data with multiple subjects, separate the data into folders by subject, ensure that each folder has static and dynamic files, and then pass CMZ builder the path to the parent folder holding all subject folders.

All other inputs are optional.

Metadata

Metadata Viewer

If you were to load a .csv file with only one header labelled "hello_world" and populated with a random string, the metadata viewer would show this output:

This example is intended to show the bare bones of the metadata viewer. It has three columns, "Header", "Description" and "Subject Specific" and two dropdown menus with options for height and weight units. These will always appear no matter what your metadata file contains.

Header: is the first item in each column of the csv file. All headers appear in the first row of the csv file and are separated by commas. The column header at position N corresponds to all data in column N.

Description: This is a dropdown menu of pre-programmed options. The options are:

• Height
• Weight
• Text
• Metric
• Identifier_Static
• Identifier_Dynamic
• Ignore

Subject_Specific: this is a checkbox that is intended to store whether or not the value of the header changes on a subject by subject basis.

Error Messages and Troubleshooting

A sample of the dialog that will appear is below:

The current implementation expects several columns (ex. Height, Weight, StaticTrialName). Each row contains data for that subject/trial.

Combo box options:

• Identifier_Static
  • Note: There must be exactly one Identifier_Static
  • This column should describe name of the static C3D file in some way (ex. Sub01_Static_01.c3d) and identifies this row as containing information for this subject
• Indentifier_Dynamic
  • Note: There must be exactly one Identifier_Dynamic
  • This column should describe name of the dynamic C3D file in some way (ex. Sub01_Walk_01.c3d) and identifies this row as containing information for this trial
• Metric
  • Any metric value (ex. pitch speed)
• Text
  • Any text value (ex. playing level)
• Height
• Weight

• Specify units for height/weight!

Subject Specific checkbox:

• Subject specific values are the same for all trials (ex. height, weight, playing level)
• Trial specific values differ for each trial (ex. pitch speed)

Make edits here as necessary, then click "Apply".

See Tutorial: Build CMZs for a sample files and examples of using the Build CMZ function.

Messages

Warning Messages

• No C3D files without CMZs found. Skipping build.
  • This notice shows up when the folder you've selected does not contain any C3D files OR does not contain any C3D files that are not already contained in a CMZ file.
  • Inspect3D will close the Build CMZs dialog without making any changes.
• Warning: You must select both a static and dynamic identifier to proceed.
  • Exactly one static and one dynamic identifier is required in order for Inspect3D to build the CMZ file.
  • Inspect3D will return you to the Metadata dialog
• Warning: Meta Data File not found! Name:
  • Did you forget to Browse to the location of your Metadata file? If you do not intend to include metadata, please uncheck the box next to the Metadata file.
• MDH File not found! Name:
  • Did you forget to Browse to the location of your MDH file? If you do not intend to include a model file, please uncheck the box next to the Metadata file.

Error Messages

• No information passed. Cannot build CMZs.
  • This is an uncommon error. It means there was an issue with the Build CMZs dialog and it is no longer accessible.
• No files selected. Cannot build CMZs.
  • This is an uncommon error. It means that no files at all were returned by the Build CMZ dialog.