nmr-processing 12.12.2 → 13.0.0

package/nmr-processing.d.ts

@@ -61,13 +61,12 @@ export declare function apodization(data: DataReIm | DataXReIm, options?: Apodiz
     im: DoubleArray;
 };
 
+export declare interface Apodization2DOptions {
+    f1: ApodizationOptions;
+    f2: ApodizationOptions;
+}
+
 export declare function apodizationFilter(datum1D: Entry1DApodizationFilter, options: ApodizationOptions): {
-    windowData: Float64Array;
-    x: DoubleArray;
-    re: DoubleArray;
-    im: DoubleArray;
-} | {
-    windowData: Float64Array;
     re: DoubleArray;
     im: DoubleArray;
 };
@@ -88,9 +87,15 @@ export declare interface ApodizationFilterOptions {
 }
 
 export declare interface ApodizationOptions {
-    lineBroadening: number;
-    gaussBroadening: number;
-    lineBroadeningCenter: number;
+    /**
+     * apply the window data to input data
+     * @default true
+     */
+    apply?: boolean;
+    /**
+     * parameters of the shape plus the kind of shape to identify
+     */
+    shapes?: Array<ShapeToAdd<FlexibleWindowFunctions>>;
 }
 
 /***
@@ -461,7 +466,7 @@ export { FiltersManager }
  */
 export declare function findMultiplet(name: string): MultipletDefinition | undefined;
 
-export declare type FlexibleWindowFunctions = Exponential<Partial<ExponentialOptions>> | LorentToGauss<Partial<LorentzToGaussOptions>> | SineBell<Partial<SineBellOptions>> | Traf<Partial<TrafOptions>> | ModifiedGaussian<Partial<ModifiedGaussianOptions>>;
+export declare type FlexibleWindowFunctions = Exponential<Partial<ExponentialOptions>> | LorentToGauss<Partial<LorentzToGaussOptions>> | SineBell<Partial<SineBellOptions>> | SineSquare<Partial<SineBellOptions>> | Traf<Partial<TrafOptions>> | ModifiedGaussian<Partial<ModifiedGaussianOptions>>;
 
 export declare interface ForwardLPOptions {
     /**
@@ -2320,17 +2325,17 @@ declare interface LorentzToGaussOptions {
      * Gaussian Broaden Width, Hz
      * @default 0
      */
-    gaussianHz?: number;
+    gaussBroadening?: number;
     /**
      * Inverse Exponential Width, Hz
      * @default 0
      */
-    exponentialHz?: number;
+    lineBroadening?: number;
     /**
      * Location of Gauss Maximum, this value should be between 0 to 1
-     * @default 0
+     * @default 1
      */
-    center?: number;
+    lineBroadeningCenter?: number;
 }
 
 declare type MakeMandatory<T, K extends keyof T> = T & {
@@ -2690,7 +2695,7 @@ export declare function optimizeSignals(data: DataXY, signals: Signal[], options
     delta: number;
     js: Jcoupling[];
     shape: {
-        kind: "gaussian" | "lorentzian" | "pseudoVoigt";
+        kind: "gaussian" | "lorentzian" | "pseudoVoigt" | "generalizedLorentzian";
         fwhm: number;
     };
     intensity: number;
@@ -2857,7 +2862,7 @@ declare interface OptionsXYAutoRangesPicking {
     logger?: Logger;
 }
 
-declare type Parameter = 'delta' | 'intensity' | 'fwhm' | 'mu' | 'coupling';
+declare type Parameter = 'delta' | 'intensity' | 'fwhm' | 'mu' | 'coupling' | 'gamma';
 
 declare type ParametersFromOptions = Record<Parameter, Record<string, number | ((options?: {
     signal?: Signal;
@@ -3407,6 +3412,11 @@ declare interface ShapeOptions<ShapeWindow = WindowFunctions> {
 }
 
 declare interface ShapeToAdd<ShapeWindows = WindowFunctions> {
+    /**
+     * if it is false the shape is not included in the apodization
+     * @default true
+     */
+    apply?: boolean;
     /**
      * Start Location for Applying Apodize Window
      */
@@ -3699,6 +3709,11 @@ declare interface SineBellOptions {
     length: number;
 }
 
+declare interface SineSquare<ShapeOption = SineBellOptions> {
+    kind: 'sineSquare';
+    options: ShapeOption;
+}
+
 export declare type Solvent = keyof typeof impuritiesContent;
 
 declare type Solvent_2 = keyof typeof impurities;
@@ -3872,7 +3887,7 @@ declare function unlink(range: Range_2, options?: UnlinkOptions): Range_2;
 
  export declare function updateRangesRelativeValues(spectrum: Entry1D, forceCalculateIntegral?: boolean): void;
 
- export declare type WindowFunctions = Exponential | LorentToGauss | SineBell | Traf | ModifiedGaussian;
+ export declare type WindowFunctions = Exponential | LorentToGauss | SineBell | SineSquare | Traf | ModifiedGaussian;
 
  /**
   * Predict back points by singular value decomposition.