nmr-processing 14.0.4 → 14.0.6

package/nmr-processing.d.ts

@@ -264,6 +264,21 @@ declare interface BooleanField extends Field<boolean> {
 
 declare type CacheResult = EmptyValue | PredictionBase1D | Promise<EmptyValue | PredictionBase1D>;
 
+export declare interface CalculateDiffussionCoefficientOptions {
+    /**
+     * gyromagnetic ratio, it is based in the nucleus
+     */
+    gyromagneticRatio: number;
+    /**
+     * pulse field gradient duraction, it assume that only the amplitude is variable.
+     */
+    gradientPulseDuration: number;
+    /**
+     * it depends of the experiment and include the diffusion time.
+     */
+    timeCorrection: number;
+}
+
 declare interface CalculateT1Options {
     optimization?: any;
 }
@@ -392,6 +407,16 @@ declare function deleteFilter(datum: Entry1D, id?: string, logger?: Logger): voi
 
 declare function deleteFilter_2(datum: Entry2D, id?: string, logger?: Logger): void;
 
+declare class DiffusionRegression extends BaseRegression {
+    coefficient: number;
+    signalAbsenseDiffussion: number;
+    gyromagneticRatio: number;
+    gradientPulseDuration: number;
+    timeCorrection: number;
+    constructor(coefficient: number, signalAbsenseDiffussion: number, options: CalculateDiffussionCoefficientOptions);
+    _predict(gradientAmplitude: number): number;
+}
+
 declare type DigitalFilter = FilterFactory<Entry1D, DigitalFilterOptions> & Pick<DigitalFilterOption, 'name'>;
 
 declare type DigitalFilter2D = FilterFactory<Entry2D, DigitalFilterOptions_2> & Pick<DigitalFilter2DOptions, 'name'>;
@@ -922,6 +947,7 @@ export declare interface Info1D extends Info {
 
 export declare interface Info2D extends Info {
     nucleus: string[];
+    isFtDimensionOne: boolean;
     digitalFilter?: number;
     originFrequency: number[];
     baseFrequency: number[];
@@ -2000,12 +2026,12 @@ declare namespace RangeUtilities {
 }
 export { RangeUtilities }
 
-declare function reapplyFilters(datum: Entry1D, options: {
+declare function reapplyFilters(datum: Entry1D, options?: {
     filters?: Filter1DOptions[];
     logger?: Logger;
 }): void;
 
-declare function reapplyFilters_2(datum: Entry2D, options: {
+declare function reapplyFilters_2(datum: Entry2D, options?: {
     filters?: Filter2DOptions[];
     logger?: Logger;
 }): void;
@@ -2565,6 +2591,20 @@ declare function unlink(range: Range_2, options?: UnlinkOptions): Range_2;
   */
  export declare function xyAutoRangesPicking(data: DataXY<Float64Array>, options: OptionsXYAutoRangesPicking): NMRRange[];
 
+ /**
+  * Estimate the diffusion coefficient of an independent component by fitting of imput data with the Stejskal–Tanner equation.
+  */
+ export declare function xyCalculateDiffussionCoefficient(
+ /**
+  * x is the amplitude of the pulse field gradient
+  * y is the exponential decay signal.
+  */
+ data: DataXY, options: CalculateDiffussionCoefficientOptions): {
+     regression: DiffusionRegression;
+     coefficient: number;
+     signalAbsenseDiffussion: number;
+ };
+
  export declare function xyCalculateT1(data: DataXY, options?: CalculateT1Options): {
      relaxationT1: number;
      fullMagnetization: number;