CorrelationBaseTrimCorrelationT Method

Creates a windowed view into the correlation. This does not create a copy of the input correlation.

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4

Syntax

protected virtual T TrimCorrelation<T>(
	T z,
	CorrelationBaseWindowing opt
)
where T : Object, ISliceable<T>

Protected Overridable Function TrimCorrelation(Of T As {Object, ISliceable(Of T)}) ( 
	z As T,
	opt As CorrelationBaseWindowing
) As T

protected:
generic<typename T>
where T : Object, ISliceable<T>
virtual T TrimCorrelation(
	T z, 
	CorrelationBaseWindowing opt
)

abstract TrimCorrelation : 
        z : 'T * 
        opt : CorrelationBaseWindowing -> 'T  when 'T : Object and ISliceable<'T>
override TrimCorrelation : 
        z : 'T * 
        opt : CorrelationBaseWindowing -> 'T  when 'T : Object and ISliceable<'T>

Parameters

z T: A correlation result.
opt CorrelationBaseWindowing: Boundary windowing option.

Type Parameters

T: [Missing <typeparam name="T"/> documentation for "M:CenterSpace.NMath.Core.CorrelationBase.TrimCorrelation``1(``0,CenterSpace.NMath.Core.CorrelationBase.Windowing)"]

Return Value

Reference

CorrelationBase Class

CenterSpace.NMath.Core Namespace