Class CoverageSamplerExtensions

Namespace

EncDotNet.S100.Datasets.Pipelines.Query

Assembly

EncDotNet.S100.Core.dll

Sampling of a single ICoverageSampler: at a point and time, over a time window, and along a polyline. Each is CoverageSampling with one dataset.

public static class CoverageSamplerExtensions

Inheritance

object

CoverageSamplerExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

SampleAlong(ICoverageSampler, IEnumerable<(double Latitude, double Longitude)>, ICrsTransformFactory, DateTimeOffset?, bool)

Samples at each vertex of a polyline; see SampleAlong<TSource>(IReadOnlyList<CoverageSamplerEntry<TSource>>, IEnumerable<(double Latitude, double Longitude)>, ICrsTransformFactory, DateTimeOffset?, bool).

public static IReadOnlyList<CoverageSampleOutcome<ICoverageSampler>> SampleAlong(this ICoverageSampler sampler, IEnumerable<(double Latitude, double Longitude)> vertices, ICrsTransformFactory transforms, DateTimeOffset? time = null, bool nearestWhenOutOfRange = false)

Parameters

sampler ICoverageSampler

The dataset's sampler.

vertices IEnumerable<(double Latitude, double Longitude)>

The polyline's vertices (decimal degrees, WGS-84).

transforms ICrsTransformFactory

Reprojects each vertex into the dataset's native CRS.

time DateTimeOffset?

The requested time, applied to every vertex; null for the first step.

nearestWhenOutOfRange bool

Read the nearest step, rather than fail, when the time is outside the dataset's range.

Returns

IReadOnlyList<CoverageSampleOutcome<ICoverageSampler>>

SampleAt(ICoverageSampler, CoverageSampleQuery, DateTimeOffset?, bool)

Samples at a point and time; see SampleAt<TSource>(IReadOnlyList<CoverageSamplerEntry<TSource>>, CoverageSampleQuery, DateTimeOffset?, bool).

public static CoverageSampleOutcome<ICoverageSampler> SampleAt(this ICoverageSampler sampler, CoverageSampleQuery query, DateTimeOffset? time = null, bool nearestWhenOutOfRange = false)

Parameters

sampler ICoverageSampler

The dataset's sampler.

query CoverageSampleQuery

The point.

time DateTimeOffset?

The requested time, or null for the first step.

nearestWhenOutOfRange bool

Read the nearest step, rather than fail, when the time is outside the dataset's range.

Returns

CoverageSampleOutcome<ICoverageSampler>

SampleWindow(ICoverageSampler, CoverageSampleQuery, CoverageTimeWindow)

Samples over a range or series window; see SampleWindow<TSource>(IReadOnlyList<CoverageSamplerEntry<TSource>>, CoverageSampleQuery, CoverageTimeWindow).

public static CoverageSampleOutcome<ICoverageSampler> SampleWindow(this ICoverageSampler sampler, CoverageSampleQuery query, CoverageTimeWindow window)

Parameters

sampler ICoverageSampler

The dataset's sampler.

query CoverageSampleQuery

The point.

window CoverageTimeWindow

The window.

Returns

CoverageSampleOutcome<ICoverageSampler>