SpectrumMarkTool Class

Source: SignalToolsTee.cs · Assembly: Dew.Signal.Tee
ToolSeriesCursorMarkToolSpectrumMarkTool

public class SpectrumMarkTool : CursorMarkTool

Marks peaks in the frequency spectrums. Use this Tool to examine peaks (their exact frequency, amplitude and phase) of a frequency spectrum.

Properties

NameTypeDescription
ActiveMarkTMarkRecordReturns the currently active mark.
AmpltFormatStringDefines the number format (like: 0.0##) used to format the amplitude value displayed for the marked peak.
ConfMarksOnlyBooleanIf True, the confidence limit points will be added for marked peaks only. Then a point series should be used for upper and lower limits.
CursorActiveBooleanSet this property to false, to disable this TeeTool and hide the cursor.
DescriptionString
DoubleClickClearBooleanIf True, all marked points will deleted when the user double clicks the chart.
FreqFormatStringDefines the number format (like: 0.0##) used to format the frequency value displayed for the marked peak.
LabelHeadersBooleanIf True, the label displaying the amplitude of the marked peak, will be preceded with 'A = ' and the phase will be preceded with 'P = '.}
LowerLimitSeriesSeriesDefines the lower limit series for the confidence interval.
MarkModeSpectrumMarkModeDefines how the marks will be drawn.
MarkSeriesSeriesDefines a chart series to draw marks. Usually this is a Point Series or some other series usefull to make marked points stand out. TeeChart only provides means to draw all marks or every second, third etc... By drawing marks on a separate series, you can have any number of marks at any location ranging from zero to values count.}
MarkTypeSpectrumMarkTypeDefines the mark type which can show Amplitde, Phase or both.
PeakFilterModeBooleanSet this property to True, if you want to use digital filter to remove each clicked peak, instead to mark it.
PeakZoomBandBooleanIf True and if the frequency spectrum is zoomed, the peak search will be restricted only to the displayed bandwidth.
PhaseFormatStringDefines the number format (like: 0.0##) used to format the phase value displayed for the marked peak.
SummaryString
UpperLimitSeriesSeriesDefines the upper limit series for the confidence interval.

Methods

NameDescription
ClearMarksClears the list of existing marks from the associate frequency spectrum.
ctor (2)
FilterPeaksFilters all marked peaks out of the time signal connected to the TSpectrumAnalyzer and clears the list of existing marked peaks in the TSpectrumAnalyzer. The digital filter simply subtracts the sines matching in amplitude, frequency and phase the values of marked peaks from the time signal.
GetSpectrumReturns associated TSpectrumAnalayzer or TSpectrum object. The search is done by matching the Series property value with the Spectrums[i].Series property.
MarkedPeakCountReturns the number of marked peaks in the associated TSpectrumAnalyzer.
PublicChartEvent