Interface SLSimpleDataBuffer.ISLRealBuffer

Revision as of 16:52, 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 ISLRealBuffer = interface( ISLLinearDataBuffer )

Summary

Real data buffer interface.

Description

This is the Real data buffer interface.

Properties

• Items - Access to individual Real(double) item of the buffer.
• Min - Returns the min value in the buffer.
• Max - Returns the max value in the buffer.

Methods

• function Read() : PReal - Returns read only pointer to the buffer data.
• function Write() : PReal - Returns write pointer to the buffer data.
• function Modify() : PReal - Returns read and write pointer to the buffer data.
• function GetItem(Index : Integer) : Real
• procedure SetItem(Index : Integer; Value : Real)
• procedure VectorJaehne(AMagnitude : Real) - Creates a test Jaehne data in the buffer.
• procedure Add(Right : ISLRealBuffer) - Adds the elements of the buffer to the corresponding elements of another buffer.
• procedure Subtract(Right : ISLRealBuffer) - Subtracts the elements of the buffer by the corresponding elements of another buffer.
• procedure Multiply(Right : ISLRealBuffer) - Multiplies the elements of the buffer by the corresponding elements of another buffer.
• procedure Divide(Right : ISLRealBuffer) - Divides the elements of the buffer by the corresponding elements of another buffer.
• procedure SetValue(AValue : Real) - Sets all the elements of the buffer to a certain value.
• procedure AddValue(AValue : Real) - Adds a double value to each element of the buffer.
• procedure SubtractValue(AValue : Real) - Subtracts a double value from each element of the buffer.
• procedure MultiplyValue(AValue : Real) - Multiplies a real value to each element of the buffer.
• procedure DivideValue(AValue : Real) - Divides each element of the buffer data by a value.
• procedure Zero() - Sets all the elements of the buffer to 0.
• procedure ToInt(OutBuffer : PInteger; ARound : Boolean) - Copies the content of the buffer to memory location as Integers.
• procedure ToShort(OutBuffer : PSmallInt; ARound : Boolean) - Copies the content of the buffer to memory location as SmallInts.
• procedure ToSingle(OutBuffer : PSingle) - Copies the content of the buffer to memory location as Singles(floats).
• procedure FromInt(InBuffer : PInteger) - Copies the content of memory location to the buffer as Integers.
• procedure FromShort(InBuffer : PSmallInt) - Copies the content of memory location to the buffer as SmallInts.
• procedure FromSingle(InBuffer : PSingle) - Copies the content of memory location to the buffer as Singles(floats).
• procedure NormalizeFrom(Src : ISLRealBuffer; Offset : Real; Factor : Real) - Normalizes the elements of another buffer using offset and division operations, and assigns the result to this buffer.
• procedure Normalize(Offset : Real; Factor : Real) - Normalizes the elements of the buffer using offset and division operations.
• function Dot(Right : ISLRealBuffer) : Real - 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 : ISLRealBuffer; 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 : ISLRealBuffer) - Computes a square of each element of another buffer, and assigns the result to this buffer.
• procedure Sqrt() - Computes a square root of each element of the buffer.
• procedure SqrtFrom(Src : ISLRealBuffer) - Computes a square root of each element of another buffer, and assigns the result to this buffer.
• procedure AutoCorr(Src : ISLRealBuffer; AType : TSLAutoCorrType) - Estimates normal, biased, and unbiased auto-correlation of a vector.
• procedure CrossCorr(Src1 : ISLRealBuffer; Src2 : ISLRealBuffer; LoLag : Integer) - Estimates the cross-correlation of two buffers. and stores the result in the buffer.
• procedure Abs() - Converts each element of the buffer to its absolute value.
• procedure AbsFrom(Src : ISLRealBuffer) - Assigns each element of the buffer with the absolute value of the corresponding element of another buffer.
• procedure Exp() - Computes e to the powerof each element of the buffer.
• procedure ExpFrom(Src : ISLRealBuffer) - Computes e to the powerof each element of another buffer and store the result in the buffer.
• procedure Ln() - Computes the natural logarithm of each element of the buffer.
• procedure LnFrom(Src : ISLRealBuffer) - Computes the natural logarithm of each element of another buffer, and assigns the result to this buffer.
• function Mean() : Real - Computes the mean value of the buffer.
• function StdDev() : Real - Computes the standard deviation value of a vector.
• procedure Convolve(Src : ISLRealBuffer; H : ISLRealBuffer) - Performs finite, linear convolution of the elements of the buffer and the elements of another buffer.
• function Norm(Src : ISLRealBuffer; AType : TSLNormType) : Real - Computes the C, L1, or L2 norm of the buffer.
• function GetMinValue() : Real
• function GetMaxValue() : Real
• function GetMinIndex(var AIndex : Integer) : Real - Returns the index of the smallest sample in the buffer.
• function GetMaxIndex(var AIndex : Integer) : Real - Returns the index of the biggest sample in the buffer.
• function GetMin(IndexBegin : Integer; IndexEnd : Integer) : Real
• function GetMax(IndexBegin : Integer; IndexEnd : Integer) : Real
• function GetMinRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real
• function GetMaxRestricted(IndexBegin : Integer; IndexEnd : Integer) : Real
• function IsEqualToValue(AValue : Real) : Boolean - Checks if all the elements in the buffer are equal to a value.