QGIS TUFLOW Run TUFLOW Utilities: Difference between revisions
Content deleted Content added
Ellis Symons (talk | contribs) No edit summary |
|||
| (25 intermediate revisions by 2 users not shown) | |||
Line 1:
This tool offers a basic graphical user interface for the '''<u>[[TUFLOW_Utilities | TUFLOW Utilities]]</u>'''. Users can choose to use the interface for common use cases or use the advanced tab to use batch file commands directly. The tool also has a convenient option to automatically download the latest version of each utility.
<br><br>
__TOC__
<br>
{{Tips Navigation
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
}}<br>
<Br><br>
==Running the Tool==
The tool can be found in the TUFLOW Plugin toolbar, or via the QGIS menu '''Plugins >> TUFLOW >> TUFLOW Utilities'''.
Line 20 ⟶ 26:
* '''Statistics''' - Computes a range of statistics of all input grids for each grid cell. Must add at least 2 grids via "Add Grids To Function". '''<u>[[ASC_to_ASC#Statistics | More information...]]</u>'''
* '''Convert''' - Converts all inputs grids between ASC and FLT (the output format is dependent on the input format). Must add at least one grid via "Add Grids To Function". '''<u>[[ASC_to_ASC#Convert | More information...]]</u>'''
* '''Breakline''' - Creates a 2d_zsh breakline from an input polyline and raster dem. The polyline must have the attributes of a 2d_zsh and be populated as per the <b><u>[[ASC_to_ASC#Extract_Breaklines_from_DEM | asc_to_asc documention]]. </u></b> ''(Available since v3.7.0.28)''.
<Br>
'''TUFLOW_to_GIS'''<br>
Line 33 ⟶ 40:
* '''Maximum''' - Calculates the maximum from a number of different inputs. Must specify at least one XMDF or DAT via "Add XMDF or DAT to Function". For XMDF inputs, must also specify a type using the dropbox. Users can also manually enter text here if the desired result type isn't listed. Input mesh layers mush have the same mesh (.2dm file). '''<u>[[RES_to_RES#Max | More information... ]]</u>'''
* '''Concatenate''' - Joins separate output files together into a single XMDF file. Must specify at least one XMDF or DAT via "Add XMDF or DAT to Function". For XMDF inputs, must also specify a type using the dropbox. Users can also manually enter text here if the desired result type isn't listed. Input mesh layers mush have the same mesh (.2dm file). '''<u>[[RES_to_RES#Concatenate | More information... ]]</u>'''
==Advanced==
Prior to running the tool from the advanced tab, the tool must have access to the TUFLOW Utilities. This is done via the '''<u>[[#Executables | Executables]]</u>''' tab.
<Br><br>
The advanced tab allows users to
<Br>
The utility should be selected from the dropdown box at the top of the dialog. It is recommended that users select a working directory. A working directory lets the users pass relative references to inputs via the argument text box. Arguements are entered under "Flags and Values" and should be identical to what are entered through a batch file with the exception that the utility exe location is not required and the batch file flag '-b' is also automatically added.<br>
<Br>
Users can also use the "Find File" for convenience. The chosen file(s) will be automatically added to the arguments text box. If a working directory is present, the input files will automatically be inserted with a relative referene to the working directory.
==Executables==
The executables tab tells the tool where the utilities are located. They can be manually entered (the entered locations will be saved globally) or users can choose to let the tool automatically download the latest utilities from '''<u>[https://tuflow.com tuflow.com]</u>''' and update the paths.<br>
<br>
The '''ASC_to_ASC Version''' button can be used to get the version of the asc_to_asc utility. If the version is <b><u>[[ASC_to_ASC#2023-03-AA_.28and_later.29 | 2023-01]]</u></b> or later, then additional input and output options will be available in the 'Common Functions' tab as well letting users know they can use the latest formats in the 'Advanced' tab.
==Examples==
'''Common Functions - Asc_to_Asc - Converting multiple ASC rasters to fLT'''<Br>
[[File: TUFLOW_Utilities_CF_convert_example.gif]]
<Br><Br>
'''Common Functions - TUFLOW_to_GIS - Converting an XMDF depth result to an ASC raster - Optional extra step of naming the output file.'''<Br>
[[File: TUFLOW_Utilities_CF_tuf2gis_example.gif]]
<br><Br>
'''Common Functions - Res_to_Res - Info'''<br>
[[File: TUFLOW_Utilities_CF_res2res_example.gif]]
<Br><Br>
'''Advanced Functions - Asc_to_Asc - Taking the difference between a Design Scenario and Existing Case'''<Br>
[[File: TUFLOW_Utilities_Adv_diff_example.gif]]
<Br>
<Br>
{{Tips Navigation
|uplink=[[TUFLOW_QGIS_Plugin#Usage| Back to TUFLOW QGIS Plugin Main Page]]
}}
| |||