DataFrame.Resample Method

Definition

Namespace: Numerics.NET.DataAnalysis
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.3

Overload List

Resample<C>(DataFrame<DateTime, C>, Recurrence, IDictionary<C, AggregatorGroup>, Direction)	Resamples the rows of the data frame according to the specified recurrence.
Resample<C>(DataFrame<DateTime, C>, Recurrence, IList<AggregatorGroup>, Direction)	Resamples the rows of the data frame according to the specified recurrence.
Resample<C, C1>(DataFrame<DateTime, C>, Recurrence, IEnumerable<ValueTuple<C, AggregatorGroup>>, Index<C1>, Direction)	Resamples the rows of the data frame according to the specified recurrence.

Resample<C>(DataFrame<DateTime, C>, Recurrence, IDictionary<C, AggregatorGroup>, Direction)

Resamples the rows of the data frame according to the specified recurrence.

public static DataFrame<DateTime, C> Resample<C>(
	this DataFrame<DateTime, C> frame,
	Recurrence recurrence,
	IDictionary<C, AggregatorGroup> aggregators,
	Direction direction = Direction.Backward
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Resample(Of C) ( 
	frame As DataFrame(Of DateTime, C),
	recurrence As Recurrence,
	aggregators As IDictionary(Of C, AggregatorGroup),
	Optional direction As Direction = Direction.Backward
) As DataFrame(Of DateTime, C)

C++/CLI

public:
[ExtensionAttribute]
generic<typename C>
static DataFrame<DateTime, C>^ Resample(
	DataFrame<DateTime, C>^ frame, 
	Recurrence^ recurrence, 
	IDictionary<C, AggregatorGroup^>^ aggregators, 
	Direction direction = Direction::Backward
)

[<ExtensionAttribute>]
static member Resample : 
        frame : DataFrame<DateTime, 'C> * 
        recurrence : Recurrence * 
        aggregators : IDictionary<'C, AggregatorGroup> * 
        ?direction : Direction 
(* Defaults:
        let _direction = defaultArg direction Direction.Backward
*)
-> DataFrame<DateTime, 'C>

Parameters

frame DataFrame<DateTime, C>: A data frame.
recurrence Recurrence: The recurrence pattern to resample to.
aggregators IDictionary<C, AggregatorGroup>: A dictionary that maps column keys to aggregators.
direction Direction (Optional): Indicates whether the entries in frame's row index should be taken as the start (Forward) or end (Backward) of a sampling interval.

Type Parameters

C

Return Value

DataFrame<DateTime, C>
A new data frame with a column for each entry in aggregators which is the result of resampling the column with the entry's key using the specified recurrence pattern and the aggregator in the entry's value. The order of the columns is preserved.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type DataFrame<DateTime, C>. 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).

Exceptions

ArgumentNullException

frame is null.

-or-

recurrence is null.

-or-

aggregators is null.

Resample<C>(DataFrame<DateTime, C>, Recurrence, IList<AggregatorGroup>, Direction)

Resamples the rows of the data frame according to the specified recurrence.

public static DataFrame<DateTime, C> Resample<C>(
	this DataFrame<DateTime, C> frame,
	Recurrence recurrence,
	IList<AggregatorGroup> aggregators,
	Direction direction = Direction.Backward
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Resample(Of C) ( 
	frame As DataFrame(Of DateTime, C),
	recurrence As Recurrence,
	aggregators As IList(Of AggregatorGroup),
	Optional direction As Direction = Direction.Backward
) As DataFrame(Of DateTime, C)

C++/CLI

public:
[ExtensionAttribute]
generic<typename C>
static DataFrame<DateTime, C>^ Resample(
	DataFrame<DateTime, C>^ frame, 
	Recurrence^ recurrence, 
	IList<AggregatorGroup^>^ aggregators, 
	Direction direction = Direction::Backward
)

[<ExtensionAttribute>]
static member Resample : 
        frame : DataFrame<DateTime, 'C> * 
        recurrence : Recurrence * 
        aggregators : IList<AggregatorGroup> * 
        ?direction : Direction 
(* Defaults:
        let _direction = defaultArg direction Direction.Backward
*)
-> DataFrame<DateTime, 'C>

Parameters

frame DataFrame<DateTime, C>: A data frame.
recurrence Recurrence: The recurrence pattern to resample to.
aggregators IList<AggregatorGroup>: A list of aggregators.
direction Direction (Optional): Indicates whether the entries in frame's row index should be taken as the start (Forward) or end (Backward) of a sampling interval.

Type Parameters

C

Return Value

DataFrame<DateTime, C>
A new data frame which is the result of resampling each column with the corresponding aggregator in aggregators.

Usage Note

Exceptions

ArgumentNullException

frame is null.

-or-

recurrence is null.

-or-

aggregators is null.

DimensionMismatchException

The length of aggregators does not equal the number of columns in frame.

Resample<C, C1>(DataFrame<DateTime, C>, Recurrence, IEnumerable<ValueTuple<C, AggregatorGroup>>, Index<C1>, Direction)

Resamples the rows of the data frame according to the specified recurrence.

public static DataFrame<DateTime, C1> Resample<C, C1>(
	this DataFrame<DateTime, C> frame,
	Recurrence recurrence,
	IEnumerable<(C , AggregatorGroup )> aggregators,
	Index<C1> newIndex,
	Direction direction = Direction.Backward
)

Visual Basic

<ExtensionAttribute>
Public Shared Function Resample(Of C, C1) ( 
	frame As DataFrame(Of DateTime, C),
	recurrence As Recurrence,
	aggregators As IEnumerable(Of ( As C,  As AggregatorGroup)),
	newIndex As Index(Of C1),
	Optional direction As Direction = Direction.Backward
) As DataFrame(Of DateTime, C1)

C++/CLI

public:
[ExtensionAttribute]
generic<typename C, typename C1>
static DataFrame<DateTime, C1>^ Resample(
	DataFrame<DateTime, C>^ frame, 
	Recurrence^ recurrence, 
	IEnumerable<ValueTuple<C, AggregatorGroup^>>^ aggregators, 
	Index<C1>^ newIndex, 
	Direction direction = Direction::Backward
)

[<ExtensionAttribute>]
static member Resample : 
        frame : DataFrame<DateTime, 'C> * 
        recurrence : Recurrence * 
        aggregators : IEnumerable<ValueTuple<'C, AggregatorGroup>> * 
        newIndex : Index<'C1> * 
        ?direction : Direction 
(* Defaults:
        let _direction = defaultArg direction Direction.Backward
*)
-> DataFrame<DateTime, 'C1>

Parameters

frame DataFrame<DateTime, C>: A data frame.
recurrence Recurrence: The recurrence pattern to resample to.
aggregators IEnumerable<ValueTuple<C, AggregatorGroup>>: A sequence of tuples of column keys and aggregators.
newIndex Index<C1>: The column index of the new data frame.
direction Direction (Optional): Indicates whether the entries in frame's row index should be taken as the start (Forward) or end (Backward) of a sampling interval.

Type Parameters

C
C1

Return Value

DataFrame<DateTime, C1>
A new data frame with a column for each key-aggregator tuple in aggregators which is the result of resampling the column with the key using the specified recurrence pattern and the aggregator.

Usage Note

Exceptions

ArgumentNullException

frame is null.

-or-

recurrence is null.

-or-

aggregators is null.

DataFrame.Resample Method

Definition

Overload List

Resample<C>(DataFrame<DateTime, C>, Recurrence, IDictionary<C, AggregatorGroup>, Direction)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

Resample<C>(DataFrame<DateTime, C>, Recurrence, IList<AggregatorGroup>, Direction)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

Resample<C, C1>(DataFrame<DateTime, C>, Recurrence, IEnumerable<ValueTuple<C, AggregatorGroup>>, Index<C1>, Direction)

Parameters

Type Parameters

Return Value

Usage Note

Exceptions

See Also

Reference