ITableGeoPathReader

Description

interface Tinman.Engine.Scenes.Data.ITableGeoPathReader → <TSample ^val>

Derived from: ITableGeoPathReaderBase
IGeoPathReader<TSample>
Extended by: TableGeoPathReader ^abstract

Base interface for geo path readers that consume tabular data.

The header row in the data table defines the column names, which may be used for the mapping from table columns to geo path values. Each subsequent row represents a geo path sample.

Public / Methods

Default

public method Default → (2)

index ⁱⁿ : int32: [0..ITableGeoPathReaderBase.Values-1]
The geo path sample value index.
value ⁱⁿ : float64: The default value to use.
returns → ITableGeoPathReader<TSample>: this

Specifies the default value for the given geo path sample value.

Default values are used if a geo path sample value is not mapped.

Initially, all default values are zero.

Mapping

_2 overloads

public method Mapping¹ → (2)

index ⁱⁿ : int32: [0..ITableGeoPathReaderBase.Values-1]
The geo path sample index.
column ⁱⁿ : int32: [-1..ITableGeoPathReaderBase.Columns-1]
The column index in the data table.
returns → ITableGeoPathReader<TSample>: this

Specifies the data table column mapping for the given geo path sample value index ⁱⁿ.

Initially, all geo path sample values are mapped to -1.

public method Mapping² → (2)

value ⁱⁿ : GeoPathValue: The geo path sample value.
column ⁱⁿ : string: The column name in the data table.
returns → ITableGeoPathReader<TSample>: this

Specifies the data table column mapping for the given geo path sample value ⁱⁿ.

Initially, all geo path sample values are unmapped. If value ⁱⁿ or column ⁱⁿ is invalid, this method will return silently, without setting the.

See also: IGeoPathReaderBase.IndexOfValue
ITableGeoPathReaderBase.IndexOfColumn

Transform

public method Transform → (3)

index ⁱⁿ : int32: [0..ITableGeoPathReaderBase.Values-1]
The geo path sample value index.
offset ^opt : float64 = 0: The offset coefficient (see remarks).
scale ^opt : float64 = 1: The scale coefficient (see remarks).
returns → ITableGeoPathReader<TSample>: this

Specifies a linear transformation for the values that are read from the data table.

The linear transformation is defined as follows:

output = input * scale + offset

where input is the value that has been read from the data table (according to Mapping¹) and output is the value that will be present in the geo path sample returned by IGeoPathReader.ReadSample.