| SeriesExtensionsSampleV Method (SeriesDateTimeOffset, V, TimeSpan, Direction) |
Finds values at, or near, the specified times in a given series. The operation generates
keys starting from the smallest key of the original series, using the specified `interval`
and then finds nearest smaller values close to such keys according to `dir`.
## Parameters
- `series` - An input series to be resampled
- `interval` - The interval between the individual samples
- `dir` - Specifies how the keys should be generated. `Direction.Forward` means that the
key is the smallest value of each chunk (and so first key of the series is returned and
the last is not, unless it matches exactly _start + k*interval_); `Direction.Backward`
means that the first key is skipped and sample is generated at, or just before the end
of interval and at the end of the series.
## Remarks
This operation is only supported on ordered series. The method throws
`InvalidOperationException` when the series is not ordered.
[category:Lookup, resampling and scaling]
Namespace:
Deedle
Assembly:
Deedle (in Deedle.dll) Version: 1.2
Syntax public static Series<DateTimeOffset, V> Sample<V>(
this Series<DateTimeOffset, V> series,
TimeSpan interval,
Direction dir
)
Parameters
- series
- Type: DeedleSeriesDateTimeOffset, V
[Missing <param name="series"/> documentation for "M:Deedle.SeriesExtensions.Sample``1(Deedle.Series{System.DateTimeOffset,``0},System.TimeSpan,Deedle.Direction)"]
- interval
- Type: SystemTimeSpan
[Missing <param name="interval"/> documentation for "M:Deedle.SeriesExtensions.Sample``1(Deedle.Series{System.DateTimeOffset,``0},System.TimeSpan,Deedle.Direction)"]
- dir
- Type: DeedleDirection
[Missing <param name="dir"/> documentation for "M:Deedle.SeriesExtensions.Sample``1(Deedle.Series{System.DateTimeOffset,``0},System.TimeSpan,Deedle.Direction)"]
Type Parameters
- V
Return Value
Type:
SeriesDateTimeOffset,
V[Missing <returns> documentation for "M:Deedle.SeriesExtensions.Sample``1(Deedle.Series{System.DateTimeOffset,``0},System.TimeSpan,Deedle.Direction)"]
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type
SeriesDateTimeOffset,
V. When you use instance method syntax to call this method, omit the first parameter. For more information, see
Extension Methods (Visual Basic) or
Extension Methods (C# Programming Guide).
See Also