visual3d:documentation:pipeline:file_commands:file_rename
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | |||
visual3d:documentation:pipeline:file_commands:file_rename [2024/07/17 15:45] – created sgranger | visual3d:documentation:pipeline:file_commands:file_rename [2025/07/25 15:09] (current) – wikisysop | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== File Rename ====== | ====== File Rename ====== | ||
- | \\ | + | ===== Overview ===== |
- | Renames the specified file(s). This can also be done manually by going to File-> | + | |
- | |< | + | The **File_Rename** command in Visual3D is used to rename one or more existing C3D files in the workspace. This command is especially helpful when automating naming conventions for large datasets or batch-processing files across multiple subjects or trials. |
- | \\ | + | This is equivalent to selecting **File > Rename** from the Visual3D application menu. The command provides flexible renaming options, including the ability to use Search/ |
+ | ===== Pipeline Command ===== | ||
- | === Parameters === | + | The command below is as seen on the Visual3D application, |
- | * **EXISTING_FILE_NAME: | + | < |
- | * **NEW_FILE_NAME:** If renaming an individual C3D file, the new name can be specified here\\ | + | File_Rename |
+ | ! / | ||
+ | ! /NEW_FILE_NAME= | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ! / | ||
+ | ; | ||
+ | </ | ||
- | * **USE_SEARCH_REPLACE: | + | ===== Command Parameters ===== |
- | * **SEARCH_FOR: | + | The following table shows the command |
- | | + | |**Parameter**|**Description**| |
+ | |**! / | ||
+ | |**! / | ||
+ | |**! / | ||
+ | |**! / | ||
+ | |**! / | ||
+ | |**! / | ||
+ | |**! / | ||
- | * **REMOVE_FILE_PATH: | + | ===== Dialog ===== |
- | **NOTE:** Since users use similar naming conventions for C3D files, Visual3D stores | + | The command can be edited in the text editor, or in dialog form. To edit in the dialog, either click on the Edit button in the pipeline workshop or double-click on the pipeline command. The dialog is shown below: |
- | * **RENAME_STATIC_CALIBRATION_FILES:**Specify TRUE or FALSE to also perform search/ | + | {{:visual3d: |
+ | * **Existing File(s)**: Dropdown to select a specific file or ALL_FILES. | ||
+ | * **New File Name**: Used to rename one file to a new fixed name. | ||
+ | * **Remove File Paths**: Options to strip the full file path from the file reference in workspace. | ||
+ | * **Rename using Search/ | ||
+ | * **Search For/Replace With**: Provide the substring to search and the new text to replace it with. | ||
+ | * **Also Rename Static Calibration Files**: Ensures associated calibration files are renamed accordingly. | ||
- | === Example1: Search/ | + | ===== Examples ===== |
- | The search/ | + | The following example will go through |
- | In the following | + | ==== Example 1: Search/ |
+ | |||
+ | This example | ||
+ | |||
+ | Assume you have files named like **Sub01_Walk001.c3d, Sub01_Walk002.c3d, | ||
< | < | ||
File_Rename | File_Rename | ||
- | ! / | + | / |
- | ! / | + | / |
/ | / | ||
/ | / | ||
/ | / | ||
- | ! / | + | / |
- | ! / | + | / |
; | ; | ||
</ | </ | ||
- | \\ | + | This command scans all loaded files, finds any filenames containing WALK and replaces that portion with " |
+ | |||
+ | ===== Notes ===== | ||
+ | * This command only renames files inside the Visual3D workspace. If you want to rename physical files on disk, that must be handled externally. | ||
+ | |||
+ | |||
+ | ---- | ||
[[Visual3D: | [[Visual3D: | ||
visual3d/documentation/pipeline/file_commands/file_rename.txt · Last modified: 2025/07/25 15:09 by wikisysop