Class WeatherGridDatasetData

Namespace

EncDotNet.S100.Datasets.Pipelines.Catalog

Assembly

EncDotNet.S100.Datasets.Pipelines.dll

The catalog payload of a weather grid dataset (NetCDF-CF or GRIB2): a ProductDatasetData that describes itself and samples its grid, so sample_coverage and sample_coverage_along answer with wave heights and winds and their units with no MCP change (design note weather-sources.md §8.8).

public sealed record WeatherGridDatasetData : ProductDatasetData, IEquatable<LoadedDatasetData>, IEquatable<ProductDatasetData>, ICoverageSampler, ITimeSteppedDatasetData, IEquatable<WeatherGridDatasetData>

Inheritance

object

LoadedDatasetData

ProductDatasetData

WeatherGridDatasetData

Implements

IEquatable<LoadedDatasetData>

IEquatable<ProductDatasetData>

ICoverageSampler

ITimeSteppedDatasetData

IEquatable<WeatherGridDatasetData>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

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

CoverageSamplerExtensions.SampleAt(ICoverageSampler, CoverageSampleQuery, DateTimeOffset?, bool)

CoverageSamplerExtensions.SampleWindow(ICoverageSampler, CoverageSampleQuery, CoverageTimeWindow)

Remarks

The payload holds the open grid set, whose time steps are read from the file when sampled. A payload opened from a stream (OpenData) keeps an in-memory copy of the file's bytes for that; one projected from a processor (ILoadedDatasetProjection) shares the processor's file.

Constructors

WeatherGridDatasetData(WeatherGridSet, DatasetMetadata, DateTime?)

Creates the payload.

public WeatherGridDatasetData(WeatherGridSet gridSet, DatasetMetadata metadata, DateTime? referenceTime)

Parameters

gridSet WeatherGridSet

The grid set.

metadata DatasetMetadata

The dataset's spec, extent and time coverage.

referenceTime DateTime?

The model run's reference time, or null.

Properties

GridSet

The grid set.

public WeatherGridSet GridSet { get; }

Property Value

WeatherGridSet

Metadata

The dataset's declared spec, extent and time coverage.

public override DatasetMetadata Metadata { get; }

Property Value

DatasetMetadata

TimeSteps

The dataset's time steps (UTC), in ascending order; empty when it has none.

public IReadOnlyList<DateTime> TimeSteps { get; }

Property Value

IReadOnlyList<DateTime>

Remarks

The valid times of the grid set's steps, the steps the processor draws.

Methods

FindSites(CoverageSampleQuery)

Finds the places in this dataset that can answer a sample at the query's point: the grid node nearest to it, or every station of a station-series dataset (the nearest across datasets is chosen later).

public CoverageSiteSearch FindSites(CoverageSampleQuery query)

Parameters

query CoverageSampleQuery

The point to sample, with the transforms that reproject it into the dataset's CRS.

Returns

CoverageSiteSearch

The sites, or an empty search when the dataset does not cover the point. Implementations may throw ObjectDisposedException when the dataset was closed during the call.

Remarks

Every known parameter at the grid node nearest the point, at the step nearest the time, as a CoverageFieldsSample: wave height in m, wind speed in m/s and kn, directions in deg ("from"), periods in s.