 | SeriesModulesampleTimeAta, b Method |
Performs sampling by time and returns chunks obtained by time-sampling as a nested
series. The operation generates keys starting at the given `start` time, using the
specified `interval` and then obtains chunks based on these
keys in a fashion similar to the `Series.resample` function.
## Parameters
- `series` - An input series to be resampled
- `start` - The initial time to be used for sampling
- `interval` - The interval between the individual samples
- `dir` - If this parameter is `Direction.Forward`, then each key is
used as the smallest key in a chunk; for `Direction.Backward`, the keys are
used as the greatest keys in a chunk.
## Remarks
This operation is only supported on ordered series. The method throws
`InvalidOperationException` when the series is not ordered.
[category:Sampling, resampling and advanced lookup]
Namespace: Deedle
Assembly: Deedle (in Deedle.dll) Version: 1.2
SyntaxC#
public static Series<a, Series<a, b>> sampleTimeAt<a, b>( a start, TimeSpan interval, Direction dir, Series<a, b> series )
Parameters
- start
- Type: a
[Missing <param name="start"/> documentation for "M:Deedle.SeriesModule.sampleTimeAt``2(``0,System.TimeSpan,Deedle.Direction,Deedle.Series{``0,``1})"]
- interval
- Type: SystemTimeSpan
[Missing <param name="interval"/> documentation for "M:Deedle.SeriesModule.sampleTimeAt``2(``0,System.TimeSpan,Deedle.Direction,Deedle.Series{``0,``1})"]
- dir
- Type: DeedleDirection
[Missing <param name="dir"/> documentation for "M:Deedle.SeriesModule.sampleTimeAt``2(``0,System.TimeSpan,Deedle.Direction,Deedle.Series{``0,``1})"]
- series
- Type: DeedleSeriesa, b
[Missing <param name="series"/> documentation for "M:Deedle.SeriesModule.sampleTimeAt``2(``0,System.TimeSpan,Deedle.Direction,Deedle.Series{``0,``1})"]
Type Parameters
- a
- b
Return Value
Type: Seriesa, Seriesa, b[Missing <returns> documentation for "M:Deedle.SeriesModule.sampleTimeAt``2(``0,System.TimeSpan,Deedle.Direction,Deedle.Series{``0,``1})"]
See Also