Differences

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

--- visual3d:documentation:pipeline:file_commands:recalc [2024/07/03 17:40] – created sgranger
+++ visual3d:documentation:pipeline:file_commands:recalc [2025/07/30 18:00] (current) – [Examples] wikisysop
@@ Line 1: / Line 1: @@
 ====== Recalc ======
-||
+===== Overview =====
-Recalculates the Workspace.
+The **Recalc** command is used to update the workspace by re-processing key calculations after any model changes are made. This is often necessary when new segments or landmarks have been added, or when model-based computations may no longer be in sync with the current model structure.
+When executed, Recalc performs a comprehensive rebuild of the workspace by:
+  * Rebuilding all models
+  * Recomputing model-based landmarks and pose (position and orientation)
+  * Reassigning force platforms
+  * Recomputing kinematics and kinetics
+  * Recomputing center of mass
+  * Updating report graphs and display windows.
+You can actually customize the commands that are executed when the Recalc is run. These are listed under the RECALC Pipeline, which can be found in the pipeline workshop or accessed via the button at the top of the Visual3D interface.
+For more information on customizing this process, visit the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|RECALC Pipeline page]].
+===== Pipeline Command =====
+The command below is as seen in the Visual3D application. It does not take any parameters, as it is a standalone command.
 <code>
 Recalc
 ;
 </code>
-Rebuilds any model(s) and any landmarks dependent on the model(s). The Recalc command also executes the [[Visual3D:Documentation:Pipeline:General_Information:RECALC_Pipeline|RECALC Pipeline]]. In addition if any changes have been made to the Events then Recalc will update any Report Graphs dependent on these events. As a general rule, anytime a change has been made to the EVENT LABELS or to PROCESSED signals that may effect the results in the report, it is always safest to RECALCULATE the workspace before printing the report or saving the CMO file.
+===== Command Parameters =====
+This command does not take any user-defined parameters, to customize what is processed with Recalc, visit the [[visual3d:documentation:pipeline:general_information:recalc_pipeline|RECALC Pipeline]] page as mentioned before.
+===== Dialog =====
+There is no dialog box for this command due to it being a stand-alone function. The application interface alternative option is the recalc button on the toolbar:
+{{:visual3d:documentation:pipeline:file_commands:toolbar_recalc_button.png?400|}}
+===== Examples =====
+The following examples will go through the use of the Recalc command in the Visual3D application.
+=== Example 1: Adding a Custom Foot Midpoint Landmark and Recalculating the Model ===
+This example walks through the process of defining a new custom landmark on the foot (midpoint between heel, MT1, and MT5), running the Recalc command to update the model, and then setting up for use in further analysis.
+Firstly, ensure that target markers are available in your workspace, so that joint positions can be determined. If they have not yet been created, use the [[visual3d:documentation:pipeline:signal_commands:create_target|Create Target]] command to ensure the required markers exist in the workspace.
+<code>
+Create_Target
+/SIGNAL_NAMES=[L.HEEL, L.MT1 + L.MT5]
+! /SIGNAL_DESCRIPTION=
+/EXPRESSION=
+! /INCLUDE_MOTIONFILE=TRUE
+! /INCLUDE_CALFILE=FALSE
+;
+</code>
+Step 2: Add the Midpoint Landmark to the Model and Recalc to ensure it is created.
+<code>
+Add_Landmark
+/LANDMARK_NAME=LF_MIDPT
+! /CALIBRATION_FILE=
+! /USER_GENERATED=TRUE
+/USE_PERCENTAGE=TRUE
+! /CALIBRATION_ONLY=FALSE
+/USE_TARGETS=TRUE
+! /SEGMENT_NAME=
+/TARGET_TYPES=TARGET+TARGET+TARGET
+/TARGET_NAMES=L.HEEL+L.MT1+L.MT5
+! /MCS_ML=0.0
+! /MCS_AP=0.0
+/MCS_AXIAL=0.5
+! /LANDMARK_LOCATION=
+! /REFERENCE_LOCATION_TYPE=
+! /REFERENCE_LOCATION_NAME=
+! /USE_REFERENCE_LOCATION=FALSE
+;
+Recalc
+;
+</code>
+Step 3: Use Landmark in Further Analysis
+Here we compute the global maximum of the LF_MIDPT landmark's vertical component, representing peak foot height.
+<code>
+Metric_Maximum
+/RESULT_METRIC_NAME=Foot_Midpt_Max_Height
+! /APPLY_AS_SUFFIX_TO_SIGNAL_NAME=FALSE
+/SIGNAL_TYPES=LANDMARK
+/SIGNAL_NAMES=LF_MIDPT
+/COMPONENT_SEQUENCE=Y
+! /EVENT_SEQUENCE=
+/EXCLUDE_EVENTS=
+! /SEQUENCE_PERCENT_START=
+! /SEQUENCE_PERCENT_END=
+/CREATE_GLOBAL_MAXIMUM=TRUE
+! /GENERATE_MEAN_AND_STDDEV=TRUE
+! /APPEND_TO_EXISTING_VALUES=FALSE
+;
+</code>
+===== Notes =====
+  * Recalc ensures your model-based computations and workspace signals are always up-to-date.
+  * If you add or edit any landmarks or segments, you should run Recalc before further calculations or reports.
+  * The RECALC Pipeline can be customized to add user-defined commands that will always run when Recalc us executed.
-\\
+----
 [[Visual3D:Documentation:Pipeline:General_Information:Pipeline_Commands_Reference|Back to Pipeline Commands Reference]]