Interface SLSimpleDataBuffer.ISLComplexBuffer

Revision as of 17:17, 18 October 2012 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Latest revision as of 00:29, 26 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)
Line 5:		Line 5:
	</span></b>		</span></b>
−	'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]	+	'''Package:''' [[Package Mitov.BasicLab|Mitov.BasicLab]]
	'''Unit:''' [[Unit SLSimpleDataBuffer|SLSimpleDataBuffer]]		'''Unit:''' [[Unit SLSimpleDataBuffer|SLSimpleDataBuffer]]

---

Latest revision as of 00:29, 26 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: Mitov.BasicLab

Unit: SLSimpleDataBuffer

Inherits: ISLLinearDataBuffer

Contents 1 Syntax 1.1 Delphi: 2 Summary 3 Description 4 Properties 5 Methods

Syntax

Delphi:

type ISLComplexBuffer = interface( ISLLinearDataBuffer )

Summary

Complex data buffer interface.

Description

This is the Complex data buffer interface.

Properties

• Items - Access to individual TOWRealComplex item of the buffer.

Methods

• function Read() : POWRealComplex - Returns read only pointer to the buffer data.
• function Write() : POWRealComplex - Returns write pointer to the buffer data.
• function Modify() : POWRealComplex - Returns read and write pointer to the buffer data.
• function GetItem(Index : Integer) : TOWRealComplex
• procedure SetItem(Index : Integer; Value : TOWRealComplex)
• function GetReal() : ISLRealBuffer - Returns the real data of the complex buffer as a new real data buffer.
• function GetImaginary() : ISLRealBuffer - Returns the imaginary data of the complex buffer as a new real data buffer.
• procedure Add(Right : ISLComplexBuffer) - Adds the elements of the buffer to the corresponding elements of another buffer.
• procedure Subtract(Right : ISLComplexBuffer) - Subtracts the elements of the buffer by the corresponding elements of another buffer.
• procedure Multiply(Right : ISLComplexBuffer) - Multiplies the elements of the buffer by the corresponding elements of another buffer.
• procedure Divide(Right : ISLComplexBuffer) - Divides the elements of the buffer by the corresponding elements of another buffer.
• procedure AddValue(AReal : Real; AImag : Real) - Adds a complex value ( defined by double Real and double Imaginary ) to each element of the buffer.
• procedure SubtractValue(AReal : Real; AImag : Real) - Subtracts a complex value ( defined by double Real and double Imaginary ) to each element of the buffer.
• procedure MultiplyValue(AReal : Real; AImag : Real) - Multiplies a complex value ( defined by double Real and double Imaginary ) to each element of the buffer.
• procedure DivideValue(AReal : Real; AImag : Real) - Divides each element of the buffer data by a complex value ( defined by double Real and double Imaginary ).
• procedure SetBuffer(AReal : ISLRealBuffer; AImag : ISLRealBuffer) - Constructs a complex buffer from two float buffers, containing the real and imaginary components.
• procedure SetValue(AReal : Real; AImag : Real) - Sets the buffer samples to a (AReal, AImag) value.
• procedure SetValue(AValue : TOWRealComplex) - Sets the buffer samples to a complex value.
• procedure Zero() - Sets all the elements of the buffer to 0.
• procedure NormalizeFrom(Src : ISLComplexBuffer; Offset : TOWRealComplex; Factor : Real) - Normalizes the elements of another buffer using offset and division operations, and assigns the result to this buffer.
• procedure Normalize(Offset : TOWRealComplex; Factor : Real) - Normalizes the elements of the buffer using offset and division operations.
• function Dot(Src : ISLComplexBuffer) : TOWRealComplex - Computes the dot product of two buffers.
• procedure Threshold(AThreshold : Real; AType : TSLThresholdType) - Performs the threshold operation on the elements of a vector by limiting the element values by Level.
• procedure ThresholdFrom(Src : ISLComplexBuffer; AThreshold : Real; AType : TSLThresholdType) - Performs the threshold operation on the elements of another vector by limiting the element values by Level, and stoes the results in the current vector.
• procedure Sqr() - Computes a square of each element of the buffer.
• procedure SqrFrom(Src : ISLComplexBuffer) - Computes a square of each element of the buffer.
• procedure Sqrt() - Computes a square root of each element of the buffer.
• function Mean() : TOWRealComplex - Computes the mean value of the buffer.
• procedure SqrtFrom(Src : ISLComplexBuffer) - Computes a square of each element of another buffer, and assigns the result to this buffer.
• procedure AutoCorr(Src : ISLComplexBuffer; AType : TSLAutoCorrType) - Estimates normal, biased, and unbiased auto-correlation of a vector.
• procedure CrossCorr(Src1 : ISLComplexBuffer; Src2 : ISLComplexBuffer; LoLag : Integer) - Estimates the cross-correlation of two buffers. and stores the result in the buffer.
• function Phase() : ISLRealBuffer - Computes the phase angles of elements of the complex buffer, and returns them as ISLRealBuffer.
• function Magnitude() : ISLRealBuffer - Computes the magnitudes of the elements of the complex buffer, and returns them as ISLRealBuffer.
• function PowerSpectrum() : ISLRealBuffer - Computes the power spectrum of the complex buffer, and returns them as ISLRealBuffer.
• function IsEqualToValue(AValue : TOWRealComplex) : Boolean - Checks if all the elements in the buffer are equal to a value.