Differences

This shows you the differences between two versions of the page.

--- sift:build_cmz:building_cmzs [2024/06/19 12:46] – sgranger
+++ sift:build_cmz:building_cmzs [2024/07/17 15:44] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{to load data in sift you will need to have created cmz files. cmz files are compressed visual3d workspaces that contain both pure data and calculated values. if you are familiar with visual3d, you may already know how to create cmz files in the visual3d interface. the build cmz feature in sift is designed to automate the generation of cmz files so that they do not have to be created one by one.
+====== Building CMZs ======
-the build cmzs feature can be accessed on the [[sift:application:load_page|load page]] in sift.
+To load data in Sift you will need to have created CMZ files. CMZ files are compressed Visual3D workspaces that contain both pure data and calculated values. If you are familiar with Visual3D, you may already know how to create CMZ files in the Visual3D interface. The Build CMZ feature in Sift is designed to automate the generation of CMZ files so that they do not have to be created one by one.
-examples of using the build cmz function can be found under the [[sift:tutorials:openbiomechanics_project:build_cmz_files|build cmz tutorial]].
+The Build CMZs feature can be accessed on the [[Sift:Application:Load_Page|Load Page]] in Sift.
-====== build cmz dialog - generic builder ======
+Examples of using the Build CMZ function can be found under the [[Sift:Tutorials:OpenBiomechanics_Project:Build_CMZ_Files|Build CMZ Tutorial]].
-genericbuilder.png
+===== Build CMZ Dialog - Generic Builder =====
-clicking the "load c3ds" button on the load page will bring up the gui shown to the right, including the generic cmz builder and the theia builder. this section focuses on the generic cmz builder. there are **four** types of inputs that can be used to build a cmz for the generic builder:
+{{:GenericBuilder.png}}
-  - **cmz directory:** this should be set to the folder where all of the c3d files that need to be included in the cmz exist, including static and dynamic files. 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.
+Clicking the "Load C3Ds" button on the Load page will bring up the GUI shown to the right, including the Generic CMZ Builder and the Theia Builder. This section focuses on the generic CMZ builder. There are **four** types of inputs that can be used to build a CMZ for the generic builder:
-  - **metadata file:** the metadata file goes here. "browse" opens a file picker dialog to help you find it. expected type is .csv.
-  - **mdh file:** the model file goes here. "browse" opens a file picker dialog to help you find it. expected type is .mdh.
-  - **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. expected file type is .v3s.
+  - **CMZ Directory:** This should be set to the folder where all of the C3D files that need to be included in the CMZ exist, including static and dynamic files. 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.
+  - **Metadata File:** The metadata file goes here. "Browse" opens a file picker dialog to help you find it. Expected type is .csv.
+  - **MDH File:** The model file goes here. "Browse" opens a file picker dialog to help you find it. Expected type is .mdh.
+  - **Scripts:** Add scripts here to run them on each C3D file prior to combining them into one CMZ.
-after all 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 sift 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).
+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. Expected file type is .v3s.
-===== minimum inputs =====
+After all 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 Sift 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).
-the only required files to build a cmz are:
+==== Minimum Inputs ====
-  * static/calibration files (.c3d)
+The only required files to build a CMZ are:
-  * 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.
+  * Static/calibration files (.c3d)
+  * Dynamic/motion trials (.c3d)
-all other inputs are optional.
+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.
-===== optional inputs =====
+All other inputs are optional.
-**metadata file:** metadata files contain supplementary information about the data you are loading (subject age, weight, walking speed, etc.) metadata files can be used to refine sift queries after the library has been loaded.
+==== Optional Inputs ====
-**mdh file:** an mdh file is an ascii file that contains the definitions of all landmarks, segments and segment properties. if you want to load segment or landmark information into sift you must load an mdh file.
+**Metadata File:** Metadata files contain supplementary information about the data you are loading (subject age, weight, walking speed, etc.) Metadata files can be used to refine Sift queries after the library has been loaded.
-**scripts:** an ascii file containing a series of visual3d pipeline commands, with the extension .v3s. you would load scripts if you wanted to run a visual3d pipeline on the created cmz workspace.
+**MDH File:** An MDH file is an ASCII file that contains the definitions of all landmarks, segments and segment properties. If you want to load segment or landmark information into Sift you must load an MDH file.
-===== troubleshooting =====
+**Scripts:** An ASCII file containing a series of Visual3D pipeline commands, with the extension .v3s. You would load scripts if you wanted to run a Visual3D pipeline on the created CMZ workspace.
-this section contains a list of the error messages you may encounter while using the build cmz and metadata functions. the build cmz dialog and metadata windows expect reasonably specific input and may not execute if files or expected inputs are missing.
+==== Troubleshooting ====
-==== warning messages ====
+This section contains a list of the error messages you may encounter while using the Build CMZ and metadata functions. The Build CMZ dialog and metadata windows expect reasonably specific input and may not execute if files or expected inputs are missing.
-**no c3d files without cmzs found. skipping build.**
+=== Warning Messages ===
-  * 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.
+**No C3D files without CMZs found. Skipping build.**
-  * sift will close the build cmzs dialog without making any changes.
-**warning: you must select both a static and dynamic identifier to proceed.**
+  * 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.
+  * Sift will close the Build CMZs dialog without making any changes.
-  * exactly one static and one dynamic identifier is required in order for sift to build the cmz file.
+**Warning: You must select both a static and dynamic identifier to proceed.**
-  * sift will return you to the metadata dialog.
-**warning: meta data file not found! name:**
+  * Exactly one static and one dynamic identifier is required in order for Sift to build the CMZ file.
+  * Sift will return you to the Metadata dialog.
-  * 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.
+**Warning: Meta Data File not found! Name:**
-**mdh 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.
-  * 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 mdh file.
+**MDH File not found! Name:**
-==== error messages ====
+  * 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 MDH file.
-**no information passed. cannot build cmzs.**
+=== Error Messages ===
-  * this is an uncommon error. it means there was an issue with the build cmzs dialog and it is no longer accessible.
+**No information passed. Cannot build CMZs.**
-**no files selected. 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.
-  * this is an uncommon error. it means that no files at all were returned by the build cmz dialog.
+**No files selected. Cannot build CMZs.**
-====== build cmz dialog - theia builder ======
+  * This is an uncommon error. It means that no files at all were returned by the Build CMZ dialog.
-sift_theiabuilder.png
+===== Build CMZ Dialog - Theia Builder =====
-this section focuses on the theia builder, which builds cmz files from theia3d outputs. this dialog closely matches the dialog for building theia3d files in visual3d, "manage_theia3d_merge". this is also accessed from the "load c3ds" button on the load page.
+{{:Sift_TheiaBuilder.png}}
-there are a variety of inputs that can be used to generate cmzs from theia3d files:
+This section focuses on the Theia Builder, which builds CMZ files from Theia3D outputs. This dialog closely matches the dialog for building Theia3D files in Visual3D, "Manage_Theia3D_Merge". This is also accessed from the "Load C3Ds" button on the Load page.
-**cmz directory:** the directory root to search for all of the theia3d files.
+There are a variety of inputs that can be used to generate CMZs from Theia3D files:
+**CMZ Directory:** The directory root to search for all of the Theia3D Files.
 \\
-**save by:** how the cmz file should be saved as.
+**Save By:** How the CMZ file should be saved as.
-**use index theia files (.hmx):** if you would like to use a .hmx file to supersede this information.
+**Use Index Theia Files (.hmx):** If you would like to use a .hmx file to supersede this information.
 \\
-**file tags:** if/how file tags should be added onto the files by.
+**File Tags:** If/how file tags should be added onto the files by.
 \\
-**primary data folder:** method by which theia3d data is stored.
+**Primary Data Folder:** Method by which Theia3D data is stored.
-**theia session folder mask:** folder mask for theia3d files (directory within top level directory to search for theia3d files).
+**Theia Session Folder Mask:** Folder mask for Theia3d files (directory within top level directory to search for Theia3D files).
-**theia file mask:** file name mask for theia3d files. can include wildcards.
+**Theia File Mask:** File name mask for Theia3D files. Can include wildcards.
-**theia file mask for model:** file name mask for model file. if blank it will select the first file as the model file. can include wildcards.
+**Theia File Mask for Model:** File name mask for model file. If blank it will select the first file as the model file. Can include wildcards.
-**theia subject tags:** subject tags for theia3d files.
+**Theia Subject Tags:** Subject tags for Theia3D files.
-**theia prefixes:** **subject prefixes for theia3d files.**
+**Theia Prefixes:** **Subject prefixes for Theia3D files.**
-**theia color:** the color of the theia3d skeleton.
+**Theia Color:** The color of the Theia3D skeleton.
-**choose kinetic thorax:** choose which type of thorax to model.
+**Choose Kinetic Thorax:** Choose which type of thorax to model.
 \\
-**merge theia3d files:** merge primary theia3d files into other theia3d files (mutually exclusive).
+**Merge Theia3D Files:** Merge primary Theia3D files into other Theia3D files (mutually exclusive).
-**import analog files:** merge primary theia3d files with analog files, such as force plate data (mutually exclusive).
+**Import Analog Files:** Merge primary Theia3D files with analog files, such as force plate data (mutually exclusive).
-**merge theia files and other files:** merge primary theia3d files with other data, such as marker-based files (mutually exclusive).
+**Merge Theia Files and Other Files:** Merge primary Theia3D files with other data, such as marker-based files (mutually exclusive).
 \\
-**secondary data folder:** method by which secondary data is stored.
+**Secondary Data Folder:** Method by which secondary data is stored.
-**static data folder:** method by which static secondary data is stored.
+**Static Data Folder:** Method by which static secondary data is stored.
-**other session folder mask:** folder mask for merged files (directory within top level directory to search for merged files).
+**Other Session Folder Mask:** Folder mask for merged files (directory within top level directory to search for merged files).
-**other file mask:** file name mask for merged files. can include wildcards.
+**Other File Mask:** File name mask for merged files. Can include wildcards.
-**other static file mask:** file name mask for static merged files. can include wildcards.
+**Other Static File Mask:** File name mask for static merged files. Can include wildcards.
-**other model template mask:** file name mask for model files (if needed). can include wildcards.
+**Other Model Template Mask:** File name mask for model files (if needed). Can include wildcards.
-**other subject tags:** subject tags for merged files.
+**Other Subject Tags:** Subject tags for merged files.
-**other prefixes:** **subject prefixes for merged files.**
+**Other Prefixes:** **Subject prefixes for merged files.**
-**other color:** the color of the secondary data files.
+**Other Color:** The color of the secondary data files.
-**analog filter cutoff:** the lowpass filter cutoff for the analog files.
+**Analog Filter Cutoff:** The lowpass filter cutoff for the analog files.
-**target filter cutoff:** the lowpass filter cutoff for the target files.
+**Target Filter Cutoff:** The lowpass filter cutoff for the target files.
-**fp_auto_baseline:** method by which forceplate data was collected.
+**FP_Auto_Baseline:** Method by which forceplate data was collected.
 \\
-**restrict number of session files:** restricts the number of session files used.
+**Restrict Number of Session Files:** Restricts the number of session files used.
-**visual3d pipeline pre-merge:** visual 3d pipeline to run before the merge occurs.
+**Visual3D Pipeline Pre-Merge:** Visual 3D pipeline to run before the merge occurs.
-**visual3d pipeline post-merge:** visual 3d pipeline to run after the merge occurs.
+**Visual3D Pipeline Post-Merge:** Visual 3D pipeline to run after the merge occurs.
 \\
-differences from the visual3d dialog include:
+Differences from the Visual3D Dialog include:
+**CMZs not opened by default:** you need to load these in through the [[Sift:Application:Load_Library_Dialog|load library]] dialog into Sift.
-**cmzs not opened by default:** you need to load these in through the [[sift:application:load_library_dialog|load library]] dialog into sift.
+**Automatic Save is on by default:** you just need to select how to save from the given options.
-**automatic save is on by default:** you just need to select how to save from the given options.
-}}}}