Class ConvertScale

Represents an operator that converts each array in the sequence to the specified bit depth, with optional linear transformation.

Inheritance

Object

ArrayTransform

ConvertScale

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Bonsai.Dsp

Assembly: Bonsai.Dsp.dll

Syntax

[Combinator]
[WorkflowElementCategory(ElementCategory.Transform)]
public class ConvertScale : ArrayTransform

Properties

Depth

Gets or sets the bit depth of each element in the output array.

Declaration

[TypeConverter(typeof(DepthConverter))]
public Depth? Depth { get; set; }

Property Value

Type	Description
Nullable<Depth>

Remarks

If this property is not specified, the bit depth of the output array will be the same as the bit depth of the input array.

Scale

Gets or sets the optional scale factor to apply to the array elements.

Declaration

public double Scale { get; set; }

Property Value

Type	Description
Double

Shift

Gets or sets the optional value to be added to the scaled array elements.

Declaration

public double Shift { get; set; }

Property Value

Type	Description
Double

Methods

Process<TArray>(IObservable<TArray>)

Converts each array in the sequence to the specified bit depth, with optional linear transformation.

Declaration

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

Parameters

Type	Name	Description
IObservable<TArray>	source	The sequence of arrays to be converted.

Returns

Type	Description
IObservable<TArray>	A sequence containing the converted and scaled arrays.

Type Parameters

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

Overrides

Bonsai.Dsp.ArrayTransform.Process<TArray>(System.IObservable<TArray>)