visual3d:documentation:pipeline:pipeline_commands:manage_file_merge
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| visual3d:documentation:pipeline:pipeline_commands:manage_file_merge [2025/05/28 15:39] – wikisysop | visual3d:documentation:pipeline:pipeline_commands:manage_file_merge [2025/05/28 19:44] (current) – wikisysop | ||
|---|---|---|---|
| Line 57: | Line 57: | ||
| ====Command Parameters==== | ====Command Parameters==== | ||
| - | - Table with parameters and descriptions (include link to parameter wiki pages if they are available) | ||
| - | |||
| The following table shows the command parameters and descriptions: | The following table shows the command parameters and descriptions: | ||
| |**Parameter** | |**Parameter** | ||
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| |**! / | |**! / | ||
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| - | |**! / | + | |**! / |
| ====Dialog==== | ====Dialog==== | ||
| The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below. | The command can be edited in a text editor or in a dialog form. To edit in the dialog pop up form either click on the **Edit** button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below. | ||
| + | There are a variety of inputs that can be used to generate CMZs from Theia3D files: | ||
| - | {{:manage_file_merge.png}} | + | {{ visual3d:documentation: |
| + | * **Root path to search:** The directory root to search for all of the Files. | ||
| + | * **Open CMZ Library After Processing: | ||
| + | * **Automatically save default CMZ files:** How the CMZ file should be saved as. | ||
| + | * **Use Index Theia Files (.hmx):** If you would like to use a .hmx file to supersede Theia3D files information. | ||
| + | * **File Tags:** If/how file tags should be added onto the files by. | ||
| - | - Brief description | + | **Primary Files:** |
| + | * **Primary Data Folder:** Method by which Theia3D data is stored. | ||
| + | * **Primary Session Folder Mask:** Folder mask for Theia3d files (directory within top level directory to search for Theia3D files). | ||
| + | * **Primary File Mask:** File name mask for Theia3D files. Can include wildcards. | ||
| + | * **Primary 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. | ||
| + | * **Theia3D Subject Tags:** Subject tags for Theia3D files. | ||
| + | * **Theia Prefixes:** Subject prefixes for Theia3D files. | ||
| + | * **Theia Color:** The color of the Theia3D skeleton. | ||
| + | * **Sex:** The sex of the Theia3D file for model inertial properties. | ||
| + | * **Choose Kinetic Thorax:** Choose which type of thorax to model. | ||
| + | |||
| + | * **Merge Primary Files:** Merge primary files into other primary files (mutually exclusive). | ||
| + | * **Import Analog Files:** Merge primary files with analog files, such as force plate data (mutually exclusive). | ||
| + | * **Merge Primary Files and Other Files:** Merge primary files with other data, such as marker-based files (mutually exclusive). | ||
| + | * **Treat Session Files as Independent: | ||
| + | |||
| + | **Secondary Files:** | ||
| + | * **Secondary Data Folder:** Method by which 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 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 Model Template Mask:** File name mask for model files (if needed). Can include wildcards. | ||
| + | * **Other Subject Tags:** Subject tags for merged files. | ||
| + | * **Other Prefixes:** Subject prefixes for merged files. | ||
| + | * **Other Color:** The color of the secondary data files. | ||
| + | * **Analog Filter Cutoff:** The lowpass filter cutoff for the analog files. | ||
| + | * **Target Filter Cutoff:** The lowpass filter cutoff for the target files. | ||
| + | * **FP_Auto_Baseline: | ||
| + | |||
| + | * **Restrict Number of Session Files:** Restricts the number of session files used. | ||
| + | * **Visual3D Pipeline Pre-Merge: | ||
| + | * **Visual3D Pipeline Post-Merge: | ||
| |[IMAGE] | |[IMAGE] | ||
| | | | | ||
| ====Examples==== | ====Examples==== | ||
| - | ===Simple example=== | + | ===Merge QTM and Theia=== |
| + | |||
| - | Showing functionality of the command, using a diagram possibly to show output. | + | ===Merge Multiple QTM Files=== |
| - | ===Complex example=== | ||
| - | Combine with other commands and show step-by-step process for frequent use case | ||
| - | ====Notes==== | + | =====Notes===== |
| - | - Important considerations (anything included in the page before | + | ==== Folder Structure ==== |
| + | There is an assumed basic directory structure for this command' | ||
| + | |**1. Study**|Although the name of this directory level suggests that the data it contains is only used for one study, this is not necessary. As a top-level concept this is the largest, most general database that is stored in one location. This could be specific to a study, or it could be specific to a project, researcher, lab, or consortium. In these latter cases it is possible to define [[Other: | ||
| + | |**2. Group**|This level of the directory structure is optional, but it allows the researcher to divide c3d files according to desired parameters, e.g., Women - Men, Old - Young. If this level is omitted from the structure then individual C3D files can be [[Visual3D: | ||
| + | |**3. Session**|This directory level can be conceived as a single day (or single effort) of data collection within the database. This is the most important level as this is where the [[Visual3D: | ||
| + | |**4. Task**|This level of the directory allows the researcher to divide c3d files according to the desired activity, e.g., walking, running, jumping, etc. As with group-level parameters, C3D files can be coded with these different tasks by using [[Visual3D: | ||
| + | |**5. Trial**|At this level of the directory structure we have individual trials. This means that we have the individual C3D files that are recorded by the motion capture system.| | ||
| + | **If you are using Theia3D files**, and use TMBATCH, the default folder structure will have 6 levels. From root folder to deepest leaf they are:\\ | ||
| + | - Study | ||
| + | - Group | ||
| + | - Session | ||
| + | - Task | ||
| + | - Trial | ||
| + | - pose_filt_0.c3d | ||
visual3d/documentation/pipeline/pipeline_commands/manage_file_merge.1748446758.txt.gz · Last modified: 2025/05/28 15:39 by wikisysop