Differences

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

--- visual3d:documentation:pipeline:other_commands:create_text_data [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:other_commands:create_text_data [2025/08/01 16:34] (current) – wikisysop
@@ Line 1: / Line 1: @@
-{{{{{{{{====== command ======
+====== Create Text Data ======
-create a signal that contains text instead of a number.
+===== Overview =====
-createtextdatadlg1.jpg
+The **Create_Text_Data** command is used to generate a text-based signal in Visual3D. Unlike standard numeric signals, this command allows a signal to be created where each frame contains text data instead of numeric values. This can be helpful for labeling data, embedding annotations, or tracking categorical information frame-by-frame in a trial.
-create_text_data
-/signal_folder=test
-/signal_name=hello
-/text_data=hello world!
-/text_file_name=
-! /prompt_on_empty=true
-**;**
-it is possible to specify **either** text_data or text_file_name but not both.
-/text_file_name refers to a the full pathname of a file on disk that will be read as a text string (e.g. an rtf file).
-\\
+===== Pipeline Command =====
-if /prompt_on_empty==true
+The command below is as seen in the Visual3D application. The parameters allow for customization of how the text signal is created"
-and the text box and filename edit box are empty
-the user is prompted for input.
-createtextdatadlg2.jpg
-example: given the dialog
+<code>
+Create_Text_Data
+/SIGNAL_FOLDER=
+/SIGNAL_NAMES=
+! /TEXT_DATA=
+! /TEXT_FILE_NAME=
+! /PROMPT_ON_EMPTY=TRUE
+;
+</code>
-createtextdatadlg3.jpg
+===== Command Parameters =====
+The following table outlines the available parameters and their functions.
+|**Parameter**|**Description**|
+|**/SIGNAL_FOLDER=**|The folder where the new text signal will be saved (e.g. PROCESSED)|
+|**/SIGNAL_NAMES=**|Name(s) of the signal(s) to be created.|
+|**! /TEXT_DATA=**|Inline text data to be inserted directly in the command.|
+|**! /TEXT_FILE_NAME=**| External text file to load the text data from (one entry per line)|
+|**! /PROMPT_ON_EMPTY=**|If TRUE, prompts the user to input data if no text or file is provided.|
+Note: Either /TEXT_DATA or /TEXT_FILE_NAME must be used. If neither is included, the user will be prompted manually during execution.
+===== Dialog =====
+The command can be edited either in the text editor or inj dialog form. To open the dialog, either double-click the command in the pipeline workshop or click 'Edit'.
+Below is the dialog box for the **Create_Text_Data** command:
+{{:visual3d:documentation:pipeline:other_commands:create_text_dlg.png?600|}}
+This dialog provides three different methods to supply text to the signal.
+  * Box 1: Displays and accepts input in RTF (Rich Text Format)
+  * Box 2: Displays and accepts input as plain formatted text.
+  * Box 3: Allows the user to browse and select an external text or RTF file to load.
+Additional Options
+  * Return with RTF Formatting: If selected, the contents of Box 1 will be used. This is useful if you are working with styled text.
+  * Return Text: Uses Box 2 (Plain Text) as the input source
+  * Return Filename: Uses the selected file path from Box 3 to load the contents of an external file.\
+If no text or file is provided, and the /PROMPT_ON_EMPTY=TRUE parameter is enabled, this dialog will appear during execution prompting the user to manually enter the text data.
+===== Examples =====
-the resulting signal in the workspace is:
-textitemsignal.jpg
-====== syntax issue ======
-consider the following:
-/text_data=08/09/2017 by wss speed = 0.4
-a forward slash (/) is a special character for pipeline commands that indicates that a parameter_name follows immediately afterwards.
-if an equals sign (=) follows visual3d confirms that a parameter was specified.
-two equals signs (==), however, does confirm that a parameter was specified.
-visual3d searches for an equals sign after each slash because this logically indicates that the user has specified a parameter.
-text_data is assigned the string 08/09
-visual3d finds an equals sign after the next slash, so interprets the rest of the string as a new parameter
-/2017 by mjt using modify_speed_metric_ver01 speed = 0.4
-it doesn't do anything with this parameter because it doesn't recognize it.
-solution
-remove the = sign
-/text_data=08/09/2017 by wss speed 0.4
-or specify two equals signs
-/text_data=08/09/2017 by wss speed == 0.4
-}}}}}}}}