classdef PeakFinderConfiguration< dsp.webscopes.measurements.BaseMeasurementConfiguration
%PeakFinderConfiguration Peak finder properties for scope.
% PeakFinderConfiguration contains the properties used by the Scope
% PeakFinder property. Peak finder computes and displays the largest
% calculated peak values.
%
% PeakFinderConfiguration properties:
%
%   MinHeight       - Level above which peaks are detected
%   NumPeaks        - Maximum number of peaks to show
%   MinDistance     - Minimum number of samples between adjacent peaks
%   Threshold       - Minimum height difference between peak and its
%                     neighboring samples
%   LabelPeaks      - Label found peaks
%   LabelFormat     - Coordinates to display next to the calculated
%                     peak value
%   Enabled         - Enable peak finder measurements

 
    %   Copyright 2021-2022 The MathWorks, Inc.

    methods
        function out=PeakFinderConfiguration
        end

        function out=getPropertyGroups(~) %#ok<STOUT>
            % This method is used to selectively display public properties
            % based on values of other properties.
        end

    end
    properties
        %LabelFormat Coordinates to display next to the calculated peak
        %value
        %   Specify the label format as one of "x" | "y" | "x + y". The
        %   default LabelFormat is "x + y". This property is tunable.
        LabelFormat;

        %LabelPeaks Label found peaks
        %   Set this property to true to label found peaks. The default is
        %   false. This property is tunable. This property is tunable.
        LabelPeaks;

        %MinDistance Minimum number of samples between adjacent peaks
        %   Specify the minimum peak distance as a positive integer scalar.
        %   The default MinDistance value is 1. This property is tunable.
        MinDistance;

        %MinHeight Level above which peaks are detected
        %   Specify the minimum peak height as a scalar value. The default
        %   MinHeight value is -Inf. This property is tunable.
        MinHeight;

        %NumPeaks Maximum number of peaks to show
        %   Specify the number of peaks as a positive integer scalar less
        %   than 100. The default NumPeaks value is 3. This property is
        %   tunable.
        NumPeaks;

        %Threshold Minimum height difference between peak and its
        %neighboring samples
        %   Specify the threshold as a nonnegative real scalar. The default
        %   Threshold value is 0. This property is tunable.
        Threshold;

    end
end
