HAS-Motion Software Documentation

User Tools

Site Tools

You are here: Main Page » visual3d » tutorials » knowledge_discovery » Looking at Large Public Data Sets
visual3d:tutorials:knowledge_discovery:looking_at_large_public_data_sets

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
visual3d:tutorials:knowledge_discovery:looking_at_large_public_data_sets [2024/06/19 12:54] – sgrangervisual3d:tutorials:knowledge_discovery:looking_at_large_public_data_sets [2024/07/17 15:46] (current) – created sgranger
Line 1: Line 1:
-{{{{{{biomechanics is coming into a new age, where large datasets are the norm and individually processing the files can be tiresome and time consuming. captured over long periods of time, datasets can be inconsistent, which makes it difficult to automate working with them.+====== Looking at Large Public Data Sets  ======
  
-in this tutorial, we will be going through common issues seen while working with large public biomechanics datasets, through the use of a large dataset released which tracks the full body gait of both stroke survivors and able-bodied participants.+Biomechanics is coming into a new age, where large datasets are the norm and individually processing the files can be tiresome and time consuming. Captured over long periods of time, datasets can be inconsistent, which makes it difficult to automate working with them.
  
-sections highlighted like this show when actions should be performed, if you are following along with the tutorial.+In this tutorial, we will be going through common issues seen while working with large public biomechanics datasets, through the use of a large dataset released which tracks the full body gait of both stroke survivors and able-bodied participants.
  
 +Sections highlighted like this show when actions should be performed, if you are following along with the tutorial.
  
-===== large datasets ===== 
  
-the dataset used for this tutorial is the raw motion data collected by (van criekinge et al [[https://www.nature.com/articles/s41597-023-02767-y|[1]]]), which includes the full-body motion capture gait of 138 able-bodied adult participants and 50 stroke survivors. they include full body kinematics (pig model), kinetics, and emg data across a wide variety of ages, heights and weights. this is an open sourced dataset, which allows for free and open science, supports the growing bio-mechanical research community and increases the ability for scientists to duplicate results of tests.+==== Large Datasets ====
  
-this dataset is unique in its size and quality for an open source dataset. large datasets are essential for scientific observations to be able to accurately draw conclusions, and are becoming the norm within the bio-mechanical community. because of their nature as large collections of data, there are often unique problems relating to working with such datasets, which is to be explored here. datasets such as these can be generated over a long period of time, where people, standards or equipment may change. large datasets can also be the culmination of several different projects, which further leads to inconsistencies. the most frequent issues we found were due to inconsistencies within the measured dataset: it can be difficult to keep a rigid structure to any large dataset, but inconsistencies can wreck the ability to automate tasks, so we’ll show how you can effectively process the data in large datasets like this.+The dataset used for this tutorial is the raw motion data collected by (Van Criekinge et al [[https://www.nature.com/articles/s41597-023-02767-y|[1]]]), which includes the full-body motion capture gait of 138 able-bodied adult participants and 50 stroke survivors. They include Full Body Kinematics (PiG Model), Kinetics, and EMG Data across a wide variety of ages, heights and weights. This is an open sourced dataset, which allows for free and open science, supports the growing bio-mechanical research community and increases the ability for scientists to duplicate results of tests.
  
-===== dataset =====+This dataset is unique in its size and quality for an open source dataset. Large datasets are essential for scientific observations to be able to accurately draw conclusions, and are becoming the norm within the bio-mechanical community. Because of their nature as large collections of data, there are often unique problems relating to working with such datasets, which is to be explored here. Datasets such as these can be generated over a long period of time, where people, standards or equipment may change. Large datasets can also be the culmination of several different projects, which further leads to inconsistencies. The most frequent issues we found were due to inconsistencies within the measured dataset: it can be difficult to keep a rigid structure to any large dataset, but inconsistencies can wreck the ability to automate tasks, so we’ll show how you can effectively process the data in large datasets like this.
  
-the dataset used for able-bodied participants is available [[https://springernature.figshare.com/articles/dataset/c3d_files_of_3d_full-body_gait_kinematics_kinetics_and_emg_of_138_able-bodied_adults/24192480?backto=/collections/a_full-body_motion_capture_gait_dataset_of_138_able-bodied_adults_across_the_life_span_and_50_stroke_survivors/6503791|here]], while the dataset used for stroke survivors is available [[https://springernature.figshare.com/articles/dataset/c3d_files_of_3d_full-body_gait_kinematics_kinetics_and_emg_of_50_adults_with_stroke/24192483?backto=/collections/a_full-body_motion_capture_gait_dataset_of_138_able-bodied_adults_across_the_life_span_and_50_stroke_survivors/65037911|here]] (also contains **subjectchar.xlsx**, an excel file with survivors parameters).+==== Dataset ====
  
-the authors have made an already-processed dataset available for use, but for the purposes of this tutorial, we shall be using the original, raw data.+The dataset used for able-bodied participants is available [[https://springernature.figshare.com/articles/dataset/c3d_files_of_3D_full-body_gait_kinematics_kinetics_and_EMG_of_138_able-bodied_adults/24192480?backTo=/collections/A_full-body_motion_capture_gait_dataset_of_138_able-bodied_adults_across_the_life_span_and_50_stroke_survivors/6503791|here]], while the dataset used for stroke survivors is available [[https://springernature.figshare.com/articles/dataset/c3d_files_of_3D_full-body_gait_kinematics_kinetics_and_EMG_of_50_adults_with_stroke/24192483?backTo=/collections/A_full-body_motion_capture_gait_dataset_of_138_able-bodied_adults_across_the_life_span_and_50_stroke_survivors/65037911|here]] (also contains **SubjectChar.xlsx**, an excel file with survivors parameters).
  
-please find all of the needed pipeline and model files [[https://www.has-motion.com/download/examples/processinglargedatasets/tutorial%20-%20looking%20at%20large%20public%20datasets.zip|here]].+The authors have made an already-processed dataset available for use, but for the purposes of this tutorial, we shall be using the original, raw data.
  
 +Please find all of the needed pipeline and model files [[https://www.has-motion.com/download/examples/ProcessingLargeDataSets/Tutorial%20-%20Looking%20at%20Large%20Public%20Datasets.zip|here]].
  
-===== file naming conventions ===== 
  
-a common inconsistency in large datasets can be the usage of filenames. filenames should convey information about a file in a manner that can be easily referenced, eg: calibration files should be named differently from motion files so that they can be separated, and motion files should have a trial number in their file name (if applicable), etc.+==== File Naming Conventions ====
  
-in this dataset, we found inconsistencies within filenames, as well as an error relating to the file name. particularly within the stroke survivors, there was no consistent naming convention across all of the motion files, other than all including the letters “bwa”. how the trialnumber was conveyed was done in a variety of different methods, including separating with spaces, underscores or nothing, as well as prepending a “0” to the trial number. ultimately this forces the user to use wildcards to collect all the motion files at once, and limits their ability to individually select motion files.+A common inconsistency in large datasets can be the usage of filenames. Filenames should convey information about a file in a manner that can be easily referenced, eg: calibration files should be named differently from motion files so that they can be separated, and motion files should have a trial number in their file name (if applicable), etc.
  
-there are several files which need to be altered or deleted:+In this dataset, we found inconsistencies within filenames, as well as an error relating to the file name. Particularly within the stroke survivors, there was no consistent naming convention across all of the motion files, other than all including the letters “BWA”. How the trialnumber was conveyed was done in a variety of different methods, including separating with spaces, underscores or nothing, as well as prepending a “0” to the trial number. Ultimately this forces the user to use wildcards to collect all the motion files at once, and limits their ability to individually select motion files. 
 + 
 +There are several files which need to be altered or deleted:
  
 \\ \\
  
  
-stroke survivor 47 (tvc47) has a mislabeled calibration file. this must be renamed from “bwa (0).c3d” to something following their calibration conventions, such as “tvc-47 cal 0.c3d”.+Stroke Survivor 47 (TVC47) has a mislabeled calibration file. This must be renamed from “BWA (0).c3d” to something following their calibration conventions, such as “TVC-47 Cal 0.c3d”.
  
  
Line 38: Line 40:
  
  
-stroke survivor 38 (tvc38) does not have a valid calibration file. the corresponding folder should be deleted (tvc38).+Stroke Survivor 38 (TVC38) does not have a valid calibration file. The corresponding folder should be deleted (TVC38).
  
  
Line 44: Line 46:
  
  
-able-bodied participants 37 (subj37), 42 (subj42), and 118-138 (subj118-subj138) follow a different model to mark the pelvis, or are missing necessary data. the corresponding folders should be deleted (subj38, subj42, subj118-subj138)+Able-Bodied Participants 37 (SUBJ37), 42 (SUBJ42), and 118-138 (SUBJ118-SUBJ138) follow a different model to mark the pelvis, or are missing necessary data. The corresponding folders should be deleted (SUBJ38, SUBJ42, SUBJ118-SUBJ138)
  
  
-===== building models =====+==== Building Models ====
  
-the data set used the plug in gait marker set, unfortunately not all that standard plug in gait markers were used for example the right and left upper arm markers were missing, so only a model of the lower body can be made, see the tutorial [[https://www.c-motion.com/v3dwiki/index.php?title=tutorial:_plug-in_gait_lower-limb|here]] to walk through the process of making a lower body plug in gait model.+The data set used the Plug in Gait marker set, unfortunately not all that standard Plug in Gait markers were used for example the right and left upper arm markers were missing, so only a model of the lower body can be made, see the tutorial [[https://www.c-motion.com/v3dwiki/index.php?title=Tutorial:_Plug-In_Gait_Lower-Limb|here]] to walk through the process of making a lower body plug in gait model.
  
-the subset of able-bodied participants used in this tutorial has three markers for the pelvis as opposed to the four used for the stroke survivors; two separate models need to be made. the default values provided in the tutorial can be used to build the models, as the subject data will be entered in via the processing pipeline.+The subset of able-bodied participants used in this tutorial has three markers for the pelvis as opposed to the four used for the stroke survivors; two separate models need to be made. The default values provided in the tutorial can be used to build the models, as the subject data will be entered in via the processing pipeline.
  
-for the stroke survivors, it is important to build the original model without any subject-prefixes (managed later in this tutorial). participant 58 should be used for this, as their calibration file does not have any attached subject-prefixes in the raw data.+For the Stroke Survivors, it is important to build the original model without any subject-prefixes (managed later in this tutorial). Participant 58 should be used for this, as their calibration file does not have any attached subject-prefixes in the raw data.
  
-the respective models we used have been provided in this tutorials files: **stroke_model.mdh** and **healthy_model.mdh**.+The respective models we used have been provided in this tutorials files: **stroke_model.mdh** and **healthy_model.mdh**.
  
  
-===== inconsistent subject prefixes (stroke survivors) =====+==== Inconsistent Subject Prefixes (Stroke Survivors) ====
  
-most of the markers within the static files provided are prefixed with the subject id, however the dynamic file markers are not, this will prevent the built model from linking with the dynamic markers. to begin, we will ensure that all static files include a subject-prefix, and then we will prepend these to the markers within the dynamic files.\\ +Most of the markers within the static files provided are prefixed with the subject ID, however the dynamic file markers are not, this will prevent the built model from linking with the dynamic markers. To begin, we will ensure that all static files include a subject-prefix, and then we will prepend these to the markers within the dynamic files.\\ 
-**static file marker:**\\ +**Static file marker:**\\ 
-stroke_model_prefix.png\\ +{{:stroke_model_prefix.png}}\\ 
-**dynamic file marker:**\\ +**Dynamic file marker:**\\ 
-stroke_dynamic_no_prefix.png+{{:stroke_dynamic_no_prefix.png}}
  
-stroke survivors 47 and 58 (tvc47 and tvc58) are both missing subject prefixes. to rectify, run the pipeline file **add_calibration_prefixes.v3s** once for each of these stroke survivors, changing the "/folder" section of the pipeline parameter "set_pipeline_parameter_to_list_of_files" to the folder containing each stroke survivors files (tvc47 and tvc58).+Stroke Survivors 47 and 58 (TVC47 and TVC58) are both missing subject prefixes. To rectify, run the pipeline file **add_calibration_prefixes.v3s** once for each of these stroke survivors, changing the "/FOLDER" section of the pipeline parameter "Set_Pipeline_Parameter_To_List_Of_Files" to the folder containing each stroke survivors files (TVC47 and TVC58).
  
  
-the pipeline "convert_subject_prefix_stroke.v3s" can be used to prepend the subject ids to all the marker points in the dynamic files. the subject id is stored in the parameters::subjects::names signal within the dynamic files, however they use a dash instead of an underscore, “bwa-2” vs “bwa_2” these still wont match. string expressions can be used to convert the subject id strings to match the static files.+The pipeline "convert_subject_prefix_stroke.v3s" can be used to prepend the subject IDs to all the marker points in the dynamic files. The subject ID is stored in the PARAMETERS::SUBJECTS::NAMES signal within the dynamic files, however they use a dash instead of an underscore, “BWA-2” vs “BWA_2” these still wont match. String expressions can be used to convert the subject ID strings to match the static files.
  
-run the pipeline **convert_subject_prefix_stroke.v3s**, and select the folder containing the stroke survivors (50_strokepig) when prompted.+Run the pipeline **convert_subject_prefix_stroke.v3s**, and select the folder containing the stroke survivors (50_StrokePiG) when prompted.
  
  
-below is an explanation of the important sections of the file "convert_subject_prefix_stroke.v3s".+Below is an explanation of the important sections of the file "convert_subject_prefix_stroke.v3s".
  
-**set a pipeline parameter to a list of all dynamic files contained in the "50_stroke_pig":**\\ +**Set a pipeline parameter to a list of all dynamic files contained in the "50_Stroke_PiG":**\\ 
-''%% set_pipeline_parameter_to_folder_path%%''\\ +''%% Set_Pipeline_Parameter_To_Folder_Path%%''\\ 
-''%%/parameter_name=folder%%''\\ +''%%/PARAMETER_NAME=FOLDER%%''\\ 
-''%%! /parameter_value=visual3d_default_data_folder%%''\\ +''%%! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER%%''\\ 
-''%%! /from_motion_file_in_workspace=%%''\\ +''%%! /FROM_MOTION_FILE_IN_WORKSPACE=%%''\\ 
-''%%! /parameter_value_search_for=%%''\\ +''%%! /PARAMETER_VALUE_SEARCH_FOR=%%''\\ 
-''%%! /parameter_value_replace_with=%%''\\ +''%%! /PARAMETER_VALUE_REPLACE_WITH=%%''\\ 
-''%%! /parameter_value_append=%%''\\ +''%%! /PARAMETER_VALUE_APPEND=%%''\\ 
-''%%! /set_prompt=select a directory%%''\\ +''%%! /SET_PROMPT=Select a directory%%''\\ 
-''%%! /alphabetize=true%%''\\+''%%! /ALPHABETIZE=TRUE%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%set_pipeline_parameter_to_list_of_files%%''\\ +''%%Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=dynamic_files%%''\\ +''%%/PARAMETER_NAME=DYNAMIC_FILES%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%/search_subfolders=true%%''\\ +''%%/SEARCH_SUBFOLDERS=TRUE%%''\\ 
-''%%/file_mask=*bwa*.c3d%%''\\ +''%%/FILE_MASK=*BWA*.c3d%%''\\ 
-''%%/alphabetize=false%%''\\ +''%%/ALPHABETIZE=FALSE%%''\\ 
-''%%! /return_folder_names=false%%''\\+''%%! /RETURN_FOLDER_NAMES=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**loop through all dynamic files:**\\ +**Loop through all dynamic files:**\\ 
-''%% for_each%%''\\ +''%% For_Each%%''\\ 
-''%%/iteration_parameter_name=dynamic_file%%''\\ +''%%/ITERATION_PARAMETER_NAME=DYNAMIC_FILE%%''\\ 
-''%%! /iteration_parameter_count_name=%%''\\ +''%%! /ITERATION_PARAMETER_COUNT_NAME=%%''\\ 
-''%%/items=::dynamic_files%%''\\+''%%/ITEMS=::DYNAMIC_FILES%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**open the current file:**\\ +**Open the current file:**\\ 
-''%% file_open%%''\\ +''%% File_Open%%''\\ 
-''%%/file_name=::dynamic_file%%''\\ +''%%/FILE_NAME=::DYNAMIC_FILE%%''\\ 
-''%%! /file_path=%%''\\ +''%%! /FILE_PATH=%%''\\ 
-''%%! /suffix=%%''\\ +''%%! /SUFFIX=%%''\\ 
-''%%! /set_prompt=file_open%%''\\ +''%%! /SET_PROMPT=File_Open%%''\\ 
-''%%! /on_file_not_found=prompt%%''\\ +''%%! /ON_FILE_NOT_FOUND=PROMPT%%''\\ 
-''%%! /file_types_on_prompt=%%''\\+''%%! /FILE_TYPES_ON_PROMPT=%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get the participant id from parameters:subject:names**\\ +**Get the Participant ID from PARAMETERS:SUBJECT:NAMES**\\ 
-''%% set_pipeline_parameter_to_data_value%%''\\ +''%% Set_Pipeline_Parameter_To_Data_Value%%''\\ 
-''%%/signal_types=parameters%%''\\ +''%%/SIGNAL_TYPES=PARAMETERS%%''\\ 
-''%%/signal_folder=subjects%%''\\ +''%%/SIGNAL_FOLDER=SUBJECTS%%''\\ 
-''%%/signal_names=names%%''\\ +''%%/SIGNAL_NAMES=NAMES%%''\\ 
-''%%! /signal_components=all_components%%''\\ +''%%! /SIGNAL_COMPONENTS=ALL_COMPONENTS%%''\\ 
-''%%/parameter_name=subject_id%%''\\+''%%/PARAMETER_NAME=SUBJECT_ID%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get the preceding half of the participant id using the string_left expression, since all ids begin with bwa we can hard code the index value:**\\ +**Get the preceding half of the Participant ID using the STRING_LEFT expression, since all IDs begin with BWA we can hard code the index value:**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=left_subject_id%%''\\ +''%%/PARAMETER_NAME=LEFT_SUBJECT_ID%%''\\ 
-''%%/expression=string_left("&::subject_id&",3)%%''\\ +''%%/EXPRESSION=STRING_LEFT("&::SUBJECT_ID&",3)%%''\\ 
-''%%/as_integer=false%%''\\+''%%/AS_INTEGER=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get the length of the participant id using the string_length expression:**\\ +**Get the length of the participant id using the STRING_LENGTH expression:**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=subject_id_length%%''\\ +''%%/PARAMETER_NAME=SUBJECT_ID_LENGTH%%''\\ 
-''%%/expression=string_length("&::subject_id&")%%''\\ +''%%/EXPRESSION=STRING_LENGTH("&::SUBJECT_ID&")%%''\\ 
-''%%! /as_integer=true%%''\\+''%%! /AS_INTEGER=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get the index of the dash using the string_find expression**\\ +**Get the index of the dash using the STRING_FIND expression**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=dash_index%%''\\ +''%%/PARAMETER_NAME=DASH_INDEX%%''\\ 
-''%%/expression=string_find("&::subject_id&","-",0)%%''\\ +''%%/EXPRESSION=STRING_FIND("&::SUBJECT_ID&","-",0)%%''\\ 
-''%%! /as_integer=true%%''\\+''%%! /AS_INTEGER=TRUE%%''\\
 ''%%; %%'' ''%%; %%''
  
 \\ \\
-**subtract the dash_index from subject_id_length to get the negative index of the dash, subtract that value by one to get the value needed for string_right (the negative index of the character immediately following the dash):**\\ +**Subtract the DASH_INDEX from SUBJECT_ID_LENGTH to get the negative index of the dash, subtract that value by one to get the value needed for STRING_RIGHT (the negative index of the character immediately following the dash):**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=right_subject_id%%''\\ +''%%/PARAMETER_NAME=RIGHT_SUBJECT_ID%%''\\ 
-''%%/expression=string_right("&::subject_id&",&::dash_negative_index&)%%''\\ +''%%/EXPRESSION=STRING_RIGHT("&::SUBJECT_ID&",&::DASH_NEGATIVE_INDEX&)%%''\\ 
-''%%!/as_integer=false%%''\\+''%%!/AS_INTEGER=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get the characters in the subject id following the dash using string_right:**\\ +**Get the characters in the subject id following the dash using STRING_RIGHT:**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=right_subject_id%%''\\ +''%%/PARAMETER_NAME=RIGHT_SUBJECT_ID%%''\\ 
-''%%/expression=string_right("&::subject_id&",&::dash_negative_index&)%%''\\ +''%%/EXPRESSION=STRING_RIGHT("&::SUBJECT_ID&",&::DASH_NEGATIVE_INDEX&)%%''\\ 
-''%%!/as_integer=false%%''\\+''%%!/AS_INTEGER=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**concatenate left_subject_id and right_subject_id with an underscore between them:**\\ +**Concatenate LEFT_SUBJECT_ID and RIGHT_SUBJECT_ID with an underscore between them:**\\ 
-''%% set_pipeline_parameter%%''\\ +''%% Set_Pipeline_Parameter%%''\\ 
-''%%/parameter_name=subject_id_converted%%''\\ +''%%/PARAMETER_NAME=SUBJECT_ID_CONVERTED%%''\\ 
-''%%/parameter_value=_%%''\\ +''%%/PARAMETER_VALUE=_%%''\\ 
-''%%! /parameter_value_search_for=%%''\\ +''%%! /PARAMETER_VALUE_SEARCH_FOR=%%''\\ 
-''%%! /parameter_value_replace_with=%%''\\ +''%%! /PARAMETER_VALUE_REPLACE_WITH=%%''\\ 
-''%%/parameter_value_prefix=::left_subject_id%%''\\ +''%%/PARAMETER_VALUE_PREFIX=::LEFT_SUBJECT_ID%%''\\ 
-''%%/parameter_value_append=::right_subject_id%%''\\ +''%%/PARAMETER_VALUE_APPEND=::RIGHT_SUBJECT_ID%%''\\ 
-''%%! /multi_pass=false%%''\\+''%%! /MULTI_PASS=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get a list of all target names**\\ +**Get a list of all target names**\\ 
-''%% set_pipeline_parameter_to_list_of_signal_names%%''\\ +''%% Set_Pipeline_Parameter_To_List_Of_Signal_Names%%''\\ 
-''%%/parameter_name=targets%%''\\ +''%%/PARAMETER_NAME=TARGETS%%''\\ 
-''%%/signal_types=target%%''\\ +''%%/SIGNAL_TYPES=TARGET%%''\\ 
-''%%signal_folder=original%%''\\+''%%SIGNAL_FOLDER=ORIGINAL%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**using the updated subject id and the list of target names, use the modify participants parameters pipeling function the add the neeeded subject prefixes, ensuring overwrite_c3d_file is set to true so the changes are preserved:**\\ +**Using the updated subject ID and the list of target names, use the modify participants parameters pipeling function the add the neeeded subject prefixes, ensuring OVERWRITE_C3D_FILE is set to true so the changes are preserved:**\\ 
-''%% modify_c3d_subjects_parameters%%''\\ +''%% Modify_C3D_Subjects_Parameters%%''\\ 
-''%%! /include_cal_file=true%%''\\ +''%%! /INCLUDE_CAL_FILE=TRUE%%''\\ 
-''%%/is_static=0%%''\\ +''%%/IS_STATIC=0%%''\\ 
-''%%/subjects_uses_prefixes=1%%''\\ +''%%/SUBJECTS_USES_PREFIXES=1%%''\\ 
-''%%! /remove_existing_label_prefixes=true%%''\\ +''%%! /REMOVE_EXISTING_LABEL_PREFIXES=TRUE%%''\\ 
-''%%! /remove_existing_prefix_parameters=false%%''\\ +''%%! /REMOVE_EXISTING_PREFIX_PARAMETERS=FALSE%%''\\ 
-''%%/subjects_label_prefixes=::subject_id_converted%%''\\ +''%%/SUBJECTS_LABEL_PREFIXES=::SUBJECT_ID_CONVERTED%%''\\ 
-''%%/prefix_markers=::targets%%''\\ +''%%/PREFIX_MARKERS=::TARGETS%%''\\ 
-''%%! /prefix_rotations=%%''\\ +''%%! /PREFIX_ROTATIONS=%%''\\ 
-''%%! /prefix_c3d_parameters=%%''\\ +''%%! /PREFIX_C3D_PARAMETERS=%%''\\ 
-''%%! /c3d_parameter_groups=subjects%%''\\ +''%%! /C3D_PARAMETER_GROUPS=SUBJECTS%%''\\ 
-''%%! /marker_sets=%%''\\ +''%%! /MARKER_SETS=%%''\\ 
-''%%/subjects_names=::subject_id_converted%%''\\ +''%%/SUBJECTS_NAMES=::SUBJECT_ID_CONVERTED%%''\\ 
-''%%! /subjects_display_sets=%%''\\ +''%%! /SUBJECTS_DISPLAY_SETS=%%''\\ 
-''%%! /subjects_models=%%''\\ +''%%! /SUBJECTS_MODELS=%%''\\ 
-''%%! /subjects_model_params=%%''\\ +''%%! /SUBJECTS_MODEL_PARAMS=%%''\\ 
-''%%/overwrite_c3d_file=1%%''\\+''%%/OVERWRITE_C3D_FILE=1%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**clear the workspace to preserve memory, and then close the loop:**\\ +**Clear the workspace to preserve memory, and then close the loop:**\\ 
-''%% file_new%%''\\+''%% File_New%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%end the loop%%''\\ +''%%End the loop%%''\\ 
-''%%end_for_each%%''\\ +''%%End_For_Each%%''\\ 
-''%%/iteration_parameter_name=dynamic_file%%''\\+''%%/ITERATION_PARAMETER_NAME=DYNAMIC_FILE%%''\\
 ''%%; %%'' ''%%; %%''
  
-===== inconsistent subject prefixes (able bodied) =====+==== Inconsistent Subject Prefixes (Able Bodied) ====
  
-the markers in the static files of the able bodied participants do not have subject prefixes, however a random selection of the dynamic file markers do have prefixes. in this case it makes sense to strip the subject prefixes from the select files that have them instead of adding them to every other file. this can be done using the "remove_subject_prefixes_healthy.v3s" pipeline file.+The markers in the static files of the able bodied participants do not have subject prefixes, however a random selection of the dynamic file markers do have prefixes. In this case it makes sense to strip the subject prefixes from the select files that have them instead of adding them to every other file. This can be done using the "remove_subject_prefixes_healthy.v3s" pipeline file.
  
-run the pipeline **remove_subject_prefixes_healthy.v3s**, and select the folder containing the able-bodied participants (138_healthypig_10.05) when prompted.+Run the pipeline **remove_subject_prefixes_healthy.v3s**, and select the folder containing the able-bodied participants (138_HealthyPiG_10.05) when prompted.
  
  
-because the prefixes are being removed instead of added, the pipeline is much simpler. below is the primary change to the pipeline:\\+Because the prefixes are being removed instead of added, the pipeline is much simpler. Below is the primary change to the pipeline:\\
 \\ \\
-**using the modify c3d subjects parameters pipeline function clear the participant prefixes from the files, set overwrite_c3d_file to true to ensure the changes are preserved, keep all other parameters at their default value:**\\ +**Using the modify C3D subjects parameters pipeline function clear the participant prefixes from the files, set OVERWRITE_C3D_FILE to true to ensure the changes are preserved, keep all other parameters at their default value:**\\ 
-''%% modify_c3d_subjects_parameters%%''\\ +''%% Modify_C3D_Subjects_Parameters%%''\\ 
-''%%! /include_cal_file=true%%''\\ +''%%! /INCLUDE_CAL_FILE=TRUE%%''\\ 
-''%%! /is_static=%%''\\ +''%%! /IS_STATIC=%%''\\ 
-''%%! /subjects_uses_prefixes=%%''\\ +''%%! /SUBJECTS_USES_PREFIXES=%%''\\ 
-''%%! /remove_existing_label_prefixes=true%%''\\ +''%%! /REMOVE_EXISTING_LABEL_PREFIXES=TRUE%%''\\ 
-''%%! /remove_existing_prefix_parameters=false%%''\\ +''%%! /REMOVE_EXISTING_PREFIX_PARAMETERS=FALSE%%''\\ 
-''%%! /subjects_label_prefixes=%%''\\ +''%%! /SUBJECTS_LABEL_PREFIXES=%%''\\ 
-''%%! /prefix_markers=%%''\\ +''%%! /PREFIX_MARKERS=%%''\\ 
-''%%! /prefix_rotations=%%''\\ +''%%! /PREFIX_ROTATIONS=%%''\\ 
-''%%! /prefix_c3d_parameters=%%''\\ +''%%! /PREFIX_C3D_PARAMETERS=%%''\\ 
-''%%! /c3d_parameter_groups=subjects%%''\\ +''%%! /C3D_PARAMETER_GROUPS=SUBJECTS%%''\\ 
-''%%! /marker_sets=%%''\\ +''%%! /MARKER_SETS=%%''\\ 
-''%%! /subjects_names=%%''\\ +''%%! /SUBJECTS_NAMES=%%''\\ 
-''%%! /subjects_display_sets=%%''\\ +''%%! /SUBJECTS_DISPLAY_SETS=%%''\\ 
-''%%! /subjects_models=%%''\\ +''%%! /SUBJECTS_MODELS=%%''\\ 
-''%%! /subjects_model_params=%%''\\ +''%%! /SUBJECTS_MODEL_PARAMS=%%''\\ 
-''%%/overwrite_c3d_file=true%%''\\+''%%/OVERWRITE_C3D_FILE=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
-===== processing c3ds into cmzs (stroke survivors) =====+==== Processing C3Ds into CMZs (Stroke Survivors) ====
  
-instead of manually processing each c3d file, we can use another pipeline to automate the process:+Instead of manually processing each C3D file, we can use another pipeline to automate the process:
  
-because the parameters needed to accurately calculate the models are stored within the dynamic files, they must be opened first and the data saved to pipeline parameters so it can then be applied to the model.+Because the parameters needed to accurately calculate the models are stored within the dynamic files, they must be opened first and the data saved to pipeline parameters so it can then be applied to the model.
  
-edit the pipeline command "apply_model_template" in the pipeline **process_c3ds_stroke.v3s** to point to the model file you have built (or been provided: stroke_model.mdh).+Edit the pipeline command "Apply_Model_Template" in the pipeline **process_c3ds_stroke.v3s** to point to the model file you have built (or been provided: stroke_model.mdh).
  
-run the pipeline **process_c3ds_stroke.v3s**, and select the folder containing the stroke survivors (50_strokepig) when prompted.+Run the pipeline **process_c3ds_stroke.v3s**, and select the folder containing the stroke survivors (50_StrokePiG) when prompted.
  
  
-it should also be mentioned that this dataset does not have reliable enough force plate data to accurately create gait events through kinetic events, and as such a kinematic model is used to generate these. this is done using the zeni method 1a (foot position relative to pelvis) from this [[visual3d:documentation:pipeline:event_commands:example_-_gait_events_using_kinematic_data#step_2a:_create_events_from_foot_position_max.2fmin|tutorial]].\\+It should also be mentioned that this dataset does not have reliable enough force plate data to accurately create gait events through kinetic events, and as such a kinematic model is used to generate these. This is done using the Zeni Method 1a (foot position relative to pelvis) from this [[Visual3D:Documentation:Pipeline:Event_Commands:Example_-_Gait_Events_using_Kinematic_Data#Step_2a:_Create_Events_from_Foot_Position_Max.2FMin|tutorial]].\\
  
  
 \\ \\
-**set a pipeline parameter to the current folder path**\\ +**Set a pipeline parameter to the current folder path**\\ 
-''%% set_pipeline_parameter_to_folder_path%%''\\ +''%% Set_Pipeline_Parameter_To_Folder_Path%%''\\ 
-''%%/parameter_name=folder%%''\\ +''%%/PARAMETER_NAME=FOLDER%%''\\ 
-''%%/parameter_value=%%''\\ +''%%/PARAMETER_VALUE=%%''\\ 
-''%%! /parameter_value_search_for=%%''\\ +''%%! /PARAMETER_VALUE_SEARCH_FOR=%%''\\ 
-''%%! /parameter_value_replace_with=%%''\\ +''%%! /PARAMETER_VALUE_REPLACE_WITH=%%''\\ 
-''%%! /parameter_value_append=%%''\\+''%%! /PARAMETER_VALUE_APPEND=%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**get a list of all folders within the 50_strokepig folder:**\\ +**Get a list of all folders within the 50_StrokePiG folder:**\\ 
-''%% set_pipeline_parameter_to_list_of_files%%''\\ +''%% Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=folders%%''\\ +''%%/PARAMETER_NAME=Folders%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%/search_subfolders=true%%''\\ +''%%/SEARCH_SUBFOLDERS=TRUE%%''\\ 
-''%%/file_mask=*.c3d%%''\\ +''%%/FILE_MASK=*.c3d%%''\\ 
-''%%! /alphabetize=true%%''\\ +''%%! /ALPHABETIZE=TRUE%%''\\ 
-''%%/return_folder_names=true%%''\\+''%%/RETURN_FOLDER_NAMES=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**loop through the folders:**\\ +**Loop through the folders:**\\ 
-''%% for_each%%''\\ +''%% For_Each%%''\\ 
-''%%/iteration_parameter_name=sub_folder%%''\\ +''%%/ITERATION_PARAMETER_NAME=sub_folder%%''\\ 
-''%%! /iteration_parameter_count_name=%%''\\ +''%%! /ITERATION_PARAMETER_COUNT_NAME=%%''\\ 
-''%%/items=::folders%%''\\+''%%/ITEMS=::Folders%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**calibration files are prefixed with tvc, set a pipeline parameter to all c3d files that start with tvc (there should only be one in each folder):**\\ +**Calibration files are prefixed with TVC, set a pipeline parameter to all C3D files that start with TVC (there should only be one in each folder):**\\ 
-''%% set_pipeline_parameter_to_list_of_files%%''\\ +''%% Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=subfolder_calibration%%''\\ +''%%/PARAMETER_NAME=SUBFOLDER_CALIBRATION%%''\\ 
-''%%/folder=::sub_folder%%''\\ +''%%/FOLDER=::sub_folder%%''\\ 
-''%%! /search_subfolders=false%%''\\ +''%%! /SEARCH_SUBFOLDERS=FALSE%%''\\ 
-''%%/file_mask=tvc*.c3d%%''\\ +''%%/FILE_MASK=TVC*.c3d%%''\\ 
-''%%! /alphabetize=true%%''\\ +''%%! /ALPHABETIZE=TRUE%%''\\ 
-''%%! /return_folder_names=false%%''\\+''%%! /RETURN_FOLDER_NAMES=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**start a new workspace:**\\ +**Start a new workspace:**\\ 
-''%% file_new%%''\\+''%% File_New%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**open all dynamic files within the current folder:**\\ +**Open all dynamic files within the current folder:**\\ 
-''%% file_open%%''\\ +''%% File_Open%%''\\ 
-''%%/file_name=::sub_folder&bwa*.c3d%%''\\ +''%%/FILE_NAME=::sub_folder&BWA*.c3d%%''\\ 
-''%%! /file_path=%%''\\ +''%%! /FILE_PATH=%%''\\ 
-''%%! /suffix=%%''\\ +''%%! /SUFFIX=%%''\\ 
-''%%! /set_prompt=file_open%%''\\ +''%%! /SET_PROMPT=File_Open%%''\\ 
-''%%/on_file_not_found=fail%%''\\ +''%%/ON_FILE_NOT_FOUND=FAIL%%''\\ 
-''%%! /file_types_on_prompt=%%''\\+''%%! /FILE_TYPES_ON_PROMPT=%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set all dynamic files to active:**\\ +**Set all dynamic files to active:**\\ 
-''%% select_active_file%%''\\ +''%% Select_Active_File%%''\\ 
-''%%/file_name=::sub_folder&bwa*.c3d%%''\\ +''%%/FILE_NAME=::sub_folder&BWA*.c3d%%''\\ 
-''%%! /query=%%''\\ +''%%! /QUERY=%%''\\ 
-''%%! /subject_tags=no_subject%%''\\+''%%! /SUBJECT_TAGS=NO_SUBJECT%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**save all the necessary metrics from parameters:processing into pipeline parameters:**\\ +**Save all the necessary metrics from PARAMETERS:PROCESSING into pipeline parameters:**\\ 
-''%% set_pipeline_parameter_to_data_value%%''\\ +''%% Set_Pipeline_Parameter_To_Data_Value%%''\\ 
-''%%/signal_types= parameters%%''\\ +''%%/SIGNAL_TYPES= PARAMETERS%%''\\ 
-''%%/signal_folder= processing%%''\\ +''%%/SIGNAL_FOLDER= PROCESSING%%''\\ 
-''%%/signal_names= bodymass%%''\\ +''%%/SIGNAL_NAMES= Bodymass%%''\\ 
-''%%! /signal_components=all_components%%''\\ +''%%! /SIGNAL_COMPONENTS=ALL_COMPONENTS%%''\\ 
-''%%/parameter_name= mass%%''\\+''%%/PARAMETER_NAME= mass%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 //''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\ //''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\
Line 356: Line 358:
  
 \\ \\
-**visual 3ds expected unit of measurement is meters so the knee widths, ankle widths and height need to be converted from mm to m:**\\ +**Visual 3Ds expected unit of measurement is meters so the knee widths, ankle widths and height need to be converted from mm to m:**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=height%%''\\ +''%%/PARAMETER_NAME=height%%''\\ 
-''%%/expression=&::height&/1000.0%%''\\ +''%%/EXPRESSION=&::height&/1000.0%%''\\ 
-''%%/as_integer=false%%''\\+''%%/AS_INTEGER=False%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 //''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\ //''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\
Line 366: Line 368:
  
 \\ \\
-**get the subject id from parameters:subjects and save it to a pipeline parameter:**\\ +**Get the subject ID from PARAMETERS:SUBJECTS and save it to a pipeline parameter:**\\ 
-''%% set_pipeline_parameter_to_data_value%%''\\ +''%% Set_Pipeline_Parameter_To_Data_Value%%''\\ 
-''%%/signal_types=parameters%%''\\ +''%%/SIGNAL_TYPES=PARAMETERS%%''\\ 
-''%%/signal_folder=subjects%%''\\ +''%%/SIGNAL_FOLDER=SUBJECTS%%''\\ 
-''%%/signal_names=names%%''\\ +''%%/SIGNAL_NAMES=NAMES%%''\\ 
-''%%! /signal_components=all_components%%''\\ +''%%! /SIGNAL_COMPONENTS=ALL_COMPONENTS%%''\\ 
-''%%/parameter_name=sub_name%%''\\+''%%/PARAMETER_NAME=SUB_NAME%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**create a hybrid model using the calibration file:**\\ +**Create a hybrid model using the calibration file:**\\ 
-''%% create_hybrid_model%%''\\ +''%% Create_Hybrid_Model%%''\\ 
-''%%/calibration_file=::subfolder_calibration%%''\\ +''%%/CALIBRATION_FILE=::SUBFOLDER_CALIBRATION%%''\\ 
-''%%! /range=all_frames%%''\\+''%%! /RANGE=ALL_FRAMES%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**apply the model template:**\\ +**Apply the model template:**\\ 
-''%% apply_model_template%%''\\ +''%% Apply_Model_Template%%''\\ 
-''%%/calibration_file=::subfolder_calibration%%''\\ +''%%/CALIBRATION_FILE=::SUBFOLDER_CALIBRATION%%''\\ 
-''%%/subject_prefix=::sub_name&:%%''\\ +''%%/SUBJECT_PREFIX=::SUB_NAME&:%%''\\ 
-''%%/model_template=!!! set path to stroke model template !!!%%''\\ +''%%/MODEL_TEMPLATE=!!! SET PATH TO STROKE MODEL TEMPLATE !!!%%''\\ 
-''%%! /set_prompt=open model file%%''\\ +''%%! /SET_PROMPT=Open model file%%''\\ 
-''%%! /view_buildmodel_results=2%%''\\ +''%%! /VIEW_BUILDMODEL_RESULTS=2%%''\\ 
-''%%! /missing_target_message=false%%''\\+''%%! /MISSING_TARGET_MESSAGE=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set all the necessary model metrics and recalculate the model:**\\ +**Set all the necessary model metrics and recalculate the model:**\\ 
-''%% set_model_metric%%''\\ +''%% Set_Model_Metric%%''\\ 
-''%%! /calibration_file=%%''\\ +''%%! /CALIBRATION_FILE=%%''\\ 
-''%%/metric_name= mass%%''\\ +''%%/METRIC_NAME= Mass%%''\\ 
-''%%/metric_value= ::mass%%''\\ +''%%/METRIC_VALUE= ::mass%%''\\ 
-''%%! /subject=%%''\\+''%%! /SUBJECT=%%''\\
 ''%%;%%''\\ ''%%;%%''\\
-//''%%... see the attached pipeline for full list of commands ...%%''//''%% %%''\\+//''%%... See the attached pipeline for full list of commands ...%%''//''%% %%''\\
  
  
 \\ \\
-**assign the model to the dynamic files:**\\ +**Assign the model to the dynamic files:**\\ 
-''%% assign_model_file%%''\\ +''%% Assign_Model_File%%''\\ 
-''%%/calibration_file=::subfolder_calibration%%''\\ +''%%/CALIBRATION_FILE=::SUBFOLDER_CALIBRATION%%''\\ 
-''%%/motion_file_names=::sub_folder&bwa*.c3d%%''\\ +''%%/MOTION_FILE_NAMES=::sub_folder&BWA*.c3d%%''\\ 
-''%%! /remove_existing_assignments=false%%''\\+''%%! /REMOVE_EXISTING_ASSIGNMENTS=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set all files to active:**\\ +**Set all files to active:**\\ 
-''%% select_active_file%%''\\ +''%% Select_Active_File%%''\\ 
-''%%/file_name= all_files%%''\\ +''%%/FILE_NAME= ALL_FILES%%''\\ 
-''%%! /query=%%''\\ +''%%! /QUERY=%%''\\ 
-''%%! /subject_tags=no_subject%%''\\+''%%! /SUBJECT_TAGS=NO_SUBJECT%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**filter and interpolate available data**\\ +**Filter and Interpolate available data**\\ 
-''%% %%''//''%%...see attached pipeline for examples of computation commands ...%%''//''%% %%''+''%% %%''//''%%...See attached pipeline for examples of computation commands ...%%''//''%% %%''
  
 \\ \\
-**calculate gait events through the use of kinematic signals**\\ +**Calculate Gait Events through the use of Kinematic signals**\\ 
-''%% %%''//''%%...see attached pipeline for examples of computation commands ...%%''//''%% %%''+''%% %%''//''%%...See attached pipeline for examples of computation commands ...%%''//''%% %%''
  
 \\ \\
Line 437: Line 439:
  
 \\ \\
-**run all desired computations and then save the workspace to a cmz using the subject id as the file name and end the loop**\\ +**Run all desired computations and then save the workspace to a CMZ using the subject ID as the file name and end the loop**\\ 
-''%% %%''//''%%...see attached pipeline for examples of computation commands ...%%''//\\+''%% %%''//''%%...See attached pipeline for examples of computation commands ...%%''//\\
 \\ \\
-''%%file_save_as%%''\\ +''%%File_Save_As%%''\\ 
-''%%/file_name=::sub_name%%''\\ +''%%/FILE_NAME=::SUB_NAME%%''\\ 
-''%%/folder=::sub_folder%%''\\ +''%%/FOLDER=::sub_folder%%''\\ 
-''%%! /set_prompt=save cmz file as%%''\\ +''%%! /SET_PROMPT=Save CMZ file as%%''\\ 
-''%%! /save_embedded_graphics=false%%''\\ +''%%! /SAVE_EMBEDDED_GRAPHICS=FALSE%%''\\ 
-''%%! /create_folder_path=false%%''\\+''%%! /CREATE_FOLDER_PATH=FALSE%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%end_for_each%%''\\ +''%%End_For_Each%%''\\ 
-''%%/iteration_parameter_name= sub_folder%%''\\+''%%/ITERATION_PARAMETER_NAME= sub_folder%%''\\
 ''%%; %%'' ''%%; %%''
  
-===== processing c3ds into cmzs (able-bodied participants) =====+==== Processing C3Ds into CMZs (Able-Bodied Participants) ====
  
-since the naming convention for the able-bodied participants is different from the stroke survivors the "process_c3ds_healthy.v3s" pipeline can be used instead of the pipeline used for the stroke survivors. the model information needed is stored in the calibration file and not the dynamic file, finally the subject ids are not consistent throughout all the files so a new naming convention must be made for the cmz files.\\+Since the naming convention for the able-bodied participants is different from the stroke survivors the "process_c3ds_healthy.v3s" pipeline can be used instead of the pipeline used for the stroke survivors. The model information needed is stored in the calibration file and not the dynamic file, finally the subject IDs are not consistent throughout all the files so a new naming convention must be made for the CMZ files.\\
  
  
-edit the pipeline command "apply_model_template" in the pipeline **process_c3ds_healthy.v3s** to point to the model file you have built (or been provided: healthy_model.mdh).+Edit the pipeline command "Apply_Model_Template" in the pipeline **process_c3ds_healthy.v3s** to point to the model file you have built (or been provided: healthy_model.mdh).
  
-run the pipeline **process_c3ds_healthy.v3s**, and select the folder containing the able-bodied participants (138_healthypig_10.05) when prompted.+Run the pipeline **process_c3ds_healthy.v3s**, and select the folder containing the able-bodied participants (138_HealthyPiG_10.05) when prompted.
  
  
 \\ \\
-**set a pipeline parameter to 0, this will be used for the naming of the cmz file. the value will be iterated within the loop:**\\ +**Set a pipeline parameter to 0, this will be used for the naming of the CMZ file. The value will be iterated within the loop:**\\ 
-''%% set_pipeline_parameter%%''\\ +''%% Set_Pipeline_Parameter%%''\\ 
-''%%/parameter_name=sub_num%%''\\ +''%%/PARAMETER_NAME=SUB_NUM%%''\\ 
-''%%/parameter_value=0%%''\\ +''%%/PARAMETER_VALUE=0%%''\\ 
-''%%! /parameter_value_search_for=%%''\\ +''%%! /PARAMETER_VALUE_SEARCH_FOR=%%''\\ 
-''%%! /parameter_value_replace_with=%%''\\ +''%%! /PARAMETER_VALUE_REPLACE_WITH=%%''\\ 
-''%%! /parameter_value_prefix=%%''\\ +''%%! /PARAMETER_VALUE_PREFIX=%%''\\ 
-''%%! /parameter_value_append=%%''\\ +''%%! /PARAMETER_VALUE_APPEND=%%''\\ 
-''%%! /multi_pass=false%%''\\+''%%! /MULTI_PASS=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set a pipeline parameter to a list of folders containing c3ds within the 138_healthy_pig_10.05 folder:**\\+**Set a pipeline parameter to a list of folders containing C3Ds within the 138_Healthy_PiG_10.05 folder:**\\
 \\ \\
-''%%set_pipeline_parameter_to_folder_path%%''\\ +''%%Set_Pipeline_Parameter_To_Folder_Path%%''\\ 
-''%%/parameter_name=folder%%''\\ +''%%/PARAMETER_NAME=FOLDER%%''\\ 
-''%%! /parameter_value=visual3d_default_data_folder%%''\\ +''%%! /PARAMETER_VALUE=VISUAL3D_DEFAULT_DATA_FOLDER%%''\\ 
-''%%! /from_motion_file_in_workspace=%%''\\ +''%%! /FROM_MOTION_FILE_IN_WORKSPACE=%%''\\ 
-''%%! /parameter_value_search_for=%%''\\ +''%%! /PARAMETER_VALUE_SEARCH_FOR=%%''\\ 
-''%%! /parameter_value_replace_with=%%''\\ +''%%! /PARAMETER_VALUE_REPLACE_WITH=%%''\\ 
-''%%! /parameter_value_append=%%''\\ +''%%! /PARAMETER_VALUE_APPEND=%%''\\ 
-''%%! /set_prompt=select a directory%%''\\ +''%%! /SET_PROMPT=Select a directory%%''\\ 
-''%%! /alphabetize=true%%''\\+''%%! /ALPHABETIZE=TRUE%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%set_pipeline_parameter_to_list_of_files%%''\\ +''%%Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=sub_folders%%''\\ +''%%/PARAMETER_NAME=SUB_FOLDERS%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%/search_subfolders=true%%''\\ +''%%/SEARCH_SUBFOLDERS=TRUE%%''\\ 
-''%%/file_mask=*.c3d%%''\\ +''%%/FILE_MASK=*.c3d%%''\\ 
-''%%! /alphabetize=true%%''\\ +''%%! /ALPHABETIZE=TRUE%%''\\ 
-''%%/return_folder_names=true%%''\\+''%%/RETURN_FOLDER_NAMES=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**loop through the folders:**\\ +**Loop through the folders:**\\ 
-''%% for_each%%''\\ +''%% For_Each%%''\\ 
-''%%/iteration_parameter_name=folder%%''\\ +''%%/ITERATION_PARAMETER_NAME=FOLDER%%''\\ 
-''%%! /iteration_parameter_count_name=%%''\\ +''%%! /ITERATION_PARAMETER_COUNT_NAME=%%''\\ 
-''%%/items=::folders%%''\\+''%%/ITEMS=::FOLDERS%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**calibrations files are numbered (0) so get a list of all files ending with 0) (there should only be one in each folder):**\\ +**Calibrations files are numbered (0) so get a list of all files ending with 0) (There should only be one in each folder):**\\ 
-''%% set_pipeline_parameter_to_list_of_files%%''\\ +''%% Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=cal_file%%''\\ +''%%/PARAMETER_NAME=Cal_File%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%! /search_subfolders=false%%''\\ +''%%! /SEARCH_SUBFOLDERS=FALSE%%''\\ 
-''%%/file_mask=*0)*.c3d%%''\\ +''%%/FILE_MASK=*0)*.c3d%%''\\ 
-''%%! /alphabetize=true%%''\\ +''%%! /ALPHABETIZE=TRUE%%''\\ 
-''%%! /return_folder_names=false%%''\\+''%%! /RETURN_FOLDER_NAMES=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**open a new workspace:**\\ +**Open a new workspace:**\\ 
-''%% file_new%%''\\+''%% File_New%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**open the calibration file:**\\ +**Open the calibration file:**\\ 
-''%% file_open%%''\\ +''%% File_Open%%''\\ 
-''%%/file_name=::cal_file%%''\\ +''%%/FILE_NAME=::CAL_FILE%%''\\ 
-''%%! /file_path=%%''\\ +''%%! /FILE_PATH=%%''\\ 
-''%%! /suffix=%%''\\ +''%%! /SUFFIX=%%''\\ 
-''%%! /set_prompt=file_open%%''\\ +''%%! /SET_PROMPT=File_Open%%''\\ 
-''%%/on_file_not_found=fail%%''\\ +''%%/ON_FILE_NOT_FOUND=FAIL%%''\\ 
-''%%! /file_types_on_prompt=%%''\\+''%%! /FILE_TYPES_ON_PROMPT=%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set the calibration file to active:**\\ +**Set the calibration file to active:**\\ 
-''%% select_active_file%%''\\ +''%% Select_Active_File%%''\\ 
-''%%/file_name=::cal_file%%''\\ +''%%/FILE_NAME=::CAL_FILE%%''\\ 
-''%%! /query=%%''\\ +''%%! /QUERY=%%''\\ 
-''%%! /subject_tags=no_subject%%''\\+''%%! /SUBJECT_TAGS=NO_SUBJECT%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**save all the necessary information stored in parameters:processing into pipeline parameters:**\\ +**Save all the necessary information stored in PARAMETERS:PROCESSING into pipeline parameters:**\\ 
-''%% set_pipeline_parameter_to_data_value%%''\\ +''%% Set_Pipeline_Parameter_To_Data_Value%%''\\ 
-''%%/signal_types= parameters%%''\\ +''%%/SIGNAL_TYPES= PARAMETERS%%''\\ 
-''%%/signal_folder= processing%%''\\ +''%%/SIGNAL_FOLDER= PROCESSING%%''\\ 
-''%%/signal_names= bodymass%%''\\ +''%%/SIGNAL_NAMES= Bodymass%%''\\ 
-''%%! /signal_components=all_components%%''\\ +''%%! /SIGNAL_COMPONENTS=ALL_COMPONENTS%%''\\ 
-''%%/parameter_name= bodymass%%''\\+''%%/PARAMETER_NAME= BODYMASS%%''\\
 ''%%;%%''\\ ''%%;%%''\\
-//''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\+//''%%... See attached pipeline for full list of commands ...%%''//''%% %%''\\
  
  
 \\ \\
-**visual 3ds expected unit of measurement is meters so the knee widths, ankle widths and height need to be converted from mm to m:**\\ +**Visual 3Ds expected unit of measurement is meters so the knee widths, ankle widths and height need to be converted from mm to m:**\\ 
-''%% set_pipeline_parameter_from_expression%%''\\ +''%% Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=r_knee_width%%''\\ +''%%/PARAMETER_NAME=R_KNEE_WIDTH%%''\\ 
-''%%/expression=&::r_knee_width&/1000.0%%''\\ +''%%/EXPRESSION=&::R_KNEE_WIDTH&/1000.0%%''\\ 
-''%%/as_integer=false%%''\\+''%%/AS_INTEGER=False%%''\\
 ''%%;%%''\\ ''%%;%%''\\
-//''%%... see attached pipeline for full list of commands ...%%''//''%% %%''\\+//''%%... See attached pipeline for full list of commands ...%%''//''%% %%''\\
  
  
 \\ \\
-**close the calibration file:**\\ +**Close the calibration file:**\\ 
-''%% file_close%%''\\ +''%% File_Close%%''\\ 
-''%%/file_name=::cal_file%%''\\ +''%%/FILE_NAME=::CAL_FILE%%''\\ 
-''%%! /query=%%''\\ +''%%! /QUERY=%%''\\ 
-''%%! /close_associated_models=false%%''\\+''%%! /CLOSE_ASSOCIATED_MODELS=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**to open the dynamic files without re-opening the calibration file, list all c3d files within the current folder:**\\ +**To open the dynamic files without re-opening the calibration file, list all C3D files within the current folder:**\\ 
-''%% set_pipeline_parameter_to_list_of_files%%''\\ +''%% Set_Pipeline_Parameter_To_List_Of_Files%%''\\ 
-''%%/parameter_name=dynamic_files%%''\\ +''%%/PARAMETER_NAME=DYNAMIC_FILES%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%! /search_subfolders=false%%''\\ +''%%! /SEARCH_SUBFOLDERS=FALSE%%''\\ 
-''%%/file_mask=*.c3d%%''\\ +''%%/FILE_MASK=*.c3d%%''\\ 
-''%%! /alphabetize=true%%''\\ +''%%! /ALPHABETIZE=TRUE%%''\\ 
-''%%! /return_folder_names=false%%''\\+''%%! /RETURN_FOLDER_NAMES=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**loop through each file:**\\ +**Loop through each file:**\\ 
-''%% for_each%%''\\ +''%% For_Each%%''\\ 
-''%%/iteration_parameter_name=dynamic_file%%''\\ +''%%/ITERATION_PARAMETER_NAME=DYNAMIC_FILE%%''\\ 
-''%%! /iteration_parameter_count_name=%%''\\ +''%%! /ITERATION_PARAMETER_COUNT_NAME=%%''\\ 
-''%%/items=::dynamic_files%%''\\+''%%/ITEMS=::DYNAMIC_FILES%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**use a conditional statement to check that the current file name does not match the calibrations file name:**\\ +**Use a conditional statement to check that the current file name does not match the calibrations file name:**\\ 
-''%% conditional_statement%%''\\ +''%% Conditional_Statement%%''\\ 
-''%%/iteration_parameter_name=is_dynamic%%''\\ +''%%/ITERATION_PARAMETER_NAME=IS_DYNAMIC%%''\\ 
-''%%/expression= "&::dynamic_file&" >< "&::cal_file&"%%''\\ +''%%/EXPRESSION= "&::DYNAMIC_FILE&" >< "&::CAL_FILE&"%%''\\ 
-''%%! /as_integer=true%%''\\+''%%! /AS_INTEGER=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
Line 610: Line 612:
 \\ \\
 **if the file names do not match open the selected file:**\\ **if the file names do not match open the selected file:**\\
-''%% file_open%%''\\ +''%% File_Open%%''\\ 
-''%%/file_name=::dynamic_file%%''\\ +''%%/FILE_NAME=::DYNAMIC_FILE%%''\\ 
-''%%! /file_path=%%''\\ +''%%! /FILE_PATH=%%''\\ 
-''%%! /suffix=%%''\\ +''%%! /SUFFIX=%%''\\ 
-''%%! /set_prompt=file_open%%''\\ +''%%! /SET_PROMPT=File_Open%%''\\ 
-''%%! /on_file_not_found=prompt%%''\\ +''%%! /ON_FILE_NOT_FOUND=PROMPT%%''\\ 
-''%%! /file_types_on_prompt=%%''\\+''%%! /FILE_TYPES_ON_PROMPT=%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**close the conditional statement and the loop**\\ +**Close the conditional statement and the loop**\\ 
-''%% conditional_statement_end%%''\\ +''%% Conditional_Statement_End%%''\\ 
-''%%/iteration_parameter_name=is_dynamic%%''\\+''%%/ITERATION_PARAMETER_NAME=IS_DYNAMIC%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%end_for_each%%''\\ +''%%End_For_Each%%''\\ 
-''%%/iteration_parameter_name=dynamic_file%%''\\+''%%/ITERATION_PARAMETER_NAME=DYNAMIC_FILE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set all dynamic files to active:**\\ +**Set all dynamic files to active:**\\ 
-''%% select_active_file%%''\\ +''%% Select_Active_File%%''\\ 
-''%%/file_name=::folder&subj*.c3d%%''\\ +''%%/FILE_NAME=::FOLDER&SUBJ*.c3d%%''\\ 
-''%%! /query=%%''\\ +''%%! /QUERY=%%''\\ 
-''%%! /subject_tags=no_subject%%''\\+''%%! /SUBJECT_TAGS=NO_SUBJECT%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**create a hybrid model using the calibration file:**\\ +**Create a hybrid model using the calibration file:**\\ 
-''%% create_hybrid_model%%''\\ +''%% Create_Hybrid_Model%%''\\ 
-''%%/calibration_file=::cal_file%%''\\ +''%%/CALIBRATION_FILE=::CAL_FILE%%''\\ 
-''%%! /range=all_frames%%''\\+''%%! /RANGE=ALL_FRAMES%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**apply the model template:**\\ +**Apply the model template:**\\ 
-''%% /calibration_file=::cal_file%%''\\ +''%% /CALIBRATION_FILE=::CAL_FILE%%''\\ 
-''%%!/subject_prefix=%%''\\ +''%%!/SUBJECT_PREFIX=%%''\\ 
-''%%/model_template=!!! set path to healthy model template !!!%%''\\ +''%%/MODEL_TEMPLATE=!!! SET PATH TO HEALTHY MODEL TEMPLATE !!!%%''\\ 
-''%%! /set_prompt=open model file%%''\\ +''%%! /SET_PROMPT=Open model file%%''\\ 
-''%%! /view_buildmodel_results=2%%''\\ +''%%! /VIEW_BUILDMODEL_RESULTS=2%%''\\ 
-''%%! /missing_target_message=false%%''\\+''%%! /MISSING_TARGET_MESSAGE=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**set the necessary model metrics using the parameters saved from the calibration file and then recalculate the model:**\\ +**Set the necessary model metrics using the parameters saved from the calibration file and then recalculate the model:**\\ 
-''%% set_model_metric%%''\\ +''%% Set_Model_Metric%%''\\ 
-''%%! /calibration_file=%%''\\ +''%%! /CALIBRATION_FILE=%%''\\ 
-''%%/metric_name= mass%%''\\ +''%%/METRIC_NAME= Mass%%''\\ 
-''%%/metric_value= ::bodymass%%''\\ +''%%/METRIC_VALUE= ::BODYMASS%%''\\ 
-''%%! /subject=%%''\\+''%%! /SUBJECT=%%''\\
 ''%%;%%''\\ ''%%;%%''\\
-//''%%... see the attached pipeline for full list of commands ...%%''//''%% %%''\\+//''%%... See the attached pipeline for full list of commands ...%%''//''%% %%''\\
  
  
 \\ \\
-**assign model to the dynamic files:**\\ +**Assign model to the dynamic files:**\\ 
-''%% assign_model_file%%''\\ +''%% Assign_Model_File%%''\\ 
-''%%/calibration_file=::cal_file%%''\\ +''%%/CALIBRATION_FILE=::CAL_FILE%%''\\ 
-''%%/motion_file_names=::folder&subj*.c3d%%''\\ +''%%/MOTION_FILE_NAMES=::FOLDER&SUBJ*.c3d%%''\\ 
-''%%! /remove_existing_assignments=false%%''\\+''%%! /REMOVE_EXISTING_ASSIGNMENTS=FALSE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**run all desired computations, and then iterate the sub_num pipeline parameter:**\\ +**Run all desired computations, and then iterate the SUB_NUM pipeline parameter:**\\ 
-''%% %%''//''%%... see attached pipeline for examples of computation commands ...%%''//\\ +''%% %%''//''%%... See attached pipeline for examples of computation commands ...%%''//\\ 
-''%%set_pipeline_parameter_from_expression%%''\\ +''%%Set_Pipeline_Parameter_From_Expression%%''\\ 
-''%%/parameter_name=sub_num%%''\\ +''%%/PARAMETER_NAME=SUB_NUM%%''\\ 
-''%%/expression=&::sub_num&+1%%''\\ +''%%/EXPRESSION=&::SUB_NUM&+1%%''\\ 
-''%%! /as_integer=true%%''\\+''%%! /AS_INTEGER=TRUE%%''\\
 ''%%; %%''\\ ''%%; %%''\\
  
  
 \\ \\
-**save the workspace as a cmz appending the sub_num variable to the name, then close the loop:**\\ +**Save the workspace as a CMZ appending the SUB_NUM variable to the name, then close the loop:**\\ 
-''%% /file_name=subj&::sub_num&.cmz%%''\\ +''%% /FILE_NAME=SUBJ&::SUB_NUM&.cmz%%''\\ 
-''%%/folder=::folder%%''\\ +''%%/FOLDER=::FOLDER%%''\\ 
-''%%! /set_prompt=save cmz file as%%''\\ +''%%! /SET_PROMPT=Save CMZ file as%%''\\ 
-''%%! /save_embedded_graphics=false%%''\\ +''%%! /SAVE_EMBEDDED_GRAPHICS=FALSE%%''\\ 
-''%%! /create_folder_path=false%%''\\+''%%! /CREATE_FOLDER_PATH=FALSE%%''\\
 ''%%;%%''\\ ''%%;%%''\\
 \\ \\
-''%%end_for_each%%''\\ +''%%End_For_Each%%''\\ 
-''%%/iteration_parameter_name= folder%%''\\+''%%/ITERATION_PARAMETER_NAME= FOLDER%%''\\
 ''%%; %%'' ''%%; %%''
  
-===== missing parameters =====+==== Missing Parameters ==== 
 + 
 +Upon inspection some of the dynamic files were missing or have incorrectly named parameters needed to calculate the model (height, mass, ankle widths, and knee widths) in the case of the stroke participants this data was provided in a spreadsheet so the values can be entered manually and the models recalculated.
  
-upon inspection some of the dynamic files were missing or have incorrectly named parameters needed to calculate the model (height, mass, ankle widths, and knee widths) in the case of the stroke participants this data was provided in a spreadsheet so the values can be entered manually and the models recalculated.+{{:missing.jpg}}
  
-missing.jpg+Open the CMZ one of Stroke Survivors 24, 34, or 57 (TVC_24.cmz, TVC_34.cmz, and TVC_57.cmz) . Edit the "Subject Data/Metrics" **Height, Mass, Left_Knee_Width, Right_Knee_Width, Left_Ankle_Width, and Right_Ankle_Width** to match those in the file **SubjectChar.xlsx**.
  
-open the cmz one of stroke survivors 24, 34, or 57 (tvc_24.cmz, tvc_34.cmz, and tvc_57.cmz) . edit the "subject data/metrics" **height, mass, left_knee_width, right_knee_width, left_ankle_width, and right_ankle_width** to match those in the file **subjectchar.xlsx**.+Run the pipeline **pipeline_manual.v3s** while the CMZ is open to recalculate the desired metrics.
  
-run the pipeline **pipeline_manual.v3s** while the cmz is open to recalculate the desired metrics.+Do this separately for all 3 stroke survivors.
  
-do this separately for all 3 stroke survivors. 
  
 +After completing this, you will have a completely processed dataset! You can follow other [[https://www.c-motion.com/v3dwiki/index.php?title=Category:Tutorials|tutorials]] to see what analysis you might do with this data afterwards.
  
-after completing this, you will have a completely processed dataset! you can follow other [[https://www.c-motion.com/v3dwiki/index.php?title=category:tutorials|tutorials]] to see what analysis you might do with this data afterwards.+==== Conclusion ====
  
-===== conclusion =====+Through this tutorial we have identified the common pitfalls that may occur when processing a large biomechanics dataset. Using the public dataset from Van Criekinge et al. as an example, we have identified the challenges encountered and presented realistic solutions. Just like the underlying data set, we made all of our files openly available. You are encouraged to work with this dataset as we did and to build upon our work by analyzing the post-processed data.
  
-through this tutorial we have identified the common pitfalls that may occur when processing a large biomechanics dataset. using the public dataset from van criekinge et al. as an example, we have identified the challenges encountered and presented realistic solutions. just like the underlying data set, we made all of our files openly available. you are encouraged to work with this dataset as we did and to build upon our work by analyzing the post-processed data.+==== References ====
  
-===== references =====+**Paper:** Van Criekinge et al. a full-body motion capture gait dataset of 138 able-bodied adults across the life span and 50 stroke survivors: [[https://www.nature.com/articles/s41597-023-02767-y|[2]]]
  
-**paper:** van criekinge et al. a full-body motion capture gait dataset of 138 able-bodied adults across the life span and 50 stroke survivors: [[https://www.nature.com/articles/s41597-023-02767-y|[2]]] 
  
  
-}}}}}} 
visual3d/tutorials/knowledge_discovery/looking_at_large_public_data_sets.1718801667.txt.gz · Last modified: 2024/06/19 12:54 by sgranger