nmr-processing 22.1.0 → 22.2.0

package/dist/nmr-processing.d.ts

@@ -97,6 +97,8 @@ import type { SineBellOptions } from '@zakodium/nmr-types';
 import type { SymmetrizeCosyLikeOptions } from '@zakodium/nmr-types';
 import type { TopicMolecule } from 'openchemlib-utils';
 import type { TrafOptions } from '@zakodium/nmr-types';
+import type { TrimFilterOptions } from '@zakodium/nmr-types';
+import type { TrimOptions } from '@zakodium/nmr-types';
 import type { XRobustDistributionStats } from 'ml-spectra-processing';
 import type { XYNumber } from 'spectrum-generator';
 import type { ZeroFillingDimension1Options } from '@zakodium/nmr-types';
@@ -606,7 +608,7 @@ export declare function fftIndirectDimension(data: {
     im: DoubleArray[] | Matrix;
 }, options?: IndirectDimensionOptions): Record<string, Matrix>;
 
-export declare type Filter1D = FFT1D | BaselineCorrection1D | BackwardLinearPrediction1D | Apodization1D | DigitalFilter | EquallySpaced | ExclusionZones | ForwardLP1D | PhaseCorrection1D | ShiftX | SignalProcessing | ZeroFilling;
+export declare type Filter1D = FFT1D | BaselineCorrection1D | BackwardLinearPrediction1D | Apodization1D | DigitalFilter | EquallySpaced | ExclusionZones | ForwardLP1D | PhaseCorrection1D | ShiftX | SignalProcessing | Trim | ZeroFilling;
 
 export declare type Filter2D = ApodizationDimension1 | ApodizationDimension2 | BaselineCorrection2D | BackwardLPDimension1 | BackwardLPDimension2 | NUSDimension2 | FFTDimension1 | FFTDimension2 | FordwardLPDimension1 | FordwardLPDimension2 | DigitalFilter2D | PhaseCorrection2D | ZeroFillingDimension1 | ZeroFillingDimension2 | SymmetrizeCosyLike | Shift2DX | Shift2DY;
 
@@ -2515,6 +2517,41 @@ declare interface Traf<ShapeOption = TrafOptions> {
  */
 export declare function translateMultiplet(name: string): string;
 
+declare type Trim = FilterFactory<Entry1D, TrimOptions> & Pick<TrimFilterOptions, 'name'>;
+
+export declare interface TrimApplyOptions {
+    /**
+     * Percentage (0-100) of points to trim from the low side. If undefined, no percentage-based trimming is applied to the low.
+     * @default undefined
+     */
+    lowPercentage?: number;
+    /**
+     * Percentage (0-100) of points to trim from the high side. If undefined, no percentage-based trimming is applied to the high.
+     * @default undefined
+     */
+    highPercentage?: number;
+    /**
+     * Value of the leftmost point to keep. If set, all points to the low of this value are trimmed.
+     * @default undefined
+     */
+    lowValue?: number;
+    /**
+     * Value of the rightmost point to keep. If set, all points to the high of this value are trimmed.
+     * @default undefined
+     */
+    highValue?: number;
+    /**
+     * Number of points to remove from the low side. If set, trims this many points from the low.
+     * @default 0
+     */
+    lowNbPoints?: number;
+    /**
+     * Number of points to remove from the high side. If set, trims this many points from the high.
+     * @default 0
+     */
+    highNbPoints?: number;
+}
+
 /**
  * Options for specifying the region and resolution of the 2D spectrum
  */
@@ -2586,6 +2623,16 @@ export declare function xreimMultipletAnalysis(
  */
 data: DataXReOptionalIm, options?: XreimMultipletAnalysis): any;
 
+/**
+ * Trims the input arrays in the object by removing points from the low and high according to the provided options.
+ *
+ * @param input - The input data containing x (required), re (required), and optionally im arrays. All arrays must be of the same length.
+ * @param options - The trimming options specifying how many points or what range to trim.
+ * @throws Error if the x array is not sorted in ascending order.
+ * @returns A new DataXReOptionalIm object with trimmed x, re, and (if present) im arrays.
+ */
+export declare function xreimTrim(input: DataXReOptionalIm, options: TrimApplyOptions): DataXReOptionalIm;
+
 export declare function xyAutoPeaksPicking(data: DataXY<Float64Array>, options: OptionsXYAutoPeaksPicking): NMRPeak1DWithShapeID[];
 
 /**