Differences

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

--- visual3d:documentation:pipeline:file_commands:merge_aurora_files [2024/06/19 12:50] – sgranger
+++ visual3d:documentation:pipeline:file_commands:merge_aurora_files [2026/04/27 16:01] (current) – [Notes] wikisysop
@@ Line 1: / Line 1: @@
-merges a set of ndi aurora files into a visual3d ascii file.
+====== Merge Aurora Files ======
+The **Merge Aurora Files** command merges a set of NDI Aurora files into a Visual3D ASCII file.
+====Pipeline Command====
+The command can be found in the Pipeline Workshop within the **File Open/Import** folder as so:
 <code>
-merge_aurora_files
+Merge_Aurora_Files
-! /input_file_names=
+! /INPUT_FILE_NAMES=
-! /output_file_name=
+! /OUTPUT_FILE_NAME=
-! /frame_rate=1000
+! /FRAME_RATE=1000
-! /units=cm
+! /UNITS=cm
+! /SET_PROMPT=Open Aurora files
 ;
 </code>
-wildcards (*) can be used for the input_file_names.
+====Command Parameters====
+The following table shows the command parameters seen above and their descriptions:
+^ Parameter ^ Description ^
+|**! /INPUT_FILE_NAME=**|Name of input file|
+|**! /OUTPUT_FILE_NAME=**|Name of file to be created|
+|**! /FRAME_RATE=**|Frame rate for both files|
+|**! /UNITS=**|Units to be used for file data|
+|**! /SET_PROMPT=**|Optional prompt message shown if no input file is selected. Defaults to 'Open Aurora Files'.|
+====Example: Open Aurora File from Prompt====
+The following code can be used to prompt the user to select an Aurora file with a frame rate of 540 fps and units of meters:
+<code>
+Merge_Aurora_Files
+! /INPUT_FILE_NAMES=
+/OUTPUT_FILE_NAME=OUTPUT_TEST
+/FRAME_RATE=540
+/UNITS=m
+/SET_PROMPT=Open Aurora files
+;
+</code>
+====Notes====
+Wildcards (*) can be used for the INPUT_FILE_NAMES, for example:
+<code>
+/INPUT_FILE_NAMES=*input_test*
+</code>
 \\
-[[visual3d:documentation:pipeline:general_information:pipeline_commands_reference|back to pipeline commands reference]]
+[[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]