Class Histogram2D

Namespace

Bonsai.Dsp

Assembly

Bonsai.Dsp.dll

Represents an operator that computes a sequence of two-dimensional histograms from each element in the sequence.

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

Inheritance

object

Histogram2D

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Accumulate

Gets or sets a value specifying whether the histogram should be continuously updated.

public bool Accumulate { get; set; }

Property Value

bool

BinsX

Gets or sets the number of bins in the horizontal dimension of the histogram.

public int BinsX { get; set; }

Property Value

int

BinsY

Gets or sets the number of bins in the vertical dimension of the histogram.

public int BinsY { get; set; }

Property Value

int

MaxX

Gets or sets the upper range of the histogram bins in the horizontal dimension.

public float MaxX { get; set; }

Property Value

float

MaxY

Gets or sets the upper range of the histogram bins in the vertical dimension.

public float MaxY { get; set; }

Property Value

float

MinX

Gets or sets the lower range of the histogram bins in the horizontal dimension.

public float MinX { get; set; }

Property Value

float

MinY

Gets or sets the lower range of the histogram bins in the vertical dimension.

public float MinY { get; set; }

Property Value

float

Normalize

Gets or sets a value specifying whether the histogram should be normalized such that the sum of bins adds up to one.

public bool Normalize { get; set; }

Property Value

bool

Methods

Process(IObservable<Mat>)

Computes a sequence of two-dimensional histograms from an observable sequence of multi-channel arrays of point coordinates.

public IObservable<IplImage> Process(IObservable<Mat> source)

Parameters

source IObservable<Mat>

A sequence of two-channel arrays, or single-channel arrays with two rows, where the different elements in an array represent the horizontal and vertical dimensions used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Process(IObservable<Point2f>)

Computes a sequence of two-dimensional histograms from an observable sequence of 2D points with single-precision floating-point coordinates.

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

Parameters

source IObservable<Point2f>

A sequence of 2D points with single-precision floating-point coordinates used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Process(IObservable<Point>)

Computes a sequence of two-dimensional histograms from an observable sequence of 2D points with integer coordinates.

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

Parameters

source IObservable<Point>

A sequence of 2D points with integer coordinates used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Process(IObservable<Tuple<int, int>>)

Computes a sequence of two-dimensional histograms from an observable sequence of pairs of integer coordinates.

public IObservable<IplImage> Process(IObservable<Tuple<int, int>> source)

Parameters

source IObservable<Tuple<int, int>>

A sequence of pairs of integer coordinates used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Process(IObservable<Tuple<float, float>>)

Computes a sequence of two-dimensional histograms from an observable sequence of pairs of single-precision floating-point coordinates.

public IObservable<IplImage> Process(IObservable<Tuple<float, float>> source)

Parameters

source IObservable<Tuple<float, float>>

A sequence of pairs of single-precision floating-point coordinates used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Process<TArray>(IObservable<Tuple<TArray, TArray>>)

Computes a sequence of two-dimensional histograms from an observable sequence of pairs of one-dimensional arrays of coordinates.

public IObservable<IplImage> Process<TArray>(IObservable<Tuple<TArray, TArray>> source) where TArray : Arr

Parameters

source IObservable<Tuple<TArray, TArray>>

A sequence of pairs of one-dimensional arrays, where each array represents respectively the horizontal and vertical dimensions used to calculate the two-dimensional histogram.

Returns

IObservable<IplImage>

A sequence of IplImage objects representing the two-dimensional histogram calculated from the values in the source sequence.

Type Parameters

TArray

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