Class RasterLayer

Represents a generic raster implementation which provides functionality to explore for nearest cells and saved objects, to pass a "metadata.csv" with a file-mapping to enable a time-series dimension and a concurrency control to be used by multiple concurrent threads.
Inheritance
System.Object
DisposeBase
DataSet
BoundDataSet
Raster<System.Double>
Raster
MatrixRaster
RasterLayer
RasterModelLayer
Inherited Members
Namespace: Mars.Components.Layers
Assembly: Mars.Components.dll
Syntax
public abstract class RasterLayer : MatrixRaster, IRasterLayer, IDataLayer, IRaster, IRaster<double>, IBoundedDataLayer, IDataSet, IDisposable, IChangingLayer, ILayer, IModelObject

Fields

Context

Declaration
protected ISimulationContext Context
Field Value
Type Description
ISimulationContext

CurrentDir

Declaration
protected string CurrentDir
Field Value
Type Description
System.String

HasTs

Declaration
protected bool HasTs
Field Value
Type Description
System.Boolean

Properties

LookupTree

Gets the underlying Kd-tree index to perform knn queries
Declaration
protected K2DTree<double> LookupTree { get; }
Property Value
Type Description
K2DTree<System.Double>
Remarks
This index is created when it is accessed the first time

Methods

Explore(Position, Double, Int32, Func<Double, Boolean>)

Executes a point query at the specified position to get all features inside radius, filtered by an optional predicate and limited
Declaration
public ICollection<NodeDistance<K2dTreeNode<double>>> Explore(Position position, double radius = null, int count = null, Func<double, bool> predicate = null)
Parameters
Type Name Description
Position position The outgoing position from which to start the query.
System.Double radius The exploration radius.
System.Int32 count The limit of queried features
Func<System.Double, System.Boolean> predicate The optional predicate to filter out specific features
Returns
Type Description
ICollection<NodeDistance<K2dTreeNode<System.Double>>> A collection with distance based order of the explored features.

GetCurrentTick()

Declaration
public override long GetCurrentTick()
Returns
Type Description
System.Int64
Overrides

GetNeighbourCellWithMaxValue(Position)

Declaration
public Position GetNeighbourCellWithMaxValue(Position coordinate)
Parameters
Type Name Description
Position coordinate
Returns
Type Description
Position

GetValue(Position)

Declaration
public double GetValue(Position coordinate)
Parameters
Type Name Description
Position coordinate
Returns
Type Description
System.Double

GetValueByGeoPosition(Position)

Declaration
public double GetValueByGeoPosition(Position coordinate)
Parameters
Type Name Description
Position coordinate
Returns
Type Description
System.Double

GetValueByGridPosition(Position)

Declaration
public double GetValueByGridPosition(Position coordinate)
Parameters
Type Name Description
Position coordinate
Returns
Type Description
System.Double

InitLayer(LayerInitData, RegisterAgent, UnregisterAgent)

Declaration
public override bool InitLayer(LayerInitData layerInitData, RegisterAgent registerAgentHandle, UnregisterAgent unregisterAgentHandle)
Parameters
Type Name Description
LayerInitData layerInitData
RegisterAgent registerAgentHandle
UnregisterAgent unregisterAgentHandle
Returns
Type Description
System.Boolean
Overrides

ParseData(String)

Declaration
protected void ParseData(string file)
Parameters
Type Name Description
System.String file

PrettyPrintMetadata()

Prints the metadata of this raster in a well readable format.
Declaration
public string PrettyPrintMetadata()
Returns
Type Description
System.String The metadata description of this raster

SerializeValueCells()

Declaration
public IEnumerable<string> SerializeValueCells()
Returns
Type Description
IEnumerable<System.String>

SetCurrentTick(Int64)

Declaration
public override void SetCurrentTick(long currentTick)
Parameters
Type Name Description
System.Int64 currentTick
Overrides

Implements

IDisposable