David Alm: Automated Syncronization with Documentation

2013-06-26T00:29:30Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:29, 26 June 2013
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]]

David Alm: Automated Syncronization with Documentation

2012-10-18T17:17:36Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]

'''Unit:''' [[Unit SLSimpleDataBuffer|SLSimpleDataBuffer]]

'''Inherits:''' [[Interface SLSimpleDataBuffer.ISLLinearDataBuffer|ISLLinearDataBuffer]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' ISLComplexBuffer = '''interface'''( [[Interface SLSimpleDataBuffer.ISLLinearDataBuffer|ISLLinearDataBuffer]] )
</code>
== Summary ==
Complex data buffer interface.

== Description ==
This is the Complex data buffer interface.

== Properties ==
*[[Property SLSimpleDataBuffer.ISLComplexBuffer.Items|Items]] - Access to individual TOWRealComplex item of the buffer.

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

[[Category:Interfaces]]

Interface SLSimpleDataBuffer.ISLComplexBuffer - Revision history

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation