Tuflow

GRID to GRID draft: Difference between revisions

Browse history interactively
← Older edit
Content deleted Content added
VisualWikitext
 
(45 intermediate revisions by one other user not shown)
Line 1:
=Introduction=
The grid_to_grid.exe is a utility that can be used to perform a range of operations on gridded files. The input grids can be eithera combination of GeoTIFF (.tif), ESRI ASCII grid (.asc), binary float grids (.flt) geopackage (.gpkg), NetCDF (.nc) and Cloud Optimised GeoTIFFs (.cog) grids, all of which can be input and output from TUFLOW and any of the format can be set as output from the utility.<br>
For some options (such as processing maximums or differences) the input files must be of the same row/column dimensions.<br>
This utility is useful for comparing and processing TUFLOW outputs from different .2dm meshes, which can't be compared with the <u>[[RES_to_RES| res_to_res.exe]]</u>.<br>
For some options (such as processing maximums or differences) the input (.tif, .asc or .flt) files must be of the same row/column dimensions.<br>
The inputs can be a combination of .tif, .asc, .flt, .gpkg, .nc, .cog grids and the -tif, -asc, -flt, -gpkg, -nc, .cog options can be used to set the output type.<br>
 
=Output Switches=
Line 11 ⟶ 9:
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
|-
|"-tif"||Output to GeoTIFF format.
|-
|"-asc"||Output to ASC format.
|-
|"-flt"||Output to FLT format.
|-
|"-gpkg"||Output to GeoPackage format, see <u>[[#GPKG_and_NetCDF | GPKG and NetCDF]]</u>.
|-
|"-nc"||Output to NetCDF format, specifies that the output format should be NetCDF for all operations, see <u>[[#GPKG_and_NetCDF | GPKG and NetCDF]]</u>.
|-
|"-cog"||Output to Cloud Optimised GeoTIFF format, overviews (pyramids) for GPKG rasters.
|-
|"-out <output_name/output_name.ext>"||Specifies output file name. When output extension is included in the name it also specifies output extension. A space is required between the -out and the filename.
|"-co"||Creation option switch. See <b><u>[[#Creation_Options | Creation Options]]</u></b> section below.
|-
|"-co"||Creation option switch, see <u>[[#Creation_Options | Creation Options]]</u>.
|-
|"-b"|| Run the utility in batch mode, this suppresses the prompt to press enter at the end of processing. Used in .bat files where two or more files are to be processed. The -b flag should be placed after the grid_to_grid.exe call, before the function command. For example:<br> <tt>grid_to_grid.exe -b -brkline 2d_zsh_breaklines_L.gpkg DEM.tif</tt><br>
|-
|"-check"||This creates check files for the data processing if applicable.
|-
|"-src"||For use with -min,-max or various stat options to supress the source grid output. Will only output the minimum, maximum, mean, median, frac grid. The src_legend.csv is also supressed.
|-
|"-grc"||For use with the "-classify" option and ASC format output. This creates a classified grid (uses name rather than number). This is only valid if using Vertical Mapper, neither QGIS or ArcMap will recognise this format. This can also be used with the -RGB option to specify the output colouring of the grid.
|}
 
=2023-03-AA (and later)=
<span style="color:red;font-size:14">This release incorporates new GIS/GRID formats included in the 2023-03-AA TUFLOW release. Some slight changes to the command line interface have been made to accomodate the new formats therefore please be aware that some of behaviour in 2023 release contradicts documentation presented elsewhere on this page (these are explicitly listed in <b><u>[[#Changes_to_Old_Switches | Changes to Old Switches]]</u></b> below). Where contradiction occurs, the behaviour listed here is the latest information and supersedes the behaviour listed elsewhere. </span> <span style="font-size:11"></span><br>
 
The '''ASC_to_ASC-2023-03-AA''' release incorporates several new GIS formats - '''GeoTIFF''', '''GPKG''', '''NetCDF''' (note: NetCDF was previously supported but now has better integration with all operations). The commands are largely unchanged and now support input and output to a range of new formats.
 
The 2023-03-AA release also supports GPKG vector inputs e.g. for the <tt>"-brkline"</tt> operation.<br>
The 2023-09-AA release supports Cloud Optimised GeoTIFFs (COG) and overviews (pyramids) for GPKG rasters.
 
 
===Changes to Old Switches===
* -nc - The <tt>"-nc"</tt> switch previously converted the input file to a NetCDF raster. The -nc switch now specifies that the output format should be NetCDF (for all operations). Use the following command to get the previous behaviour <tt>"-conv -nc"</tt>.
 
 
Another change in behaviour in the 2023 release is that the output format can also be specified by adding a supported extension when using the <tt>"-out [output_name.ext]"</tt> switch.
 
===GPKG and NetCDF===
GeoPackage and NetCDF are database formats and are able to contain multiple layers in a single file. When passing in an input or output reference to a GeoPackage or NetCDF file the layer name is assumed to be the same as the database name unless otherwise specified. To give the layer a different name than the database, use the following syntax <tt>"database.ext >> layer"</tt>:<Br>
<pre>grid_to_grid.exe -dif "database.gpkg >> raster1" "database.gpkg >> raster2"</pre>
''<b>Note:</b>''
* ''quotes will always be required when using this syntax''
* ''wildcard expansion (i.e. * or ?) is not supported yet when using this syntax''
More notes on behaviour:
* GPKG output paths can be either a new or existing database i.e. the utility supports writing new layers into an existing database. NetCDF outputs do not support this yet and will overwrite any existing NetCDF file
* Typically outputs to the GPKG or NetCDF format will be grouped together into a single output file
 
===Creation Options===
The 2023 release supports GDAL style creation options. Creation options can be passed in using the <tt>"-co"</tt> flag then the name of the creation option and the value:<Br>
<pre>-co COMPRESS=DEFLATE</pre>
Multiple creation options can be used (each will require its own -co flag).<Br>
<Br>
The creation options have adopted the same naming as GDAL (more information on the options can be found at <b><u>[https://gdal.org https://gdal.org]</u></b>) however not all options in GDAL are supported in the grid_to_grid.exe utility. The following creation options are supported in the grid_to_grid 2023-Beta:<Br>
====GeoTIFF====
* COMPRESS=NONE/DEFLATE/LZW - output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* NUM_THREADS=[N]/ALL_CPUS - Number of threads to use when processing GeoTIFFs. Default - ALL_CPUS
* BIGTIFF=YES/NO/IF_NEEDED - Controls whether the ouput file uses the BigTIFF format or classic TIFF. Default - IF_NEEDED.
* TILED=YES/NO - Controls whether the output GeoTIFF should use tiles or strips. Default - NO.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. The grid_to_grid tool only supports internal overviews and therefore this option is only supported for tiled GeoTIFFs. Default - NO.
 
====Cloud Optimised GeoTIFF (COG)====
Same options as GeoTIFF however will automatically use 'TILED=YES' and 'OVERVIEWS=YES' creation options.
 
====GeoPackage====
* COMPRESS=NONE/LZW - output compression. Default - LZW
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. Default - NO.
 
====NetCDF====
* COMPRESS=NONE/DEFLATE- output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9
 
====ASC====
* DECIMAL_PRECISION=N - The number of decimal places in the output. This option is analogous to the <tt>"-decimal[N]"</tt> switch. Default - 3
 
===Examples===
*Runs a difference operation on GeoTIFF outputs.<br>
:<tt>grid_to_grid.exe -diff proposed.tif existing.tif</tt>
* Runs a difference operation on GPKG outputs. The layer name needed is assumed to be the same as the database name.<br>
:<tt>grid_to_grid.exe -diff proposed.gpkg existing.gpkg</tt>
* Runs a difference operation on GeoPackage outputs where the layer name is different than the database name.<br>
:<tt>grid_to_grid.exe -diff "proposed_grid_results.gpkg >> proposed_max_h" "existing_grid_results.gpkg >> existing_max_h"</tt>
* Converts an ASC grid to a GeoTIFF with an LZW compression and horizontal predictor.<br>
:<tt>grid_to_grid.exe -conv -tif DEM_M01.asc -co COMPRESS=LZW -co PREDICTOR=2</tt>
* Runs a maximum operation on all FLT grids in a given location and outputs to a GeoPackage raster.<br>
:<tt>grid_to_grid.exe -max -out "output_grids.gpkg >> maximum_h" *.flt</tt>
* Converts GeoTIFF to a Cloud Optimised GeoTIFF. Requires <tt>-out</tt> flag since the extension for COG is also '.tif' and therefore the default output file would be the same as the input file.<br>
:<tt>grid_to_grid.exe -conv -cog DEM_M01.tif -out DEM_M01_COG.tif</tt>
 
=Operations=
==Convert==
'''"-conv"'''<br>
Converts betweengrid .tif,formats .ascas andspecified .flt format. For this operationby the output file type is based on the .tif, .asc or -flt operationswitch.<br>
ExamplesExample:<br>
*Converts all .fltFLT grids to .tifTIF format.<br>
:<tt>grid_to_grid.exe -conv -tif *.flt</tt>
*Converts the file "DEM.asc" to.flt FLT format.<br>
:<tt>grid_to_grid.exe -conv -flt DEM.asc</tt>
* Converts an ASC grid to a GeoTIFF with an LZW compression and horizontal predictor, see <u>[[#Creation_Options | Creation Options]]</u>.<br>
:<tt>grid_to_grid.exe -conv -tif DEM_M01.asc -co COMPRESS=LZW -co PREDICTOR=2</tt>
* Converts GeoTIFF to a Cloud Optimised GeoTIFF. Requires <tt>-out</tt> flag since the extension for COG is also .tif and the default output file would be the same as the input file.<br>
:<tt>grid_to_grid.exe -conv -cog DEM_M01.tif -out DEM_M01_COG.tif</tt>
 
==Maximum==
'''"-max"'''<br>
Determines the maximum value in all the input .asc files. Two output grids are created:<br>
*A numerical grid containing the maximum value.<br>
*A classified grid with the namesuffix _src.asc which contains the source grid for the maximum value.<br>
ExamplesExample:<br>
*Creates a new grid containing the maximum of the 3 input water level grids.<br>
:<tt>grid_to_grid.exe -max Q100_30min_h.asctif Q100_45min_h.asctif Q100_60min_h.asctif</tt><br>
*As per item 2 above, but specifies the output name "Q100_Max_Levels.asctif".<br>
:<tt>grid_to_grid.exe -out Q100_Max_Levels.asctif -max Q100_30min_h.asctif Q100_45min_h.asctif Q100_60min_h.asctif</tt><br>
*Wildcard character "*" is supported in filenames.<br>
:<tt>grid_to_grid.exe -out Q100_Max_Levels.asctif -max Q100_*min_h.asctif</tt>
* Runs a maximum operation on all FLT grids in a given location and outputs to a GeoPackage raster.<br>
:<tt>grid_to_grid.exe -max -out "output_grids.gpkg >> maximum_h" *.flt</tt>
 
==Difference==
'''"-dif"'''<br>
Takes the difference between the first two .asc filesgrids, the second gridoutput is subtractedthe fromfirst grid minus the firstsecond grid. If an optional third .asc filegrid is specified, this is used as the output file, otherwise, grid_to_grid creates its own output filename using the names of the two input grids.asc files. The output is the first .asc file minus the second .asc file. <br>
Two .asc grids are output:
*The first is the difference values between the two grids.asc files. A difference value only occurs at grid cells that have a value in both grids. If the cell has a null value (iei.e. the TUFLOW output was dry at that location) in either or both .asc grids, a null value is output.
*A second grid with a “_wd” suffix is output to indicate which .asc grid cells were once wet and are now dry (value -99) or oncewere dry and are now wet (value +99). withFirst first .ascgrid to be the developed case and second .ascgrid to be the existing case). Importing this grid into Vertical Mapper creates a .grc (grid classification) grid that has two categories: “Was Wet Now Dry” and “Was Dry Now Wet”. This grid is particularly useful for displaying areas that were previously inundated or previously flood-free.<br>
Example:
*Runs a difference operation on GeoTIFF outputs.<br>
*Creates new grids comparing the differences in flood levels and extents for: "difference.asc" = "after_h.asc" - "before_h.asc"<br>
:<tt>grid_to_grid.exe -out difference.asc -dif after_hproposed.asctif before_hexisting.asctif</tt>
*As above with specified output name "difference.tif".<br>
:<tt>grid_to_grid.exe -out difference.tif -dif proposed.tif existing.tif</tt>
* Runs a difference operation on GPKG outputs. The layer name needed is assumed to be the same as the database name.<br>
:<tt>grid_to_grid.exe -dif proposed.gpkg existing.gpkg</tt>
* Runs a difference operation on GeoPackage outputs where the layer name is different than the database name, see <u>[[#GPKG_and_NetCDF | GPKG and NetCDF]]</u>.<br>
:<tt>grid_to_grid.exe -dif "proposed_grid_results.gpkg >> proposed_max_h" "existing_grid_results.gpkg >> existing_max_h"</tt>
 
Secondary options (only one can be used):
Line 138 ⟶ 89:
*If two grids are specified, the first value is used for setting the cutoff depth and the values from the second grid are processed.<br>
*If three grids are specified, the third grid is used for setting the filename for the output grid. This is ignored if the "-out" option is used.<br>
Example:
Examples:
*Creates a new depth grid only where the depth is greater than 0.1m.<br>
:<tt>grid_to_grid.exe -cd0.1 depth.asctif</tt>
*Creates a new level grid only where the depth is greater than 0.1m.<br>
:<tt>grid_to_grid.exe -cd0.1 depth.asctif levels.asctif</tt>
*As per the example above, but sets the output name as "filtered_levels.asctif".<br>
:<tt>grid_to_grid.exe -cd0.1 -out filtered_levels.asctif depths.asctif levels.asctif</tt>
 
==Resize==
'''"-resize<factor>"'''<br>
Resize the grid based on the factor above. The factor must be an integer (greater than 1). The output grid has the same origin (lower left) coordinates as the input grid. The new cell size is the factor times the old cell size. For example if a -resize5 is used on a 2m resolution grid the output grid will be 10m. For processing the grid three options are available:
===Average (default)===
This is the defualt processing method, which can also be specified with the '''-rm_avg''' (resize method - average) input flag. When processing for each tile in the new grid, the average of all non-null values in the input grid is taken. For example with a resize factor of 5, the 25 values in the input grid are averaged.<br>
Example:
*Creates a new 10m DEM (DEM_10m.asc) based on the the 2m DEM using an averaging approach.<br>
:<tt>grid_to_grid.exe -resize5 -out DEM_10m.asctif DEM_2m.asctif</tt>
 
===Minimum===
Alternative processing method for resize, specified with the '''-rm_min''' (resize method - minimum) flag. At each output grid the values isare the minimum of the values in the input grid.<br>
Example:
*Creates a new 10m DEM (DEM_10m_min.asc) based on the the 2m DEM using an minimum approach.<br>
:<tt>grid_to_grid.exe -resize5 -rm_min -out DEM_10m_min.asctif DEM_2m.asctif</tt>
 
===Maximum===
Alternative processing method for resize, specified with the '''-rm_max''' (resize method - maximum) flag. At each output grid the values isare the maximum of the values in the input grid.<br>
Example:
*Creates a new 10m DEM (DEM_10m_max.asc) based on the the 2m DEM using an maximum approach.<br>
:<tt>grid_to_grid.exe -resize5 -rm_max -out DEM_10m_max.asctif DEM_2m.asctif</tt>
 
==Transform==
Transforms the values using a simple y = mx + c approach. theThe multiplier (m) is specified with flag '''-trans_m<value>'''. The add value (c) with flag '''-trans_c<value>'''. Only one valuesvalue is required to be specified.<br>
Example:
Examples:
*Multiplies all values by 0.3048.<br>
:<tt>grid_to_grid.exe -trans_m0.3048 DEM.asctif</tt>
*Multiplies all values by 0.3048 and then adds 10.0.<br>
:<tt>grid_to_grid.exe -trans_m0.3048 -trans_c10 DEM.asctif</tt>
 
==Decimal==
Converts .flt to .asc formatgrids with specified number of decimal spaces. For example ASC format created directly from TUFLOW comes only with three decimal spaces, FLT and TIF format has more decimal spaces.<br>
Example:
*Converts all .fltTIF grids to .ascASC format with 5 decimal spaces.<br>
:<tt>grid_to_grid.exe -conv -asc -decimal5 *.flttif</tt>
 
==Classify==
Classifies the grid based on the input classifications. The output file is a classified .asc grid. The classification .csv file should have two columns, cutoff value and name (in that order). The first line in .csv treated as a header line and ignored. Any values over the greatest cutoff with be outputted to class "above".<br>
{| class="wikitable"
 
Line 195 ⟶ 146:
|}
 
Example:
Examples:
*Outputs a classified grid, based on the cut off values and names in the "classifications.csv".<br>
:<tt>grid_to_grid.exe -classify classifications.csv results_VMax.asctif</tt>
*If using vertical mapper the -grc option can be used to create the .ascflt file in classified grid format,. inIn this format, rather than storing a numerical value when interrogating an area, a label is returned. This format is not recognised by ArcMap or QGIS. If using the grc option it is also possible to specify the desired RGB (red, green, blue) values for the output grid in the .csv file used for the classification. The RGB values should be specified in the 3-5th columns of the .csv file.<br>
:<tt>grid_to_grid.exe -RGB -grc -classify depth_classify.csv results_dMax.ascflt</tt><br>
 
:{| class="wikitable"
Line 223 ⟶ 174:
==Extract Breaklines from DEM==
'''"-brkline <gis file in 2d_zsh format>"'''<br>
Extracts elevations from a DEM for breaklines in the 2d_zsh format. This GIS input should have four attributes, z, dz, width and shape_options, as described in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. For the utility the '''dz''', '''shape_width''' and the '''shape_options''' are used. Valid shape_options are "Max" and "Min" or blank (average used). The utility extracts an elevation at each vertex along the line.<br>
This feature was added to the 2013-06-AA version of the utility.<br>
Extracts elevations from a DEM for breaklines in the 2d_zsh format. This GIS input should have four attributes, z, dz, width and shape_options, as described in the <u>[https://docs.tuflow.com/classic-hpc/manual/latest/ TUFLOW Manual]</u>. For the utility the '''dz''', '''shape_width''' and the '''shape_options''' are used. Valid shape_options are "Max" and "Min" or blank (average used). The utility will extract an elevation at each <u>vertex</u> along the line.<br>
Depending on the line width and DEM cell size, the following methods are used:<br>
* If the width is set to 0, the closest DEM value to the vertex is used. If a "shape_option" is specified, this is ignored.
* If the width is greater than 0, but less than 1.5 times the DEM cell size, the four DEM values surrounding the vertex are used. If max or min is specified in the "shape_option" the max or min of the four values is used. If max or min option is not specified (attribute is blank), the average of the four values is used.
* If the width is greater than 1.5 times the DEM cell size, at each vertex a buffer region (search radius) is created and all non null DEM values within the buffer object are processed. The diameter of the buffer region is equal to the width specified. If max or min option is not specified, the average of the values within the region is used. These buffer regions are outputted as a separate file, if '''"-check"''' switch is specified in the batch command.<br>
Line 232 ⟶ 182:
'''NOTE:''' For the output GIS file, the '''dz''' attribute is set to 0.0 regardless of the value set in the input field. <br>
Example:
*<tt>grid_to_grid.exe -brkline 2d_zsh_breaklines_L.shp DEM.ascflt</tt>
*<tt>grid_to_grid.exe -brkline 2d_zsh_breaklines_L.gpkg DEM.tif</tt>
 
==Fuzzy Map==
'''"-fuzzy <input grids>"'''<br>
This feature was added to the 2014-03-AB version of the utility.<br>
A fuzzy map can be used when comparing a large number of simulations.<br>
For each input grid (or scenario) the grid is classed as either 1 if the results grid is wet or 0 if dry. The total score for each grid cell is is calculated and then divided by the total number of input grids. A value of 1 indicates that the cell was wet in each simulation ,a value of 0 is dry in all simulations. Grids with a value of 0.5 are most sensitive.<br>
This can be useful for quantifying the sensitivity of the model to parameters.<br>
Example:
*Create a fuzzy map from all maximum depth grids in the directory.<br>
:<tt>grid_to_grid.exe -fuzzy *_d_Max.flttif</tt>
 
==Histogram==
'''"-histogram bins.csv <input grid>"'''<br>
This feature was added to the 2014-03-AB version of the utility.<br>
Calculates the number of cells and percentage of cells that fall in each range. Requires and input .csv file containing the bin values.<br>
Example:
Examples:
*An example inputs bin file is:<br>
:{| class="wikitable"
Line 290 ⟶ 239:
|Above 5.0|| Above 5.0 || 973 || 0.06
|}
*Example usage:
:<tt>grid_to_grid.exe –histogram histogram_bins.csv results_d_Max.asctif</tt>
 
==Extract 1D Model Inputs==
'''"-egc control_file.egc"'''<br>
This allows 1D Network (1d_nwk) and/or 1D Crosscross-Sectionssections to be extracted from a series of grids.<br>
A simple input file similar to the TUFLOW geometry control file is input into the utility. This is nominally given the extension .egc (Estry Geometry Control).<br>
<br>
Line 355 ⟶ 304:
|Read GIS XS == <1d_cut GIS file>|| Reads the cross-section cut lines, these are described above.
|-
|Read GIS FLC == <GIS file>|| Optional GIS layer of polygons that can be used to specify form loss coefficients to the 1d_nwk layer. A single GIS (float) attribute is required. A FLC value of greater than 0 will be split between all 1d_nwk channels within the region. A FLC value of less than 0, will apply the absolute value to all channels within the polygon. For example if an FLC value of -0.1 is specified, all channels that fall within the polygon will have a form_loss attribute of 0.1. If a channel falls within multiple polygons, the form loss values will be added.
Reads the polygons off losses from GIS layer. cross-section cut lines, these are described above.
|-
|Set XS dx == <distance>|| Sets the default distance across section to extract elevations and materials data. This can be specified on the cut lines as detailed above.
Line 380 ⟶ 328:
|FLC per Unit Length == <form loss per unit length> || The form loss per unit length is written to the "exit_loss" attribute of all 1d_nwk channels.
|}
Example usage:
*<tt>grid_to_grid.exe -egc MR_1d_001.egc</tt>
 
Line 395 ⟶ 343:
 
Set XS Mat == 1 !default Material ID of 1
Read Grid Mat == grid\grid_5m_2d_mat_MR_001.flttif
 
Set XS Z == 99
Read Grid Z == grid\dem_5m_regional.flttif
Read Grid Z == grid\dem_1m_bathymetry.flttif
Read Grid Z == grid\dem_1m_survey.flttif
</pre>
 
Line 408 ⟶ 356:
The input GIS region file should have the same attributes as the 1d_tab file format produced by TUFLOW. The first attribute ("Source" ) should contain a valid .csv file name.<br>
The out nodal area table extends from the minimum to the maximum elevation in the DEM. A user defined minimum value can be specified using the "Skew" attribute of the GIS region.<br>
Example usage:
*<tt>grid_to_grid.exe -na 1d_na_storage_Rstorage_R.shp DEM_1m.flttif</tt>
 
==Calibration Points==
'''"-cp <cp_file>"'''<br>
For appending the value from a .asc or .fltgrid file to a .mif or .shp file. The cp_file contains points representing locations where results are extracted from TUFLOW. The file format includes two attributes. The first attribute is a numeric field containing the recorded value. The second field is a char(100) text field containing the cp name.<br>
'''"-config <config_file>"''' (optional)<br>
Points to a csv file containing accuracy thresholds and style control options, e.g. symbol, colour and size.<br>
Line 420 ⟶ 368:
'''"-cpmm<mm>"''' (optional)<br>
The second search radius used to search for maximum and minimum values in meters.<br>
Example usage:
*<tt>grid_to_grid.exe -cp Flood_Marks.MIF -config diff_config.csv -cpsd100 -cpmm50 results_h_Max.asctif</tt><br>
 
==Statistics==
<big>'''"-stat<type>"'''</big>
As of the 2017-10-AA build, theThe grid_to_grid.exe utility allows the user to perform a number of statistical analyses on a group of input grids (*.flt or *.asc format). This is particularly useful when extracting information from assessments that produce multiple result files for a single event, for example, processing grids from an ensemble assessment with numerous temporal pattern arrangements.
 
The available options are:
Line 444 ⟶ 392:
* A value grid: the resulting median value
* An SRC grid: a grid listing which source input grid the median result value came from (a corresponding .csv file is also written as a legend)<br>
Example usage:
*<tt>grid_to_grid.exe -statMedian Q100_30min_TP1_h.asctif Q100_30min_TP2_h.asctif Q100_30min_TP3_h.asctif Q100_30min_TP4_h.asctif Q100_30min_TP5_h.asc.. Q100_30min_TP10_h.tif </tt><br>
 
[[File: asc_to_asc_statsMedian_eg.PNG|1000px|]]<br>
<br>
Note, the median value for thatthe cellexample wasbelow dryis (a 'NULL') value, then the output wouldis bea dry cell. For example, 7 out of the 10 inputs are dry at athis particular locationcell. Once theythe outputs are ordered them (with NULL showing at the lowest spots), then the median (6th) value for thisthe cell is 'NULL' (dry) and the source would be 8, as shown below. Therefore, at this location you would see a dry cell in the median output, and '8' inis the source grid output.
<br>
[[File:A2A median.png|400px]]<br>
Line 458 ⟶ 406:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the result value came from or was the next above (a corresponding .csv file is also written as a legend)<br>
Example usage:
*<tt>grid_to_grid.exe -statMean Q100_30min_*_h.asctif</tt><br>
 
==="-statFrac"===
Line 465 ⟶ 413:
 
The utility outputs one grid:
* A Frac grid: the resulting Fractionfraction value<br>
Example usage:
*<tt>grid_to_grid.exe -statFrac Q100_30min_*_h.asctif</tt><br>
 
==="-statMin"===
The -statMin flag outputs the minimum value at each grid cell from all the input grids. This flag is analogous with the [[#Minimum|-Min]] operation flag.
 
The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the minimum result value came from (a corresponding .csv file is also written as a legend)<br>
Example usage:
*<tt>grid_to_grid.exe -statMin Q100_30min_*_h.asctif</tt><br>
 
==="-statMax"===
Line 484 ⟶ 432:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the maximum result value came from (a corresponding .csv file is also written as a legend)<br>
Example usage:
*<tt>grid_to_grid.exe -statMax Q100_30min_*_h.asctif</tt><br>
 
==="-statAll"===
Line 494 ⟶ 442:
* An SRC grid: for the median, mean, min and max calculations (calculation of source grids as detailed above)
* A .csv file that contains the legend for all SRC grids<br>
Example usage:
*<tt>grid_to_grid.exe -statAll Q100_30min_*_h.asctif</tt><br>
 
==="-statRank<integer id>"===
The -statRank<integer> flag outputs the ''n<integer>'' ranked value at each grid cell from all the input grids. All the input grids are considered, regardless of if the grid cell is dry in some of the input grids (dry areas are still ranked as low e.g. Rank1, Rank2 and so on). For example, if the number of input grids is 10, at each grid cell the values are ranked lowest to highest (from 1 to 10). -statRank8 will output results taken from the 8th ranked grid. In this example, -statRank1 is equivalent to ''Min'', -statRank10 is equivalent to ''Max'', and -statRank6 is equivalent to ''Median''. The Rank flag allows additional functionality that lets users extract results in between those that are pre-programmed.
 
The utility outputs two grids:
* A value grid: the resulting value
* An SRC grid: a grid listing which source input grid the ranked result value came from (a corresponding .csv file is also written as a legend)<br>
Example usage:
*<tt>grid_to_grid.exe -statRank5 Q100_30min_*_h.asctif</tt><br>
 
==Flood Extent==
'''"-fe"'''<br>
Returns a simple grid with value of 1 where the input grid has an active, non-zero value.<br>
Example usage:
*<tt>grid_to_grid.exe -fe results_dMax.asctif</tt><br>
 
==Remap==
'''"-wl <wl_file> -dem <dem_file>"'''<br>
Remap a water level grid to a higher resolution DEM.<br>
Remaps coarser resolution water level grid to a finer resolution DEM.<br>
'''"-wl <wl_file>"'''<br>
Sets the coarser resolution water level grid to remap from.<br>
'''"-dem <dem_file>"'''<br>
Sets the finer resolution DEM.<br>
The default interpolation method is TIN. But "-idw_npt<number of points>" flag can be used to change the interpolation method to IDW and set the number of points used for IDW interpolation (default is 12).<br>
Example:
Examples:
*TheRemaps utilitywater canlevel also remap additional map output grids (e.g. velocity, hazard and others)grid to the resolution of the DEM file, e.g.:<br>
:<tt>grid_to_grid.exe -remap -wl lowres_h.asctif -dem DEM_highres.asctif</tt>
*The utility can also applyremap adepth bufferoutput distancegrids or add freeboard. For example,to the below applies a buffer distanceresolution of 20m, and adds a freeboard of 0.2m to the original water levelDEM grid.file:<br>
:<tt>grid_to_grid.exe -remap -wl lowres_h.asctif -dem DEM_highres.asctif lowres_vlowres_d.asc lowres_hazard.asctif</tt>
*The utility can also apply a buffer distance or add a freeboard. The below applies a buffer distance of 20m, and adds a freeboard of 0.2m to the original water level grid.<br>
:<tt>grid_to_grid.exe -remap -fb0.2 -bd20 -wl lowres_h.asc -dem DEM_highres.asc</tt>
:<tt>grid_to_grid.exe -remap -fb0.2 -bd20 -wl lowres_h.tif -dem DEM_highres.tif</tt>
 
Note that, for any output types other than depth, this utility does NOT interpolate the result from the coarser grid to the finer grid, but only extends/reduces the output extent to the dry/wet extent. More discussions on this function is documented here <u>[[TUFLOW_Remapping | TUFLOW Remapping Tool]]</u>.<br>
 
=GPKG and NetCDF=
=Other Options (switches)=
GeoPackage and NetCDF are database formats and are able to contain multiple layers in a single file. When passing in an input or output reference to a GeoPackage or NetCDF file the layer name is assumed to be the same as the database name unless otherwise specified. To give the layer a different name than the database, the following syntax <tt>"database.ext >> layer"</tt> can be used:<Br>
A list of the general switches is provided in the table below, these are available for all operations listed above:<br>
<pre>grid_to_grid.exe -dif "database.gpkg >> raster1" "database.gpkg >> raster2"</pre>
{| align="center" class="wikitable"
Notes:
* Quotes will always be required when using this syntax.
* GPKG output paths can be either a new or existing database i.e. the utility supports writing new layers into an existing database.
* NetCDF outputs will overwrite any existing NetCDF file.
* Typically outputs to the GPKG or NetCDF format will be grouped together into a single output file.
 
=Creation Options=
! style="background-color:#005581; font-weight:bold; color:white;"| Switch
The grid_to_grid.exe supports GDAL style creation options. Creation options can be passed in using the "-co" flag then the name of the creation option and the value:<Br>
! style="background-color:#005581; font-weight:bold; color:white;" width=80% | Description
<pre>-co COMPRESS=DEFLATE</pre>
|-
Multiple creation options can be used (each will require its own "-co" flag).<Br>
|"-b"|| Run the utility in batch mode, this suppresses the prompt to press enter at the end of processing. Used in .bat files where two or more files are to be processed. The -b flag should be placed after the grid_to_grid.exe call, before the function command. For example:<br> <tt>grid_to_grid.exe -b -brkline 2d_zsh_breaklines_L.shp DEM.asc</tt><br>
<Br>
|-
The creation options have adopted the same naming as GDAL (more information on the options can be found at <b><u>[https://gdal.org https://gdal.org]</u></b>), however, not all options in GDAL are supported in the grid_to_grid.exe utility. The following creation options are supported:<Br>
|"-out <output grid name>"||Specify the output filename for the new grid. <br> '''Note:''' a space is required between the -out and the filename.
====GeoTIFF====
|-
* COMPRESS=NONE/DEFLATE/LZW - output compression. Default - DEFLATE.
|"-flt"||Set the output grid format to binary float (.flt).
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is hightest compression. Only supported for DEFLATE compression method. Default - 9.
|-
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
|"-asc"||Set the output grid format to ESRI ascii format (.asc).
* NUM_THREADS=[N]/ALL_CPUS - Number of threads to use when processing GeoTIFFs. Default - ALL_CPUS.
|-
* BIGTIFF=YES/NO/IF_NEEDED - Controls whether the ouput file uses the BigTIFF format or classic TIFF. Default - IF_NEEDED.
|"-grc"||For use with the "-classify" option and .asc format output. This creates a classified grid (uses name rather than number). This is only valid if using Vertical Mapper, neither QGIS or ArcMap will recognise this format. This can also be used with the -RGB option to specify the output colouring of your grid.
* TILED=YES/NO - Controls whether the output GeoTIFF should use tiles or strips. Default - NO.
|-
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. The grid_to_grid tool only supports internal overviews and therefore this option is only supported for tiled GeoTIFFs. Default - NO.
|"-check"||This creates check files for the data processing if applicable.
====Cloud Optimised GeoTIFF (COG)====
|-
Same options as GeoTIFF however will automatically use 'TILED=YES' and 'OVERVIEWS=YES' creation options.
|"-src"||For use with -min,-max or various stat options to supress the source grid output. Will only output the minimum, maximum, mean, median, frac grid. The src_legend.csv is also supressed.
====GeoPackage====
|}
* COMPRESS=NONE/LZW - output compression. Default - LZW
* PREDICTOR=1/2 - Compression predictor. Supported options are none [1] and horizontal differencing [2]. Default - 2.
* OVERVIEWS=YES/NO - Controls whether overviews (also known as pyramids) should be created. Default - NO.
====NetCDF====
* COMPRESS=NONE/DEFLATE- output compression. Default - DEFLATE
* ZLEVEL=[0-9] - Compression level. Zero is no compression, 9 is highest compression. Only supported for DEFLATE compression method. Default - 9.
====ASC====
* DECIMAL_PRECISION=N - The number of decimal places in the output. This option is analogous to the <tt>"-decimal[N]"</tt> switch. Default - 3.
<br>
<br>
 
Retrieved from "https://wiki.tuflow.com/GRID_to_GRID_draft"