nmr-processing 3.3.3 → 4.0.0

package/src/types/ml-gsd/index.d.ts

@@ -1,164 +0,0 @@
-declare module 'ml-gsd' {
-  export interface XYNumberArray {
-    x: Array<number> | Float64Array;
-    y: Array<number> | Float64Array;
-  }
-
-  export interface GSDOptions {
-    /**
-     * Noise threshold in spectrum y units. Default is three/thresholdFactor times the absolute median of data.y.
-     * @default `median(data.y) * (options.thresholdFactor || 3)`
-     */
-    noiseLevel?: number;
-    /**
-     * Threshold to determine if a given peak should be considered as a noise, bases on its relative height compared to the highest peak.
-     * @default 0.01
-     */
-    minMaxRatio?: number;
-    /**
-     * If broadRatio is higher than 0, then all the peaks which second derivative smaller than broadRatio * maxAbsSecondDerivative will be marked with the soft mask equal to true.
-     * @default 0.00025
-     */
-    broadRatio?: number;
-    /**
-     * Select the peak intensities from a smoothed version of the independent variables.
-     * @default true
-     */
-    smoothY?: boolean;
-    /**
-     * if it is true, it optimizes the x and intensity by extrapolation.
-     * @default false
-     */
-    realTopDetection?: boolean;
-    /**
-     * options to shape used to adapt the FWHM
-     * @default {kind:'gaussian'}
-     */
-    shape?: { kind: string };
-    /**
-     * Options for savitz Golay
-     */
-    sgOptions?: { windowSize: number; polynomial: number };
-    /**
-     * filter based on intensity of the first derive.
-     * @default -1
-     */
-    /**
-     * Peaks are local maximum(true) or minimum(false)
-     * @default true
-     */
-    maxCriteria?: boolean;
-    /**
-     * Filters based on the amplitude of the first derivative
-     * @default -1
-     */
-    derivativeThreshold?: number;
-    /**
-     * Factor to multiply the calculated height (usually 2)
-     * @default 0
-     */
-    heightFactor?: number;
-  }
-
-  export interface GSDPeak {
-    x: number;
-    y: number;
-    shape: {
-      width: number;
-      noiseLevel?: number;
-      soft?: boolean;
-      kind?: string;
-    };
-  }
-
-  export interface OptimizePeaksOptions {
-    /**
-     * factor to determine the width at the moment to group the peaks in signals in 'GSD.optimizePeaks' function.
-     * @default 1
-     */
-    factorWidth?: number;
-    /**
-     * times of width to use to optimize peaks
-     * @default 2
-     */
-    factorLimits?: number;
-    /**
-     * options to shape used to adapt the FWHM
-     * @default {kind:'gaussian'}
-     */
-    shape?: { kind: string };
-    /**
-     * options for optimization step
-     */
-    optimization?: OptimizationOptions;
-  }
-
-  export interface OptimizationOptions {
-    /**
-     * represent the algorithm to optimize.
-     * @default {kind:'lm'}
-     */
-    kind?: string;
-    /**
-     * Time limit to stop the optimization in seconds.
-     * @default 10
-     */
-    timeout?: number;
-  }
-
-  export interface OptimizedPeak {
-    x: number;
-    y: number;
-    shape: {
-      width: number;
-      noiseLevel?: number;
-      soft?: boolean;
-      kind?: string;
-      mu?: number;
-    };
-  }
-
-  export function gsd(data: XYNumberArray, options?: GSDOptions): GSDPeak[];
-
-  export function optimizePeaks(
-    data: XYNumberArray,
-    peakList: GSDPeak[],
-    options?: OptimizePeaksOptions,
-  ): OptimizedPeak[];
-
-  export function joinBroadPeaks(
-    peakList: GSDPeak[],
-    options?: JoinBroadPeaksOptions,
-  ): GSDPeak[];
-
-  export interface JoinBroadPeaksOptions {
-    /**
-     * @default 0.25
-     */
-    width: number;
-    /**
-     * @default { kind: 'gaussian' }
-     */
-    shape: { kind: string };
-    /**
-     * @default { kind: 'lm', timeout: 10 }
-     */
-    optimization: OptimizationOptions;
-  }
-
-  export function groupPeaks(peakList: GSDPeak[], factor?: number): GSDPeak[][];
-
-  export function broadenPeaks(
-    peakList: GSDPeak[],
-    options?: {
-      /**
-       * @default 2
-       */
-      factor: number;
-      /**
-       * @default false
-       */
-      overlap: boolean;
-    },
-  ): GSDPeak[];
-}