Differences

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

--- visual3d:tutorials:reports:comparing_data_sets [2024/06/19 12:55] – sgranger
+++ visual3d:tutorials:reports:comparing_data_sets [2024/07/17 15:47] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{====== introduction ======
+====== Comparing Data Sets ======
-this tutorial is going to describe comparing different data sets. in this example, we're going to compare data between various subjects.
+===== Introduction =====
-==== download ====
+This tutorial is going to describe comparing different data sets. In this example, we're going to compare data between various subjects.
-[[https://www.has-motion.com/download/examples/comparingdatasets.zip|the sample files can be downloaded here.]]
+=== Download ===
-  * data:
+[[https://www.has-motion.com/download/examples/ComparingDataSets.zip|The sample files can be downloaded here.]]
-    * sub 01 cmz
-    * sub 02 cmz
-    * sub 03 cmz
-  * scripts:
-    * tag.v3s (example script that can be used to tag the files)
-    * tag_loop.v3s (example script that can be used to tag the files using a for_each loop)
-    * overlay.v3s (example script that can be used to overlay the report template with another subject)
-    * overlay_loop.v3s (example script that can be used to overlay the report template with another subject using a for_each loop)
-  * report templates:
-    * report_template_all_files.rgt
-    * report_template_sub_01.rgt
-====== prepare the workspace ======
+  * Data:
+    * Sub 01 CMZ
+    * Sub 02 CMZ
+    * Sub 03 CMZ
+  * Scripts:
+    * Tag.v3s (Example script that can be used to tag the files)
+    * Tag_Loop.v3s (Example script that can be used to tag the files using a For_Each loop)
+    * Overlay.v3s (Example script that can be used to overlay the report template with another subject)
+    * Overlay_Loop.v3s (Example script that can be used to overlay the report template with another subject using a For_Each loop)
+  * Report Templates:
+    * Report_Template_ALL_FILES.rgt
+    * Report_Template_Sub_01.rgt
-the first step is to load the data. it's recommended that you use the cmo library to view multiple cmz files at once. many users simply choose to do a file -> open if they're viewing two small files. this option works for smaller data sets, but it's really recommended to use the cmo library instead.
+===== Prepare the Workspace =====
-==== view files using the cmz library ====
+The first step is to load the data. It's recommended that you use the CMO Library to view multiple CMZ files at once. Many users simply choose to do a File -> Open if they're viewing two small files. This option works for smaller data sets, but it's really recommended to use the CMO Library instead.
-  - **cmo library -> set cmo library path**
+=== View files using the CMZ Library ===
-    - select **..comparing data sets\data folder**
-    - click **ok**
-  - **cmo library -> browse cmo library**
-    - select **yes**
-[[visual3d:documentation:definitions:cmo_library_#load_the_cmo_library|more detailed instructions to load the cmo library can be found here]].
+  - **CMO Library -> Set CMO Library Path**
+    - Select **..Comparing Data Sets\Data folder**
+    - Click **OK**
+  - **CMO Library -> Browse CMO Library**
+    - Select **Yes**
-====== tag files ======
+[[Visual3D:Documentation:Definitions:CMO_Library_#Load_the_CMO_Library|More detailed instructions to load the CMO Library can be found here]].
-|**once the data is loaded in the workspace, create three tags:**\\ \\ ****\\ \\ - sub_01\\ - sub_02\\ - **sub_03**  |  comparedatasets_tags.png  |
+===== Tag Files =====
-**there are a few ways to create tags:** (choose one method of the following)
+|**Once the data is loaded in the workspace, create three tags:**\\ \\ ****\\ \\ - Sub_01\\ - Sub_02\\ - **Sub_03**  |  {{:CompareDataSets_Tags.png}}  |
-  - [[visual3d:documentation:definitions:tag#creating_tags:|manually add tags]] to the files or use the pipeline.
+**There are a few ways to create tags:** (Choose one method of the following)
-  - use the [[visual3d:documentation:pipeline:file_commands:assign_tags_to_file|assign_tags_to_file]] command to assign tags to subjects based on the filename. this can be done using the provided **tag.v3s file**.
-  - using the [[visual3d:documentation:pipeline:pipeline_commands:for_each_and_end_for_each|for_each]] command, you can loop over all the subjects in your workspace to create individual tags for them. this can be done using the provided **tag_loop.v3s file**.
-====== graph data ======
+  - [[Visual3D:Documentation:Definitions:Tag#Creating_Tags:|Manually add tags]] to the files or use the pipeline.
+  - Use the [[Visual3D:Documentation:Pipeline:File_Commands:Assign_Tags_To_File|Assign_Tags_To_File]] command to assign tags to subjects based on the filename. This can be done using the provided **Tag.v3s file**.
+  - Using the [[Visual3D:Documentation:Pipeline:Pipeline_Commands:For_Each_and_End_For_Each|For_Each]] command, you can loop over all the subjects in your workspace to create individual tags for them. This can be done using the provided **Tag_Loop.v3s file**.
-once the data has been loaded and tagged, create a report template that plots the data.
+===== Graph Data =====
-==== 1. change report template to plot sub_01 tag ====
+Once the data has been loaded and tagged, create a report template that plots the data.
-a. **open a report template** that plots the signals you are interested in viewing (ex. open provided **report_template_all_files.rgt**)
+=== 1. Change Report Template to Plot Sub_01 tag ===
-b. change the tag from all_files (or whatever you're currently plotting) to one of the tags you want to plot (ex. sub_01) and set the line color to the same for both the right and left sides.
-a. **search/replace**:
-|a1. old file tag: **all_files**\\ \\ a2. new file tag: **sub_01**\\ \\ a3. click **"add>>"**\\ \\ a4. old line color: **#109900**\\ \\ a5. new line color: **purple**\\ \\ a6. click **"add>>"**\\ \\ a7. old line color: **#990000**\\ \\ a8. new line color: **purple**\\ \\ a9. click **"add>>"**\\ \\ a10. select **"entire report"**\\ \\ a11. click **"replace"**  |  comparedatasets_searchreplace.png  |
-d. **save report template** (ex. report_template_sub_01.rgt)
+A. **Open a report template** that plots the signals you are interested in viewing (ex. Open provided **Report_Template_ALL_FILES.rgt**)
-==== 2. overlay other subject's data ====
+B. Change the tag from ALL_FILES (or whatever you're currently plotting) to one of the tags you want to plot (ex. Sub_01) and set the line color to the same for both the right and left sides.
+a. **Search/Replace**:
+|a1. Old File Tag: **ALL_FILES**\\ \\ a2. New File Tag: **Sub_01**\\ \\ a3. Click **"Add>>"**\\ \\ a4. Old Line Color: **#109900**\\ \\ a5. New Line Color: **Purple**\\ \\ a6. Click **"Add>>"**\\ \\ a7. Old Line Color: **#990000**\\ \\ a8. New Line Color: **Purple**\\ \\ a9. Click **"Add>>"**\\ \\ a10. Select **"Entire Report"**\\ \\ a11. Click **"Replace"**  |  {{:CompareDataSets_SearchReplace.png}}  |
-**the step to overlay the subject data can be done manually (as described below), or using the pipeline** (ex. provided scripts from download overlay.v3s or overlay_loop.v3s).
+D. **Save report template** (ex. Report_Template_Sub_01.rgt)
+=== 2. Overlay other subject's data ===
-a. overlay sub_02 on top of sub_01
+**The step to overlay the subject data can be done manually (as described below), or using the pipeline** (ex. provided scripts from download Overlay.v3s or Overlay_Loop.v3s).
-a. **overlay report**:
-|a1. page no: all_pages\\ \\ a2. identifier type: tag_name\\ \\ a3. identifier value: sub_01\\ \\ a4. new tag: sub_02\\ \\ a5. new color: blue  |  comparedatasets_overlay.png  |
+A. Overlay Sub_02 on top of Sub_01
+a. **Overlay Report**:
+|a1. Page No: ALL_PAGES\\ \\ a2. Identifier Type: TAG_NAME\\ \\ a3. Identifier Value: Sub_01\\ \\ a4. New Tag: Sub_02\\ \\ a5. New Color: Blue  |  {{:CompareDataSets_Overlay.png}}  |
+B. Overlay Sub_03 on top of Sub_01
+a. **Overlay Report**:
+a1. Page No: **ALL_PAGES**
+a2. Identifier Type: **TAG_NAME**
+a3. Identifier Value: **Sub_01**
+a4. New Tag: **Sub_03**
+a5. New Color: **Cyan**
+C. Display the tag name in the Legend of the report
-b. overlay sub_03 on top of sub_01
-a. **overlay report**:
-a1. page no: **all_pages**
-a2. identifier type: **tag_name**
-a3. identifier value: **sub_01**
-a4. new tag: **sub_03**
-a5. new color: **cyan**
-c. display the tag name in the legend of the report
-}}}}}}