Property SLNoiseStats.TSLNoiseStats.BinMask

From Mitov Wiki Doc
Jump to: navigation, search

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.

Class: TSLNoiseStats

Contents

Syntax

Delphi:

property BinMask : TSLBinMask read FBinMask write SetBinMask;

C++ Builder:

__property TSLBinMask * BinMask = { read=FBinMask, write=SetBinMask };

Summary

Array of Count integers holding the values of bins to be masked from statistic calculations.

Description

You can mask (exclude) a bin’s value from contributing to noise statistic calculations (SNR, SINAD, etc) by adding the bin’s sequential bin number to the BinMask array (using procedure BinMask.Add). After a bin’s bin number is added to the BinMask array, for subsequent statistical calculations, that bin’s initial FFT output amplitude is set to the average of all bins. Often, users have a need to mask bins near the fundamental frequency bin or near its harmonic bins; because of this need, the OnBinMaskOpportunity property is provided. This TSLBinMaskOpportunityEvent is generated after the fundamental and harmonic bins have been located, and these locations are supplied as event parameters. The array of bins to be masked is retained across TSLBinMaskOpportunityEvents unless bins are explicitly added or the array is cleared; hence, for efficiency, client code often will not call procedure BinMask.Add() with each event handler call, but will keep track of when the mask needs to be cleared or set.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox