User Tools

Site Tools


visual3d:documentation:pipeline:general_information:recalc_pipeline

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:documentation:pipeline:general_information:recalc_pipeline [2024/06/19 14:00] – created sgrangervisual3d:documentation:pipeline:general_information:recalc_pipeline [2024/07/17 15:45] (current) – created sgranger
Line 1: Line 1:
 +====== RECALC Pipeline ======
 +
 The pipeline processing dialog contains two buttons above the middle list box. The pipeline processing dialog contains two buttons above the middle list box.
  
Line 7: Line 9:
 **Note:** that any items that are in the **CMO Recalc Script** when a Report Template is saved are stored in the report template. **Note:** that any items that are in the **CMO Recalc Script** when a Report Template is saved are stored in the report template.
  
-==== What processing happens ====+=== What processing happens ===
  
 When the RECALC button is pressed. The following processing occurs: When the RECALC button is pressed. The following processing occurs:
Line 27: Line 29:
 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. 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.
  
-{{RECALC_Pipeline.jpg}}+{{:RECALC_Pipeline.jpg}}
 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. 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 ====+=== Saving the Recalc Pipeline ===
  
 If the button is checked to display the Recalc pipeline, the pipeline list box will be shaded pink. If the button is checked to display the Recalc pipeline, the pipeline list box will be shaded pink.
Line 40: Line 42:
 Deleting the Recalc pipeline will remove the Recalc pipeline from the workspace. Deleting the Recalc pipeline will remove the Recalc pipeline from the workspace.
  
-==== Opening a Report Template ====+=== Opening a Report Template ===
  
 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. 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.
  
-==== Recalc Pipeline Processing acts on the Active Files ====+=== Recalc Pipeline Processing acts on the Active Files ===
  
 By default, ALL_FILES are active for the Recalc Pipeline. By default, ALL_FILES are active for the Recalc Pipeline.
Line 50: Line 52:
 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. 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.
  
-==== Removing a signal from the Workspace ====+=== Removing a signal from the Workspace ===
  
 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. 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.
Line 58: Line 60:
 Visual3D checks for duplicate entries in the RECALC pipeline, but it is possible that a user can inadvertently add duplicates to the pipeline. 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 ====+=== 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. 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.
Line 66: Line 68:
 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. 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 ====+=== 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 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.
visual3d/documentation/pipeline/general_information/recalc_pipeline.1718805658.txt.gz · Last modified: 2024/06/19 14:00 by sgranger