User:Jcreer/SMS:Toolbox

Starting with version 13.2 , SMS includes a general purpose toolbox that allows the SMS process to interact with external python scripts. In SMS 13.2 this is a beta feature. For this version, the user accesses the toolbox by right clicking on the "Project" item at the top of the tree in the "Project Explorer" and selecting "Toolbox". This bring up the SMS toolbox dialog.

SMS Toolbox

Tools in the toolbox allow the user to operate on data in an SMS interactive session as well as data in external files. Each tool in the toolbox links to a python script that produces a specific output. Example output from a tool could include, but are not limited to:

• a graphic or plot.
• a report (document or spreadsheet) for a specified analytical process.
• a new geometry item in SMS.
• a new dataset in SMS.
• a new data file.

Tools Tab

Available tools in the SMS Tool dialog are divided into categories, typically based on the type of output or the type of arguments used in the tool. Currently these categories include:

• Datasets – Contains tools for manipulating datasets attached meshes, scatters sets, or Ugrids.
• Rasters – Contains tools for manipulating raster files in the GIS module.
• UGrids – Contains tools for manipulating UGrids, scatter sets, and meshes.

History Tab

The toolbox maintains a history of all tools invoked for a session of SMS. Eventually this history will be recorded so that it includes all tools invoked for this project.

The history section includes the tool and the date/time the tool was invoked. Double-clicking on an entry in the history tab launches the listed tool. The input fields are populated with the arguments that were used in the previous invocation of the tool. These inputs can be changed for the new invocation of the tool.

Dataset Tools

Angle Convention

This tool converts between angle conventions, converting an angle convention to another angle convention dataset. The tool has the following options:

• Input scalar dataset – Select the scalar dataset that will be the input.
• Input angle convention – Select the type of angle convention used in the input scalar dataset.
  • "Cartesian" – Specifies that the input dataset uses a Cartesian angle convention.
  • "Meteorologic" – Specifies that the input dataset uses a Meteorological angle convention.
  • "Oceanographic" – Specifies that the input dataset uses an Oceanographic angle convention.
• Output angle convention – Select the angle convention for the new dataset.
  • "Cartesian" – Sets that the output dataset will use a Cartesian angle convention.
  • "Meteorologic" – Sets that the output dataset will use a Meteorological angle convention.
  • "Oceanographic" – Sets that the output dataset will use an Oceanographic angle convention.
• Output dataset name – Enter the name for the output dataset.

Canopy Coefficient

This tool computes a canopy coefficient from a landuse raster. The tool has the following options:

• Input landuse raster – Select which landuse raster in the project will be the input.
• Interpolation option – Select which of the following options will be used for interpolating the canopy coefficient.
  • "Node location" – Interpolation based around where the nodes are located.
  • "Area around node" – Interpolation based around the area around the nodes. This adds an option to the dialog.
    • Minimum percent blocked which ignores wind stress – Sets the minimum potential percent of the canopy that will be blocked and ignore the wind stress.
• Target grid – Select which grid will be the target.
• Landuse raster type – Select what type the landuse raster is.
  • "NLCD" – Sets the landuse raster type to National Land Cover Dataset (NLCD).
  • "C-CAP" – Sets the landuse raster type to Coastal Change Analysis Program (C-CAP).
  • "Other" – Sets the landuse raster type to be set by the user. This adds an option to the dialog.
    • Landuse to canopy coefficient mapping table – The Select File... button will allow a table file to be selected. The entire file name will be displayed in the text box to its right.
• Output canopy coefficient dataset – Enter the name for the new canopy coefficient dataset.

Compare Datasets

This tool compares two datasets by creating a new dataset of the differences. The tool has the following options:

• Dataset 1 – Select the first dataset to compare.
• Inactive values option – From the drop-down menu, select the desired approach for handling inactive values in the dataset.
  • "Use specified value for inactive value" – A specified value will replace inactive values.
  • "Inactive values result in an inactive value" – Inactive values will be left as inactive in the comparison dataset.
• Specified value – Enter a value that will be used for inactive values.
• Dataset 2 – Select the second dataset to compare. This has the same options available as Dataset 1 for dealing with inactive values.
• Output dataset name – Enter the name of the new comparison dataset.

Directional Roughness

The Landuse Raster to Directional Roughness tool converts a landuse raster (NLCD, C-CAP, etc.) to a coastal directional roughness dataset. The tool has the following options:

• Input landuse raster – Select which landuse raster in the project will be the input.
• Method – Select which method will be used for computation of the conversion.
  • "Linear" – Computations will convert in a linear fashion.
  • "Sector" – Computations will convert through the use of sectors.
• Total distance – Sets the total distance of the directional roughness, measured in the units that the project is set in.
• Weighted distance – Sets the weighted distance of the directional roughness, measured in the units that the project is set in.
• Target grid – Select which grid will be the target.
• Landuse raster type – Select which type the landuse raster is.
  • "NLCD" – Sets the landuse raster type to National Land Cover Dataset (NLCD).
  • "C-CAP" – Sets the landuse raster type to Coastal Change Analysis Program (C-CAP).
  • "Other" – Sets the landuse raster type to be set by the user. This selection adds an option to the dialog.
    • Landuse to directional roughness mapping table – The Select File... button allows a table file to be selected. Its full file name will appear on the box to its right.
• Default wind reduction value – Set the default level of wind reduction for the new dataset.
• Output wind reduction dataset – Enter the name for the new wind reduction dataset

Geometry Gradient

This tool computes geometry gradient datasets. The tool has the following options:

• Input dataset – Select the dataset to use in the gradient computations.
• Gradient vector – Select to create a gradient vector dataset.
• Gradient magnitude – Select to create a gradient magnitude dataset.
• Gradient direction – Select to create a gradient direction dataset.
• Output gradient vector dataset name – Enter the name for the new gradient vector dataset.
• Output gradient magnitude dataset name – Enter the name for the new gradient magnitude dataset.
• Output gradient direction dataset name – Enter the name for the new gradient direction dataset.

Landuse Raster to Mannings N

This tool converts a landuse raster (NLCD, C-CAP, etc.) to a Mannings N dataset. The tool has the following options:

• Input landuse raster – Select which landuse raster in the project will be the input.
• Landuse raster type – Select which type the landuse raster is.
  • "NLCD" – Sets the landuse raster type to National Land Cover Dataset (NLCD).
  • "C-CAP" – Sets the landuse raster type to Coastal Change Analysis Program (C-CAP).
  • "Other" – Sets the landuse raster type to be set by the user.
• Target grid – Select the grid that will be the target.
• Landuse to Mannings N mapping table The Select File... button allows a table file to be selected. Its full file name will appear on the box to its right.
• Default Mannings N option – Select which of the following will be used as the default for Mannings N. The option that is selected will populate an option in the dialog.
  • "Constant" – Sets a constant value to be the default for Mannings N.
    • Default Mannings N value – Sets a constant value to be the default for Mannings N.
  • "Dataset" – Sets a dataset to be the default for Mannings N.
    • Default Mannings N dataset – Select a dataset to be used as the default for Mannings N.
• Subset mask dataset (optional) – Select a dataset to be used for the subset mask, which is optional.
• Output Mannings N dataset – Enter the name for the new Mannings N dataset

Map Activity

This tool builds a dataset with values copied from one dataset and activity mapped from another. The tool has the following options:

• Value dataset– Select the dataset that will define the values for the new dataset.
• Activity dataset – Select the dataset that will define the activity for the new dataset.
• Output dataset – Enter the name for the new activity dataset.

Scalar to Vector

This tool converts a pair of scalar datasets to a vector dataset. The tool has the following options:

• Input type – In order to convert the scalar dataset, the tool needs to know input to use.
  • "Vx and Vy" – This option will designate the input dataset values as Vx and Vy.
  • "Magnitude and Direction" This option will designate the input dataset values as magnitude and direction.
• Input Vx or magnitude scalar dataset – Select the scalar dataset to use for the Vx or magnitude input.
• Input Vy or direction scalar dataset – Select the scalar dataset to use for the Vy or direction input.
• Output vector dataset name – Enter the name for the new vector dataset.

Smooth Datasets

This tool smooths datasets by limiting slope or area. The tool has the following options:

• Input elevation data set – Set the elevation dataset that will be the input.
• Anchor – Select which type of anchor.
  • "Minimum value" – Sets the anchor to minimum value.
  • "Maximum value" – Sets the anchor to maximum value.
• Smoothing option – Select which type of smoothing option. The option selected will add options to the dialog.
  • "Elemental area change" – Sets the smoothing option to elemental area change.
    • Smoothing area change limit – Sets a limit to the smoothing area change.
    • Smoothing minimum cell size – Sets the minimum cell size to the smoothing.
  • "Maximum slope" – Sets the smoothing option to maximum slope.
    • Smoothing maximum slope – Sets the maximum slope to the smoothing.
• Subset mask data set (optional) – Select a data set for the subset mask (which is optional).
• Output dataset – Type out a name for the dataset that will be output.

Smooth Datasets by Neighbor

This tool smooths datasets by averaging nodal neighbors. The tool has the following options:

• Input data set – Set the dataset that will be the input.
• Number of levels – The amount of levels to the dataset.
  • "1"
  • "2"
• Interpolation method – Set the interpolation method for the smoothing. The option selected may add options to the dialog.
  • "Average" – Sets the interpolation method to average.
    • Weight of nodal neighbors – Set the value for the weight of the nodal neighbors.
  • "IDW" – Sets the interpolation method to IDW.
• Subset mask data set (optional) – Select a data set for the subset mask (which is optional).
• Output dataset – Type out a name for the dataset that will be output.

Vector to Scalar

This tool converts vector datasets to scalar datasets. The tool has the following options:

• Input vector data set – Select the vector dataset located in the project.
• Data set name prefix – Enter a prefix that will be affixed to the converted datasets.
• Magnitude – Enter the magnitude for the dataset.
• Direction – Enter the direction for the dataset.
• Vx – Enter the Vx for the dataset.
• Vy – Enter the Vy for the dataset.

Raster Tools

Blend Raster to Edges

The Blend Raster to Edges tool is intended to facilitate the use of multiple topo/bathy DEMs (potentially from multiple sources) as a source for elevation data on a surface and avoid discontinuities that may exist between the DEMs.

The tool creates a new raster that is a modified version of the raster that is the second argument to the tool. The modified version transition along its active edges from the values in the raster to the values in the primary raster (the first argument).

This tool is intended to be used to pre-condition topo/bathy sources for use in the Interpolate Priority Rasters tool.

Blend raster to edges

Input parameters

• Primary raster – Use the drop-down to select the raster that will be designated as the primary raster.
• Secondary raster – Use the drop-down to select the raster that will be designated as the secondary raster.
• Blend width along edge – Where the edges of the primary and secondary rasters meet, the edges will be blended to the width specified with this option.

Output parameters

• Output raster – Provide a name for the new blended raster.

Current Location in toolbox

Rasters/Blend Raster to Edges

Related Tools

• Interpolate Priority Rasters
• Clip Raster from Elevations

Clip Raster from Elevations

Channel to clip example

Combined sources

The Clip Raster from Elevations tool creates a new raster (DEM) from a source raster creating invalid data regions in areas where the source raster data are determined to be invalid. To be invalid, the data from the source raster would be either above, or below a provide elevation raster. The side that is invalid is specified as an input parameter.

The Clip Raster from Elevations tool is intended to facilitate the use of multiple topo/bathy DEMs (potentially from multiple sources).

The example of forcing a low flow channel into a DEM illustrates one example of an application of this tool. In this case, it is common for the DEM to have the water surface elevation in regions where the low flow channel exists. These water surface elevation values should not be used in a hydraulic simulation of the area. Instead, channel bed elevations should be supplied. Local survey cross sections are often composed into a channel surface for this purpose. However, due to datum adjustments, time, and roundoff error, the surfaces may have discontinuities. Depending on the situation, the modeler may choose to invalidate the portion of the channel surface that is above the DEM to prevent numerical levees along the edge of the channel.

This tool is intended to be used to pre-condition topo/bathy sources for use in the Interpolate Priority Rasters tool.

Input parameters

• Raster to clip – This option designates the raster which will have elevation values clipped by the elevation raster.
• Elevation raster – This option selects the elevation raster to use.
• Clip elevations above or below elevations raster – Once the raster to clip and elevation raster have been specified, the tool can either clip elevation values either above or below the elevation raster's values.
  • "Clip elevations above" – This option removes values that are above the elevation values of the elevation raster.
  • "Clip elevations below" – This option removes values that are below the elevation values of the elevation raster.

Output parameters

• Output raster – Enter the name for the new clipped raster.

Current Location in toolbox

Rasters/Blend Raster to Edges

Related Tools

• Interpolate Priority Rasters
• Blend Raster to Edges

Interpolate Priority Rasters

The Interpolate Priority Rasters tool creates a new dataset for a selected geometry (UGrid/Mesh2D/Scatter Set) by interpolating from multiple rasters according to a user specified priority. Each source is added to the list in priority order. If a value is not obtained when interpolating from the highest priority source, the tool looks for a value in the next source until either a value is found or all sources are exhausted.

It should be noted that rasters from different sources may have errors or differences from one another for a variety of reasons. Principal causes of incompatibilities between rasters include the changes between the times when each source was gathered, differences in survey methods, and slight adjustments to datums. Large raster differences can result in discontinuities in the surface. These discontinuities can have ramifications on the hydraulic results for simulations of flow over the combined surface.

Observation profiles can be extracted from the surfaces to visualize the differences. If significant differences exist, the Blend Raster to Edges tool and the Clip Raster from Elevations tool can be used to correct them.

It should be noted that the output dataset must be mapped to be the Elevation of the target geometry if that is desired. It is not mapped automatically.

Input parameters

• Grid – Allows selecting the geometry that will receive the interpolated raster values.
• Default dataset – Allows selecting a dataset in the project to use as the default values for interpolation.
• Resample algorithm – Select the method that will be used for interpolation.
  • "blinear" – Select to use the linear interpolation method.
  • "nearest_neighbor" – Select to use the natural neighbor interpolation method.
• Raster 1 (highest priority) – Select the raster that will be given highest priority during the interpolation process.
• Raster 2 – Select the raster that will be given the next highest priority during the interpolation process.
• Raster n – Additional rasters may be selected and given priority in the order they are selected.

Output parameters

• Output dataset name – Allows setting the name of the new dataset on the specified mesh, UGrid, or scatter set.

Current Location in toolbox

Rasters/Interpolate Priority Rasters

Related Tools

• Blend Raster to Edges
• Clip Raster from Elevations
• Merge Elevation Rasters

Merge Elevation Rasters

The Merge Elevation Rasters tool creates a new raster by merging two or more elevation rasters with priority into a new raster. The resolution of the resulting raster will be the resolution of the principal raster (raster 1). The extents of the resulting raster be expanded from the base of the extent defined by raster 1 to include all other rasters.

It should be noted that this operation can result in very large rasters. If a low priority raster has a coarser resolution than the primary raster, it will be super sampled to match the resolution of the primary raster in the areas where this raster extends the domain. This super sampling does not provide new data. For this reason, the Interpolate Priority Rasters tool is recommended ahead of using this operation.

Input parameters

• Raster 1 – Select the first elevation raster to be merged. This raster will be given the highest priority during the merge.
• Blend distance – Enter a distance for the edges of the raster to be blended when merged with another raster. This option can be set for each raster being merged.
• Raster 2 – Select second raster to be merged. This raster will have the next highest priority.
• Raster n – Additional rasters can be added to the merge with lowering priority. These parameters appear as needed. The last field should be left blank

Output parameters

• Merged raster – Enter a name for the new merged raster.

Current Location in toolbox

Rasters/Merge Elevation Rasters

Related Tools

• Interpolate Priority Rasters

UGrid to Raster

This tool converts a UGrid into a raster. The tool has the following options:

• Dataset – From the drop-down menu, select the dataset to convert to a raster.
• Pixel size – Enter the pixel resolution size for the new raster.
• Null value – Enter the null value.
• Extrapolation width – Set the extrapolation width.
• Output raster – Enter the name for the new raster.

UGrid Tools

Convert to Voronoi UGrid

This tool converts an existing UGrid to a Voronoi UGrid. The tool has the following options:

• Input grid – Select the geometry that will be converted to a Voronoi UGrid.
• Output grid name – Enter the name for the new Voronoi UGrid.

Merge Ugrids

The tool merges two 2D UGrids into a new 2D grid. The tool has the following options:

• Primary grid – Select the grid that will act as the primary grid. If there are conflicts during the merge, this grid will receive priority to resolve the conflict.
• Secondary grid – Select the grid that will act as the secondary grid during the merge.
• Merged grid – Enter the name of the new merged UGrid.

Smooth UGrid

This tool smooths a UGrid. The tool has the following options:

• Input grid – Select the UGrid to use.
• Maximum slope – Set the maximum potential slope.
• Anchor type – Select which of the following options will be the anchor type.
  • "Minimum value" – Sets the anchor type to minimum value.
  • "Maximum value" – Sets the anchor type to maximum value.
• Smoothed grid – Enter the name of the new smoothed UGrid.