David Alm: Automated Syncronization with Documentation

2013-06-26T00:31:06Z

Automated Syncronization with Documentation

← Older revision		Revision as of 00:31, 26 June 2013
Line 28:		Line 28:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' ~~TSLNoiseStats~~ : [[Class SLFourier.TSLFourierBase\|Mitov.SignalLab.FourierBase]]	+	'''public ref class''' NoiseStats : [[Class SLFourier.TSLFourierBase\|Mitov.SignalLab.FourierBase]]
	</code>		</code>
	== Summary ==		== Summary ==

David Alm: Automated Syncronization with Documentation

2013-06-26T00:11:56Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:11, 26 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-25T23:53:54Z

Automated Syncronization with Documentation

← Older revision

Revision as of 23:53, 25 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T02:45:49Z

Automated Syncronization with Documentation

← Older revision

Revision as of 02:45, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:17:29Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:17, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-11T00:07:17Z

Automated Syncronization with Documentation

← Older revision

Revision as of 00:07, 11 June 2013

David Alm: Automated Syncronization with Documentation

2013-06-10T20:30:15Z

Automated Syncronization with Documentation

← Older revision		Revision as of 20:30, 10 June 2013
Line 67:		Line 67:
	exclude a single bin adjacent left and adjacent right of the		exclude a single bin adjacent left and adjacent right of the
	first harmonic, inside the event handler use code such as:		first harmonic, inside the event handler use code such as:
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:SLNoiseStats_Preview.png]]


Line 105:		Line 111:
	in the FFT output spectrum by setting them to the average		in the FFT output spectrum by setting them to the average
	amplitude of the signal.		amplitude of the signal.
		+
		+
	Note		Note
	This change has effect only for statistic calculations that		This change has effect only for statistic calculations that
Line 113:		Line 121:

	=== Published ===		=== Published ===
		+	*[[Property SLNoiseStats.TSLNoiseStats.Normalization\|Normalization]] - The normalization type for the FFT operation.
	*[[Property SLNoiseStats.TSLNoiseStats.BinMask\|BinMask]] - Array of Count integers holding the values of bins to be masked from statistic calculations.		*[[Property SLNoiseStats.TSLNoiseStats.BinMask\|BinMask]] - Array of Count integers holding the values of bins to be masked from statistic calculations.
	*[[Property SLNoiseStats.TSLNoiseStats.MinDataVal\|MinDataVal]] - The minimal value expected in the data stream.		*[[Property SLNoiseStats.TSLNoiseStats.MinDataVal\|MinDataVal]] - The minimal value expected in the data stream.

David Alm: Automated Syncronization with Documentation

2011-11-22T00:24:31Z

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>

[[Image:BIGSLNoiseStats.gif]] [[Image:SLNoiseStats.gif]] [[Image:NETSLNoiseStats.gif]]

'''Package:''' [[Package SignalLabPkg|SignalLabPkg]]

'''Unit:''' [[Unit SLNoiseStats|SLNoiseStats]]

'''Inherits:''' [[Class SLFourier.TSLFourierBase|TSLFourierBase]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' TSLNoiseStats = '''class'''( [[Class SLFourier.TSLFourierBase|TSLFourierBase]] )
</code>
=== C++ Builder: ===
<code>
'''class''' TSLNoiseStats : '''public''' [[Class SLFourier.TSLFourierBase|TSLFourierBase]]
</code>
=== Visual C++ (MFC): ===
<code>
'''class''' CTSLNoiseStats : '''public''' [[Class SLFourier.TSLFourierBase|CTSLFourierBase]]
</code>
=== C# (.NET): ===
<code>
'''public ref class''' TSLNoiseStats : [[Class SLFourier.TSLFourierBase|Mitov.SignalLab.FourierBase]]
</code>
== Summary ==
Calculates the noise stats of a signal.

== Description ==
[[Class SLNoiseStats.TSLNoiseStats|TSLNoiseStats]] is a component that accepts either a real or
complex input data stream containing a single fundamental
frequency within a noisy signal, and analyzes the stream in
order to calculate a number of useful statistics, including
Signal-to-Noise ratio (SNR), Total Harmonic Distortion (THD),
and Signal-to-Noise-and-Distortion (SINAD). The component
achieves these calculations with the following sequential
steps: 1) The input signal is normalized and an initial FFT
is performed, 2) the fundamental frequency and its harmonics
are located within the FFT output spectrum, 3) the various
statistics are calculated, 4) a [[Type SLNoiseStats.TSLNoiseStatsNotifyEvent|TSLNoiseStatsNotifyEvent]] is
generated to supply the calculated statistics (in the form of
a [[Class SLNoiseStats.TSLNoiseStatResults|TSLNoiseStatResults]] object) to the client, and finally 5)
the results of the initial FFT are made available on the
OutpuPin and SpectrumOutputPin.

In addition to the above 5-step process, an event is provided
to allow clients to mask (exclude) certain bins from the
statistic calculations. For example, clients sometimes need
to exclude skirt bins near the fundamental or harmonics.
And because harmonic location occurs in step (2) above, and
statistic calculations occur in step (3) above, bin exclusion
needs to be specified midway through the algorithm. To allow
this, a [[Type SLNoiseStats.TSLBinMaskOpportunityEvent|TSLBinMaskOpportunityEvent]] is generated just after
step (2). To utilize this event, assign property
[[Event SLNoiseStats.TSLNoiseStats.OnBinMaskOpportunity|OnBinMaskOpportunity]] to an event handler. Within the handler,
clients have access to the fundamental and harmonic bin
locations, and can call the [[Class SLNoiseStats.TSLNoiseStats|TSLNoiseStats]].[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add()
method to add a bin number to exclude. For example, to
exclude a single bin adjacent left and adjacent right of the
first harmonic, inside the event handler use code such as:

Delphi Example:

<code>
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Clear(); // remove all existing masks
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] 1 );
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] + 1 );
</code>

C++ Builder Example:

<code>
SLNoiseStats1->[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]]->Clear(); // remove all existing masks
SLNoiseStats1->[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]]->Add( Harmonics->HarmonicBin[ 0 ] 1 );
SLNoiseStats1->[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]]->Add( Harmonics->HarmonicBin[ 0 ] + 1 );
</code>

Visual C++/MFC Example:

<code>
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Clear(); // remove all existing masks
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] 1 );
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] + 1 );
</code>

Visual C# Example:

<code>
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Clear(); // remove all existing masks
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] 1 );
SLNoiseStats1.[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]].Add( Harmonics.HarmonicBin[ 0 ] + 1 );
</code>

This code will change the amplitudes of these adjacent bins
in the FFT output spectrum by setting them to the average
amplitude of the signal.
Note
This change has effect only for statistic calculations that
follow the FFT there is no change in the actual FFT output
stream available on the OutputPin or SpectrumOutputPin.

== Properties ==

=== Published ===
*[[Property SLNoiseStats.TSLNoiseStats.BinMask|BinMask]] - Array of Count integers holding the values of bins to be masked from statistic calculations.
*[[Property SLNoiseStats.TSLNoiseStats.MinDataVal|MinDataVal]] - The minimal value expected in the data stream.
*[[Property SLNoiseStats.TSLNoiseStats.MaxDataVal|MaxDataVal]] - The maximal value expected in the data stream.
*[[Property SLNoiseStats.TSLNoiseStats.WindowThreshold|WindowThreshold]] - Threshold for bins with (frequency-domain) window magnitudes.
*[[Property SLNoiseStats.TSLNoiseStats.NumHarmonics|NumHarmonics]] - The NumHarmonics harmonic frequencies used in the calculation of SINAD and THD
*[[Property SLNoiseStats.TSLNoiseStats.DCBinWidth|DCBinWidth]] - Size of a bin window (number of bins) to be treated as a single bin for the DC component of the signal.
*[[Property SLNoiseStats.TSLNoiseStats.HarmonicBinWidth|HarmonicBinWidth]] - Size of a bin window (number of bins) to be treated as a single bin for determining the fundamental and harmonic contributions.
*[[Property SLNoiseStats.TSLNoiseStats.SynchronizeType|SynchronizeType]] - Type of thread buffer synchronization.

=== Public ===
*[[Property SLNoiseStats.TSLNoiseStats.Masked|Masked]] - Array of Boolean, with each element corresponding to the initial FFT output bin.
*[[Property SLNoiseStats.TSLNoiseStats.CompexData|CompexData]] - Returns pointer to the processed FFT data.
*[[Property SLNoiseStats.TSLNoiseStats.DataSize|DataSize]] - Returns the size of the processed FFT data.

== Events ==
*[[Event SLNoiseStats.TSLNoiseStats.OnBinMaskOpportunity|OnBinMaskOpportunity]] - Occurs after the initial FFT and location of the fundamental frequency and harmonics.
*[[Event SLNoiseStats.TSLNoiseStats.OnStatsAvailable|OnStatsAvailable]] - Occurs after all [[Class SLNoiseStats.TSLNoiseStats|TSLNoiseStats]] calculations are performed.

== From [[Class SLFourier.TSLFourierBase|TSLFourierBase]] ==

== Properties ==

=== Published ===
*[[Property SLFourier.TSLFourierBase.WindowType|WindowType]] - Windowing function to be applied on the signal prior performing FFT.
*[[Property SLFourier.TSLFourierBase.NumberTerms|NumberTerms]] - Specifies the number of Cosine sum window function terms.
*[[Property SLFourier.TSLFourierBase.Order|Order]] - The order of the FFT.
*[[Property SLFourier.TSLFourierBase.SamplingWindowStep|SamplingWindowStep]] - Step in samples when the next FFT will be applied.
*[[Property SLFourier.TSLFourierBase.Synchronize|Synchronize]] - Specifies if the [[Event SLFourier.TSLFourierBase.OnFrequencyResult|OnFrequencyResult]] event will be synchronized with the main thread.

== Pins ==
*[[Pin SLFourier.TSLFourierBase.FrequencyOutputPin|FrequencyOutputPin]] - Single Sample Real(double) data Highest Frequency Output Pin.

== Events ==
*[[Event SLFourier.TSLFourierBase.OnFrequencyResult|OnFrequencyResult]] - Occurs when highest amplitude frequency is detected.

== From [[Class SLFourier.TSLFourierBaseComponent|TSLFourierBaseComponent]] ==

== Properties ==

=== Published ===
*[[Property SLFourier.TSLFourierBaseComponent.Alpha|Alpha]] - Adjustable parameter associated with some of the windowing equations.
*[[Property SLFourier.TSLFourierBaseComponent.IgnoreDC|IgnoreDC]] - Ignores the DC component.

== Pins ==
*[[Pin SLFourier.TSLFourierBaseComponent.InputPin|InputPin]] - The Real(double) or Complex input pin of the FFT.
*[[Pin SLFourier.TSLFourierBaseComponent.OutputPin|OutputPin]] - The Complex output pin of the FFT.
*[[Pin SLFourier.TSLFourierBaseComponent.SpectrumOutputPin|SpectrumOutputPin]] - The Real(double) spectrum output pin.

== From [[Class SLCommonFilter.TSLBasicThreadedFilter|TSLBasicThreadedFilter]] ==

== Properties ==

=== Published ===
*[[Property SLCommonFilter.TSLBasicThreadedFilter.Threading|Threading]]

[[Category:Components]][[Category:Classes]]

Class SLNoiseStats.TSLNoiseStats - Revision history

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation

David Alm: Automated Syncronization with Documentation