GIS Manager Tools¶
Properties of a tool (if any) can be specified in the Properties window in MIKE Workbench.
ASCII Temporal Import Tool¶
This tool imports rasters stored in an ASCII formatted grid file (as output by ArcGIS, for example) from given directory to the temporal raster. One file is imported to one time step. Date/time for time step is taken from file name based on given mask.
The tool imports grids stored in what is known as the ArcInfo ASCII Grid format. It looks like the following:
ncols 4
nrows 6
xllcorner 0.0
yllcorner 0.0
cellsize 50.0
NODATA_value -9999
-9999 -9999 5 2
-9999 20 100 36
3 8 35 10
32 42 50 6
88 75 27 9
13 5 1 -9999
The remainder of the file lists the raster values for each cell, starting at the upper-left corner. These real numbers (with optional decimal point, if needed) and are delimited using a single space character. Coordinate system can be read from the file, having the same name as world file and extension prj.If such file exists and contain coordinate system description, recognized by MIKE OPERATIONS – coordinate system field is filled. Item and Unit EUM are stored in the database as integer code, corresponding to the MikeZero type.Scripts needs to use numbers, not string representation.
Tool Info | |
---|---|
Display Name | ASCII Temporal Import Tool |
API Name | Import temporal rasters from ASCII files |
Tools Explorer | /Import/ASCII Temporal Import Tool |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ASCIITemporalImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.IASCIITemporalImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input | ||
File name time mask | DateTimeFilenameMask | Gets or sets the mask to be used for extracting date/time from file name. Each file is imported to one time step. |
Folder Path | DirectoryPath | Gets or sets the directory path of the ASCII files (*.asc) to import. |
Item EUM | Enum_Item | Gets or sets the enum Type of the values stored in the grid. Selected from list, corresponding to the item types used in MIKE Zero files. It is used for example during export to the Dfs2 file. Can be empty. Note that the property is only available when: AddToExistingRaster=False |
Unit EUM | Enum_Unit | Gets or sets the unit of the values, stored in the grid. Selected from list, corresponding to the item types used in MIKE Zero files. Only units, supported for the selected Item EUM are provided in the list. It is used for example during export to the Dfs2 file. Can be empty. Note that the property is only available when: AddToExistingRaster=False |
Output | ||
Raster Name | RasterName | Gets or sets the name of the Raster to create to store rasters imported from ASCII files |
Parameters | ||
Add to existing raster | AddToExistingRaster | Gets or sets a value indicating whether new imported files will be added to exiting raster as new time steps. If false and raster already exists – an error is raised. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the ASCII file to import. Note that the property is only available when: AddToExistingRaster=False |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import temporal rasters from ASCII files")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.IASCIITemporalImportTool(app.Tools.CreateNew("Import temporal rasters from ASCII files"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import temporal rasters from ASCII files") as DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.IASCIITemporalImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.ASCIITemporalImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ASCIITemporalImportTool.dll" />
Buffer¶
Calculates a polygon representing the buffer around the input geometry(ies) at the given distance, inclusive of the input geometry(ies) area. The output will be a feature class with a single polygon feature.
Tool Info | |
---|---|
Display Name | Buffer |
API Name | Buffer |
Tools Explorer | /Geo Processing/Buffer |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IBufferTool |
Input Items | A single features or a single feature class |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Distance | Distance | Gets or sets the distance from the geometry (feature) where the buffer will be calculated |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Unit | Unit | Gets or sets the unit for the distance. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Buffer")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IBufferTool(app.Tools.CreateNew("Buffer"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Buffer") as DHI.Solutions.GISManager.Tools.GeoProcessing.BufferTool;
// Create a features object containing features.
var gisModule = application.Modules.Get(typeof(DHI.Solutions.GISManager.Interfaces.IGISModule)) as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClass = gisModule.FeatureClassList.Fetch("/Sava/Reservoirs");
var featureList = featureClass.FetchAll();
var features = new DHI.Solutions.GISManager.Business.Features();
features.Add(featureList);
// Add input, set properties and execute the tool.
tool.InputItems.Add(features);
tool.Distance = 1;
tool.Unit = DHI.Solutions.GISManager.Interfaces.DisplayUnit.Kilometer;
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.BufferTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Catchment Rainfall Generation¶
The Catchment Rainfall Generation tool, combines the two tools “Time Series to Temporal Raster” and “Temporal Zonal Statistics Tool” into one tool calling the two tools in sequence to calculate feature statistics.
- Creates a new raster based on time series associated to point features in a feature class using the “Time Series to Temporal Raster” tool.
- Based on the created raster, calculate statistics for every feature(polygon, lines or points) in a feature class using the “Temporal Zonal statistics” tool.
Note that the “Catchment Rainfall Generation Tool” uses the same feature class as input for both tools, hence only point feature classes are supported. Refer to the “Time Series to Temporal Raster” tool and the “Temporal Zonal statistics” tool for more information.
Tool Info | |
---|---|
Display Name | Catchment Rainfall Generation |
API Name | Catchment Rainfall Generation Tool |
Tools Explorer | /Temporal Tools/Catchment Rainfall Generation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TemporalRaster |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.Temporal.dll |
API Reference | DHI.Solutions.GISManager.Tools.Temporal.ICatchmentRainfallGenerationTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Catchment Feature Class | ||
Catchment TS Attribute Name | CatchmentTSAttributeName | Gets or sets the attribute name of the catchment feature to be used for naming of result time series names. |
Catchments Feature Class Name | CatchmentsFeatureClassName | Gets or sets the full path to the feature class obtaining catchment polygons. |
Input Feature Class | ||
Add Input TS Association | AddAssociation | Gets or sets a value indicating whether an association should be added. Note that the property is only available when: UseAssociation=False |
Input Timeseries | ||
Group Name | TSGroupName | Gets or sets the time series group name. Note that the property is only available when: UseAssociation=False |
Timeseries mask (as Regular expression) | TSNamePattern | Gets or sets a regular expression used to filter timeseries by name. If this is left empty, the tool will assume a one to one match between the names written in the attribute table and the timeseries names. |
TS Connection Attribute | TsNameFeatureAttributeName | Gets or sets the value of TS name feature attribute. Note that the property is only available when: UseAssociation=False |
Use Timeseries from Feature Association | UseAssociation | Gets or sets a value indicating whether the last timestep from the selected timeseries are written to the attribute table. If set to False, the timestep to pick will need to be specified. If the timestep does not exist, the value will be Null. |
OutputRaster | ||
Interpolation Method | InterpolationMethod | Gets or sets the value of the interpolation method |
Raster Definition | RasterDefinition | Gets or sets the definition of the output raster. The editable properties correspond to the raster properties, as defined in World Files. This includes the extent, rotation, cell size and origin of the raster to create. The extent is by default taken from the feature class extent. Scale X and Scale Y correspond to the cell size for a raster that is not rotated. The Scale Y is negative because the origin of the raster is the top left corner. The read only properties are derived from the editable properties. |
Raster Name | RasterName | Gets or sets the name of the output raster. If it already exists, it will be overwritten. |
Save to group | RasterGroup | Gets or sets the value of raster group |
Use autoscale | AutoScale | Gets or sets a value indicating whether the tool will automatically adjust the width/height or the scale to keep the overall extent equal to the input extent. Changing the width/height will automatically change the scale or vice-versa. |
OutputTimeseries | ||
Associate Rainall TS To Catchments | AssociateTsToFeatures | Gets or sets a value indicating whether output rainfall should be associated to features in the input feature class. |
End Time | EndTime | Gets or sets the end maximum possible end time of the temporal output raster. If timeseries do not have timesteps at this particular date/time, no interpolation is carried out and the raster will end at last available timestep (preceding EndTime). |
Name suffix | NameSuffix | Gets or sets the suffix added to all time series names. If left empty, no suffix will be added. |
Save to group | OutputTSGroup | Gets or sets the group in which to save the timeseries (in format: /Group1/Group2). If this field is left empty, series will be saved in the root. |
Start Time | StartTime | Gets or sets the minimum possible start time of the temporal output raster. If timeseries do not have timesteps at this particular date/time, no interpolation is carried out and the raster will start at first available timestep (following StartTime). |
Statistics | SelectedStatistic | Gets or sets the statistics to be used in Zonal Statistic computation. |
Time Step | TimeStep | Gets or sets the timestep of the output raster. This should match the input timeseries timestep. The tool looks for a given timestep in each input timeseries. If it not found, MissingValue is used. |
Time Step Unit | TimeStepUnit | Gets or sets the time step unit (second, minute, day ...) |
Unit | TimeseriesUnit | Gets or sets the unit of the output time series. Only allowed units are available in the list. The allowed units are defined by the variable type. |
Value type | TimeSeriesValueType | Gets or sets the value of time series value type. |
Variable | TimeSeriesVariable | Gets or sets the variable described by the time series. Each variable will have a set of allowed units, and hence changing the variable can potentially change the list of available units. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *
# Get the tool.
tool = app.Tools.CreateNew("Catchment Rainfall Generation Tool")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.Temporal.ICatchmentRainfallGenerationTool(app.Tools.CreateNew("Catchment Rainfall Generation Tool"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Catchment Rainfall Generation Tool") as DHI.Solutions.GISManager.Tools.Temporal.CatchmentRainfallGenerationTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClass = gisModule.FeatureClassList.Fetch("/TemporalTest");
tool.InputItems.Add(featureClass);
tool.AddAssociation = false;
tool.UseAssociation = false;
tool.TSNamePattern = @"([\w\s\d\.]*)_rainfall";
tool.TsNameFeatureAttributeName = "tsname";
tool.TimeStep = 1;
tool.AutoScale = true;
tool.RasterName = "outputraster";
tool.RasterGroup = "/temprasters";
tool.TSGroupName = "/tsdata";
tool.RasterDefinition.Height = 100;
tool.StartTime = new DateTime(1961, 8, 24, 0, 0, 0);
tool.EndTime = new DateTime(1961, 8, 24, 8, 0, 0);
tool.CatchmentsFeatureClassName = "/TemporalCatchment";
tool.CatchmentTSAttributeName = "catchname";
tool.TimeseriesUnit = "mm";
tool.TimeSeriesValueType = DHI.Solutions.Generic.DataSeriesValueType.Step_Accumulated;
tool.TimeSeriesVariable = "Rainfall";
tool.OutputTSGroup = "/catchTS";
tool.NameSuffix = "_catch";
tool.Execute();
// Get the output of the tool.
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.Temporal.CatchmentRainfallGenerationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.Temporal.dll" />
Clip Feature Classes¶
A tool for clipping a feature class to the features of another.
Tool Info | |
---|---|
Display Name | Clip Feature Classes |
API Name | Clip Feature Classes |
Tools Explorer | /Geo Processing/Clip Feature Classes |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IClipTool |
Input Items | Two feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Clipping Feature Class | FeatureClassToClipTo | Gets or sets the feature class to clip to. This feature class shall be of polygon type. |
Feature Class Name | ClippedFeatureClassName | Gets or sets name of the new clipped feature class |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Clip Feature Classes")
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IClipTool(app.Tools.CreateNew("Clip Feature Classes"))
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Clip Feature Classes") as DHI.Solutions.GISManager.Tools.GeoProcessing.ClipTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var cities = gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/Cities");
var polygon = gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/1Polygon");
tool.InputItems.Add(cities);
tool.InputItems.Add(polygon);
tool.FeatureClassToClipTo = polygon;
tool.ClippedFeatureClassName = "ClippedCities";
tool.Execute();
// Get the output of the tool.
var output = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.ClipTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Crop Management (C)¶
Calculates crop management factor (C) for the RUSLE soil erosion equation. This tool works similarly to the raster Reclassification tool. The mapped values should be derived from the literature.
Tool Info | |
---|---|
Display Name | Crop Management (C) |
API Name | Soil Erosion Crop Management (C) |
Tools Explorer | /Soil Erosion/Crop Management (C) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionCTool |
Input Items | A single raster or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Crop Type Attribute | CropTypeAttribute | The feature class attribute which contains the crop type. (Only used when the input is a feature class). |
Mapping | Mapping | Gets or sets the mapping of values. The keys in the dictionary shall be values representing each type. The mapping values data type shall be single values. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Crop Management (C)")
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionCTool(app.Tools.CreateNew("Soil Erosion Crop Management (C)"))
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Crop Management (C)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionCTool;
// Add input items.
tool.InputItems.Add(<A single raster or a single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionCTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
DHI Data Catalog download¶
The MIKE Cloud Shared Data Download tool allows the download of selected data from global datasets (e.g. rainfall, Evapotranspiration) published by third party (Copernicus, NASA, NOAA...). The data is automatically imported and stored in MIKE Cloud by DHI and made available for free to users with a MIKE Cloud account. Downloaded data can be saved to file(s) or to the database. Data corresponding to the one feature in a feature class are saved to one file or dataset in the database.
Tool Info | |
---|---|
Display Name | DHI Data Catalog download |
API Name | MikeCloudSharedDataDownloadTool |
Tools Explorer | /MIKE Cloud/DHI Data Catalog download |
NuGet Package | DHI.MikeOperations.GISManager.Tools.MikeCloudSharedData |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.IMikeCloudSharedDataDownloadTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Dataset Description | DatasetDescription | Gets the dataset description (if any) after specifying the dataset. |
Dataset | Dataset | Gets or sets the name of the dataset. |
First timestep for extraction | From | Gets or sets the datetime from. |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Last timestep for extraction | To | Gets or sets the datetime to. |
Output Folder | OutputDiskFolder | Gets or sets the output path. Note that the property is only available when: OutputLocation=File |
Output Location | OutputLocation | Gets or sets the output location (database or file). |
Output Name | OutputName | Gets or sets the output name of the feature class that will be used to name outputs files of datasets. |
Output Type | OutputType | Gets or sets the output type. In case of ClipToPolygon, Dfs2(s) or temporal raster(s) is created. In case of AreaAverage, Dfs0(s) or Time series in the database is created. Note that the property is only available when: IsPolygon=True |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool")
from DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool import *
# Get the tool.
tool = app.Tools.CreateNew("MikeCloudSharedDataDownloadTool")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool")
from DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.IMikeCloudSharedDataDownloadTool(app.Tools.CreateNew("MikeCloudSharedDataDownloadTool"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("MikeCloudSharedDataDownloadTool") as DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.MikeCloudSharedDataDownloadTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.Attribute = "Attrib1";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.MikeCloudSharedDataDownloadTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.MikeCloudSharedDataTool.dll" />
Dissolve Feature Class¶
The Dissolve tool combines multiple polygons with identical attribute values (user selected attribute) into a single feature.
Tool Info | |
---|---|
Display Name | Dissolve Feature Class |
API Name | Dissolve Feature Class |
Tools Explorer | /Geo Processing/Dissolve Feature Class |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IDissolveTool |
Input Items | A single feature class |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to dissolve on. |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Dissolve Feature Class")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IDissolveTool(app.Tools.CreateNew("Dissolve Feature Class"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Dissolve Feature Class") as DHI.Solutions.GISManager.Tools.GeoProcessing.DissolveTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.Attribute = "Attrib1";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.DissolveTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Erase Feature Class¶
A tool for erasing a feature class to the features of another.
Tool Info | |
---|---|
Display Name | Erase Feature Class |
API Name | Erase Feature Classes |
Tools Explorer | /Geo Processing/Erase Feature Class |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IEraseTool |
Input Items | Two feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Erasing Feature Class | FeatureClassToErase | Gets or sets the feature class to erase from the other. This feature class shall be of polygon type. |
Feature Class Name | ErasedFeatureClassName | Gets or sets name of the new erased feature class |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Erase Feature Classes")
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IEraseTool(app.Tools.CreateNew("Erase Feature Classes"))
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Erase Feature Classes") as DHI.Solutions.GISManager.Tools.GeoProcessing.EraseTool;
// Set the tool properties and execute.
var cities = _gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/Cities");
var polygon = _gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/1Polygon");
tool.InputItems.Add(cities);
tool.InputItems.Add(polygon);
tool.FeatureClassToErase = polygon;
tool.ErasedFeatureClassName = "ErasedCities";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.EraseTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Erosion Control (P)¶
Calculates erosion control factor (P) for the RUSLE soil erosion equation. This tool works similarly to the raster Reclassification tool. The mapped values should be derived from the literature.
Tool Info | |
---|---|
Display Name | Erosion Control (P) |
API Name | Soil Erosion Erosion Control (P) |
Tools Explorer | /Soil Erosion/Erosion Control (P) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionPTool |
Input Items | A single raster or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Control Type Attribute | ControlTypeAttribute | Gets or sets the feature class attribute which contains the erosion control type. (Only used when the input is a feature class). |
Mapping | Mapping | Gets or sets the mapping of values. The keys in the dictionary shall be values representing each type. The mapping values data type shall be single values. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Erosion Control (P)")
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionPTool(app.Tools.CreateNew("Soil Erosion Erosion Control (P)"))
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Erosion Control (P)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionPTool;
// Add input items.
tool.InputItems.Add(<A single raster or a single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionPTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
Export to ASCII Grid file¶
The ASCII Grid File Export Tool exports an input raster to an ESRI ASCII file with a associated .prj file containing projection information.
Tool Info | |
---|---|
Display Name | Export to ASCII Grid file |
API Name | ASCII Grid File Export Tool |
Tools Explorer | /Output Tools/Export to ASCII Grid file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ASCIIGridFileExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.IASCIIGridFileExportTool |
Input Items | A single raster |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the entity should be exported. |
Tool Settings | ||
ASCII Grid file path | FilePath | Gets or sets the path of the file where the file be saved on the file system. |
Raster Band | RasterBand | Gets or sets the index of the Rater band to be exported. In case of temporal raster it is time step. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool")
from DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("ASCII Grid File Export Tool")
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool")
from DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.IASCIIGridFileExportTool(app.Tools.CreateNew("ASCII Grid File Export Tool"))
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("ASCII Grid File Export Tool") as DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.ASCIIGridFileExportTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = gisModule.RasterList.Fetch("/group/raster");
tool.InputItems.Add(raster);
tool.FilePath = @"c:\temp\export_grid.asc";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.ASCIIGridFileExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.ASCIIGridFileExportTool.dll" />
Export to DFS2 file¶
This tool creates DFS2 file from a temporal raster. Item EUM and Unit EUM are in database, DFS2 file and in scripts are saved as integer enumeration. Available codes can be found in EUM.ubg. If Item EUM is empty Item and units are written as Unknown type in DFS2. If Start Time is empty all time steps are exported.
Tool Info | |
---|---|
Display Name | Export to DFS2 file |
API Name | DFS2 File Export Tool |
Tools Explorer | /Output Tools/Export to DFS2 file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.Dfs2TemporalRasterFileExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.IDFS2TemporalRasterFileExportTool |
Input Items | A single raster |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the entity should be exported. |
Tool Settings | ||
Coordinate system as string | CoordinateSystemAsString | Gets or sets the coordinate system as string. By default, the source coordinate system of the input raster is used. |
DFS2 file path | FilePath | Gets or sets the path of the file where the file be saved on the file system. |
Item EUM | Enum_Item | Gets or sets the MIKE Zero item code to be used in DFS2 file. Combo is filled by the available MIKE Zero item types. Preselected if the raster definition contains this info. |
Start Time | Start_Time | Gets or sets the start time of time steps of the temporal raster to be exported. If the start time is not set, all time steps are exported. |
Unit EUM | Enum_Unit | Gets or sets the MIKE Zero unit code to be used in DFS2 file. Combo is filled by the available MIKE Zero item types. Preselected if the raster definition contains this info. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool")
from DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("DFS2 File Export Tool")
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool")
from DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.IDFS2TemporalRasterFileExportTool(app.Tools.CreateNew("DFS2 File Export Tool"))
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("DFS2 File Export Tool") as DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.DFS2TemporalRasterFileExportTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = module.RasterList.Fetch("/Aladin_4km");
tool.InputItems.Add(raster);
tool.FilePath = @"c:\temp\aladin.dfs2";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.DFS2TemporalRasterFileExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.DFS2TemporalRasterFileExportTool.dll" />
Export to KML/KMZ file¶
Tool for exporting a feature class to a KML file or a zipped KMZ file.
Tool Info | |
---|---|
Display Name | Export to KML/KMZ file |
API Name | Export to KMZ/KML file |
Tools Explorer | /Output Tools/Export to KML/KMZ file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.KmlFileExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.KMLFileExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.KMLFileExportTool.IKMLFileExportTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the entity should be exported. |
Tool Settings | ||
File path | FilePath | Gets or sets file path of exported file. Specifying file extension .kmz, will zip the KML file generated. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.KMLFileExportTool")
from DHI.Solutions.GISManager.Tools.KMLFileExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Export to KMZ/KML file")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.KMLFileExportTool")
from DHI.Solutions.GISManager.Tools.KMLFileExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.KMLFileExportTool.IKMLFileExportTool(app.Tools.CreateNew("Export to KMZ/KML file"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Export to KMZ/KML file") as DHI.Solutions.GISManager.Tools.KMLFileExportTool.KMLFileExportTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClass = module.FeatureClassList.Fetch("/Sava/Lakes");
tool.InputItems.Add(featureClass);
tool.FilePath = @"c:\temp\lakes.kml";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.KMLFileExportTool.KMLFileExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.KMLFileExportTool.dll" />
Export to shape file¶
Tool for exporting a feature class into a shape file. The tool exports to a standard shape file (dbf, prj, shp and shx). In case of the export of temporal feature class – one shp file is exported. Date/time value is exported as feature parameter.
Tool Info | |
---|---|
Display Name | Export to shape file |
API Name | Export to shape file |
Tools Explorer | /Output Tools/Export to shape file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ShapeFileExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.ShapeFileExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.ShapeFileExportTool.IShapeFileExportTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the feature class should be exported. |
Tool Settings | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name. |
Shape file path | FilePath | Gets or sets file path of exported file. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ShapeFileExportTool")
from DHI.Solutions.GISManager.Tools.ShapeFileExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Export to shape file")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ShapeFileExportTool")
from DHI.Solutions.GISManager.Tools.ShapeFileExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.ShapeFileExportTool.IShapeFileExportTool(app.Tools.CreateNew("Export to shape file"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Export to shape file") as DHI.Solutions.GISManager.Tools.ShapeFileExportTool.ShapeFileExportTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClass = module.FeatureClassList.Fetch("/Sava/Lakes");
tool.InputItems.Add(featureClass);
tool.FilePath = @"c:\temp\lakes.shp";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.ShapeFileExportTool.ShapeFileExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.ShapeFileExportTool.dll" />
Feature Class Query Tool¶
This tool queries for feature classes by name and group.
Tool Info | |
---|---|
Display Name | Feature Class Query Tool |
API Name | Feature Class query |
Tools Explorer | /Data tools/Feature Class Query Tool |
NuGet Package | DHI.MikeOperations.GISManager.Tools.FeatureClassQuery |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.IFeatureClassQueryTool |
Input Items | No input items required |
Output Items | List of results |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Query parameters | ||
Metadata | Metadata | Gets or sets the metadata to search for. Note that the property is only available when: HasMetadataModule=True |
Name | FeatureClassName | Gets or sets the feature class name (or name pattern) to search for. |
Within Group | WithinGroup | Gets or sets name name of the group name (or name pattern) that the feature class should be in. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.FeatureClassQueryTool")
from DHI.Solutions.GISManager.Tools.FeatureClassQueryTool import *
# Get the tool.
tool = app.Tools.CreateNew("Feature Class query")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.FeatureClassQueryTool")
from DHI.Solutions.GISManager.Tools.FeatureClassQueryTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.IFeatureClassQueryTool(app.Tools.CreateNew("Feature Class query"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Feature Class query") as DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.IFeatureClassQueryTool;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.FeatureClassQueryTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.FeatureClassQueryTool.dll" />
Flood area¶
FloodedAreaTool exports input feature to file
Tool Info | |
---|---|
Display Name | Flood area |
API Name | Flood tool |
Tools Explorer | /Flood Tools/Flood area |
NuGet Package | DHI.MikeOperations.GISManager.Tools.FloodedArea |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.FloodedAreaTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.FloodedAreaTool.IFloodedAreaTool |
Input Items | A single feature class or a single features |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Flood area feature class name | MergedFloodFeatureName | Gets or sets the name of the merged flood feature. The name of the merged flood feature. Note that the property is only available when: ReturnFlooding=True |
Flooding Attribute | FloodingAttribute | Gets or sets the attribute name of the feature class indicating the flooded feature of the flooded area. |
Flooding feature | FloodingFeatureClassName | Gets or sets the name of the feature class to be used as flooding |
Output feature class name | ResultFeatureClassName | Gets or sets the name of the feature class where the results will be stored |
Results name prefix | OutputAttributePrefix | Gets or sets output attribute prefix |
Return flooded area | ReturnFlooding | Gets or sets a value indicating whether return flooding feature classs. true if [return flooding]; otherwise, false . |
Return only flooded features | ReturnFloodedOnly | Gets or sets a value indicating whether return only flooded features. true if [return flooded only]; otherwise, false . |
Threshold | Treshold | Gets or sets the treshold used for the flooding status |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.FloodedAreaTool")
from DHI.Solutions.GISManager.Tools.FloodedAreaTool import *
# Get the tool.
tool = app.Tools.CreateNew("Flood tool")
# Add input items.
tool.InputItems.Add(<A single feature class or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.FloodedAreaTool")
from DHI.Solutions.GISManager.Tools.FloodedAreaTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.FloodedAreaTool.IFloodedAreaTool(app.Tools.CreateNew("Flood tool"))
# Add input items.
tool.InputItems.Add(<A single feature class or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Flood tool") as DHI.Solutions.GISManager.Tools.FloodedAreaTool.IFloodedAreaTool;
// Add input items.
tool.InputItems.Add(<A single feature class or a single features>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.FloodedAreaTool.FloodedAreaTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.FloodedAreaTool.dll" />
Flood Map Interpolation¶
The flood map interpolation tool will generate a new flood map from a library of pre-cooked flood maps and a set of gauge timeseries. For each gauge, the tool will: - Get the time series - Optionally run the script for it if specified. - Resample it - For each timestep it will interpolate the point flood maps from the library based on the water level.Find two flood maps with levels at the gauge above and below and create a new set of values with all pixels linearly interpolated with respect to the value at the gauge.
This will result in a raster with a band for each output time step and a dictionary of interpolated values from the flood map library for each pixel for each of these timesteps.
Finally, the tool will perform inverse distance interpolation using all the pixel values as points in each timestep to generate an interpolated flood map for each timestep.
Note: Gauges, selected for the computation must be covered by minimum flooding in requested time period. Time steps in Flood Map Library (temporal rasters) do not need cover requested period. They are used as catalogs – time information is not used.
Tool Info | |
---|---|
Display Name | Flood Map Interpolation |
API Name | Flood Map InterpolationTool |
Tools Explorer | /Raster Interpolation/Flood Map Interpolation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.FloodMapInterpolation |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool.IFloodMapInterpolationTool |
Input Items | No input items required |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input | ||
DEM | DEM | Gets or sets the Optional DEM raster used as basis for the flooding. If not specified, the output with be the same size as the floodmap of the first gauge. |
Flood Map Libraries | FloodMapLibrary | Gets or sets the raster for each gauge. A flood map must exist for each gauge. Each gauge raster is a multiband raster where bands represent different water levels at the gauge. Band at index 0 represents lowest water level. There should be at least two bands representing lowest and highest level at the point. |
Gauge Locations | GaugeLocations | Gets or sets the gauge locations to use for the feature class. |
Gauge Readings | GaugeReadings | Gets or sets time series of water level at the selected gauges. This is specified manually instead of using associated time series. |
Period | TimePeriod | Gets or sets a time period and the output interval (number of years/months/days/hours/minutes/seconds). Note that all time series should cover the period to allow resampling.value of a start and stop time for the interpolation and a time period frequency. |
Script | Script | Gets or sets an optional script to use for interpolating water levels. The script MUST have 3 parameters: - A dictionary of the attributes the gauge feature class (attribute name, attribute) - A dictionary of input parameters, “Time Period”, “Frequency”, “Flood Map Library” (for the gauge), and “DEM”. - InputTS – the time series of the gauge The script may modify or create the gauge level time series from information in the flood map libraries. |
Output | ||
Interplolated Flood Map | InterpolatedFloodMap | Gets or sets the path for the interpolation raster, which is stored in the database |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool")
from DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool import *
# Get the tool.
tool = app.Tools.CreateNew("Flood Map InterpolationTool")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool")
from DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool.IFloodMapInterpolationTool(app.Tools.CreateNew("Flood Map InterpolationTool"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Flood Map Interpolation Tool") as DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool;
// Set the tool properties and execute.
tool.GaugeLocations = new GaugeLocation();
tool.GaugeLocations.FeatureClassPath = "/gauges";
IFeatureClass gaugeFeatureClass = _gisModule.FeatureClassList.Fetch(tool.GaugeLocations.FeatureClassPath);
List <IFeature> features = gaugeFeatureClass.FetchAll();
int index = 1;
foreach (var feature in features)
{
string gaugeName = "Gauge" + index.ToString();
tool.GaugeLocations.Locations.Add(feature.Id, gaugeName);
index++;
}
tool.FloodMapLibrary = new LocationsPath();
tool.FloodMapLibrary.Add("Gauge1","/floodLib_raster");
tool.GaugeReadings = new LocationsPath();
tool.GaugeReadings.Add("Gauge1","/TS1_one_timeSeries");
tool.DEM = "/dem";
tool.Script = "";
tool.TimePeriod.StartTime = new DateTime(2022,8,1,15,45,0);
tool.TimePeriod.StopTime = new DateTime(2022,8,1,16,45,0);
tool.TimePeriod.Period = 5;
tool.TimePeriod.PeriodType = EnumPeriod.Minutes;
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool.FloodMapInterpolationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.FloodMapInterpolationTool.dll" />
Flow Direction¶
Tool for calculating the flow direction of a raster representing elevation values (DEM) based on the slope of steepest decent from any given cell. Output flow direction values are: 0 = None, 1 = East, 2 = Southest, 4 = South, 8 = Southwest, 16 = West, 32 = Northwest, 64 = North, 128 = Northeast, 256 = Local minimum, -512 = Undefined.
Flow direction values are often used as input to other tools, such as catchment delineation. Currently there are no tools that use this tool output directly. (The interactive catchment delineation described above calculates the flow direction internally.)
Tool Info | |
---|---|
Display Name | Flow Direction |
API Name | Flow Direction |
Tools Explorer | /Raster Processing/Flow Direction |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IFlowDirectionTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
The tool has no properties.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Flow Direction")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IFlowDirectionTool(app.Tools.CreateNew("Flow Direction"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Flow Direction") as DHI.Solutions.GISManager.Tools.RasterProcessing.FlowDirectionTool;
// Set the tool properties and execute.
tool.InputItems.Add(raster);
tool.Execute();
// Get the output of the tool.
var outRaster = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.FlowDirectionTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Generic Raster Exporter¶
This tool exports a raster to GDAL Grid file. Metadata for raster is also written in case ExportMetadata is true. This tool supports the formats below: GTiff; HFA; ADRG; BT; EHdr; ENVI; ERS; HFA; ILWIS; RRASTER; RMF; CTable2; IDA; INGR; MFF; PCIDSK; SAGA; SGI; MFF2; Leveller; PCRaster; RST; GTX; MRF; GSBG; GS7BG; JP2ECW. Refer to GDAL raster driver documentation for more information https://gdal.org/drivers/raster/index.html.
Tool Info | |
---|---|
Display Name | Generic Raster Exporter |
API Name | Generic Raster Exporter |
Tools Explorer | /Output Tools/Generic Raster Exporter |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GenericRasterExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GenericRasterExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.GenericRasterExportTool.IGenericRasterExportTool |
Input Items | A single raster |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the rasters should be exported if any. The metadata is placed in a file with the extension “dssmet”. |
Tool Settings | ||
GDALGrid file path | FilePath | Gets or sets file path of exported file. |
Raster Format | RasterFormat | Gets or sets the format (raster driver) of the raster export. The following GDAL raster drivers are supported: GTiff (.tif), HFA (.img), ADRG (.gen), BT (.bt), EHdr (.bil), ENVI (.bin), ERS (.ers), ILWIS (.mpr), RRASTER (.grd), RMF (.rsw), CTable2 (.bin), IDA (.img), INGR (.cot), MFF (.hdr), PCIDSK (.ovr), SAGA (.SDAT), SGI (.rle), MFF2 (.HKV), Leveller (.ter), PCRaster (.map), RST (.rst), GTX (.gtx), MRF (.mrf), GSBG (.grd), GS7BG (.grd), JP2ECW (.jp2) |
Time Step | TimeSteps | Gets or sets the time step of the raster to export in the format "yyyy-MM-ddTHH:mm:ss". Required when exporting a time step from a temporal raster. Note that the property is only available when: IsTemporal=True |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericRasterExportTool")
from DHI.Solutions.GISManager.Tools.GenericRasterExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Generic Raster Exporter")
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericRasterExportTool")
from DHI.Solutions.GISManager.Tools.GenericRasterExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GenericRasterExportTool.IGenericRasterExportTool(app.Tools.CreateNew("Generic Raster Exporter"))
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Generic Raster Exporter") as DHI.Solutions.GISManager.Tools.GenericRasterExportTool.GenericRasterExportTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get(typeof(DHI.Solutions.GISManager.Interfaces.IGISModule)) as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = gisModule.RasterList.Fetch("/Aladin/Aladin_4km");
tool.InputItems.Add(raster);
tool.FilePath = @"c:\temp\rasterexport";
tool.TimeSteps = "2012-11-04T13:00:00";
tool.RasterFormat = "GTiff";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GenericRasterExportTool.GenericRasterExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GenericRasterExportTool.dll" />
Generic Raster Importer¶
The tool enables import of GDAL-supported raster formats. This tool supports the formats below: GTiff; HFA;ADRG; BT; EHdr; ENVI; ERS; HFA; ILWIS; RRASTER; RMF; CTable2; IDA; INGR;MFF; PCIDSK; SAGA; SGI; PCRaster; RST; GTX; MRF; GSBG; GS7BG;JP2ECW;ZIP;ASC.
More information on raster drivers can be found at gdal.org.
Tool Info | |
---|---|
Display Name | Generic Raster Importer |
API Name | Generic Raster Importer |
Tools Explorer | /Import/Generic Raster Importer |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GenericRasterImporter |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.IGenericRasterImporterTool |
Input Items | A single raster group |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the file, in case the file does not contain coordinate system information. Note that the property is only available when: IsZipFile=False |
File Path | FilePath | Gets or sets the file path of the file to import. The coordinate system will be read from the file when the file path property is changed. |
Raster | RasterName | Gets or sets the full path of the Raster to create to store the imported raster. By default the raster is placed in the input raster group in input items. Specifying the rastpath will overwrite the location of the raster imported. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericRasterImporterTool")
from DHI.Solutions.GISManager.Tools.GenericRasterImporterTool import *
# Get the tool.
tool = app.Tools.CreateNew("Generic Raster Importer")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericRasterImporterTool")
from DHI.Solutions.GISManager.Tools.GenericRasterImporterTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.IGenericRasterImporterTool(app.Tools.CreateNew("Generic Raster Importer"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Generic Raster Importer") as DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.GenericRasterImporterTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClassGroup = module.RasterGroupList.Fetch("/Aladin");
tool.InputItems.Add(featureClassGroup);
tool.FilePath = @"c:\temp\gdal_20121104160000.tif";
// Place the raster in another path than the in the raster group in input items.
tool.RasterName = "/Aladin54/MyGdalRaster";
tool.Execute();
// Get the output of the tool.
var raster = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster:
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.GenericRasterImporterTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GenericRasterImporterTool.dll" />
Generic Vector Exporter¶
This tool exports a feature class to a GDAL file. Metadata for feature class is also written in case ExportMetadata is true. The tool supports the following formats: ESRI Shapefile; KML; GPX; GeoJSON; XLSX; CSV; PDF; BNA; DGN; Geoconcept; GMT; MapInfo File; GPSTrackMaker;PGDUMP.
Tool Info | |
---|---|
Display Name | Generic Vector Exporter |
API Name | Generic Vector Exporter |
Tools Explorer | /Output Tools/Generic Vector Exporter |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GenericVectorExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GenericVectorExportTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.GenericVectorExportTool.IGenericVectorExportTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Metadata | ||
Export Metadata | ExportMetadata | Gets or sets a value indicating whether the metadata of the entity should be exported. The metadata is placed in a file with the extension "dssmet". |
Tool Settings | ||
File Path | FilePath | Gets or sets file path of exported file. |
Vector Format | VectorFormat | Gets or sets the vector format to use to get the GDAL vector driver from. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericVectorExportTool")
from DHI.Solutions.GISManager.Tools.GenericVectorExportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Generic Vector Exporter")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericVectorExportTool")
from DHI.Solutions.GISManager.Tools.GenericVectorExportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GenericVectorExportTool.IGenericVectorExportTool(app.Tools.CreateNew("Generic Vector Exporter"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Generic Vector Exporter") as DHI.Solutions.GISManager.Tools.GenericVectorExportTool.GenericVectorExportTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClass = module.FeatureClassList.Fetch("/Sava/Rivers");
tool.InputItems.Add(featureClass);
tool.VectorFormat = "KML";
tool.FilePath = @"C:\temp\Rivers5.kml";
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GenericVectorExportTool.GenericVectorExportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GenericVectorExportTool.dll" />
Generic Vector Importer¶
This tool enables import of GDAL-supported vector formats. The tool supports the following formats: ESRI Shapefile; KML; KMZ; GPX; GeoJSON; PDF; DGN; GMT; MapInfoFile; GPSTrackMaker; ZIP; DXF.
Tool Info | |
---|---|
Display Name | Generic Vector Importer |
API Name | Generic Vector Importer |
Tools Explorer | /Import/Generic Vector Importer |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GenericVectorImporter |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.IGenericVectorImporterTool |
Input Items | A single feature class group |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name. Note that the property is only available when: IsZipFile=False |
Feature Class Name | FeatureClassName | Gets or sets the name of the Feature Class to create to store the imported feature class. |
File Path | FilePath | Gets or sets the input file path to import. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericVectorImporterTool")
from DHI.Solutions.GISManager.Tools.GenericVectorImporterTool import *
# Get the tool.
tool = app.Tools.CreateNew("Generic Vector Importer")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GenericVectorImporterTool")
from DHI.Solutions.GISManager.Tools.GenericVectorImporterTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.IGenericVectorImporterTool(app.Tools.CreateNew("Generic Vector Importer"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Generic Vector Importer") as DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.GenericVectorImporterTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var featureClassGroup = module.FeatureClassGroupList.Fetch("/Sava");
tool.InputItems.Add(featureClassGroup);
tool.FilePath = @"C:\temp\Rivers.kml";
tool.FeatureClassName = "/Sava/Rivers1";
tool.Execute();
// Get the output of the tool.
var featureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.GenericVectorImporterTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GenericVectorImporterTool.dll" />
Import from ASCII file¶
This tool imports point features from ASCII text files.
Several file types are supported, each having an expected format:
- csv and txt:
- comma separated columns
- 1 line header
- decimal divider is "."
- A column called "X" exists and contains x values as double
- A column called "Y" exists and contains y values as double
- If a column called "Z" exists, it contains z values as double
- Additional columns will be imported in the attribute table. Values type and length will be auto-detected and the attribute will be created with the corresponding data type.
- xyz:
- space/tab separated columns
- no header
- decimal divider is "."
- First column: X values as double
- Second column: Y values as double
- Third column (optional): Z values as double
Note that:
- If a line starts with “;” or “#” it will be ignored for csv and txt file
- Z values are stored as an attribute, not as a 3D feature class
The tool can import:
- a single file or
- all files stored in a folder:
- Folder are read recursively. All files matching the extension selected will be imported.
- Each ASCII file will generate a feature class in the specified Group. The folder structure will not be replicated inside MIKE OPERATIONS.
- If several files have the same name, this will throw an error.
Tool Info | |
---|---|
Display Name | Import from ASCII file |
API Name | Import from ASCII file |
Tools Explorer | /Import/Import from ASCII file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ASCIIFileImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.IASCIIFileImportTool |
Input Items | A single feature class group |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the ASCII file to import. |
Feature Class | FeatureClassName | Gets or sets the name of the feature class to create to store the imported ASCII file. Note that the property is only available when: ImportFromOption=SingleFile |
File Path | FilePath | Gets or sets the file path fo the ASCII file to import. Enabled when ImportFromOption = SingleFile. Note that the property is only available when: ImportFromOption=SingleFile |
Folder | Folder | Gets or sets the Folder from which the file will be imported from. Enabled when ImportFromOption = Folder. Note that the property is only available when: ImportFromOption=Folder |
Group | Group | Gets or sets the full group path holding the feature classes to where the file will be imported. Note that the property is only available when: ImportFromOption=Folder |
Import from | ImportFromOption | Gets or sets the import option. The import option determines if a single file, or all files in a specified folder shall be imported. |
Save To Database | SaveToDatabase | Gets or sets a value indicating whether to save the feature class to the database. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool import *
clr.AddReference("DHI.Solutions.GISManager.Tools.BaseGISTool")
from DHI.Solutions.GISManager.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("Import from ASCII file")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.IASCIIFileImportTool(app.Tools.CreateNew("Import from ASCII file"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Import from ASCII file") as DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.ASCIIFileImportTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
tool.ImportFromOption = DHI.Solutions.GISManager.Tools.ImportTypeOption.SingleFile;
tool.FilePath = @"c:\temp\file1.csv";
tool.FeatureClassName = "/Group/ASCIItst";
tool.CoordinateSystem = gisModule.DefaultCoordinateSystem;
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.ASCIIFileImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ASCIIFileImportTool.dll" />
Import from ASCII grid file¶
This tool imports rasters stored in an ASCII formatted grid file (as output by ArcGIS, for example).
The tool imports grids stored in what is known as the ArcInfo ASCII Grid format. It looks like the following:
- ncols 4
- nrows 6
- xllcorner 0.0
- yllcorner 0.0
- cellsize 50.0
- NODATA_value -9999
- -9999 -9999 5 2
- -9999 20 100 36
- 3 8 35 10
- 32 42 50 6
- 88 75 27 9
- 13 5 1 -9999
where
- ncols and nrows are the numbers of rows and columns, respectively (represented as integers)
- xllcorner and yllcorner are the western(left) x-coordinate and southern(bottom) y-coordinates, such as easting and northing(represented as real numbers with an optional decimal point)
- cellsize is the length of one side of a square cell(a real number); and,
- NODATA_value is the value that is regarded as "missing" or "not applicable"; this line is optional, but highly recommended as some programs expect this line to be declared (a real number).
The remainder of the file lists the raster values for each cell, starting at the upper-left corner. These real numbers (with optional decimal point, if needed) and are delimited using a single space character. Coordinate system can be read from the file, having the same name as world file and extension prj.If such file exists and contain coordinate system description, recognized by MIKE OPERATIONS – coordinate system field is filled.
Tool Info | |
---|---|
Display Name | Import from ASCII grid file |
API Name | Import from ASCII grid file |
Tools Explorer | /Import/Import from ASCII grid file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ASCIIGridFileImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.IASCIIGridImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the ASCII grid file to import. |
File Path | FilePath | Gets or sets the file path fo the ASCII Grid file to import |
Raster | RasterName | Gets or sets the name of the Raster to create to store the imported ASCII file |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from ASCII grid file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool")
from DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.IASCIIGridImportTool(app.Tools.CreateNew("Import from ASCII grid file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Import from ASCII grid file") as DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.ASCIIGridImportTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
tool.FilePath = @"c:\temp\small_grid.asc";
tool.RasterName = "/Group/ASCIItst";
// Set the coordinate system of the ESRI ASCII file to import (here the default coordinate system of the GIS module is used).
tool.CoordinateSystem = gisModule.DefaultCoordinateSystem;
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.ASCIIGridImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ASCIIGridImportTool.dll" />
Import from Dfs2 file¶
This tool imports rasters stored in an Dfs2 file to the temporal raster grids. One raster is created for each selected item.
Item types and units are copied to the corresponding raster properties.
Tool Info | |
---|---|
Display Name | Import from Dfs2 file |
API Name | Import from Dfs2 file |
Tools Explorer | /Import/Import from Dfs2 file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.Dfs2Import |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.IDfs2ImportTool |
Input Items | A single raster group |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Convert dfs coordinate to EPSG | ConvertToEPSG | If set to true, the tool will try and match the coordinate system found in the dfs2 file to a EPSG one. This is good when processing and visualising the raster in MIKE Workbench GIS Manager or when publishing (web) and sharing (export). If set to false, a new coordinate system will be created if the dfs2 file has a MIKE Zero specific coordinate system (i.e. not EPSG). This option should be used when the raster file is expected to be used as input to a MIKE model. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the Dfs2 file to import. |
File Path | FilePath | Gets or sets the file path fo the Dfs2 file to import |
Include derived items | AdditionalItems | Gets or sets a value indicating whether additional items will be computed during DFS2 loading. |
Raster Group | RasterGroupName | Gets or sets the name of the Raster Group to create to store rasters imported Dfs2 file |
Raster Items | RasterItem | Gets or sets the raster item to import. |
Tool Methods
- FillChangeLog(System.String fileName ,System.Int32 position ,System.String logName ,DHI.Solutions.Generic.IEntity entity ,DHI.Solutions.Generic.IChangeLogModule changeLogModule): Fills the change log.
- FillRasterBand(DHI.Solutions.GISManager.Interfaces.IRasterBand rasterBand ,System.String fileName ,System.Int32 position ,System.Boolean keepOpened): Fills the raster band.
- CloseFile(System.String fileName): Closes the file.
- GetRastersList(System.String fileName): Gets the rasters list.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Dfs2 file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.IDfs2ImportTool(app.Tools.CreateNew("Import from Dfs2 file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Import from Dfs2 file") as DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.Dfs2ImportTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var rasterGroup = module.RasterGroupList.Fetch("/MyRasterGroup");
// Set input items before specifying the file name in order to read the coordinate system from the file.
tool.InputItems.Add(rasterGroup);
tool.FilePath = @"c:\temp\raster.dfs2";
tool.Execute();
// Get the output of the tool.
var rasterOutput = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.Dfs2ImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.Dfs2ImportTool.dll" />
Import from Dfs3 file¶
This tool imports raster(s) stored in an Dfs3 file to the temporal raster grids. One raster is created for each selected item and layer. Item types and units are copied to the corresponding raster properties.
Tool Info | |
---|---|
Display Name | Import from Dfs3 file |
API Name | Import from Dfs3 file |
Tools Explorer | /Import/Import from Dfs3 file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.Dfs3Import |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.IDfs3ImportTool |
Input Items | A single raster group |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Convert dfs coordinate to EPSG | ConvertToEPSG | Gets or sets a value indicating whether to convert dfs coordinate to EPSG |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the Dfs3 file to import. |
File Path | FilePath | Gets or sets the file path fo the Dfs3 file to import |
Include derived items | AdditionalItems | Gets or sets a value indicating whether additional items will be computed during DFS3 loading. |
Layer Numbers | LayerNumbers | Gets or sets the value of LayerNumbers |
Raster Group | RasterGroupName | Gets or sets the name of the Raster Group to create to store rasters imported Dfs3 file |
Raster Items | RasterItem | Gets or sets the raster item to import. |
Tool Methods
- FillChangeLog(System.String fileName ,System.Int32 position ,System.String logName ,DHI.Solutions.Generic.IEntity entity ,DHI.Solutions.Generic.IChangeLogModule changeLogModule): Fills the change log.
- FillRasterBand(DHI.Solutions.GISManager.Interfaces.IRasterBand rasterBand ,System.String fileName ,System.Int32 position ,System.Boolean keepOpened): Fills the raster band.
- CloseFile(System.String fileName): Closes the file.
- GetRastersList(System.String fileName): Gets the rasters list.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Dfs3 file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.IDfs3ImportTool(app.Tools.CreateNew("Import from Dfs3 file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from Dfs3 file") as DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.IDfs3ImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.Dfs3ImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.Dfs3ImportTool.dll" />
Import from Dfsu file¶
This tool imports unstructured data stored in dfsu format (as output by MIKE 21 FM for example). When running the tool from the Tools Explorer, a user-friendly data view interface will appear to assist in setting the tool properties. For optimal processing of meshes, they are stored in blocks defined by a size space(i.e.number of elements) and time(number of time steps). A given block will have a specific timespan, x range and y range for a given item.A item will be stored in several blocks of different geographical and temporal extent.
Depending on the structure of the dfsu file, the tool will propose a way to define the size (in space and time) of the blocks to store in the database. In the example above, the blocks will have a maximum of 100 timesteps. For a given item and a given geographical extent, the 265 timesteps of the file will thus be stored in 3 different sets of blocks. The mesh has 3636 elements that are stored, geographically, in 37 block of up to 100 elements.
Tool Info | |
---|---|
Display Name | Import from Dfsu file |
API Name | Import from Dfsu file |
Tools Explorer | /Import/Import from Dfsu file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.DfsuImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.IDfsuImportTool |
Input Items | A single mesh group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Info | ||
Elements Count | ElementsCount | Gets the elements count. |
Space Blocks Count | SpaceBlocksCount | Gets the space blocks count. |
Time Blocks Count | TimeBlocksCount | Gets the time blocks count. |
Time Steps Count | TimeStepsCount | Gets the time steps count. |
Parameters | ||
Convert dfs coordinate to EPSG | ConvertToEPSG | If set to true, the tool will try and match the coordinate system found in the dfsu file to a EPSG one. This is good when processing and visualising the mesh in MIKE Workbench GIS Manager or when publishing (web) and sharing (export). If set to false, a new coordinate system will be created if the dfsu file has a MIKE Zero specific coordinate system (i.e. not EPSG). This option should be used when the dfsu file is expected to be used as input to a MIKE model. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the Dfsu file to import. |
File Path | FilePath | Gets or sets the file path fo the Dfsu file to import |
Mesh Name | MeshName | Gets or sets the name of the mesh object to create. |
Space Block Size | SpaceBlockSize | Gets or sets the number of elements to store together. |
Time Block Size | TimeBlockSize | Gets or sets the number of timesteps to store together. |
Time Space Ratio | TimeSpaceRatio | Gets or sets the time / space blok side ratio. |
Tool Methods
- SetOptimalBlockSize(System.Int32 numTimeSteps ,System.Int32 numElements ,System.Double timeSpaceRatio): Sets the size of the optimal block.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.DfsuImportTool")
from DHI.Solutions.GISManager.UI.Tools.DfsuImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Dfsu file")
# Add input items.
tool.InputItems.Add(<A single mesh group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.DfsuImportTool")
from DHI.Solutions.GISManager.UI.Tools.DfsuImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.IDfsuImportTool(app.Tools.CreateNew("Import from Dfsu file"))
# Add input items.
tool.InputItems.Add(<A single mesh group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from Dfsu file") as DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.IDfsuImportTool;
// Add input items.
tool.InputItems.Add(<A single mesh group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.DfsuImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.DfsuImportTool.dll" />
Import from dfsu file to Feature class¶
The tool imports a dfsu file into a feature class. When a file is selected, element count, number of time steps and coordinate system are read from the file and shown as info. Data can be imported to temporal or non-temporal feature classes There are five ways of importing from a dfsu file.
- Max
- Min
- Average
- TimeStepValue
- TemporalFeature
Tool Info | |
---|---|
Display Name | Import from dfsu file to Feature class |
API Name | Import from Dfsu file to feature class |
Tools Explorer | /Import/Import from dfsu file to Feature class |
NuGet Package | DHI.MikeOperations.GISManager.Tools.DfsuToFeaturesImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.IDfsuFcImportTool |
Input Items | A single feature class group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Info | ||
Time Steps Count | TimeStepsCount | Gets the time steps count. |
Parameters | ||
Dfsu Item | DfsItemName | Gets or sets the Item of the dfsu file to import. |
Feature Class | FeatureClassName | Gets or sets the full path of the feature class to create and to store the imported shape file. Note that the property is only available when: ImportFromOption=SingleFile |
File Path | FilePath | Gets or sets the file path fo the Dfsu file to import |
Time interval for import | TimeInterval | Gets or sets the time interval for read in case of Temporal feature class. The time interval in num of steps. Note that the property is only available when: SelectionVariable=TemporalFeature |
Time Step Index | TimeStepIndex | Gets or sets the time step index (zero based) to be imported. Note that the property is only available when: SelectionVariable=TimeStepValue |
Variable(s) | SelectionVariable | Gets or sets the selection variable. When creating statistics feature class with minimum, average and maximum values for each element, the variable should be set to “Statistics”; When creating a feature class representing a given timesteps, the variable should be set to “TimeStepValue”. When creating temporal feature class variable should be set to Time interval for importing. First and last steps will be every time imported. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool")
from DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Dfsu file to feature class")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool")
from DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.IDfsuFcImportTool(app.Tools.CreateNew("Import from Dfsu file to feature class"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from Dfsu file to feature class") as DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.IDfsuFcImportTool;
// Add input items.
tool.InputItems.Add(<A single feature class group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.DfsuFcImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.DfsuToFeaturesImportTool.dll" />
Import from Image file¶
This tool imports rasters stored in an image file to the raster of image type.
To import a georeferenced TIFF file, see the Import from TIFF file tool below.
Tool Info | |
---|---|
Display Name | Import from Image file |
API Name | Import from Image file |
Tools Explorer | /Import/Import from Image file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ImageFileImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Settings | ||
File Path | FilePath | Gets or sets the file path of the Image file to import. Note that the property is only available when: RasterType=BackgroundMapRasterType=BackgroundImageWorldCoordinates |
Raster | RasterName | Gets or sets the name of the Raster to create to store the imported Image file |
Upper Left X | UpperLeftX | Gets or sets the X coordinate of upper left corner. If DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool.ScaleImageWhenZooming is true, this represents the longitude value of the upper left corner in decimal degrees (WGS 84) If DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool.ScaleImageWhenZooming is false, this represents the horizontal offset in pixels from the upper left corner of the map |
Upper Left Y | UpperLeftY | Gets or sets the Y coordinate of upper Left corner. If DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool.ScaleImageWhenZooming is true, this represents the latitude value of the upper left corner in decimal degrees (WGS 84) If DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool.ScaleImageWhenZooming is false, this represents the vertical offset in pixels from the upper left corner of the map |
Use scale | ScaleImageWhenZooming | Gets or sets a value indicating whether image shall be scaled or not. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Image file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool(app.Tools.CreateNew("Import from Image file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from Image file") as DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.IImageFileImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.ImageFileImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ImageFileImportTool.dll" />
Import from IMG file¶
Tool for importing Erdas Imagine (.img) files as raters into the MIKE OPERATIONS database.
Depend on the selected file format see Raster drivers — GDAL documentation raster of the type Image or Grid is created. If positioning data and/or coordinate system are loaded from the file Upper Left X, Upper Left Y and Use scale parameters are overwritten and not used.
Tool Info | |
---|---|
Display Name | Import from IMG file |
API Name | Import from IMG file |
Tools Explorer | /Import/Import from IMG file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ImgRasterImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.IIMGRasterImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the IMG file to import. |
File Path | FilePath | Gets or sets the file path fo the Erdas Imagine (.img) file to import. |
Raster | RasterName | Gets or sets the name of the Raster to create to store the imported IMG file |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool")
from DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from IMG file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool")
from DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.IIMGRasterImportTool(app.Tools.CreateNew("Import from IMG file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from IMG file") as DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.IIMGRasterImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.IMGRasterImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.IMGRasterImportTool.dll" />
Import from KML/KMZ file¶
This tool imports features from a KML/KMZ file or from a folder which contains KML/KMZ files. It is not possible to use the tool in cases where features in the KML/KMZ file are loosely defined in a way that attributes are not shared or features are a mix of points and/or lines and/or polygons.
Tool Info | |
---|---|
Display Name | Import from KML/KMZ file |
API Name | Import from KML/KMZ file |
Tools Explorer | /Import/Import from KML/KMZ file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.KmlFileImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.IKMLFileImportTool |
Input Items | A single feature class group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Feature Class | FeatureClassName | Gets or sets the name of the feature class to create to store the imported KML file. Note that the property is only available when: ImportFromOption=SingleFile |
File Path | FilePath | Gets or sets the file path fo the KML file to import. Enabled when ImportFromOption = SingleFile. Note that the property is only available when: ImportFromOption=SingleFile |
Folder | Folder | Gets or sets the Folder from which the file will be imported from. Enabled when ImportFromOption = Folder. Note that the property is only available when: ImportFromOption=Folder |
Group | Group | Gets or sets the full group path holding the feature classes to where the file will be imported. Note that the property is only available when: ImportFromOption=Folder |
Import from | ImportFromOption | Gets or sets the import option. The import option determines if a single file, or all files in a specified folder shall be imported. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool import *
clr.AddReference("DHI.Solutions.GISManager.Tools.BaseGISTool")
from DHI.Solutions.GISManager.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("Import from KML/KMZ file")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.IKMLFileImportTool(app.Tools.CreateNew("Import from KML/KMZ file"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from KML/KMZ file") as DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.IKMLFileImportTool;
// Add input items.
tool.InputItems.Add(<A single feature class group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.KMLFileImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.KMLFileImportTool.dll" />
Import from NetCDF file¶
This tool imports a raster from a NetCDF file using Unidata NetCDF parsing. Time varying NetCDF files are supported.
Limitations:
- All value parameters from NetCDF are imported as distinct rasters in raster group
- Rasters will be created with:
- EUM Item = Unknown
- EUM Unit empty
- x axis variable must be equidistant
- y axis variable must be equidistant
- Time axis is taken from the NetCDF and can be either equidistant or non-equidistant. Relative time is not supported.
When more flexible imports are needed use Advance import.
Tool Info | |
---|---|
Display Name | Import from NetCDF file |
API Name | Import from NetCDF file |
Tools Explorer | /Import/Import from NetCDF file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.NetCdfImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.INetCDFImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Configuration | Configuration | Gets or sets the configuration for engine type IKVM_OpenJDK. Option removed with MIKE OPERATIONS 2025, only Unidata is now available. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the NetCDF file to import. Because the information is not standatized in NetCDF file, it needs to be set manually. The tool's default coordinate system is WGS84. |
File Path | FilePath | Gets or sets the file path for the NetCDF file to import. Note that the property is only available when: NetCDFEngine=DHI |
NetCDF Parser | NetCDFEngine | Gets or sets the NetCDF engine to use (DHI or IKVM_OpenJDK). Option removed with MIKE OPERATIONS 2025, only Unidata is now available. |
Output dfs2 | OutputDfs2 | Gets or sets the output dfs2 for engine type IKVM_OpenJDK. Option removed with MIKE OPERATIONS 2025, only Unidata is now available. |
Raster Group | RasterGroupName | Gets or sets the name of the Raster Group to create to store the imported NetCDF file |
Tool Methods
- FillChangeLog(System.String fileName ,System.Int32 position ,System.String logName ,DHI.Solutions.Generic.IEntity entity ,DHI.Solutions.Generic.IChangeLogModule changeLogModule): Fills the change log.
- FillRasterBand(DHI.Solutions.GISManager.Interfaces.IRasterBand rasterBand ,System.String fileName ,System.Int32 position ,System.Boolean keepOpened): Fills the raster band.
- CloseFile(System.String fileName): Closes the file.
- GetRastersList(System.String fileName): Gets the rasters list.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool")
from DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from NetCDF file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool")
from DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.INetCDFImportTool(app.Tools.CreateNew("Import from NetCDF file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from NetCDF file") as DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.INetCDFImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.NetCDFImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.dll" />
Import from NetCDF file (Advanced)¶
This tool imports a raster from a NetCDF file using Unidata NetCDF parsing. Time varying NetCDF files are supported.
This tool allows the user to manually specify:
- Coordinate system
- EUM Item
- EUM Unit
Additionaly, the tool can overwrite the parameters from the NetCDF file:
- Time can be changed (by offset, change of the start time...)
- x axis an y variable can be non-equidistant but no values will still be applied based on ranking in array
Tool Info | |
---|---|
Display Name | Import from NetCDF file (Advanced) |
API Name | Import from NetCDF file (Advanced) |
Tools Explorer | /Import/Import from NetCDF file (Advanced) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.NetCdfImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.IFlexibleNetCDFImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input | ||
File Path | FilePath | Gets or sets the file path for the NetCDF file to import. |
Variable | Variable | Gets or sets the variable name to be imported from the NetCDF file. |
Output | ||
Existing Raster Option | ExistingRasterOption | Gets or sets The behavior for overwriting when an existing raster is specified. This property is ignored when no raster exists at the specified location. |
Raster Group | RasterGroupName | Gets or sets the name of the Raster Group to create to store the imported NetCDF file. |
Raster Name | RasterName | Gets or sets the name of the output raster. If left blank, this will be set to be equal to the variable name plus the NetCDF unit, if available. |
Spatial Parameters | ||
Cell Height | CellHeight | Gets or sets the cell height to apply for the raster. (Defaults to average height between Y points in NetCDF file.) This parameter is used to set the target raster's dy. Setting a Cell Height different from the original NetCDF file will not trigger an interpolatation, values will still be assigned based on the index of the element in the variable array. This should only be used to round the vertical dimension, creating only a slight offset of the cells. |
Cell Width | CellWidth | Gets or sets the cell width to apply for the raster. (Defaults to average width between X points in NetCDF file.). This parameter is used to set the target raster's dy. Setting a Cell Width different from the original NetCDF file will not trigger an interpolatation, values will still be assigned based on the index of the element in the variable array. This should only be used to round the horizontal dimension, creating only a slight offset of the cells. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the NetCDF file to import. Because the information is not standatized in NetCDF file, it needs to be set manually. The tool's default coordinate system is WGS84. |
Scale Factor X | ScaleX | Gets or sets the scale factor for the X coordinates. (Coordinates will be multiplied by this factor.). This parameter is not used for interpolation, it will only recompute CellWidth and assign corresponding value |
Scale Factor Y | ScaleY | Gets or sets the scale factor for the Y coordinates. (Coordinates will be multiplied by this factor.). This parameter is not used for interpolation, it will only recompute CellHeight and assign corresponding value |
Temporal Parameters | ||
Base Time | BaseTime | Gets or sets the base time for the time dimension. Most time dimensions are of units "XX hours since DDTT" where DDTT is a parsable DateTime. This property allows you to override this base time. It is not necessarily the same as the first time step. |
Start Time | StartTime | Gets the start time calculated for the current variable's time dimension, the base time, and time offset. |
Time Offset | TimeOffset | Gets or sets a time offset in hours used to adjust the time of each time step. This can be used to adjust for time zone differences, for example. |
Unit Parameters | ||
EUM Item | EumItem | Gets or sets the MIKE Zero EUM Item (unit type) code. This is not extracted from the NetCDF file and must be selected manually. |
EUM Unit | EumUnit | Gets or sets the MIKE Zero EUM Unit code. This is not extracted from the NetCDF file and must be selected manually. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool")
from DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from NetCDF file (Advanced)")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool")
from DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.IFlexibleNetCDFImportTool(app.Tools.CreateNew("Import from NetCDF file (Advanced)"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from NetCDF file (Advanced)") as DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.IFlexibleNetCDFImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.FlexibleNetCDFImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.NetCDFImportTool.dll" />
Import from Res11 file¶
This tool imports res11 data. It imports the network as GIS data and the time series data as time series associated to the GIS features.Res11 files can only be imported if the projection is already defined in the DSS. Otherwise, add the projection mapping to ESRIProjections.txt file in the application folder.
Tool Info | |
---|---|
Display Name | Import from Res11 file |
API Name | Import from Res11 file |
Tools Explorer | /Import/Import from Res11 file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.Res11Import |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.IRes11ImportTool |
Input Items | A single feature class group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the res11 data to import. |
File Path | FilePath | Gets or sets the file path for the res11 file to import. Enabled when ImportFromOption = SingleFile. Note that the property is only available when: ImportFromOption=SingleFile |
Folder | Folder | Gets or sets the Folder from which the file will be imported from. Enabled when ImportFromOption = Folder. Note that the property is only available when: ImportFromOption=Folder |
Group | Group | Gets or sets the full group path holding the feature classes to where the network will be imported |
Import from | ImportFromOption | Gets or sets the import option. The import option determines if a single file, or all files in a specified folder shall be imported. |
TimeSeries Group | TimeSeriesGroup | Gets or sets the group where time series will be imported to |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Res11ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Res11ImportTool import *
clr.AddReference("DHI.Solutions.GISManager.Tools.BaseGISTool")
from DHI.Solutions.GISManager.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("Import from Res11 file")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.Res11ImportTool")
from DHI.Solutions.GISManager.UI.Tools.Res11ImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.IRes11ImportTool(app.Tools.CreateNew("Import from Res11 file"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from Res11 file") as DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.IRes11ImportTool;
// Add input items.
tool.InputItems.Add(<A single feature class group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.Res11ImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.Res11ImportTool.dll" />
Import from shape file¶
This tool imports features from one or more shape file(s) stored on the file system and creates a feature class in the database.
Tool Info | |
---|---|
Display Name | Import from shape file |
API Name | Import from shape file |
Tools Explorer | /Import/Import from shape file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ShapeFileImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.IShapeFileImportTool |
Input Items | A single feature class group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
IsOneFeatureClass | IsOneFeatureClass | Gets a value indicating whether this instance create one feature class. true if this instance create one feature class; otherwise, false . |
Input_Category | ||
File name time mask | DateTimeFilenameMask | Gets or sets the date time filename mask. Note that the property is only available when: ImportTemporal=True |
Folder | DirectoryPath | Gets or sets the directory path of the Shp files (.shp) to import. Note that the property is only available when: ImportTemporal=True* |
Parameters | ||
Add to existing feature class | AddToExistingFeatureClass | Gets or sets a value indicating whether add to existing raster. Note that the property is only available when: ImportTemporal=True |
Codepage Value | CodePageValue | Gets or sets the code page value to use. Default is codepage 1252. Specify the value of the code page to be used when interpreting attributes with text. |
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the shape file to import. If a prj-file is available the coordinate system will be added automatically. If a prj-file is not available the user must identify the source file coordinate system on import (from a pull down with a list of coordinate systems known to MIKE Workbench). Note that the property is only available when: IsOneFeatureClass=True |
Feature Class | FeatureClassName | Gets or sets the name of the feature class to create to store the imported shape file. Note that the property is only available when: IsOneFeatureClass=True |
File Path | FilePath | Gets or sets the file path of the shape file to import. Enabled when ImportFromOption = SingleFile. Note that the property is only available when: ImportFromOption=SingleFileImportTemporal=False |
Folder | Folder | Gets or sets the Folder from which the file will be imported from. Enabled when ImportFromOption = Folder. Note that the property is only available when: ImportFromOption=FolderImportTemporal=False |
Group | Group | Gets or sets the full group path holding the feature classes to where the file will be imported. Note that the property is only available when: ImportFromOption=FolderImportTemporal=False |
Import as temporal | ImportTemporal | Gets or sets a value indicating whether [import into temporal feature class]. true if [import into temporal feature class]; otherwise, false . |
Import from | ImportFromOption | Gets or sets the import option. The import option determines if a single file, or all files in a specified folder shall be imported. Note that the property is only available when: ImportTemporal=False |
Save To Database | SaveToDatabase | Gets or sets a value indicating whether to save the feature class to the database. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool import *
clr.AddReference("DHI.Solutions.GISManager.Tools.BaseGISTool")
from DHI.Solutions.GISManager.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("Import from shape file")
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool")
from DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.IShapeFileImportTool(app.Tools.CreateNew("Import from shape file"))
# Add input items.
tool.InputItems.Add(<A single feature class group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from shape file") as DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.IShapeFileImportTool;
// Add input items.
tool.InputItems.Add(<A single feature class group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.ShapeFileImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ShapeFileImportTool.dll" />
Import from TIFF file¶
This tool imports raster from a TIFF file.
In contrast to the Import from Image file tool, the TIFF image is imported as a Grid type raster rather than an image. File can contain double values instead of color codes. The tool requires a world file (*.tfw) to be present as well. The world file defines the position, scale, and skew (rotation) of the raster. More information on world files can be found at Wikipedia. Coordinate system can be read from the file, having the same name as world file and extension prj. If such file exists and contain coordinate system description, recognized by MIKE OPERATIONS – coordinate system field is filled.
In case of the GeoTIFF information about coordinate system and position is included to the TIFF file. Info from eventual world file is not used.
Tool Info | |
---|---|
Display Name | Import from TIFF file |
API Name | Import from TIFF file |
Tools Explorer | /Import/Import from TIFF file |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TiffImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.ITIFFRasterImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input | ||
File Path | FilePath | Gets or sets the file path fo the TIFF file to import. |
Output | ||
Raster | RasterName | Gets or sets the name of the Raster to create to store the imported TIFF file. |
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the TIFF file to import. |
World File | WorldFile | Gets or sets the file containing information about position, scale and skew of TIFF image. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool")
from DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import from TIFF file")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool")
from DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.ITIFFRasterImportTool(app.Tools.CreateNew("Import from TIFF file"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import from TIFF file") as DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.ITIFFRasterImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.TIFFRasterImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.TIFFRasterImportTool.dll" />
Import temporal raster from TIFF files¶
This tool imports a raster from a TIFF files.
In contrast to the Import from Image file tool, the TIFF image is imported as a Grid type raster rather than an image. The file can contain double values instead of color codes. The tool requires a world file (*.tfw) to be present as well. The world file defines the position, scale, and skew (rotation) of the raster. More information on world files can be found at Wikipedia
Coordinate system can be read from the file, having the same name as world file and extension prj. If such file exists and contain coordinate system description, recognized by MIKE OPERATIONS – coordinate system field is filled.
In case of the GeoTIFF information about coordinate system and position is included to the TIFF file. Info from eventual world file is not used.
Tool Info | |
---|---|
Display Name | Import temporal raster from TIFF files |
API Name | Import temporal rasters from TIFF files |
Tools Explorer | /Import/Import temporal raster from TIFF files |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TiffTemporalImport |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.ITIFFTemporalImportTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input | ||
File name mask | DateTimeFilenameMask | Gets or sets the date time filename mask. |
Folder Path | DirectoryPath | Gets or sets the directory path fof the TIFF file to import |
Item EUM | Enum_Item | Gets or sets the enum item. Note that the property is only available when: AddToExistingRaster=False |
Unit EUM | Enum_Unit | Gets or sets the enum unit. Note that the property is only available when: AddToExistingRaster=False |
Output | ||
Raster Name | RasterName | Gets or sets the name of the Raster to create to store rasters imported from TIFF files |
Parameters | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name of the TIFF file to import. Note that the property is only available when: AddToExistingRaster=False |
Extend existing raster | AddToExistingRaster | Gets or sets a value indicating whether add to existing raster. |
World File | WorldFile | Gets or sets the file path fo the TIFF world file |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool")
from DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool import *
# Get the tool.
tool = app.Tools.CreateNew("Import temporal rasters from TIFF files")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool")
from DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.ITIFFTemporalImportTool(app.Tools.CreateNew("Import temporal rasters from TIFF files"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Import temporal rasters from TIFF files") as DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.ITIFFTemporalImportTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.TIFFTemporalImportTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.TIFFTemporalImportTool.dll" />
Intersect Feature Classes¶
The intersect tool creates a geometric intersection of two input polygon feature classes. Only the features, or portions of features, which overlap in all input feature classes will be written to the output feature class. Attributes from all input features are mapped to all output features.
Tool Info | |
---|---|
Display Name | Intersect Feature Classes |
API Name | Intersect Feature Classes |
Tools Explorer | /Geo Processing/Intersect Feature Classes |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IIntersectTool |
Input Items | Two feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Name of Intersection feature class | IntersectFeatureClassName | Gets or sets the Name of new Intersection Feature Class. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Intersect Feature Classes")
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IIntersectTool(app.Tools.CreateNew("Intersect Feature Classes"))
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Intersect Feature Classes") as DHI.Solutions.GISManager.Tools.GeoProcessing.IntersectTool;
// Set the tool properties and execute.
var cities = _gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/Cities");
var polygon = _gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/1Polygon");
tool.InputItems.Add(cities);
tool.InputItems.Add(polygon);
tool.IntersectFeatureClassName= "IntersectedFeatureClass";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.IntersectTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Inverse Distance Weighted Interpolation¶
This tool interpolates point data producing a raster with values given by the specified attribute of the input point feature class. The tool uses the Inverse Distance Weighted algorithm which assigns to every grid cell the weighted combination of the in neighboring points. The weights are computed using the inverse distance. Selection of the points and method the combination of the values is done using modified Shepard method for non-uniform datasets.
Tool Info | |
---|---|
Display Name | Inverse Distance Weighted Interpolation |
API Name | Inverse Distance Weighted Interpolation |
Tools Explorer | /Raster Interpolation/Inverse Distance Weighted Interpolation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterInterpolation |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterInterpolation.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterInterpolation.IIDWInterpolationTool |
Input Items | A single features or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to get values for the points to use in the interpolation |
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
Extrapolate values | ExtrapolateValues | Gets or sets a value indicating whether interpolated values are used even in case where they are bigger than maximum input value or smaller than minimum input value. Otherwise maximum and minimum values are used respectively. |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster Coordinate system is not used. Instead, coordinate system for input feature class is used. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = app.Tools.CreateNew("Inverse Distance Weighted Interpolation")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterInterpolation.IIDWInterpolationTool(app.Tools.CreateNew("Inverse Distance Weighted Interpolation"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Inverse Distance Weighted Interpolation") as DHI.Solutions.GISManager.Tools.RasterInterpolation.IIDWInterpolationTool;
// Add input items.
tool.InputItems.Add(<A single features or a single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterInterpolation.IDWInterpolationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterInterpolation.dll" />
Kriging Interpolation¶
This tool interpolates point data producing a raster with values given by the specified attribute of the input point feature class using the kriging algorithm which assigns to every grid cell a value calculated using the simple kriging method with specified covariance method. The interpolated values are computed using linear regression of input values.
Tool Info | |
---|---|
Display Name | Kriging Interpolation |
API Name | Kriging Interpolation |
Tools Explorer | /Raster Interpolation/Kriging Interpolation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterInterpolation |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterInterpolation.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterInterpolation.IKrigingInterpolationTool |
Input Items | A single features or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to get values for the points to use in the interpolation |
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
Covariance Type | CovarianceType | Gets or sets the DHI.Solutions.GISManager.Tools.RasterInterpolation.IKrigingInterpolationTool.CovarianceType to use to compute covariance of the values in two points using the scaled distance between points |
Extrapolate values | ExtrapolateValues | Gets or sets a value indicating whether interpolated values are used even in case where they are bigger than maximum input value or smaller than minimum input value. Otherwise maximum and minimum values are used respectively. |
Missing Value | MissingValue | Gets or sets the missing value when the distance to the closest point is bigger than radius |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster |
Relative Scaling Factor | RelativeScalingFactor | Gets or sets the scaling factor to normalize point distances (typically 1) |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Kriging Interpolation")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterInterpolation.IKrigingInterpolationTool(app.Tools.CreateNew("Kriging Interpolation"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Kriging Interpolation") as DHI.Solutions.GISManager.Tools.RasterInterpolation.KrigingInterpolationTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.Execute();
// Get the output of the tool.
var output = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterInterpolation.KrigingInterpolationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterInterpolation.dll" />
Mean Annual Soil Loss (A)¶
Calculates the mean annual soil loss (A) based on the RUSLE soil erosion equation. The mean annual soil loss is calculated by multiplying each of the input factors together: A = R * K * LS * C * P
Tool Info | |
---|---|
Display Name | Mean Annual Soil Loss (A) |
API Name | Soil Erosion Mean Annual Soil Loss (A) |
Tools Explorer | /Soil Erosion/Mean Annual Soil Loss (A) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionATool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Crop Management (C) | CropManagementFactor | Gets or sets the raster representing the crop management factor (C) of the RUSLE soil erosion formula. |
Erosion Control (P) | ErosionControlFactor | Gets or sets the raster representing the erosion control factor (P) of the RUSLE soil erosion formula. |
Rainfall Erosivity (R) | RainfallErosivityFactor | Gets or sets the raster representing the rainfall erosivity factor (R) of the RUSLE soil erosion formula. |
Slope Length (LS) | SlopeLengthFactor | Gets or sets the raster representing the slope length factor (LS) of the RUSLE soil erosion formula. |
Soil Erodibility (K) | SoilErodibilityFactor | Gets or sets the raster representing the soil erodibility factor (K) of the RUSLE soil erosion formula. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Mean Annual Soil Loss (A)")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionATool(app.Tools.CreateNew("Soil Erosion Mean Annual Soil Loss (A)"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Mean Annual Soil Loss (A)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionATool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionATool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
Measure¶
Tool for adding the attributes “area” and “perimeter” to a polygon feature class or attribute “length” to a line feature class.
Tool Info | |
---|---|
Display Name | Measure |
API Name | Measure |
Tools Explorer | /Geo Processing/Measure |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IMeasureTool |
Input Items | One or more feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Unit | Unit | Gets or sets the unit for the measures |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Measure")
# Add input items.
tool.InputItems.Add(<One or more feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IMeasureTool(app.Tools.CreateNew("Measure"))
# Add input items.
tool.InputItems.Add(<One or more feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Measure") as DHI.Solutions.GISManager.Tools.GeoProcessing.MeasureTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.Unit = DHI.Solutions.GISManager.Interfaces.DisplayUnit.Kilometer;
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.MeasureTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Merge Feature Classes¶
Merge tool. This tool takes 2 feature classes and generates a 3rd feature class with merged geometries.
Tool Info | |
---|---|
Display Name | Merge Feature Classes |
API Name | Merge Feature Classes |
Tools Explorer | /Geo Processing/Merge Feature Classes |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IMergeTool |
Input Items | Two feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attributes Mapping | AttributesMapping | Gets the dictionary of mapping between attributes in master feature class and attribute in feature class to merge |
Feature Class Name | MergeFeatureClassName | Gets or sets name of the new merged feature class |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Master Feature Class | MasterFeatureClass | Gets or sets the feature class to act as master feature class. Master feature class is the feature class whose attribute will be used for merging |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Merge Feature Classes")
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IMergeTool(app.Tools.CreateNew("Merge Feature Classes"))
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Merge Feature Classes") as DHI.Solutions.GISManager.Tools.GeoProcessing.MergeTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass1);
tool.InputItems.Add(featureClass2);
tool.MergeFeatureClassName = "MergeFeatureClassName";
tool.MasterFeatureClass = featureClass1;
tool.AttributesMapping.Clear();
tool.AttributesMapping.Add("Attrib1", "Attrib1");
tool.AttributesMapping.Add("Attrib2", "Attrib2");
tool.AttributesMapping.Add("Attrib3", "Attrib3");
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.MergeTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
MIKE Cloud Spatial Upload Tool¶
Tool for uploading shape, dfs2 or dfsu files to the DHI Cloud Platform storage (MIKE Cloud).
Tool Info | |
---|---|
Display Name | MIKE Cloud Spatial Upload Tool |
API Name | MIKECloudDfsUploadTool |
Tools Explorer | /MIKE Cloud Spatial/MIKE Cloud Spatial Upload Tool |
NuGet Package | DHI.MikeOperations.GISManager.Tools.MikeCloudDfsUpload |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.IMikeCloudSpatialUploadTool |
Input Items | No input items required |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Advance | ||
Compresion type | Compression | Compresion to be used in Cloud multidimensional storage Note that the property is only available when: AdvanceMeshSettings=TrueFileType=Dfsu |
Multidimensional storage type | MultidimensionalStorageType | Type of multidimensional storage - optimized to Time Series or Time Step extraction performance. If both types are needed - it is good idea load data in Cloud twice Note that the property is only available when: AdvanceMeshSettings=TrueFileType=Dfsu |
Spatial group size | SpatialGroupSize | Number of spatial elements per block (int) In case of Time step optimized storage -> number of mesh elements can be good option In case of Time series optimized number 1 can be good option. Note that the property is only available when: AdvanceMeshSettings=TrueFileType=Dfsu |
Time group size | TimeGroupSize | Number of steps per block (int). In case of Time step optimized storage and big mesh -> value 1 is good option In case of Time series optimized + data storege, where no new time steps will be added -> number of time steps can be good option. Note that the property is only available when: AdvanceMeshSettings=TrueFileType=Dfsu |
Options | ||
Advance settings | AdvanceMeshSettings | Provide posibility to optimize way, how to store data in cloud multidimensional storage. Default is Time step optimized. Note that the property is only available when: FileType=Dfsu |
Destination Root Path | DestinationRootPath | Gets or sets the path in the MIKE Cloud Platform project to upload time series and time series groups to. |
File path | FilePath | Gets or sets the file or folder path containing dfs files to be uploaded to the MIKE Cloud Platform. |
File type | FileType | Gets or sets the dfs file type to upload. |
MIKE Cloud Provider | MIKECloudProvider | Gets or sets the MIKE Cloud Raster provider to be used for uploading dfs2 ,shp and dfsu files. |
Overwrite | Overwrite | Gets or sets a value indicating whether existing time series should be overwritten. If False, existing time series will be skipped. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool")
from DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("MIKECloudDfsUploadTool")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool")
from DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.IMikeCloudSpatialUploadTool(app.Tools.CreateNew("MIKECloudDfsUploadTool"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("MIKECloudDfsUploadTool") as DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.IMikeCloudSpatialUploadTool;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.MikeCloudSpatialUploadTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.MikeCloudSpatialUploadTool.dll" />
Nearest Neighbour Interpolation¶
This tool interpolates point data producing a raster with values given by the specified attribute of the input feature class using the nearest neighbour algorithm, which assigns to every grid cell the value in the closest input point.
Tool Info | |
---|---|
Display Name | Nearest Neighbour Interpolation |
API Name | Nearest Neighbour Interpolation |
Tools Explorer | /Raster Interpolation/Nearest Neighbour Interpolation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterInterpolation |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterInterpolation.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterInterpolation.INearestNeighbourInterpolationTool |
Input Items | A single features or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to get values for the points to use in the interpolation |
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
Missing Value | MissingValue | Gets or sets the value to use when the distance to the closest points is bigger than radius |
Radius | Radius | Gets or sets the value for the maximum radius to the closest point so it's value is used in the interpolation -1 means infinite radius |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster Coordinate system is not used. Instead, coordinate system for input feature class is used |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = app.Tools.CreateNew("Nearest Neighbour Interpolation")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterInterpolation.INearestNeighbourInterpolationTool(app.Tools.CreateNew("Nearest Neighbour Interpolation"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Nearest Neighbour Interpolation") as DHI.Solutions.GISManager.Tools.RasterInterpolation.NearestNeighbourInterpolationTool;
// Set the tool properties and execute.
too.InputItems.Add(featureClass);
tool.Execute();
// Get the output of the tool.
var outputRaster = _testTool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterInterpolation.NearestNeighbourInterpolationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterInterpolation.dll" />
Project¶
A tool for projecting rasters to a different coordinate system.
Tool Info | |
---|---|
Display Name | Project |
API Name | Raster Project |
Tools Explorer | /Raster Processing/Project |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterProjectTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name. |
Interpolation Method | InterpolationMethod | Gets or sets the interpolation method to use. Can be Nearest Neighbor, Bilinear, or Cubic. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Raster Project")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterProjectTool(app.Tools.CreateNew("Raster Project"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Raster Project") as DHI.Solutions.GISManager.Tools.RasterProcessing.RasterProjectTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = module.RasterList.Fetch("/smallOresund/H Water Depth m");
tool.InputItems.Add(raster);
tool.CoordinateSystemName = "WGS 84 / UTM zone 33N";
tool.InterpolationMethod = DHI.Solutions.GISManager.Interfaces.RasterInterpolationMethod.Cubic;
tool.Execute();
// Get the output of the tool.
var projectedTaster = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterProjectTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Query FeatureClass¶
The “QueryFeatureClass” tool creates a new feature class with attribute(s) storing specific values. For selected Item in mesh it can extract a given time step or compute statistics (Minimum, Average, Maximum). When creating a statistics feature class with minimum, average and maximum values for each element, the variable should be set to "Statistics". In case of cloud provider works only for Time step optimized Cloud multidimensional storage.
Tool Info | |
---|---|
Display Name | Query FeatureClass |
API Name | QueryFeatureClass |
Tools Explorer | /Mesh Processing/Query FeatureClass |
NuGet Package | DHI.MikeOperations.GISManager.Tools.MeshProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.MeshProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryFeatureClass |
Input Items | A single mesh |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Description | ||
Tool | DisplayName | Gets or sets the display name. |
Output Feature class | ||
FeatureClass Name | FeatureClassName | Gets or sets The name of the feature class to create. |
Parameters | ||
EndTime | EndTime | Gets the end time of the feature class query. Note that the property is only available when: SelectionVariable=TimeStepValue |
Selection Time | TimeSelection | Gets or sets the time selection. (Time step index or given time). Note that the property is only available when: SelectionVariable=TimeStepValue |
Start Time | StartTime | Gets the start time of the feature class query. Note that the property is only available when: SelectionVariable=TimeStepValue |
Time Step Index | TimeStepIndex | Gets or sets the index of the selected time step. Note that the property is only available when: ShowTimeIndex=Show |
Time | TimeStep | Gets or sets the time step to be selected. Closest time step is found. If lover then start time first time step is used. If higer then end time last time step is used. Note that the property is only available when: ShowTime=Show |
Variable(s) | SelectionVariable | Gets or sets the selection variable (Statistic or TimeStepValue). |
Tool Settings | ||
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Tool Methods
- Clone(): Clone the Query Feature Class.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MeshProcessing")
from DHI.Solutions.GISManager.Tools.MeshProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("QueryFeatureClass")
# Add input items.
tool.InputItems.Add(<A single mesh>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MeshProcessing")
from DHI.Solutions.GISManager.Tools.MeshProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryFeatureClass(app.Tools.CreateNew("QueryFeatureClass"))
# Add input items.
tool.InputItems.Add(<A single mesh>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("QueryFeatureClass") as DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryFeatureClass;
// Add input items.
tool.InputItems.Add(<A single mesh>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.MeshProcessing.QueryFeatureClass"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.MeshProcessing.dll" />
Query Time Series¶
This tool extracts timeseries from a mesh for given x and y coordinates or list of mesh ids. In case of cloud provider works only for Time series optimized Cloud multidimensional storage.
Tool Info | |
---|---|
Display Name | Query Time Series |
API Name | QueryTimeSeries |
Tools Explorer | /Mesh Processing/Query Time Series |
NuGet Package | DHI.MikeOperations.GISManager.Tools.MeshProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.MeshProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryTimeSeries |
Input Items | A single mesh or a single features |
Output Items | A time series |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Description | ||
Tool | DisplayName | Gets or sets the display name. |
Output TS | ||
Export directory | ExportDirectory | Gets or sets the directory to export to when saving to disk. Note that the property is only available when: SaveTo=SaveToDisk |
Export format | ExportFormat | Gets or sets the export format (ASCII, Excel or dfs0). Note that the property is only available when: SaveTo=SaveToDisk |
Output TS group | OutputTSGroup | Gets or sets the output ts group. Note that the property is only available when: SaveTo=SaveToDatabase |
Save to | SaveTo | Gets or sets the save type (Database, disk or memory) |
Time Series Name | TimeSeriesName | Gets or sets the full path to the time series create. |
Unit | TimeseriesUnit | Gets or sets the unit of the new timeseries. By default this is provided by the information from the mesh. |
Value Type | TimeSeriesValueType | Gets or sets the type of timestep to create the new timeseries with. |
Variable | TimeSeriesVariable | Gets or sets the variable of the new timeseries. By default this is provided by the information from the mesh. |
Parameters | ||
Element IDs | ElementIDs | Gets or sets the element ids to query. One time series generated for one input Id. Time series name created as combination of the given time series name and element Id. Note that the property is only available when: SelectionGeometry=ElementIDs |
EndTime | EndTime | Gets or sets the end time. Note that the property is only available when: SelectionTime=Interval |
Geometry WKT | WktString | Gets or sets the WKT string. Not supported in current release. Note that the property is only available when: SelectionGeometry=Wkt |
Point coord. system | SelectionCoordinateSystem | Coordinate system of selection point. Mash, Map or Long/Lat coordinate system can be used for interpretation of X, Y coordinates. Note that the property is only available when: SelectionGeometry=Point |
Selection Geometry Type | SelectionGeometry | Gets or sets type of spatial query. Can be selected by Point geometry or list of mesh Ids |
Selection Time | SelectionTime | Gets or sets the selection time type (Full or interval). |
Start Time | StartTime | Gets or sets the start time. Note that the property is only available when: SelectionTime=Interval |
X coordinate | XCoordinate | Gets or sets the X coordinate of the point to extract from. Will be eventualy projected to the mesh coordinate system based on Input coordinate system selection. Note that the property is only available when: SelectionGeometry=Point |
Y coordinate | YCoordinate | Gets or sets the Y coordinate of the point to extract from. Will be eventualy projected to the mesh coordinate system based on Input coordinate system selection. Note that the property is only available when: SelectionGeometry=Point |
Tool Settings | ||
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Tool Methods
- Clone(): Colne th etime series query.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MeshProcessing")
from DHI.Solutions.GISManager.Tools.MeshProcessing import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *
# Get the tool.
tool = app.Tools.CreateNew("QueryTimeSeries")
# Add input items.
tool.InputItems.Add(<A single mesh or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.MeshProcessing")
from DHI.Solutions.GISManager.Tools.MeshProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryTimeSeries(app.Tools.CreateNew("QueryTimeSeries"))
# Add input items.
tool.InputItems.Add(<A single mesh or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("QueryTimeSeries") as DHI.Solutions.GISManager.Tools.MeshProcessing.IQueryTimeSeries;
// Add input items.
tool.InputItems.Add(<A single mesh or a single features>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.MeshProcessing.QueryTimeSeries"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.MeshProcessing.dll" />
Radial Basis Interpolation¶
This tool interpolates point data producing a raster with values given by the specified attribute of the input point feature class using the radial basis algorithm,
which assigns to every grid cell a value calculated using a real-valued function whose value depends only on the distance from the origin f(x) = f(||x||)
or alternatively on the distance from some other point c, called a center f(x) = f(||x - c||).
Any function that satisfies the property is a radial function. Radial basis functions are typically used to build up function approximations
approximating function y(x) is represented as a sum of N radial basis functions, each associated with a different center xi, and weighted by an appropriate coefficient.
Tool Info | |
---|---|
Display Name | Radial Basis Interpolation |
API Name | Radial Basis Interpolation |
Tools Explorer | /Raster Interpolation/Radial Basis Interpolation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterInterpolation |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterInterpolation.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterInterpolation.IRadialBasisInterpolationTool |
Input Items | A single features or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to get values for the points to use in the interpolation |
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
Extrapolate values | ExtrapolateValues | Gets or sets a value indicating whether interpolated values are used even in case where they are bigger than maximum input value or smaller than minimum input value. Otherwise maximum and minimum values are used respectively. |
Radial Basis Function | RadialBasisFunction | Gets or sets a value for the DHI.Solutions.GISManager.Tools.RasterInterpolation.IRadialBasisInterpolationTool.RadialBasisFunction to use to compute approximation functions |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster Coordinate system is not used. Instead, coordinate system for input feature class is used |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Radial Basis Interpolation")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterInterpolation")
from DHI.Solutions.GISManager.Tools.RasterInterpolation import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterInterpolation.IRadialBasisInterpolationTool(app.Tools.CreateNew("Radial Basis Interpolation"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Radial Basis Interpolation") as DHI.Solutions.GISManager.Tools.RasterInterpolation.IRadialBasisInterpolationTool;
// Add input items.
tool.InputItems.Add(<A single features or a single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterInterpolation.RadialBasisInterpolationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterInterpolation.dll" />
Rainfall Erosivity (R)¶
Calculates rainfall erosivity (R) for the RUSLE soil erosion equation.
The default formula for rainfall erosivity is as follows, but can be changed by the user as required. This equation assumes you have two input grids, “intensity” and “depth”. These need to be mapped in the Name Mapping property to these names. =(0.29 * (1 - (0.596 EXP(-0.04[intensity]))))[depth][intensity]
Tool Info | |
---|---|
Display Name | Rainfall Erosivity (R) |
API Name | Soil Erosion Rainfall Erosivity (R) |
Tools Explorer | /Soil Erosion/Rainfall Erosivity (R) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionRTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Formula | Formula | Gets or sets the raster calculator formula for calculating rainfall erosivity (R) from the input rainfall intensity and depth rasters. |
Name Mapping | NameMapping | Gets or sets the mapping between the input rasters and the raster names entered in the formula. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R)")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionRTool(app.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R)"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionRTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionRTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
Rainfall Erosivity (R) (extended)¶
Soil erosion tool
Tool Info | |
---|---|
Display Name | Rainfall Erosivity (R) (extended) |
API Name | Soil Erosion Rainfall Erosivity (R) (extended) |
Tools Explorer | /Soil Erosion/Rainfall Erosivity (R) (extended) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosionR |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosionRTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosionRTool.ISoilErosionRTool |
Input Items | One or more time series |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Catchment feature class | CatchmentFeatureClass | Gets or sets the feature class with catchments. Shall have the same coordinate system as StationsFeatureClass |
Raster height | RasterHeight | Gets or sets the value of raster height |
Raster width | RasterWidth | Gets or sets the value of raster width |
Resampling time step interval | ResampligTimeStepInterval | Gets or sets the time step interval. The interval to use to resample the input data so that correct multiplication factor to convert fixed intervals into break points (where rainfall intensity changes during a storm) can be applied. Multiplication factors according to resampling time step interval are: 60 min: 1.730, 30 min: 1.161, 15 min: 1.078, 10 min: 1.044 and 5 min: 1.014 |
Stations feature class | StationsFeatureClass | Gets or sets the feature class with rainfall stations. Shall have the same coordinate system as CatchmentFeatureClass |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosionRTool")
from DHI.Solutions.GISManager.Tools.SoilErosionRTool import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R) (extended)")
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosionRTool")
from DHI.Solutions.GISManager.Tools.SoilErosionRTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosionRTool.ISoilErosionRTool(app.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R) (extended)"))
# Add input items.
tool.InputItems.Add(<One or more time series>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Rainfall Erosivity (R) (extended)") as DHI.Solutions.GISManager.Tools.SoilErosionRTool.ISoilErosionRTool;
// Add input items.
tool.InputItems.Add(<One or more time series>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosionRTool.SoilErosionRTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosionRTool.dll" />
Raster appearance¶
This tool will set the appearance for the raster by updating the symbology of the raster. The symbology is used when displaying the raster.
Tool Info | |
---|---|
Display Name | Raster appearance |
API Name | Raster appearance |
Tools Explorer | /Raster Processing/Raster appearance |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterAppearanceTool |
Input Items | A single raster |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Layer style | LayerStyle | Gets or sets the layer style to be used for the raster added to the map. Style definition is identical to the style definition used in map. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Style Type | RasterStyleType | Gets or sets the layer style type. Based on selected type, layer style definition parameters are changed. Available types are Gradient and Value Ranges. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Raster appearance")
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterAppearanceTool(app.Tools.CreateNew("Raster appearance"))
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Raster appearance") as DHI.Solutions.GISManager.Tools.RasterProcessing.RasterAppearanceTool;
// Set the tool properties and execute.
tool.InputItems.Add(raster);
tool.RasterStyleType = DHI.Solutions.GISManager.Interfaces.RasterStyleType.ValueRanges;
tool.Execute();
// Get the output of the tool.
var outRaster = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterAppearanceTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Raster Calculator¶
This tool performs raster math on input rasters using syntax commonly found in spreadsheet programs.
The syntax used for the formula is the same as used in the Spreadsheet Manager. Formulas can be tested in Spreadsheet Manager and then copied into the tool properties, after replacing cell references with the mapped raster names.
Tool Info | |
---|---|
Display Name | Raster Calculator |
API Name | Raster Calculator |
Tools Explorer | /Raster Processing/Raster Calculator |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterCalculatorTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters_Category | ||
Raster path | RasterPath | Gets or sets the path to which the raster is saved. Note that the property is only available when: SaveToDatabase=True |
Save to database | SaveToDatabase | Gets or sets a value indicating whether to save the output to the database. |
Tool Settings | ||
Formula | Formula | Gets or sets the formula to apply to the input rasters. Use syntax normally found in spreadsheets, but instead of cell references, enter raster names as mapped in the Mapping property within square brackets. E.g. “[myraster]” The tool can also produce one output for each input in case “[value]” mapping is used, meaning the current raster being iterated. The syntax used for the formula is the same as used in the Spreadsheet Manager. Formulas can be tested in Spreadsheet Manager and then copied into the tool properties, after replacing cell references with the mapped raster names. |
Name Mapping | NameMapping | Gets or sets the mapping of raster names used in the formula to the input rasters. Do not include brackets. By default the input rasters are mapped to their raster name. |
Temporal Output | TemporalOutput | Gets or sets a value indicating whether the output is a temporal raster. Note that the property is only available when: TemporalInputRaster=True |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Raster Calculator")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterCalculatorTool(app.Tools.CreateNew("Raster Calculator"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster Calculator") as DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterCalculatorTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterCalculatorTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Raster Clip¶
This tool clips a raster with the input geometry
Tool Info | |
---|---|
Display Name | Raster Clip |
API Name | Raster Clip |
Tools Explorer | /Raster Processing/Raster Clip |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterClipTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Parameters_Category | ||
Raster path | RasterPath | Gets or sets the path to which the raster is saved. Note that the property is only available when: SaveToDatabase=True |
Save to database | SaveToDatabase | Gets or sets a value indicating whether to save the output to the database. |
Tool Settings | ||
Feature class path | FeatureClassPath | Gets or sets the value of FeatureClassPath |
Raster band | RasterBand | Gets or sets the value of RasterBand |
Raster Processor | RasterProcessor | Gets or sets the raster processor to use when executing the tool |
Value outside | OutsideByteValue | Gets or sets the byte value which is used for cells outside the geometry |
Value outside | OutsideFloatValue | Gets or sets the float value which is used for cells outside the geometry |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Raster Clip")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterClipTool(app.Tools.CreateNew("Raster Clip"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster Clip") as DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterClipTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterClipTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Raster Group Tools¶
This tool run different tools for all rasters in raster group. Speed up process, where area is for example covered by more rasters. Individual tool and their combinations can be used for (significantly) increasing of raster(s) presentation in map. Useful in case of big raster of many rasters covering area of interest. Set/modify default symbology for individual rasters. Example of such chain can be – Project and/or Resample; Copy default style; Tiles; Resample; Set Visibility. Typically used for the final project delivery. Data analysis are done on the original full scale rasters.
Tool Info | |
---|---|
Display Name | Raster Group Tools |
API Name | Raster Group Tools |
Tools Explorer | /Raster Group Tools/Raster Group Tools |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterGroupProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterGroupProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterGroupProcessing.IRasterGroupTool |
Input Items | A single raster group |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Settings | ||
Symbology templete raster | TemplateRaster | Gets or sets the template raster. Note that the property is only available when: RasterGroupProcesingType=CopyDefaultStyle |
Layer Visibility | ||
Lower Scale | LowerScaleVisibility | Gets or sets the lower scale visibility. Note that the property is only available when: RasterGroupProcesingType=Resample,SetVisibility |
Upper Scale | UpperrScaleVisibility | Gets or sets the upperr scale visibility. Note that the property is only available when: RasterGroupProcesingType=Resample,SetVisibility |
Zoom Level | ZoomLevel | Gets or sets the zoom level. Note that the property is only available when: RasterGroupProcesingType=Resample,SetVisibility |
Parameters_Category | ||
Coordinate System | CoordinateSystemName | Gets or sets the coordinate system name. Note that the property is only available when: RasterGroupProcesingType=Project |
Tool Settings | ||
Add Source Root | AddSourceRoot | Gets or sets a value indicating whether [add source root]. Note that the property is only available when: RasterGroupProcesingType=Resample,Tiles,Project |
Duplicate Name Options | DuplicateNameOption | Gets or sets the option to be chosen when a feature with the same name is already present in the group Note that the property is only available when: RasterGroupProcesingType=Resample,Project |
Interpolation Method | InterpolationMethod | Gets or sets the interpolation method to use Note that the property is only available when: RasterGroupProcesingType=Resample,Project |
Keep Raster Location | KeepResampelingLocation | Gets or sets a value indicating whether [keep resampeling location]. Note that the property is only available when: RasterGroupProcesingType=Resample |
Keep Visibility Scale | KeepVisibilityScale | Gets or sets a value indicating whether [keep visibility scale]. Note that the property is only available when: RasterGroupProcesingType=CopyDefaultStyle |
New cell size | CellSize | Gets or sets the size of the cell. Note that the property is only available when: RasterGroupProcesingType=Resample |
Output Group Root Path | OutputGroupRootPath | Gets or sets the Output Group Root Path - be used as the root, where copy of the processed rasters will be stored. Note that the property is only available when: RasterGroupProcesingType=Resample,Tiles,Project |
Processing type | RasterGroupProcesingType | Gets or sets the type of the raster group procesing. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Tile Height | TileHeight | Gets or sets the height of the tile. Note that the property is only available when: RasterGroupProcesingType=Tiles |
Tile Width | TileWidth | Gets or sets the width of the tile. Note that the property is only available when: RasterGroupProcesingType=Tiles |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterGroupProcessing")
from DHI.Solutions.GISManager.Tools.RasterGroupProcessing import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Raster Group Tools")
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterGroupProcessing")
from DHI.Solutions.GISManager.Tools.RasterGroupProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterGroupProcessing.IRasterGroupTool(app.Tools.CreateNew("Raster Group Tools"))
# Add input items.
tool.InputItems.Add(<A single raster group>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster Group Tools") as DHI.Solutions.GISManager.Tools.RasterGroupProcessing.IRasterGroupTool;
// Add input items.
tool.InputItems.Add(<A single raster group>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterGroupProcessing.RasterGroupTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterGroupProcessing.dll" />
Raster Query Tool¶
Tool for querying rasters.
Tool Info | |
---|---|
Display Name | Raster Query Tool |
API Name | Raster query |
Tools Explorer | /Data tools/Raster Query Tool |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterQuery |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterQueryTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterQueryTool.IRasterQueryTool |
Input Items | No input items required |
Output Items | List of results |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Query parameters | ||
Metadata | Metadata | Gets or sets metadata of time series to query for. Note that the property is only available when: HasMetadataModule=True |
Name | RasterName | Gets or sets the name of rasters to query for. Wildcards are supported. |
Within Group | WithinGroup | Gets or sets the group name of rasters to query for. Wildcards are supported. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterQueryTool")
from DHI.Solutions.GISManager.Tools.RasterQueryTool import *
# Get the tool.
tool = app.Tools.CreateNew("Raster query")
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterQueryTool")
from DHI.Solutions.GISManager.Tools.RasterQueryTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterQueryTool.IRasterQueryTool(app.Tools.CreateNew("Raster query"))
# Add input items.
tool.InputItems.Add(<No input items required>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster query") as DHI.Solutions.GISManager.Tools.RasterQueryTool.IRasterQueryTool;
// Add input items.
tool.InputItems.Add(<No input items required>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterQueryTool.RasterQueryTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterQueryTool.dll" />
Raster to Vector¶
This tool creates a feature class with features for each value range specified. If value ranges are not specified, it creates features for each unique value in the raster.
The syntax used for the formula is the same as used in the Spreadsheet Manager. Formulas can be tested in Spreadsheet Manager and then copied into the tool properties, after replacing cell references with the mapped raster names.
Tool Info | |
---|---|
Display Name | Raster to Vector |
API Name | Raster to Vector |
Tools Explorer | /Raster Processing/Raster to Vector |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterToVectorTool |
Input Items | One or more rasters |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Raster Band | RasterBand | Gets or sets the band from the input rasters that is to be converted. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Tolerance | Tolerance | Gets or sets the tolerance in raster coordinate system used for the simplification of geometries. |
Value Ranges | ValueRanges | Gets or sets the values ranges to generate features. If not specified, all values are used. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Raster to Vector")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterToVectorTool(app.Tools.CreateNew("Raster to Vector"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Raster to Vector") as DHI.Solutions.GISManager.Tools.RasterProcessing.RasterToVectorTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = module.RasterList.Fetch("/small_raster");
tool.InputItems.Add(raster);
tool.RasterBand = 0;
tool.Tolerance = 0.5;
var valueRanges = new System.Collections.Generic.List<DHI.Solutions.GISManager.Interfaces.IValueRange>();
valueRanges.Add(new DHI.Solutions.GISManager.Common.ValueRange() { MinValue = 0, MaxValue = 5 });
valueRanges.Add(new DHI.Solutions.GISManager.Common.ValueRange() { MinValue = 5, MaxValue = 10 });
valueRanges.Add(new DHI.Solutions.GISManager.Common.ValueRange() { MinValue = 10, MaxValue = 20 });
valueRanges.Add(new DHI.Solutions.GISManager.Common.ValueRange() { MinValue = 20, MaxValue = 50 });
tool.ValueRanges = valueRanges;
tool.Execute();
// Get the output of the tool.
var featureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterToVectorTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Reclassification¶
This tool reclassifies a raster replacing single values or ranges of values with the values to reclassify with. All bands in the raster will be reclassified and the output raster(s) will have the same definition as input raster(s).
Tool Info | |
---|---|
Display Name | Reclassification |
API Name | Reclassification |
Tools Explorer | /Raster Processing/Reclassification |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterReclassificationTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Keep Unmapped Values | KeepUnmappedValues | Gets or sets a value indicating whether unmapped values are kept or replaced by null. |
Mapping Type | MappingType | Gets or sets the type of mapping. If single value, values are mapped one to one. Otherwise, a range of values is mapped to a new value. |
Values Mapping | Mapping | Gets or sets the mapping of values from the original raster to the reclassified raster. If DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterReclassificationTool.MappingType is SingleValue, the keys in the dictionary shall be single values. If DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterReclassificationTool.MappingType is ValueRange, the keys in the dictionary shall be DHI.Solutions.GISManager.Interfaces.IValueRange The mapping values data type depends on the DHI.Solutions.GISManager.Interfaces.IRasterBand.BandType and values will be converted accordingly. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Reclassification")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterReclassificationTool(app.Tools.CreateNew("Reclassification"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Reclassification") as DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterReclassificationTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterReclassificationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Resample¶
This tool resamples a raster to a different cell size.
Tool Info | |
---|---|
Display Name | Resample |
API Name | Raster Resample |
Tools Explorer | /Raster Processing/Resample |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterResampleTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input raster within the precision of the scale factor in each dimension. |
Interpolation Method | InterpolationMethod | Gets or sets the interpolation method to use. |
Raster Definition | RasterDefinition | Gets or sets the output definition of the raster, consisting of: Coordinate System: the output coordinate system (set by the system to the user coordinate system). Height: the number of cells vertically Scale X: the size of the cells in the X-direction Scale Y: the size of the cells in the Y-direction(enter as a negative number) Skew X: the rotation parameter in the X-direction(zero for no rotation) Skew Y: the rotation parameter in the Y-direction(zero for no rotation) Upper Left X: the X-coordinate for the upper left corner of the raster Upper Left Y: the Y-coordinate for the upper left corner of the raster Width: the number of cells horizontally |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
clr.AddReference("DHI.Solutions.GISManager.Interfaces")
from DHI.Solutions.GISManager.Interfaces import *
# Get the tool.
tool = app.Tools.CreateNew("Raster Resample")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterResampleTool(app.Tools.CreateNew("Raster Resample"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster Resample") as DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterResampleTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterResampleTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Slope¶
This tool calculates the slope for a raster in degrees. The output raster will have the same definition and as many bands as the corresponding input raster. Output data type is always float.
Given the following representation of a 3x3 neighborhood of pixels:
A B C D E F G H I
The equation for the pixel slope of cell E is: atan(sqrt(((c + 2f + i) - (a + 2d + g) / 8)^2 + (((g + 2h + i) - (a + 2b + c)) / 8) ^ 2))
Tool Info | |
---|---|
Display Name | Slope |
API Name | Slope |
Tools Explorer | /Raster Processing/Slope |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterSlopeTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
The tool has no properties.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Slope")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterSlopeTool(app.Tools.CreateNew("Slope"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Slope") as DHI.Solutions.GISManager.Tools.RasterProcessing.IRasterSlopeTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.RasterSlopeTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Slope Length¶
This tool calculates the slope length for each cell in a raster representing elevation values (DEM) by following the slope down from each cell (similar to river tracing) and calculating the change in height and the length when the slope breaks by the SlopeBreak value.
Tool Info | |
---|---|
Display Name | Slope Length |
API Name | Slope Length |
Tools Explorer | /Raster Processing/Slope Length |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.ISlopeLengthTool |
Input Items | One or more rasters |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Slope Break | SlopeBreak | Gets or sets the break in slope in percent that will mark the downstream end of the slope. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Slope Length")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.ISlopeLengthTool(app.Tools.CreateNew("Slope Length"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Slope Length") as DHI.Solutions.GISManager.Tools.RasterProcessing.ISlopeLengthTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.SlopeLengthTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Slope Length (LS)¶
Calculates slope length (LS) for the RUSLE soil erosion equation.
The tool uses the Slope and SlopeLength tools of the GIS Manager, described in the section on raster geoprocessing tools. From this the slope length is calculated as follows: LS = (x / 22.13)n(0.065 + 0.045 s + 0.0065 s^2)
where x = slope length(m) s = slope gradient(%) n = 0.5 for a slope > 5%, 0.4 for slope between 3.5 - 4.5%, 0.3 for a slope l - 3.5%, and 0.2 for a slope less than 1%.
This translates into the following spreadsheet formula which is called using the Raster Calculator Tool: =POWER([length] / 22.13, [n]) * (0.065 + 0.045 [slope] + 0.0065 [slope]*[slope])
This formula is applied 4 times for each possible value of n and then merged by adding(again using the Raster Calculator).
Tool Info | |
---|---|
Display Name | Slope Length (LS) |
API Name | Soil Erosion Slope Length (LS) |
Tools Explorer | /Soil Erosion/Slope Length (LS) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionLSTool |
Input Items | A single raster |
Output Items | A raster |
Tool Properties
The tool has no properties.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Slope Length (LS)")
# Add input items.
tool.InputItems.Add(<A single raster>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionLSTool(app.Tools.CreateNew("Soil Erosion Slope Length (LS)"))
# Add input items.
tool.InputItems.Add(<A single raster>)
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Slope Length (LS)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionLSTool;
// Add input items.
tool.InputItems.Add(<A single raster>);
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionLSTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
Soil Erodibility (K)¶
Calculates soil erodibility (K) for the RUSLE soil erosion equation. This tool works similarly to the raster Reclassification tool. The mapped values should be derived from the literature. Input items should be a raster containing values representing the soil type OR a feature class with polygons representing the soil types. Output is a raster representing the soil erodibility factor (K).
Tool Info | |
---|---|
Display Name | Soil Erodibility (K) |
API Name | Soil Erosion Soil Erodibility (K) |
Tools Explorer | /Soil Erosion/Soil Erodibility (K) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.SoilErosion |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.SoilErosion.dll |
API Reference | DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionKTool |
Input Items | A single raster or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Mapping | Mapping | Gets or sets the mapping of values. The keys in the dictionary shall be values representing each type. The mapping values data type shall be single values. |
Soil Type Attribute | SoilTypeAttribute | Gets or sets the feature class attribute which contains the soil type. (Only used when the input is a feature class). |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = app.Tools.CreateNew("Soil Erosion Soil Erodibility (K)")
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.SoilErosion")
from DHI.Solutions.GISManager.Tools.SoilErosion import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionKTool(app.Tools.CreateNew("Soil Erosion Soil Erodibility (K)"))
# Add input items.
tool.InputItems.Add(<A single raster or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Soil Erosion Soil Erodibility (K)") as DHI.Solutions.GISManager.Tools.SoilErosion.ISoilErosionKTool;
// Add input items.
tool.InputItems.Add(<A single raster or a single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.SoilErosion.SoilErosionKTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.SoilErosion.dll" />
Temporal Disaggregation¶
This tool disaggregates a scalar value according to patterns defined by time series in the fractions into a range of time series.
A time series for every combination of fractions and features of the input feature class. The value of every timestep of an output time series will be calculated in the following way: Value = ([fraction ts value] – [fraction threshold]) * [feature attribute value]*[fraction weight]/100/[accumulated fraction ts value]
The [accumulated ts value] is calculated as the accumulated exceedance([fraction ts value] – [fraction threshold]).
Tool Info | |
---|---|
Display Name | Temporal Disaggregation |
API Name | Temporal DisaggregationTool |
Tools Explorer | /Temporal Tools/Temporal Disaggregation |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TemporalRaster |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.Temporal.dll |
API Reference | DHI.Solutions.GISManager.Tools.Temporal.ITemporalDisaggregationTool |
Input Items | A single feature class |
Output Items | A time series |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute for identification | IdAttribute | Gets or sets the name of the attribute to identify features in the feature class. This attribute is used for naming the output time series of the tool. |
Attribute | Attribute | Gets or sets the name of the attribute to disaggregate into time series. The attribute of the feature class should contain a value as the attribute contains the weight of each feature when generating the output time series. |
Fractions | Fractions | Gets or sets the fractions to use when calculating the disaggregation. Each fraction defines the time series, the weight of the time series and the threshold to use when calculating the functional relationship. Threshold: The threshold is used in the functional relationship when calculating accumulation or distributing the values. - Time Series: The path of the time series to use in the fraction. - Weight: The weight of the fraction (between 0 and 100). The sum of all weights in all fractions must be 100. |
Unit | Unit | Gets or sets the unit of the output time series. Only allowed units are available in the list. The allowed units are defined by the variable type. |
Variable | Variable | Gets or sets the variable described by the time series. Each variable will have a set of allowed units, and hence changing the variable can potentially change the list of available units. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = app.Tools.CreateNew("Temporal DisaggregationTool")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.Temporal.ITemporalDisaggregationTool(app.Tools.CreateNew("Temporal DisaggregationTool"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Temporal DisaggregationTool") as DHI.Solutions.GISManager.Tools.Temporal.ITemporalDisaggregationTool;
// Add input items.
tool.InputItems.Add(<A single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.Temporal.TemporalDisaggregationTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.Temporal.dll" />
Temporal Raster To Gif¶
This tool creates a ".gif" file or a series of ".png" files from a temporal raster. The tool is designed to be called from code, and not executed from the Platform Shell. This is because the tool output items are comprised of two .NET image objects, and a .Net class containing geographic extent information.
Tool Info | |
---|---|
Display Name | Temporal Raster To Gif |
API Name | Create Gif from Temporal Raster |
Tools Explorer | /Output Tools/Temporal Raster To Gif |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GifFileExport |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.ITemporalRasterToGifTool |
Input Items | A single raster |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Output | ||
Output Folder | OutputFolder | Gets or sets the path of the folder where the file(s) will be saved on the file system. |
Raster Path | RasterPath | Gets or sets the path of the raster inside the GIS Manager. |
Tool Mode | ToolMode | Gets or sets the tool mode. Choose between saving the raster image itself and a time stamp label. Further, choose between saving as a ".gif" file and a series of ".png" files. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool")
from DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool import *
# Get the tool.
tool = app.Tools.CreateNew("Create Gif from Temporal Raster")
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool")
from DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.ITemporalRasterToGifTool(app.Tools.CreateNew("Create Gif from Temporal Raster"))
# Add input items.
tool.InputItems.Add(<A single raster>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Create Gif from Temporal Raster") as DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.TemporalRasterToGifTool;
// Set the tool properties and execute.
var module = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var raster = module.RasterList.Fetch("/Aladin_4km");
tool.InputItems.Add(raster);
tool.OutputFolder = @"c:\temp";
tool.RasterPath = "/Aladin_4km";
tool.ToolMode = DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.ToolMode.RasterGif;
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.TemporalRasterToGifTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.TemporalRasterToGifTool.dll" />
Temporal Zonal statistics¶
This tool calculates statistics on time varying raster values for polygons, lines or points. The output are time series of the selected statistics for each of the features in the feature class. The time series can be saved similarly to the “To database” tool or returned as in-memory time series
Tool Info | |
---|---|
Display Name | Temporal Zonal statistics |
API Name | Temporal Zonal Statistics Tool |
Tools Explorer | /Temporal Tools/Temporal Zonal statistics |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TemporalRaster |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.Temporal.dll |
API Reference | DHI.Solutions.GISManager.Tools.Temporal.ITemporalZonalStatisticsTool |
Input Items | A single feature class |
Output Items | A time series |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Settings | ||
Attribute | Attribute | Gets or sets the the name of the attribute to identify features in the input feature class and be used when naming time series |
Raster | Raster | Gets or sets the raster to calculate zonal statistics from. |
Output Settings | ||
Associate TS to Features | AssociateTsToFeatures | Gets or sets a value indicating whether to associate TS with features |
Name suffix | NamePostFix | Gets or sets the postfix string to be added to the timeseries name.e.g. TimeseriesA Postfix |
Overwrite option | DuplicateNameOption | Gets or sets the option to be chosen when a timeseres with the same name is already present in the group and if time series will be saved in database |
Save to database | SaveToDatabase | Gets or sets a value indicating whether to save the output to the database. |
Save to group | Group | Gets or sets the group in which to save the timeseries. |
Save with name | TimeseriesName | Gets or sets the name to be added to the timeseries, e.g. MyTs, MyTs (1), MyTs(2) etc |
Unit | TimeseriesUnit | Gets or sets the unit of the output time series. Only allowed units are available in the list. The allowed units are defined by the variable type. |
Value type | TimeSeriesValueType | Gets or sets the time series value type |
Variable | TimeSeriesVariable | Gets or sets the value of time series variable |
Tool Settings | ||
Raster Data Provider | RasterDataProvider | Gets or sets the raster data provider to use. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Statistics | SelectedStatistics | Gets or sets the selected statistics. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *
# Get the tool.
tool = app.Tools.CreateNew("Temporal Zonal Statistics Tool")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.Temporal.ITemporalZonalStatisticsTool(app.Tools.CreateNew("Temporal Zonal Statistics Tool"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Temporal Zonal Statistics Tool") as DHI.Solutions.GISManager.Tools.Temporal.ITemporalZonalStatisticsTool;
// Add input items.
tool.InputItems.Add(<A single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.Temporal.TemporalZonalStatisticsTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.Temporal.dll" />
Thiessen Polygons¶
A tool for calculating Thiessen polygons from a set of points.
Tool Info | |
---|---|
Display Name | Thiessen Polygons |
API Name | Thiessen Polygons |
Tools Explorer | /Geo Processing/Thiessen Polygons |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IThiessenPolygonTool |
Input Items | A single feature class or a single features |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Feature Class Name | ThiessenPolygonsFeatureClassName | Gets or sets name of the new feature class containing the Thiessen Polygons. |
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Thiessen Polygons")
# Add input items.
tool.InputItems.Add(<A single feature class or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IThiessenPolygonTool(app.Tools.CreateNew("Thiessen Polygons"))
# Add input items.
tool.InputItems.Add(<A single feature class or a single features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Thiessen Polygons") as DHI.Solutions.GISManager.Tools.GeoProcessing.ThiessenPolygonTool;
// Set the tool properties and execute.
var gisModule = application.Modules.Get("GIS Manager") as DHI.Solutions.GISManager.Interfaces.IGISModule;
var cities = gisModule.DefaultGISDataProvider.FeatureClassList.Fetch("/Cities");
cities.Query(new DHI.Solutions.Generic.Query());
tool.InputItems.Add(cities);
tool.ThiessenPolygonsFeatureClassName = "ThiessenPolygonsCities";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.ThiessenPolygonTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Time Series to Temporal Raster¶
This tool creates a temporal raster from a set of timeseries and a point feature class. It uses the tool “TimeSeries Step To Feature” and its help should be consulted for more information on the timeseries selection.
Tool Info | |
---|---|
Display Name | Time Series to Temporal Raster |
API Name | Time Series to Temporal Raster |
Tools Explorer | /Temporal Tools/Time Series to Temporal Raster |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TemporalRaster |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.Temporal.dll |
API Reference | DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesToTemporalRasterTool |
Input Items | A single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Feature Class | ||
Add Input TS Association | AddAssociation | Gets or sets a value indicating whether to add an association. Note that the property is only available when: UseAssociation=False |
TS Connection Attribute | TsNameFeatureAttributeName | Gets or sets the value of TS name feature attribute. Note that the property is only available when: UseAssociation=False |
Input Timeseries | ||
Group Name | TSGroupName | Gets or sets the value of TS group name. Note that the property is only available when: UseAssociation=False |
Timeseries mask (as Regular expression) | TSNamePattern | Gets or sets the value of TS name pattern |
Use Timeseries from Feature Association | UseAssociation | Gets or sets a value indicating whether to use association |
OutputRaster | ||
End Time | EndTime | Gets or sets the end time. |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster Coordinate system is not used. Instead, coordinate system for input feature class is used |
Raster Name | RasterName | Gets or sets the rastername. |
Save to group | RasterGroup | Gets or sets the value of raster group |
Start Time | StartTime | Gets or sets the minimum possible start time of the temporal output raster. If timeseries do not have timesteps at this particular date/time, no interpolation is carried out and the raster will start at first available timestep (following StartTime). |
Time Step | TimeStep | Gets or sets the time step. |
Use autoscale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
OutputTimeseries | ||
Time Step Unit | TimeStepUnit | Gets or sets the output Timeseries unit, Second/Minute/Hour/Day/Month/Year |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = app.Tools.CreateNew("Time Series to Temporal Raster")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Time Series to Temporal Raster") as DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesToTemporalRasterTool;
// Add input items.
tool.InputItems.Add(<A single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesToTemporalRasterTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.Temporal.dll" />
TimeSeries Step To Features¶
This tool copies timeseries values to features in a feature class.
Tool Info | |
---|---|
Display Name | TimeSeries Step To Features |
API Name | TimeSeries Step To Features Tool |
Tools Explorer | /Temporal Tools/TimeSeries Step To Features |
NuGet Package | DHI.MikeOperations.GISManager.Tools.TemporalRaster |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.Temporal.dll |
API Reference | DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesStepToFeaturesTool |
Input Items | A single feature class |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Feature Class | ||
AddAssociation | AddAssociation | Gets or sets a value indicating whether the timeseries used will be associate to the corresponding feature in the feature class. Note that the property is only available when: UseAssociation=False |
Target Attribute Name | TargetFeatureAttributeName | Gets or sets the attribute to which the timeseries values will written. If it does not exist, it will be created. If it exists, values will be overwritten. |
TS Connection Attribute | TsNameFeatureAttributeName | Gets or sets the attribute storing the string that will be used to select which timeseries to read the value from. This will be used along with the regular expression. Note that the property is only available when: UseAssociation=False |
Input Timeseries | ||
Group Name | TSGroupName | Gets or sets the value of time series group name group that contains the timeseries to use to populate the feature class attribute table. Note that the property is only available when: UseAssociation=False |
Timeseries mask (as Regular expression) | TSNamePattern | Gets or sets a rtegular expression used to filter timeseries by name. If this is left empty, the tool will assume a one to one match between the names written in the attribute table and the timeseries names. |
TimeStep | TimeStep | Gets or sets the value of time step. Note that the property is only available when: UseLastValue=False |
Use Timeseries from Feature Association | UseAssociation | Gets or sets a value indicating whether timeseries associated to each feature will be considered when applying the mask. If set to false, a timeseries group will need to be defined. |
UseLast | UseLastValue | Gets or sets a value indicating whether the last timestep from of the selected timeseries will be written to the attribute table. If set to False, the timestep to pick will need to be specified. If the timestep does not exist, the value will be Null. |
Tool Settings | ||
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Tool Methods
- ResetAssociation(): Resets associations, so that associated time series and features to update matches the tool properties.
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.Temporal")
from DHI.Solutions.GISManager.Tools.Temporal import *
# Get the tool.
tool = app.Tools.CreateNew("TimeSeries Step To Features Tool")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("TimeSeries Step To Features Tool") as DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesStepToFeaturesTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.AddAssociation = true;
tool.TSNamePattern = @"([\w\s\d\.]*)_rainfall";
tool.TargetFeatureAttributeName = "val1";
tool.TsNameFeatureAttributeName = "tsname";
tool.TimeStep = new DateTime(1961, 8, 24, 5, 0, 0);
tool.UseLastValue = false;
tool.TSGroupName = "/tsdata";
tool.UseAssociation = false;
tool.Execute();
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.Temporal.TimeSeriesStepToFeaturesTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.Temporal.dll" />
To attribute table¶
Tool for adding feature class attributes to an attribute table.
Tool Info | |
---|---|
Display Name | To attribute table |
API Name | To attribute table |
Tools Explorer | /Output Tools/To attribute table |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ToAttributeTable |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.ToAttributeTable.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.ToAttributeTable.ToAttributeTable |
Input Items | One or more feature classes |
Output Items | An attribute table |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool settings | ||
Output table name. | TableOutputName | This is the name of the table that will be created by the tool. Note that the property is only available when: TableDisplayOptions=SpecifiedTableAllowMerge=True |
Table option | TableDisplayOptions | This setting determines whether the input values shall be added to an existing or new table. Note that the property is only available when: AllowMerge=True |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.ToAttributeTable")
from DHI.Solutions.GISManager.UI.Tools.ToAttributeTable import *
clr.AddReference("DHI.Solutions.Generic.UI.Tools.ToTable")
from DHI.Solutions.Generic.UI.Tools.ToTable import *
# Get the tool.
tool = app.Tools.CreateNew("To attribute table")
# Add input items.
tool.InputItems.Add(<One or more feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("To attribute table") as DHI.Solutions.GISManager.UI.Tools.ToAttributeTable.ToAttributeTable;
// Add input items.
tool.InputItems.Add(<One or more feature classes>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.ToAttributeTable.ToAttributeTable"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.ToAttributeTable.dll" />
To database¶
The To Database tool stores an in memory feature class to the database. All GIS tools produces memory objects (feature classes stored in memory). To store these memory objects in the database the “To Database” tool must be used. If query tools have been used to select specific features within a feature class these may be stored in a new feature class using the “To Database” tool.
Tool Info | |
---|---|
Display Name | To database |
API Name | To database |
Tools Explorer | /Output Tools/To database |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ToDatabase |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.ToDatabaseTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.ToDatabaseTool.IToDatabaseTool |
Input Items | One or more feature classes or one or more features |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Duplicate Name Options | DuplicateNameOption | Gets or sets the option to be chosen when a feature with the same name is already present in the group Use this optin in case a feature class with the same name already exists under the same group. Replace the existing feature class, rename the feature class being saved or don't save the feature class. |
Feature Class Group | Group | Gets or sets the group in which to save the feature class. |
Feature Class Name | FeatureClassName | Gets or sets the name of the feature class to be saved Requires DHI.Solutions.GISManager.Tools.ToDatabaseTool.NameOptions.Name |
GIS Data Provider | DataProvider | Gets or sets the DHI.Solutions.GISManager.Interfaces.IGISDataProvider to save the feature class to. |
Name Postfix | NamePostFix | Gets or sets the postfix string to be added to the feature class name. The postfix is added to the name of the feature class when saving. (Only available if naming option is “By Postfix”). |
Naming Option | NameOption | Gets or sets the option to specify the name of the saved feature class. The option defines the name of the saved feature class. If Name is selected, the feature class will be saved with the name provided in the Feature Class Name property. Otherwise, if Postfix is selected, the postfix to add to the input feature class name(s) shall be provided. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ToDatabaseTool")
from DHI.Solutions.GISManager.Tools.ToDatabaseTool import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("To database")
# Add input items.
tool.InputItems.Add(<One or more feature classes or one or more features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ToDatabaseTool")
from DHI.Solutions.GISManager.Tools.ToDatabaseTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.ToDatabaseTool.IToDatabaseTool(app.Tools.CreateNew("To database"))
# Add input items.
tool.InputItems.Add(<One or more feature classes or one or more features>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("To database") as DHI.Solutions.GISManager.Tools.ToDatabaseTool.IToDatabaseTool;
// Add input items.
tool.InputItems.Add(<One or more feature classes or one or more features>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.ToDatabaseTool.ToDatabaseTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.ToDatabaseTool.dll" />
To Database¶
The "To Database" tool stores an in memory feature class to the database. Raster tools produce memory objects (rasters stored in memory). To store these memory objects in the database the "To Database" tool must be used.
Tool Info | |
---|---|
Display Name | To Database |
API Name | Raster To Database |
Tools Explorer | /Output Tools/To Database |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterToDatabase |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.IRasterToDatabaseTool |
Input Items | One or more rasters |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Duplicate Name Options | DuplicateNameOption | Gets or sets the option in case raster with the same name already exists under the same group. Replace the existing raster, rename the raster being saved or don't save the raster. |
Naming Option | NameOption | Gets or sets the option to define the name of the saved raster. If Name is selected, the raster will be saved with the name provided in the Raster Name property. Otherwise, if Postfix is selected, the postfix to add to the input raster name(s) shall be provided. |
Raster Data Provider | RasterDataProvider | Gets or sets the DHI.Solutions.GISManager.Interfaces.IRasterDataProvider to save the raster to |
Raster Group | Group | Gets or sets the group in which to save the raster |
Raster Name Postfix | NamePostFix | Gets or sets the postfix to add to the input raster name(s) when saving. (Only available if naming option is "By Postfix"). Requires DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.NameOptions.PostFix |
Raster Name | RasterName | Gets or sets the name of the raster to be saved. (Only available if naming option is "By Name"). Requires DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.NameOptions.Name |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterToDatabaseTool")
from DHI.Solutions.GISManager.Tools.RasterToDatabaseTool import *
clr.AddReference("DHI.Solutions.Generic.Tools")
from DHI.Solutions.Generic.Tools import *
# Get the tool.
tool = app.Tools.CreateNew("Raster To Database")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterToDatabaseTool")
from DHI.Solutions.GISManager.Tools.RasterToDatabaseTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.IRasterToDatabaseTool(app.Tools.CreateNew("Raster To Database"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster To Database") as DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.IRasterToDatabaseTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.RasterToDatabaseTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterToDatabaseTool.dll" />
To Display (Feature Class)¶
The "To Display" tool adds a feature class to a "New map" or to the "Active map". When running GIS processing tools they always run either "To Display" or "To Table". Note that the current "Action" setting for the "To Display" tool will be used when using "To Display" from other GIS tools.
Tool Info | |
---|---|
Display Name | To Display (Feature Class) |
API Name | To display |
Tools Explorer | /Output Tools/To Display (Feature Class) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.ToDisplay |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.ToDisplayTool.dll |
API Reference | DHI.Solutions.GISManager.Tools.ToDisplayTool.IToDisplayTool |
Input Items | One or more feature classes or one or more meshs |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Action | Action | Gets or sets the action to perform when displaying data in output. "NewDataView" adds the output feature layer to a new map. "ActiveDataView" adds the output feature layer to the active map. |
Output | Output | Gets or sets the the visualizer. Currently always ThinkGeo. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ToDisplayTool")
from DHI.Solutions.GISManager.Tools.ToDisplayTool import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *
# Get the tool.
tool = app.Tools.CreateNew("To display")
# Add input items.
tool.InputItems.Add(<One or more feature classes or one or more meshs>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.ToDisplayTool")
from DHI.Solutions.GISManager.Tools.ToDisplayTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.ToDisplayTool.IToDisplayTool(app.Tools.CreateNew("To display"))
# Add input items.
tool.InputItems.Add(<One or more feature classes or one or more meshs>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("To display") as DHI.Solutions.GISManager.Tools.ToDisplayTool.IToDisplayTool;
// Add input items.
tool.InputItems.Add(<One or more feature classes or one or more meshs>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.ToDisplayTool.ToDisplayTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.ToDisplayTool.dll" />
To Display (Raster)¶
The "To Display (Raster)" tool adds a raster to a "New map" or to the "Active map". When running GIS processing tools they always run "To Display". Note that the current "Action" setting for the "To Display" tool will be used when using "To Display" from other GIS tools.
Tool Info | |
---|---|
Display Name | To Display (Raster) |
API Name | Raster To Display |
Tools Explorer | /Output Tools/To Display (Raster) |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterToDisplay |
Assembly name (.dll) | DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.dll |
API Reference | DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.IRasterToDisplayTool |
Input Items | One or more rasters |
Output Items | No output items |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Action | Action | Gets or sets the action to perform when displaying data in output. "NewDataView" adds the output raster layer to a new map. "ActiveDataView" adds the output raster layer to the active map. |
Output | Output | Gets or sets the visualizer. Currently always ThinkGeo. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool")
from DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool import *
clr.AddReference("DHI.Solutions.Generic")
from DHI.Solutions.Generic import *
# Get the tool.
tool = app.Tools.CreateNew("Raster To Display")
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool")
from DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool import *
# Get the tool.
tool = DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.IRasterToDisplayTool(app.Tools.CreateNew("Raster To Display"))
# Add input items.
tool.InputItems.Add(<One or more rasters>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Raster To Display") as DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.IRasterToDisplayTool;
// Add input items.
tool.InputItems.Add(<One or more rasters>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.RasterToDisplayTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.UI.Tools.RasterToDisplayTool.dll" />
Union Feature Classes¶
The Union Feature Classes tool creates a geometric intersection of the input feature classes. All overlapping and non-overlapping features will be written to the output feature class. Input contains 3 different feature classes. Feature class 1 and feature class 2 both contains attribute “A”. Feature class 3 contains attribute B. The union tool would create 8 new features holding attributes.
Tool Info | |
---|---|
Display Name | Union Feature Classes |
API Name | Union Feature Classes |
Tools Explorer | /Geo Processing/Union Feature Classes |
NuGet Package | DHI.MikeOperations.GISManager.Tools.GeoProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.GeoProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.GeoProcessing.IUnionTool |
Input Items | Two feature classes |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
GIS Processor | GISProcessor | The GIS Processor to use when executing the tool. GIS Processor is the default processor. Other processors can be added and used by the tool. |
Name of union feature class | UnionFeatureClassName | Gets or sets the Name of new Union Feature Class. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Union Feature Classes")
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.GeoProcessing")
from DHI.Solutions.GISManager.Tools.GeoProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.GeoProcessing.IUnionTool(app.Tools.CreateNew("Union Feature Classes"))
# Add input items.
tool.InputItems.Add(<Two feature classes>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Union Feature Classes") as DHI.Solutions.GISManager.Tools.GeoProcessing.UnionTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass1);
tool.InputItems.Add(featureClass2);
tool.UnionFeatureClassName = "UnionFeatureClassName";
tool.Execute();
// Get the output of the tool.
var outputFeatureClass = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IFeatureClass;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.GeoProcessing.UnionTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.GeoProcessing.dll" />
Vector to Raster¶
Tool for converting a feature class to a raster using attribute values for each of the features in the feature class to fill in the raster.
Tool Info | |
---|---|
Display Name | Vector to Raster |
API Name | Vector to Raster |
Tools Explorer | /Raster Processing/Vector to Raster |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IVectorToRasterTool |
Input Items | A single features or a single feature class |
Output Items | A raster |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Tool Settings | ||
Attribute | Attribute | Gets or sets the attribute to get values for the geometries to fill in the raster |
Auto-Scale | AutoScale | Gets or sets a value indicating whether the tool should automatically calculate scale when changing height and width, or height and width when changing scale. When AutoScale is true, the tool will keep the overall extent of the output raster the same as the input feature class within the precision of the scale factor in each dimension. |
Missing Value | MissingValue | Gets or sets the value to use when data is missing. |
Raster Definition | RasterDefinition | Gets or sets the definition for the output raster. Coordinate system is not used.Instead, coordinate system for input feature class is used |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Vector to Raster")
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IVectorToRasterTool(app.Tools.CreateNew("Vector to Raster"))
# Add input items.
tool.InputItems.Add(<A single features or a single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool
var tool = application.Tools.CreateNew("Vector to Raster") as DHI.Solutions.GISManager.Tools.RasterProcessing.VectorToRasterTool;
// Set the tool properties and execute.
tool.InputItems.Add(featureClass);
tool.AutoScale = true;
tool.RasterDefinition.Width = 10;
tool.Execute();
// Get the output of the tool.
var outputRaster = tool.OutputItems[0] as DHI.Solutions.GISManager.Interfaces.IRaster;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.VectorToRasterTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />
Zonal statistic¶
Tool for calculating statistics on raster values for polygons, lines or points. The tool will create feature attributes for each selected statistics.
Tool Info | |
---|---|
Display Name | Zonal statistic |
API Name | Zonal Statistics |
Tools Explorer | /Raster Processing/Zonal statistic |
NuGet Package | DHI.MikeOperations.GISManager.Tools.RasterProcessing |
Assembly name (.dll) | DHI.Solutions.GISManager.Tools.RasterProcessing.dll |
API Reference | DHI.Solutions.GISManager.Tools.RasterProcessing.IZonalStatisticsTool |
Input Items | A single feature class |
Output Items | A feature class |
Tool Properties
Display Name | API Name | Description |
---|---|---|
Input Settings | ||
Raster Band | RasterBand | Gets or sets the index of the raster band in the raster to get values from |
Raster | Raster | Gets or sets the raster to calculate zonal statistics. |
Tool Settings | ||
Raster Data Provider | RasterDataProvider | Gets or sets the raster data provider to use. |
Raster Processor | RasterProcessor | The raster processor to use when executing the tool. PostGIS Raster Processor is the default processor. Other processors can be added and used by the tool. |
Statistics | SelectedStatistics | Gets or sets the selected statistics (Avarage, Maximum, Minimum, NrMissingValues, StDev, Sum). |
Code Sample
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = app.Tools.CreateNew("Zonal Statistics")
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
import clr
clr.AddReference("DHI.Solutions.GISManager.Tools.RasterProcessing")
from DHI.Solutions.GISManager.Tools.RasterProcessing import *
# Get the tool.
tool = DHI.Solutions.GISManager.Tools.RasterProcessing.IZonalStatisticsTool(app.Tools.CreateNew("Zonal Statistics"))
# Add input items.
tool.InputItems.Add(<A single feature class>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems
// Get the tool.
var tool = application.Tools.CreateNew("Zonal Statistics") as DHI.Solutions.GISManager.Tools.RasterProcessing.IZonalStatisticsTool;
// Add input items.
tool.InputItems.Add(<A single feature class>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;
Runtime.config
What tools to load during application startup, is specified in the XML file Runtime.config
in the plugins section of the manager.
The XML below shows the tool plugin information found in the Runtime.config
file.
<Plugin
Name="DHI.Solutions.GISManager.Tools.RasterProcessing.ZonalStatisticsTool"
Type="DHI.Solutions.Generic.ITool"
Assembly="DHI.Solutions.GISManager.Tools.RasterProcessing.dll" />