Differences

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

--- visual3d:documentation:pipeline:file_commands:remove_prefix_from_point_labels [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:remove_prefix_from_point_labels [2026/03/08 08:56] (current) – Revised into Pipeline command template. wikisysop
@@ Line 1: / Line 1: @@
-remove the prefix from marker names.
+====== Remove Prefix From Point Labels ======
-===== command =====
+Some motion capture manufacturers' software provides an option to add a prefix to all of the marker labels. This has the potential to cause a big problem when reading these files in Visual3D, since an assumption is made that markers are named consistently between files, especially between the standing trial and the movement trials. This pipeline command allows users to remove the specified prefix(es) from [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]] (marker) names within the active files.
-**remove_prefix_from_point_labels**
+===== Pipeline Command =====
-! /prefix=
-! /include_cal_file=true
-! /overwrite_c3d_file=false
-**;**
-some motion capture manufacturer's software provides an option to add a prefix to all of the marker labels. this causes visual3d a big problem because visual3d assumes that markers are named consistently between files, especially between the standing trial and the movement trials.
-this command can be used to remove marker prefix from targets.
+<code>
+Remove_Prefix_From_Point_Labels
+! /PREFIX=
+! /INCLUDE_CAL_FILE=TRUE
+! /OVERWRITE_C3D_FILE=FALSE
+;
+</code>
-===== /prefix parameter =====
+===== Command Parameters =====
-if the prefix parameter is specified, only this prefix will be removed from the signal names.
+^ Parameter ^ Description ^
+| **Prefix** | If specified, only this prefix will be removed from the signal names. If left blank, Visual3D looks for the [[visual3d:documentation:c3d_signal_types:c3d_format#c3d_parameter_format|C3D Parameter Group]] called "SUBJECTS" and the parameter "LABEL_PREFIXES". This could contain several entries, and Visual3D searches the [[visual3d:documentation:c3d_signal_types:target_data_type|TARGET]]s for signal names containing these prefixes and the prefix is removed from the name. |
+| **Include Cal File** | If TRUE, the model files will be modified as well. |
+| **Overwrite C3D File** | If TRUE, the modified C3D file will be saved over the current file on disk. **Use with caution**. It is recommended that the parameter be set to FALSE in most cases so that the new names can be verified. The files can then be exported in an independent command.|
-if the prefix parameter is left blank, visual3d looks for the c3d parameter group called "subjects" and the parameter "label_prefixes". this could contain several entries, and visual3d searches the targets for signals containing these names and the prefix is removed from the name.
+===== Example =====
-we have seen instances where the manufacturer stores these values incorrectly.
+Given a file with marker names
+  - MarkerSet_C7
+  - MarkerSet_L_ACR
+  - MarkerSet_L_CLAV
+  - MarkerSet_L_FARM_1
+  - MarkerSet_L_FARM_2
+  - MarkerSet_L_FARM_3
+  - etc.
-in this case, the user should manually specify the prefix and the c3d parameters are ignored.
+The prefix to be removed is: MarkerSet_. As with all commands, Remove_Prefix_From_Point_Labels acts on all [visual3d:documentation:definitions:active_files|active files], so ensure that you have selected the files you want modified.
-===== /include_cal_file =====
+<code>
+Remove_Prefix_From_Point_Labels
+/PREFIX=MarkerSet_
+! /INCLUDE_CAL_FILE=TRUE
+! /OVERWRITE_C3D_FILE=FALSE
+;
+</code>
-if true, the model files will be modified as well.
+The resulting TARGET names are:
+  - C7
+  - L_ACR
+  - L_CLAV
+  - L_FARM_1
+  - L_FARM_2
+  - L_FARM_3
+  - etc.
-===== /overwrite_c3d_file =====
+===== See Also =====
-if true, the modified c3d file will be exported.
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]
-use this parameter with caution. it is recommended that the parameter be set to false in most cases so that the new names can be verified. the files can then be exported in an independent command.
-===== example =====
-given a file with marker names
-markerset_c7
-markerset_l_acr
-markerset_l_clav
-markerset_l_farm_1
-markerset_l_farm_2
-markerset_l_farm_3
-etc
-the prefix to be removed is
-markerset_
-the command acts on all [active_files|active files], so ensure that you have selected the files you want modified.
-the command parameters are:
-**remove_prefix_from_point_labels**
-/prefix=markerset_
-! /include_cal_file=true
-! /overwrite_c3d_file=false
-**;**
-the result is:
-c7
-l_acr
-l_clav
-l_farm_1
-l_farm_2
-l_farm_3
-etc
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]