Class Norm

Namespace

Bonsai.Dsp

Assembly

Bonsai.Dsp.dll

Represents an operator that calculates the absolute array norm, absolute difference norm, or relative difference norm for each array in the sequence.

[Combinator]
[WorkflowElementCategory(ElementCategory.Transform)]
public class Norm

Inheritance

object

Norm

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

NormType

Gets or sets the type of array norm to calculate.

public NormTypes NormType { get; set; }

Property Value

NormTypes

Methods

Process(IObservable<Point2d>)

Calculates the absolute norm for each 2D point in an observable sequence.

public IObservable<double> Process(IObservable<Point2d> source)

Parameters

source IObservable<Point2d>

A sequence of 2D points with double-precision floating-point coordinates for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each point in the source sequence.

Process(IObservable<Point2f>)

Calculates the absolute norm for each 2D point in an observable sequence.

public IObservable<double> Process(IObservable<Point2f> source)

Parameters

source IObservable<Point2f>

A sequence of 2D points with single-precision floating-point coordinates for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each point in the source sequence.

Process(IObservable<Point3d>)

Calculates the absolute norm for each 3D point in an observable sequence.

public IObservable<double> Process(IObservable<Point3d> source)

Parameters

source IObservable<Point3d>

A sequence of 3D points with double-precision floating-point coordinates for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each point in the source sequence.

Process(IObservable<Point3f>)

Calculates the absolute norm for each 3D point in an observable sequence.

public IObservable<double> Process(IObservable<Point3f> source)

Parameters

source IObservable<Point3f>

A sequence of 3D points with single-precision floating-point coordinates for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each point in the source sequence.

Process(IObservable<Point>)

Calculates the absolute norm for each 2D point in an observable sequence.

public IObservable<double> Process(IObservable<Point> source)

Parameters

source IObservable<Point>

A sequence of 2D points with integer coordinates for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each point in the source sequence.

Process<TArray>(IObservable<TArray>)

Calculates the absolute array norm for each array in an observable sequence.

public IObservable<double> Process<TArray>(IObservable<TArray> source) where TArray : Arr

Parameters

source IObservable<TArray>

A sequence of multi-dimensional arrays for which to calculate the norm.

Returns

IObservable<double>

A sequence containing the absolute norm for each array in the source sequence.

Type Parameters

TArray

The type of the array-like objects in the source sequence.

Process<TArray1, TArray2>(IObservable<Tuple<TArray1, TArray2>>)

Calculates the absolute difference norm, or relative difference norm, between each pair of arrays in an observable sequence.

public IObservable<double> Process<TArray1, TArray2>(IObservable<Tuple<TArray1, TArray2>> source) where TArray1 : Arr where TArray2 : Arr

Parameters

source IObservable<Tuple<TArray1, TArray2>>

A sequence of pairs of multi-dimensional arrays for which to calculate the absolute difference norm or relative difference norm.

Returns

IObservable<double>

A sequence containing the absolute difference norm, or relative difference norm, between each pair of arrays in the source sequence.

Type Parameters

TArray1

The type of the first array-like object.

TArray2

The type of the second array-like object.

Process<TArray1, TArray2, TMask>(IObservable<Tuple<TArray1, TArray2, TMask>>)

Calculates the absolute difference norm, or relative difference norm, between each pair of arrays in an observable sequence with an additional operation mask.

public IObservable<double> Process<TArray1, TArray2, TMask>(IObservable<Tuple<TArray1, TArray2, TMask>> source) where TArray1 : Arr where TArray2 : Arr where TMask : Arr

Parameters

source IObservable<Tuple<TArray1, TArray2, TMask>>

A sequence of pairs of multi-dimensional arrays for which to calculate the absolute difference norm or relative difference norm, for elements in which the operation mask is non-zero.

Returns

IObservable<double>

A sequence containing the absolute difference norm, or relative difference norm, between each pair of arrays in the source sequence, for elements in which the operation mask is non-zero.

Type Parameters

TArray1

The type of the first array-like object.

TArray2

The type of the second array-like object.

TMask

The type of the array-like objects used in the operation mask.