Differences

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

--- visual3d:documentation:definitions:cmo_library [2024/06/19 12:47] – sgranger
+++ visual3d:documentation:definitions:cmo_library [2025/09/11 11:24] (current) – Cleaned up formatting. wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{{{{{cmo libraries are used to handle large data sets. common use cases include creating a normal database for comparisons or processing data across multiple subjects.
+====== CMO Library  ======
-===== introduction =====
+CMO Libraries are used to handle large data sets. Common use cases include creating a normal database for comparisons or processing data across multiple subjects.
-the cmo library opens a .cmx file, which contains an index into a [[visual3d:documentation:definitions:file_formats:cmo_format|.cmo]] or [[visual3d:documentation:definitions:file_formats:cmz_format_|.cmz]] file. this allows the cmo library to quickly find trials and signals across many files at once.
+===== Structure of the CMO Library =====
-if you place all the .cmz files under one folder/tree and set the 'cmo library path' to the root folder of the files, you can "browse" the .cmo/.cmz files inside of visual3d. it's a way of quickly opening the indices (.cmx) for the files and being able to quickly access signals/data to process them across many .cmz files.
+The CMO Library opens a .CMX file, which contains an index into a [[Visual3D:Documentation:Definitions:File_Formats:CMO_Format|.CMO]] or [[Visual3D:Documentation:Definitions:File_Formats:CMZ_Format_|.CMZ]] file. This allows the CMO Library to quickly find trials and signals across many files at once. You can run any pipeline to calculate/analyze across all of the .CMZ files in a directory/library using the CMO_LIBRARY without having to open each one, which is a faster than processing each one individually.
-you set the active files to each_cmo_workspace, or all_cmo_globals depending what data you want to examine/process/export.
+If you place all the .CMZ files under one folder/tree and set the 'CMO Library Path' to the root folder of the files, you can "Browse" the .cmo/.cmz files inside of Visual3D. It's a way of quickly opening the indices (.cmx) for the files and being able to quickly access signals/data to process them across many .CMZ files.
-you can run any pipeline to calculate/analyze across all of the .cmz files in a directory/library using the cmo_library without having to open each one, which is a faster than processing each one individually.
+The processed information is stored in the CMX file:
-\\
+|TARGET\\ ANALOG\\ FORCE\\ COFP\\ FREEMOMENT\\ |LANDMARK\\ LINK_MODEL_BASED\\ METRIC\\ FRAME_NUMERS\\ |
-the processed information is stored in the cmx file:
-|target\\ analog\\ force\\ cofp\\ freemoment\\ |landmark\\ link_model_based\\ metric\\ frame_numers\\ |
+==== Link-Model Information ====
+If using Visual3D v6 or later (and CMZ files) then the link-model information is stored in the CMZ file, so you can create LINK_MODEL_BASED signals within the CMO Library.
-prior to version 6 - the model based information was not stored in the cmo file, the user will need to calculate all link_model_based signals (kinematics and kinetics) prior to loading the cmo library. after these signals have been created, the user can load the cmo library and do further processing on kinematics and kinetics. if using version 6 (and cmz files), the link model information **is** stored in the cmz file, so you can create link_model_based signals in version 6.
+Prior to version 6 the model-based information was not stored in the CMO file, which means that the user would need to calculate all LINK_MODEL_BASED signals (kinematics and kinetics) prior to loading the CMO Library.
-===== using the cmo library =====
+===== Active Files in the CMO Library =====
-==== loading the cmo library ====
+With the CMO Library loaded you will have two new options to set as the [["Visual3D:documentation:definitions:Active_Files|active files]], depending what data you want to examine/process/export:
+  - EACH_CMO_WORKSPACE: Make all files across the entire CMO Library active and process each CMO/CMZ workspace individually.
+  - ALL_CMO_GLOBALS: Make all files across the entire CMO Library active and calculate quantities across CMO/CMZ workspaces.
-**to load the cmo library:**
+===== Example: Using the CMO Library =====
-**1.** set the cmo library path by going to **cmo library -> set cmo library path**\\
+This example demonstrates how to load in a CMO Library, select the appropriate active files, and calculate a metric quantity.
-\\
-**note:** the cmo library will load any cmo files in sub-folders
-setcmolibrarypath.png
+=== Loading the CMO Library ===
-**2.** catalog the cmo files by going to **cmo library -> maintenance -> catalog cmo files**\\
+To load the CMO Library:
-\\
-**note:** by cataloging the cmo files, visual3d updates each cmx file to ensure it reflects the processed data in the cmo file. the cmx file is also updated each time a cmo file is saved. if the cmx files have not been moved or deleted, this process does not need to be done more than once. (especially since this process can takes a long time)
-maintenance_catalogcmofiles.png
+**1.** Set the CMO Library Path by going to **CMO Library -> Set CMO Library Path**. The CMO Library will load any CMO files in sub-folders
-**3.** browse the cmo library by going to **cmo library -> browse cmo library**\\
+{{:SetCMOLibraryPath.png}}
-\\
-**4.** click **ok** in the prompt\\
-\\
+**2.** Catalog the CMO files by going to **CMO Library -> Maintenance -> Catalog CMO Files**. By cataloging the CMO files, Visual3D updates each CMX file to ensure it reflects the processed data in the CMO file. The CMX file is also updated each time a CMO file is saved. If the CMX files have not been moved or deleted, this process does not need to be done more than once. (Especially since this process can takes a long time).
-browsecmolibrary.png
+{{:Maintenance_CatalogCMOFiles.png}}
-the cmo library will now be loaded into the workspace. the files will be highlighted in a purple color (in a regular cmo file, the files are highlighted in blue, grey, & pink).\\
+**3.** Browse the CMO Library by going to **CMO Library -> Browse CMO Library**.
-\\
-. the cmo files loaded into the workspace will be listed on the left under **cmo workspace**\\
-. no files will be loaded under **models/calibration** files since model based data is not loaded in the cmo library (see [[#introduction|introduction]] for more information)\\
-. the motion files associated with each cmo file will be listed under **motion files**\\
-. the **tags** in each cmo file will be loaded as well\\
+**4.** Click **OK** in the prompt.
-loadedcmolibrary.png
+{{:BrowseCMOLibrary.png}}
-==== selecting the active file ====
+The CMO Library will now be loaded into the workspace. The files will be highlighted in a purple color (in a regular CMO file, the files are highlighted in blue, grey, & pink).
+  * The CMO files loaded into the workspace will be listed on the left under **CMO Workspace**.
+  * Model-based data will be loaded for Visual3D v6 and later (using CMZ files).
+  * The motion files associated with each CMO file will be listed under **Motion Files**.
+  * The **TAGs** in each CMO file will be loaded as well.
-**the active file selection in the cmo library is one of the most important features in visual3d.**
+{{:LoadedCMOLibrary.png}}
-although any command can be run on the cmo library, for the following example, the affect of running the metric_mean command on each of the active files will be explained.
+=== Selecting the Active File ===
-for example:
+The [[:Visual3D:Documentation:Definitions:Active_Files|Active File]] selection in the CMO Library is one of the most important features in Visual3D. Although any command can be run on the CMO Library, for the following example, the affect of running the METRIC_MEAN command on each of the active files will be explained.
-while creating the cmo_files, the maximum knee flexion during swing was calculated using the metric_maximum command. in each file there are at least two instances of maximum knee flexion.
+For example:
-after loading the cmo library with multiple subject's cmo files, the average knee flexion is being calculated. selecting different active files will have different effects on how the cmo library processes future commands:
+While creating the CMO_Files, the maximum knee flexion during swing was calculated using the Metric_Maximum command. In each file there are at least two instances of maximum knee flexion. After loading the CMO Library with multiple subject's CMO files, the average knee flexion is being calculated. Selecting different Active Files will have different effects on how the CMO Library processes future commands:
-cmolibrary_selectactivefile.png
+{{:CMOLibrary_SelectActiveFile.png}}
-**1. individual c3d file -**\\
+**1. Individual C3D file**. If METRIC_MEAN is run on a specific C3D file, the result value will be the average knee flexion for that trial. If Generate Global Mean and STDDev is checked, the average value for the specified trial will be created in the GLOBAL workspace.
+**2. EACH_CMO_WORKSPACE**. If METRIC_MEAN is run on EACH_CMO_WORKSPACE, the average of each individual trial will be calculated. If Generate Global Mean and STDDev is checked, the average value for each CMO file for each of the trials will be averaged and stored in the [[visual3d:documentation:definitions:global_workspace|GLOBAL workspace]].
-if metric_mean is run on a specific c3d file, the result value will be the average knee flexion for that trial. if generate global mean and stddev is checked, the average value for the specified trial will be created in the global workspace.
+**3. TAGs**. If METRIC_MEAN is calculated on a group of file tags, the average of each individual trial will be calculated. If Generate Global Mean and STDDev is checked, the average value for each of the tagged trials will be averaged and stored in the GLOBAL workspace.\\
-**2. each_cmo_workspace -**\\
+**4. GLOBAL**. The average values calculated while using the CMO Library will be stored here. These metrics should represent the average across multiple CMO files.\\
-if metric_mean is run on each_cmo_workspace, the average of each individual trial will be calculated. if generate global mean and stddev is checked, the average value for each cmo file for each of the trials will be averaged and stored in the global workspace.
+**5. ALL_CMO_GLOBALS**. Any global metrics calculated when creating the CMO file will be stored here. When in the library, calculating metrics when EACH_CMO_WORKSPACE is active will also result in average values being calculated here. These metrics should represent the average across multiple trials within a CMO file.
-**3. tags -**\\
+===== Further Information =====
-if metric_mean is calculated on a group of file tags, the average of each individual trial will be calculated. if generate global mean and stddev is checked, the average value for each of the tagged trials will be averaged and stored in the global workspace.
+  - A normal database can be created and plotted in other files using the CMO Library. Instructions to create and export the CMO Library can be found [[Visual3D:Documentation:Reports:Normative_Data_From_CMO_Library|here]]
-**4. global -**\\
+  - The CMO Library can be opened using the [[Visual3D:Documentation:Pipeline:File_Commands:Load_CMO_Library|Load_CMO_Library]] command
+  - The CMO Library can be closed using the [[Visual3D:Documentation:Pipeline:File_Commands:Unload_CMO_Library|Unload_CMO_Library]] command
-the average values calculated while using the cmo library will be stored here. these metrics should represent the average across multiple cmo files.
-**5. all_cmo_globals -**\\
-any global metrics calculated when creating the cmo file will be stored here. when in the library, calculating metrics when each_cmo_workspace is active will also result in average values being calculated here. these metrics should represent the average across multiple trials within a cmo file.
-===== further information =====
-  - a normal database can be created and plotted in other files using the cmo library
-    - instructions to create and export the cmo library can be found [[visual3d:documentation:reports:normative_data_from_cmo_library|here]]
-  - the cmo library can be opened using the [[visual3d:documentation:pipeline:file_commands:load_cmo_library|load_cmo_library]] command
-  - the cmo library can be closed using the [[visual3d:documentation:pipeline:file_commands:unload_cmo_library|unload_cmo_library]] command
-}}}}}}}}}}