RiverMapper Class

Class that sets up the mapping between (x,y) points (coordinates) and the river coordinate system, and sets up interpolation of values in the river coordinate system.

It sets up a number of FloodMapHSpan in NetworkHSpans, and a number of MapBoxes in MapBoxSearch.

Definition

Namespace: DHI.Mike1D.FloodMap
Assembly: DHI.Mike1D.FloodMap (in DHI.Mike1D.FloodMap.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class RiverMapper
Inheritance
Object    RiverMapper

Constructors

RiverMapper Default constructor, create a default CrossLineCreator
RiverMapper(CrossLineCreator) Constructor providing a configured CrossLineCreator

Properties

CoorFormat Formatting of coordinates when using WriteMapBoxesToFile(FilePath).
CrossLineCreator Class used for creating cross lines, cross lines are required for making map boxes.
CrossLineLocations Where to add cross lines.

Default is DigiPoints.

The CrossSections is not applicable when producing flood maps and will throw an error.

Used by the CrossLineCreator

DigiPointMinDistance Minimum distance between digipoints. The digipoints are filtered out until the distance is at least this distance.

Also used as a tolerance on when a cross section and a digi-point is merged into one location.

A sound value is a fraction of the width of the smallest cross section.

Default is 5 meters.

DirectionVectorType Specify how to calculate the direction unit vector based on the digipoints.

Default is Weighted

Used by the CrossLineCreator

DirectionVectorWidthFactor When direction vector is weighted, it is by default weighted over the maximum width of the cross section. This factor is multiplied on the maximum width to increase or decrease the weighting distance.

Default value is 1.

Used by the CrossLineCreator

ExtentsToCover Extents of areas to create flood maps for. This will limit the areas where flood mapping is set up.

Set to null to include the entire network.

FloodMapCrossSectionAdapterHub Hub for extracting cross sections
MapBoxSearch MapBox search tree, build up by the SetupMapBoxes
NetworkHSpans List of all H spans in a network.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
SetupMapBoxes Set up mapping boxes for the entire network.
SetupMapBoxesReach(IListINetworkReach, Int32, ListMapBox) Setup MapBox'es for the entire reach.
SetupMapBoxesReach(ListCrossLineData, INetworkReach, ListMapBox) Setup MapBox'es for the entire reach, using the provided crossLines
ToStringReturns a string that represents the current object.
(Inherited from Object)
WriteMapBoxesToFile Writes mapping box coordinates to a file, in a format that can be used by gnuplot.
WriteMapBoxToFile Writes a single mapBox to writer

See Also