Differences

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

--- visual3d:documentation:pipeline:general_information:recalc_pipeline [2024/06/19 12:51] – sgranger
+++ visual3d:documentation:pipeline:general_information:recalc_pipeline [2025/04/15 17:50] (current) – Cleaned up page and added many links. wikisysop
@@ Line 1: / Line 1: @@
-{{the pipeline processing dialog contains two buttons above the middle list box.
+====== RECALC Pipeline ======
-the **main pipeline** refers to the pipeline that has been loaded manually by the user.
+The [[visual3d:tutorials:pipeline:advanced_pipeline_commands#pipeline_editor|Pipeline Workshop]] dialog contains two buttons above the middle list box:
+  - The **Main Pipeline** refers to the pipeline that has been loaded manually by the user.
+  - The **CMO Recalc Script** by default contains the [[visual3d:documentation:visual3d_signal_types:link_model_based_data_type|LINK_MODEL_BASED]] calculation definitions. The user can, however, add pipeline commands to this list box manually. These commands will be processed whenever the RECALC button is executed. **Note:** that any items that are in the **CMO Recalc Script** when a Report Template is saved are stored in the report template.
-the **cmo recalc scrip**t by default contains the linkmodel based calculation definitions. the user can, however, add pipeline commands to this list box manually. these commands will be processed whenever the recalc button is executed.
+===== What RECALC accomplishes =====
-**note:** that any items that are in the **cmo recalc script** when a report template is saved are stored in the report template.
+When the user presses the RECALC button Visual3D will execute the following steps:
+  - (If [[visual3d:documentation:visual3d_signal_types:link_model_based_data_type#using_processed_signals|Use Processed Analog]] is set) Re-process force platforms.
+  - Rebuild all models in the Workspace
+  - Compute Landmarks and model pose (e.g. position and orientation of all segments) for all files in the Workspace
+  - Assign Force Platforms to Segments
+  - Compute Assigned Forces
+  - Compute Kinematics
+  - Compute Kinetics
+  - Compute Center of Mass.
+  - Execute the RECALC pipeline
+  - Update the display dialogs for any new data
+  - Recompute the Report graphs
-==== what processing happens ====
+LINK_MODEL_BASED signals are recalculated if they are in the [[visual3d:documentation:reports:report_mode|report]], but are not recalculated otherwise. DERIVED, METRIC and other signals are not recalculated by default. These calculations can be placed into the RECALC pipeline by generating the pipeline you desire, save the pipeline, switch to the CMO RECALC pipeline (using the radio button, shown below), click the 'Open Pipeline' button and append the saved pipeline to the existing RECALC pipeline.
-when the recalc button is pressed. the following processing occurs:
+{{:RECALC_Pipeline.jpg}}
-  - if **use processed analog** is set, re-process force platforms.
+Adding the calculations to the RECALC pipeline will cause them to be recalculated when the RECALC button is pressed. The RECALC pipeline is saved in the [visual3d:documentation:definitions:file_formats:cmz_format|CMZ]] file so it will always be there, and it is also saved in the report template so that when you open the report the items which should be recalculated (or calculated for a first time) are performed.
-  - rebuild all models in the workspace
-  - compute landmarks and model pose (e.g. position and orientation of all segments) for all #files in the workspace
-  - assign force platforms to segments
-  - compute assigned forces
-  - compute kinematics
-  - compute kinetics
-  - compute center of mass.
-  - execute the recalc pipeline
-  - update the display dialogs for any new data
-  - recompute the report graphs
-link_model_based signals in the report are always recalculated. link_model_based signals not in the report are not recalculated.
+==== Acting on Active Files ====
-derived, metric and other signals are not recalculated by default. these calculations can be placed into the recalc pipeline by generating the pipeline you desire, save the pipeline, switch to the cmo recalc pipeline (using the radio button, shown below), click the 'open pipeline' button and append the saved pipeline to the existing recalc pipeline.
+By default, [[visual3d:documentation:definitions:active_files|ALL_FILES are active]] for the Recalc Pipeline. It is possible to "trick" Visual3D by inserting [[visual3d:documentation:pipeline:file_commands:select_active_file|Select_Active_File]] commands into the RECALC pipeline, which allows you to selectively determine which files are being re-processed, but you need to be careful because the RECALC pipeline is a critical part of the report template, so only do this when you want the changes to persist in your report template.
-recalc_pipeline.jpg
+==== Removing a signal from the Workspace ====
-by adding the calculations to the recalc pipeline, these will be recalculated when the recalc button is pressed. the recalc pipeline is saved in the .cmo file so it will always be there, and it is also saved in the report template so that when you open the report the items which should be recalculated (or calculated for a first time) are performed.
-==== saving the recalc pipeline ====
+If a signal is defined in the RECALC pipeline, removing (or) renaming the signal in the data tree won't do the trick. As soon as the RECALC pipeline is executed the signal will re-appear. You need to remove the signal from both the RECALC pipeline and the data tree. All model-based signals are automatically added to the RECALC pipeline when they are created. Visual3D checks for duplicate entries in the RECALC pipeline, but it is possible that a user can inadvertently add duplicates to the pipeline.
-if the button is checked to display the recalc pipeline, the pipeline list box will be shaded pink.
+==== Warning about editing the RECALC pipeline ====
-selecting the button to save the pipeline will save the contents of the recalc pipeline.
+Removing an item from the RECALC pipeline does not remove the item from the data tree (e.g. the Workspace). The signal in the data tree no longer has a definition, however, so changing the properties of the model, which would normally change the related model-based signals, will not modify the signal as expected.
-selecting the button to open the pipeline will either replace or append the existing recalc pipeline.
+If you aren't sure, you can save the CMZ file, then remove all the model based signals from the data tree, select RECALC and see what signals didn't re-appear. If you are missing a specific signal, re-open the saved CMZ file and check the history of the signal missing from the RECALC pipeline. Version 4.5 of Visual3D allows you to copy the history (e.g. the model-based definition), so you can paste it into the RECALC pipeline.
-deleting the recalc pipeline will remove the recalc pipeline from the workspace.
-==== opening a report template ====
+===== Modifying and Saving the Recalc Pipeline =====
-when a report template is added to the workspace, all of the report graphs are deleted and all of the model based data definitions contained in the report template are appended to the **cmo recalc script**. for design reasons we elected not to delete the existing model based data because we felt it was easier for users to delete entries from the **cmo recalc script** than to re-create the model based data that they created before opening the report template. however, when the **recalc** button is pressed, the old compute model based signals will be **removed** from the recalc pipeline.
+If the button is checked to display the RECALC pipeline, the pipeline list box will be shaded pink.
-==== recalc pipeline processing acts on the active files ====
+You can edit the commands in the RECALC pipeline directly. In the pipeline dialog, select the button (check box) to make the RECALC pipeline editable and edit a command. You can also select [[visual3d:documentation:pipeline:model_based_data_commands:compute_model_based_data|Compute Model Based Data]] under the Model menu option, and edit the definition there. Visual3D will automatically search for a model based signal of the same name in the data tree and replace the properties.
-by default, all_files are active for the recalc pipeline.
+It is also possible to save, edit, or delete the RECALC pipeline:
+  - Selecting the button to save the pipeline will save the contents of the RECALC pipeline.
+  - Selecting the button to open the pipeline will either replace or append the existing RECALC Pipeline.
+  - Deleting the RECALC pipeline will remove the RECALC pipeline from the workspace.
-it is possible to "trick" visual3d by inserting select_active_file commands into the recalc pipeline, which allows you to selectively determine which files are being re-processed, but you need to be careful because the recalc pipeline is a critical part of the report template, so only do this when you want the changes to persist in your report template.
+===== Opening a Report Template =====
-==== removing a signal from the workspace ====
+When a report template is added to the Workspace, all of the report graphs are deleted and all of the model-based data definitions contained in the report template are appended to the **CMO RECALC Script**. For design reasons we elected not to delete the existing model-based data because we felt it was easier for users to delete entries from the **CMO RECALC Script** than to re-create the model-based data that they created before opening the report template. However, when the **RECALC** button is pressed, the old Compute Model Based signals will be **removed** from the RECALC pipeline.
-if a signal is defined in the recalc pipeline, removing (or) renaming the signal in the data tree won't do the trick. as soon as the recalc pipeline is executed the signal will re-appear. you need to remove the signal from both the recalc pipeline and the data tree.
-all model based signals are automatically added to the recalc pipeline when they are created.
-visual3d checks for duplicate entries in the recalc pipeline, but it is possible that a user can inadvertently add duplicates to the pipeline.
-==== warning about editing the recalc pipeline ====
-removing an item from the recalc pipeline does not remove the item from the data tree (e.g. the workspace). the signal in the data tree no longer has a definition, however, so changing the properties of the model, which would normally change the related model based signals, will not modify the signal as expected.
-if you aren't sure, you can save the cmo file, then remove all the model based signals from the data tree, select recalc and see what signals didn't re-appear.
-if you are missing a specific signal, re-open the saved cmo file and check the history of the signal missing from the recalc pipeline. version 4.5 of visual3d allows you to copy the history (e.g. the model based definition), so you can paste it into the recalc pipeline.
-==== modifying the definition of model based items in the recalc pipeline ====
-you can edit the commands in the recalc pipeline directly. in the pipeline dialog, select the button (check box) to make the recalc pipeline editable and edit a command.
-you can also select compute model based data under the model menu option, and edit the definition there. visual3d will automatically search for a model based signal of the same name in the data tree and replace the properties.
-}}