@zakodium/nmr-types 0.5.0 → 0.5.1

package/dist/nmr-types.d.ts

@@ -206,7 +206,7 @@ declare interface Field<T> extends BaseField {
 
 export declare type Filter1DEntry = Filter1DOptions & BaseFilterEntry;
 
-export declare type Filter1DOptions = BaselineCorrectionFilterOptions | FFT1DOptions | ZeroFillingFilterOptions | SignalProcessingFilter | ShiftXFilterOptions | PhaseCorrection1DFilterOptions | ForwardLP1DOptions | ExclusionZonesOptions | EquallySpacedOptions | DigitalFilterOption | Apodization1DFilterOptions | BackwardLinearPredictionFilterOptions;
+export declare type Filter1DOptions = BaselineCorrectionFilterOptions | FFT1DOptions | ZeroFillingFilterOptions | SignalProcessingFilter | ShiftXFilterOptions | PhaseCorrection1DFilterOptions | ForwardLP1DOptions | ExclusionZonesOptions | EquallySpacedOptions | DigitalFilterOption | Apodization1DFilterOptions | BackwardLinearPredictionFilterOptions | TrimFilterOptions;
 
 export declare type Filter2DEntry = Filter2DOptions & BaseFilterEntry;
 
@@ -675,6 +675,47 @@ export declare interface TrafOptions {
     lineBroadening: number;
 }
 
+export declare interface TrimFilterOptions extends BaseFilter {
+    name: 'trim';
+    value: TrimOptions;
+}
+
+/**
+ * Options for trimming a 1D spectrum. All properties are optional and mutually exclusive, the function keep the largest value.
+ */
+export declare interface TrimOptions {
+    /**
+     * Percentage (0-100) of points to trim from the left side. If undefined, no percentage-based trimming is applied to the left.
+     * @default undefined
+     */
+    leftPercentage?: number;
+    /**
+     * Percentage (0-100) of points to trim from the right side. If undefined, no percentage-based trimming is applied to the right.
+     * @default undefined
+     */
+    rightPercentage?: number;
+    /**
+     * Value of the leftmost point to keep. If set, all points to the left of this value are trimmed.
+     * @default undefined
+     */
+    leftValue?: number;
+    /**
+     * Value of the rightmost point to keep. If set, all points to the right of this value are trimmed.
+     * @default undefined
+     */
+    rightValue?: number;
+    /**
+     * Number of points to remove from the left side. If set, trims this many points from the left.
+     * @default 0
+     */
+    leftNbPoints?: number;
+    /**
+     * Number of points to remove from the right side. If set, trims this many points from the right.
+     * @default 0
+     */
+    rightNbPoints?: number;
+}
+
 export declare interface WhittakerOptions {
     algorithm: 'whittaker';
     lambda?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zakodium/nmr-types",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Types related to NMR data processing.",
   "author": "Zakodium Sàrl",
   "license": "CC-BY-NC-SA-4.0",
@@ -28,15 +28,15 @@
     "esbuild": "^0.27.0",
     "rimraf": "^6.1.2",
     "typescript": "~5.9.3",
-    "vitest": "^4.0.14"
+    "vitest": "^4.0.17"
   },
   "dependencies": {
     "ml-peak-shape-generator": "^4.2.0",
     "ml-signal-processing": "^2.1.0",
-    "ml-spectra-processing": "^14.18.1"
+    "ml-spectra-processing": "^14.18.2"
   },
   "volta": {
     "extends": "../../../package.json"
   },
-  "gitHead": "0ff1a936a58bd6558cb50d8ec618e2dbf2f1f70b"
+  "gitHead": "18981bfb25a6cc4bc142629c7382d1375289d041"
 }