Difference between revisions of "TUFLOW Viewer - Batch Exporting Plots"

From Tuflow
Jump to navigation Jump to search
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
===Tool Description===
 
===Tool Description===
TUFLOW Viewer offers a tool to batch export plots using a vector layer. This includes the ability to plot from results that have not been loaded into QGIS yet.<br>
+
TUFLOW Viewer offers a tool to batch export plots using a vector layer as the plot location selection object. the tool includes the ability to plot from results that have not been loaded into QGIS yet.<br>
  
The tool will use whatever the current plot settings are when it exports the plot. This includes line styles, axis settings, and legend settings. The export can also be to csv files, in which case the plot settings won't have any effect on the export. The tool currently only supports the standard time series (from a point layer) or standard cross-sections (from a line layer).<br><br>
+
The tool will use the current plot settings at the time of the export request for all outputs. This includes line styles, axis settings, and legend settings. As an alternative to exporting images, the tool can also export csv files, in which case the plot settings won't have any effect on the export. The tool currently only supports the standard time series (from a point layer) or standard cross-sections (from a line layer). It does not support Isodate (date-time) formats.<br>
  
[[File: Plotting_Batch_Export_Plot_Dialog.PNG]]<br>
+
The Batch Export Tool is initiated using the TUFLOW Viewer drop menu: '''Export >> Batch Plot and Export Features'''<br>
 +
The following image highlights the tool input and output options:
 
<ol>
 
<ol>
<li> '''GIS Layer''': Vector layer containing features used for extracting results
+
<li> '''GIS Layer''': Vector layer containing objects defining the location where results are to be extracted from.
<li> '''Name Attribute''': Name attribute field used as file name for export and chart title. If '''-None-''' is selected, the tool use the feature FID.
+
<li> '''Name Attribute''': Name attribute field used as file name for export and chart title. If '''-None-''' is selected, the tool uses the feature FID.
<li> '''Result Mesh''': Mesh layers to extract data from. Can choose to add from a file that is not yet loaded into QGIS. Only results that are selected in the list will be processed.
+
<li> '''Result Mesh''': Mesh layers to extract data from. You can choose to add from a file that is not yet loaded into QGIS. Only results that are selected in the list will be processed.
<li> '''Add from a file''': Button to browse to results that are not already present in QGIS. If no result layer at all is present in QGIS, '''Result Types''' and '''Timestep''' comboboxes are not populated. It is recommended that at least one result is loaded so that these are populated which makes selecting appropriate options easier.
+
<li> '''Add from a file''': Button to browse to results that are not already present in QGIS. If no result layer is currently present in QGIS, '''Result Types''' and '''Timestep''' options below are not populated. As such, it is recommended that at least one result layer is loaded so that these are populated, making selection of appropriate options in the following fields easier.
<li> '''Result Types''': Result types for plotting e.g. bed elevation, water level. Can select from the dropdown if results are loaded in QGIS or user can type them (for more than one, separate result types with ';;' e.g. Water Level;;Velocity
+
<li> '''Result Types''': Result types for plotting (e.g. bed elevation, water level). Can select from the dropdown if results are loaded in QGIS or user can type them (for more than one, separate result types with ';;' (e.g. Water Level;;Velocity).
<li> '''Time Step''': Output time step for cross section plotting (not used for time series). Required for cross-sections. If no results are present in QGIS, then user will need to input a timestep manually.
+
<li> '''Time Step''': Output time step for cross section plotting (not used for time series). Required for cross-sections. If no results are present in QGIS the user will need to input a timestep manually.
<li> '''Export''': Choose either all features or only currently selected features (in QGIS map window) to iterate through
+
<li> '''Export''': Choose either all features or only currently selected features (in the QGIS map window) to iterate through.
<li> '''Format''': Choose either CSV or Image
+
<li> '''Format''': Choose either CSV or Image.
<li> '''Output Folder''': Folder location for outputs
+
<li> '''Output Folder''': Folder location for outputs.
 
</ol>
 
</ol>
 +
[[File: Plotting_Batch_Export_Plot_Dialog.PNG]]<br>
 
<br><br>
 
<br><br>
 +
''<b>Note:</b>'' Exporting static data as a time series (e.g. Bed Elevation) is possible and will be exported as a single value over the time period.<Br><br>
 
{{Tips Navigation
 
{{Tips Navigation
|uplink=[[TUFLOW_Viewer#Working_With_Isodate_.28Date-Time.29_format| Back to TUFLOW Viewer Main Page]]
+
|uplink=[[TUFLOW_Viewer#Exporting_Data.2C_Plots.2C_Maps_and_Animations| Back to TUFLOW Viewer Main Page]]
 
}}
 
}}

Latest revision as of 22:01, 16 February 2023

Tool Description

TUFLOW Viewer offers a tool to batch export plots using a vector layer as the plot location selection object. the tool includes the ability to plot from results that have not been loaded into QGIS yet.

The tool will use the current plot settings at the time of the export request for all outputs. This includes line styles, axis settings, and legend settings. As an alternative to exporting images, the tool can also export csv files, in which case the plot settings won't have any effect on the export. The tool currently only supports the standard time series (from a point layer) or standard cross-sections (from a line layer). It does not support Isodate (date-time) formats.

The Batch Export Tool is initiated using the TUFLOW Viewer drop menu: Export >> Batch Plot and Export Features
The following image highlights the tool input and output options:

  1. GIS Layer: Vector layer containing objects defining the location where results are to be extracted from.
  2. Name Attribute: Name attribute field used as file name for export and chart title. If -None- is selected, the tool uses the feature FID.
  3. Result Mesh: Mesh layers to extract data from. You can choose to add from a file that is not yet loaded into QGIS. Only results that are selected in the list will be processed.
  4. Add from a file: Button to browse to results that are not already present in QGIS. If no result layer is currently present in QGIS, Result Types and Timestep options below are not populated. As such, it is recommended that at least one result layer is loaded so that these are populated, making selection of appropriate options in the following fields easier.
  5. Result Types: Result types for plotting (e.g. bed elevation, water level). Can select from the dropdown if results are loaded in QGIS or user can type them (for more than one, separate result types with ';;' (e.g. Water Level;;Velocity).
  6. Time Step: Output time step for cross section plotting (not used for time series). Required for cross-sections. If no results are present in QGIS the user will need to input a timestep manually.
  7. Export: Choose either all features or only currently selected features (in the QGIS map window) to iterate through.
  8. Format: Choose either CSV or Image.
  9. Output Folder: Folder location for outputs.

Plotting Batch Export Plot Dialog.PNG


Note: Exporting static data as a time series (e.g. Bed Elevation) is possible and will be exported as a single value over the time period.

Up
Go-up.png Back to TUFLOW Viewer Main Page