Differences

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

--- visual3d:documentation:pipeline:plugins:optotrak [2024/06/19 12:52] – sgranger
+++ visual3d:documentation:pipeline:plugins:optotrak [2024/07/17 15:46] (current) – created sgranger
@@ Line 1: / Line 1: @@
-{{{{{{{{{{{{{{{{\\
+====== Optotrak ======
+\\
-===== import_optotrak_files =====
+==== Import_Optotrak_Files ====
-this plugin imports the motion capture data (c# file) and one of the 2 types of analog data (o1#, v1#) files.
+This plugin imports the motion capture data (C# file) and one of the 2 types of analog data (O1#, V1#) files.
 \\
-|**import_optotrak_files**  |the name of the c# file containing the motion capture data. if left blank, a dialog box appears to browse for the selected file.|
+|**Import_Optotrak_Files**  |The name of the C# file containing the motion capture data. If left blank, a dialog box appears to browse for the selected file.|
-|**/file_name=**            |the type of analog file to be merged with the c# file. choose only one of the following files v1#, o1#.                         |
+|**/File_Name=**            |The type of Analog file to be merged with the C# file. Choose only one of the following files V1#, O1#.                         |
-|**/analog_file_character=**|the name of the converted file. if left blank the resulting c3d file will contain the same prefix as the original file.         |
+|**/Analog_File_Character=**|The name of the converted file. If left blank the resulting c3d file will contain the same prefix as the original file.         |
-|**/converted_file_name=**  |specifies the point label names.                                                                                                |
+|**/Converted_File_Name=**  |Specifies the Point Label names.                                                                                                |
-|**/point_label=**          |                                                                                                                                |
+|**/Point_Label=**          |                                                                                                                                |
-|**/analog_label=**         |specifies the analog label names.                                                                                               |
+|**/Analog_Label=**         |Specifies the Analog Label names.                                                                                               |
-|**/analog_offset=**        |specifies the analog offset. for the v1# and o1# files this is usually zero.                                                    |
+|**/Analog_Offset=**        |Specifies the Analog Offset. For the V1# and O1# files this is usually zero.                                                    |
-|**/analog_scale=**         |specifies the analog scale. this is multiplied by the signal value to convert the signal to volts.                              |
+|**/Analog_Scale=**         |Specifies the Analog Scale. This is multiplied by the signal value to convert the signal to volts.                              |
-|**/ndo_filename=**         |specifies the ndo filename. the translater searches the ndo file for the names of the analog and point labels                   |
+|**/NDO_Filename=**         |Specifies the NDO filename. The translater searches the NDO file for the names of the ANALOG and POINT labels                   |
-===== importing from c# and v1# files =====
+==== Importing from C# and V1# Files ====
-importing c# and v1# optotrak files. the c# files contain the motion capture data. the v1# files contain synchronized analog data in which the data are stored in units of **volts.** the following pipeline command prompts the user for the c# file; the associated v1# files is loaded automatically and should not be selected by the user.
+Importing c# and v1# optotrak files. The c# files contain the motion capture data. The v1# files contain synchronized ANALOG data in which the data are stored in units of **VOLTS.** The following Pipeline Command prompts the user for the c# file; the associated v1# files is loaded automatically and should not be selected by the user.
-**import_optotrak_files**
+**Import_Optotrak_Files**
-**/file_name=**
+**/File_Name=**
-**/analog_file_character=**
+**/Analog_File_Character=**
 \\
-download the [[https://www.has-motion.com/download/examples/importoptotrak.zip|example files]]
+Download the [[https://www.has-motion.com/download/examples/ImportOptotrak.zip|example files]]
-launch visual3d, select the command pipeline dialog, and add the "import_optotrak_files" to the pipeline
+Launch Visual3D, select the command pipeline dialog, and add the "Import_Optotrak_Files" to the Pipeline
-optotrak1.gif\\
+{{:optotrak1.gif}}\\
-edit the command and change the analog file type to import the synchronized v1# files by setting the analog_file_character to v. the v1# files contain the analog data stored in units of volts
+Edit the command and change the ANALOG file type to import the synchronized v1# files by setting the ANALOG_FILE_CHARACTER to V. The v1# files contain the ANALOG data stored in units of volts
-**visual3d expects the v1# file to have a similar name to the c# file. e.g. c#001.dat and v1#001.dat.**
+**Visual3D expects the v1# file to have a similar name to the c# file. e.g. c#001.dat and v1#001.dat.**
-optotrak2.gif\\
+{{:optotrak2.gif}}\\
-execute the pipeline
+Execute the pipeline
-optotrak3.gif\\
+{{:optotrak3.gif}}\\
-a dialog will appear prompting you for the c# file. by default visual3d has a filter to select files that end in the extensions .dat. if your files have a different extension, select a different filter option in the dialog combo. do not select the v1# file as well, or you will get one c3d file containing the c# and v1# data, and another c3d file containing the v1# data alone.
+A dialog will appear prompting you for the C# file. By default Visual3D has a filter to select files that end in the extensions .dat. If your files have a different extension, select a different filter option in the dialog combo. Do not select the V1# file as well, or you will get one C3D file containing the C# and V1# data, and another C3D file containing the V1# data alone.
-optotrak4.gif\\
+{{:optotrak4.gif}}\\
-the resulting c3d file will be loaded into the visual3d workspace automatically. the .dat files can be backed up because from this point forward, only the c3d files will be needed.
+The resulting c3d file will be loaded into the Visual3D Workspace automatically. The .dat files can be backed up because from this point forward, only the c3d files will be needed.
-===== the default scale factors for the analog data =====
+==== The default scale factors for the ANALOG Data ====
-for ndi's odau there are two ways of storing the analog data. the o1# files store the data in computer units; a scale factor must be specified that scales the data to units of volts. the v1# files store the data in volts and the scale factors should therefore be 1.
+For NDI's ODAU there are two ways of storing the ANALOG data. The O1# files store the data in computer units; a scale factor must be specified that scales the data to units of volts. The V1# files store the data in volts and the scale factors should therefore be 1.
-prior to december 22, 2005, if no scale factors were included in the visual3d command, a fairly strange (at least to us now) default scale factor was used. in retrospect, it appears that we were saving one of our early customers some effort by selecting a default scale factor that suited his o1# data.
+Prior to December 22, 2005, if no SCALE factors were included in the Visual3D Command, a fairly strange (at least to us now) default SCALE factor was used. In retrospect, it appears that we were saving one of our early customers some effort by selecting a default SCALE factor that suited his O1# data.
-for example, **analog:scale** for scaling a/d data to volts.
+For example, **ANALOG:SCALE** for scaling A/D data to volts.
-analogscalefactor.gif\\
+{{:analogScaleFactor.gif}}\\
-analog12bit.gif\\
+{{:analog12bit.gif}}\\
-analog16bit.gif\\
+{{:analog16bit.gif}}\\
-the scaling parameter stored in the c3d file for a type 2 force platform would be:
+The Scaling parameter stored in the C3D file for a Type 2 force platform would be:
-analogscale.gif\\
+{{:analogScale.gif}}\\
-this customer had 16 bit analog data, an amplifier gain of 4000, and an excitation voltage of 10. the resulting scale factor for converting from computer units to volts is:\\
+This customer had 16 bit ANALOG data, An Amplifier Gain of 4000, and an Excitation Voltage of 10. The resulting SCALE factor for converting from computer units to volts is:\\
 **0.007629395**
-using this value makes sense for this customer.
+Using this value makes sense for this customer.
-**if, however, a customer elects to use the default scale factor (e.g. by not entering the scale factors) the resulting scale is probably wrong.**
+**If, however, a customer elects to use the default scale factor (e.g. by not entering the scale factors) the resulting scale is probably wrong.**
-therefore, on december 22, 2005, we modified the import_optotrak plugin to set the default scale factors
+Therefore, on December 22, 2005, we modified the Import_Optotrak plugin to set the default scale factors
-  * for the v1# files to 1
+  * for the V1# files to 1
-  * for the o1# files to 0.000305175.
+  * for the O1# files to 0.000305175.
-===== frequently asked questions =====
+==== Frequently Asked Questions ====
-==== file extensions ====
+=== File extensions ===
-importing optotrak files only allows me to import files with the extension *.dat. i have different file extensions for every subject, such as *.f01, *.f02, etc.
+Importing OptoTrak files only allows me to import files with the extension *.dat. I have different file extensions for every subject, such as *.f01, *.f02, etc.
-there isn't actually a restriction on the extensions. by default the browse dialog displays .dat files. a second option for .trl files also exists in the dialog. for other extensions simple select files of type *.*.
+There isn't actually a restriction on the extensions. By default the Browse Dialog displays .dat files. A second option for .trl files also exists in the dialog. For other extensions simple select files of type *.*.
-note that if your file extensions are different between subjects, but the prefix to the files names is the same (e.g. trial1.f01, trial1.f02) you will need to make sure that data from different subjects is saved to different folders because the import command strips off the extension and replaces it with .c3d.
+Note that if your file extensions are different between subjects, but the prefix to the files names is the same (e.g. trial1.f01, trial1.f02) you will need to make sure that data from different subjects is saved to different folders because the import command strips off the extension and replaces it with .c3d.
-==== file size ====
+=== File Size ===
-i can import my shorter optotrak files (collected for 10s at 100hz for optotrak). however, the larger trials (collected for 50s at 100hz for optotrak) the program either crashes or comes up with an error. is there a limit on the file size?
+I can import my shorter optotrak files (collected for 10s at 100Hz for Optotrak). However, the larger trials (collected for 50s at 100Hz for Optotrak) the program either crashes or comes up with an error. Is there a limit on the file size?
-the c3d file format has a limit of 32k frames of data because the point:frames parameter is traditionally a signed integer. visual3d was modified in version 3.0 to treat the point:frames parameter as a unsigned integer, which increases the number of frames to 64k.
+The C3D File format has a limit of 32K frames of data because the POINT:FRAMES parameter is traditionally a SIGNED INTEGER. Visual3D was modified in Version 3.0 to treat the POINT:FRAMES parameter as a UNSIGNED INTEGER, which increases the number of frames to 64K.
-in visual3d beta version 3.0 we modified the c3d reader to accept a new parameter
+In Visual3D Beta version 3.0 we modified the C3D reader to accept a new parameter
 \\
-**point:long_frames** the parameter is a float that contains the number of frames. if this parameter exists, it takes precedence over the point:frames parameter.
+**POINT:LONG_FRAMES** The parameter is a FLOAT that contains the number of frames. If this parameter exists, it takes precedence over the POINT:FRAMES parameter.
+=== Changing the default TARGET names. ===
-==== changing the default target names. ====
+The C# and V# files created by Northern Digital software do not contain names for the signals stored. Data that are collecting in NDI's Toolbench software use a .ndo file (an ASCII file in a standard .ini format) to store information.
-the c# and v# files created by northern digital software do not contain names for the signals stored. data that are collecting in ndi's toolbench software use a .ndo file (an ascii file in a standard .ini format) to store information.
+Signal information is usually stored in the .ndo file. For example, a typical .ndo file should contain lines similar to the following.
-signal information is usually stored in the .ndo file. for example, a typical .ndo file should contain lines similar to the following.
+[Marker 1]
-[marker 1]
+MarkerName=3020_Strober_Adapter_M001\\
+FOR=-1\\
+Visible=TRUE\\
+RawView=0
-markername=3020_strober_adapter_m001\\
+The .ndo file can be modified by the user without disturbing the Toolbench software. The following modification to this section will cause Visual3D to use the MarkerLabel parameter to name the signal in the c3d file during the import of the data.
-for=-1\\
-visible=true\\
-rawview=0
-the .ndo file can be modified by the user without disturbing the toolbench software. the following modification to this section will cause visual3d to use the markerlabel parameter to name the signal in the c3d file during the import of the data.
+[Marker 1]
-[marker 1]
+MarkerName=3020_Strober_Adapter_M001\\
+MarkerLabel=R.THIGH1\\
+FOR=-1\\
+Visible=TRUE\\
+RawView=0
-markername=3020_strober_adapter_m001\\
+A typical Visual3D optotrak import command would look like the following:
-markerlabel=r.thigh1\\
-for=-1\\
-visible=true\\
-rawview=0
-a typical visual3d optotrak import command would look like the following:
+**Import_Optotrak_Files**\\
+! /FILE_NAME=\\
+! /ANALOG_FILE_CHARACTER=O\\
+! /CONVERTED_FILE_NAME=\\
+! /POINT_LABEL=\\
+! /ANALOG_LABEL=\\
+! /ANALOG_OFFSET=\\
+! /ANALOG_SCALE=\\
+/NDO_FILENAME=c:Visual3DExampleoptotrak.ndo **;**
-**import_optotrak_files**\\
+This command will prompt the user for the C# files, will use the default parameters, and will use the optotrak.ndo file for specifying the signal names.
-! /file_name=\\
-! /analog_file_character=o\\
-! /converted_file_name=\\
-! /point_label=\\
-! /analog_label=\\
-! /analog_offset=\\
-! /analog_scale=\\
-/ndo_filename=c:visual3dexampleoptotrak.ndo **;**
-this command will prompt the user for the c# files, will use the default parameters, and will use the optotrak.ndo file for specifying the signal names.
+**Note that the full filename (including path) for the .ndo file must be used.**
-**note that the full filename (including path) for the .ndo file must be used.**
-}}}}}}}}}}}}}}}}