From 18a6bf80d7863490c68d9f9b6e84656336784ea2 Mon Sep 17 00:00:00 2001 From: mljs-bot Date: Thu, 29 Feb 2024 09:13:29 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20mljs/spe?= =?UTF-8?q?ctra-processing@8b2dae6c9563b0c026e956a4e7d61edb4030fd7a=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- functions/createFromToArray.html | 2 +- functions/createRandomArray.html | 2 +- functions/createStepArray.html | 2 +- functions/getOutputArray.html | 6 +++--- functions/getRescaler.html | 2 +- functions/isPowerOfTwo.html | 2 +- functions/matrixAbsoluteMedian.html | 2 +- functions/matrixApplyNumericalEncoding.html | 2 +- functions/matrixAutoCorrelation.html | 2 +- functions/matrixBoxPlot-1.html | 2 +- functions/matrixCenterZMean.html | 2 +- functions/matrixCheck.html | 2 +- functions/matrixClone.html | 2 +- functions/matrixColumnsCorrelation.html | 2 +- functions/matrixCreateEmpty.html | 5 +++-- functions/matrixHistogram.html | 2 +- functions/matrixMaxAbsoluteZ.html | 2 +- functions/matrixMedian.html | 2 +- functions/matrixMinMaxAbsoluteZ.html | 2 +- functions/matrixMinMaxZ.html | 2 +- functions/matrixNoiseStandardDeviation.html | 2 +- functions/matrixNumericalDecoding.html | 2 +- functions/matrixNumericalEncoding.html | 2 +- functions/matrixPQN.html | 2 +- functions/matrixSetSubMatrix.html | 2 +- functions/matrixToArray.html | 2 +- functions/matrixZPivotRescale.html | 2 +- functions/matrixZRescale.html | 2 +- functions/matrixZRescalePerColumn.html | 2 +- functions/nextPowerOfTwo.html | 2 +- functions/reimAbsolute.html | 2 +- functions/reimAutoPhaseCorrection.html | 2 +- functions/reimFFT.html | 2 +- functions/reimPhaseCorrection.html | 2 +- functions/xAbsolute.html | 2 +- functions/xAbsoluteMedian.html | 2 +- functions/xAdd.html | 2 +- functions/xApplyFunctionStr.html | 2 +- functions/xAutoCorrelation.html | 2 +- functions/xBoxPlot-1.html | 2 +- functions/xCheck.html | 2 +- functions/xCheckLengths.html | 2 +- functions/xCorrelation.html | 2 +- functions/xCostMatrix.html | 2 +- functions/xCrossCorrelation.html | 2 +- functions/xCumulative.html | 2 +- functions/xDivide.html | 2 +- functions/xDotProduct.html | 2 +- functions/xEnsureFloat64.html | 2 +- functions/xFindClosestIndex.html | 2 +- functions/xGetFromToIndex.html | 2 +- functions/xGetTargetIndex.html | 2 +- functions/xHilbertTransform.html | 2 +- functions/xHistogram.html | 2 +- functions/xIsEquallySpaced.html | 2 +- functions/xIsMonotonic.html | 2 +- functions/xMassCenterVectorSimilarity.html | 2 +- functions/xMaxAbsoluteValue.html | 2 +- functions/xMaxIndex.html | 2 +- functions/xMaxValue.html | 2 +- functions/xMean.html | 2 +- functions/xMeanAbsoluteError.html | 2 +- functions/xMeanSquaredError.html | 2 +- functions/xMeanWeighted.html | 2 +- functions/xMedian.html | 2 +- functions/xMedianAbsoluteDeviation.html | 2 +- functions/xMinIndex.html | 2 +- functions/xMinMaxDelta.html | 2 +- functions/xMinMaxValues.html | 2 +- functions/xMinValue.html | 2 +- functions/xMode.html | 2 +- functions/xMultiply.html | 2 +- functions/xNoiseSanPlot.html | 2 +- functions/xNoiseStandardDeviation.html | 2 +- functions/xNorm.html | 2 +- functions/xNormed.html | 2 +- functions/xPadding.html | 2 +- functions/xParetoNormalization.html | 2 +- functions/xRescale.html | 2 +- functions/xRolling.html | 2 +- functions/xRollingAverage.html | 2 +- functions/xRollingMax.html | 2 +- functions/xRollingMedian.html | 2 +- functions/xRollingMin.html | 2 +- functions/xRotate.html | 2 +- functions/xSampling.html | 2 +- functions/xSequentialFill.html | 6 +++--- functions/xSortAscending.html | 5 +++-- functions/xSortDescending.html | 2 +- functions/xStandardDeviation.html | 2 +- functions/xSubtract.html | 2 +- functions/xSum.html | 2 +- functions/xUniqueSorted.html | 2 +- functions/xVariance.html | 2 +- functions/xreimSortX.html | 2 +- functions/xreimZeroFilling.html | 2 +- functions/xy2ToXY.html | 2 +- functions/xyAlign.html | 2 +- functions/xyArrayAlign.html | 2 +- functions/xyArrayAlignToFirst.html | 2 +- functions/xyArrayMerge.html | 2 +- functions/xyArrayWeightedMerge.html | 2 +- functions/xyCheck.html | 2 +- functions/xyCovariance.html | 2 +- .../xyCumulativeDistributionStatistics.html | 2 +- functions/xyEnsureGrowingX.html | 2 +- functions/xyEquallySpaced.html | 2 +- functions/xyExtract.html | 2 +- functions/xyFilter.html | 2 +- functions/xyFilterMinYValue.html | 2 +- functions/xyFilterTopYValues.html | 2 +- functions/xyFilterX.html | 2 +- functions/xyFilterXPositive.html | 2 +- functions/xyFindClosestPoint.html | 2 +- functions/xyGetNMaxY.html | 2 +- functions/xyGrowingX.html | 2 +- functions/xyIntegral.html | 2 +- functions/xyIntegration.html | 2 +- functions/xyJoinX.html | 2 +- functions/xyMassCenterVector.html | 2 +- functions/xyMaxClosestYPoint.html | 2 +- functions/xyMaxMerge.html | 2 +- functions/xyMaxY.html | 2 +- functions/xyMaxYPoint.html | 2 +- functions/xyMaximaY.html | 2 +- functions/xyMedian.html | 2 +- functions/xyMergeByCentroids.html | 2 +- functions/xyMinClosestYPoint.html | 2 +- functions/xyMinYPoint.html | 2 +- functions/xyMinimaY.html | 2 +- functions/xyObjectBestPoints.html | 2 +- functions/xyObjectCheck.html | 2 +- functions/xyObjectJoinX.html | 2 +- functions/xyObjectMaxXPoint.html | 2 +- functions/xyObjectMaxYPoint.html | 2 +- functions/xyObjectMinXPoint.html | 2 +- functions/xyObjectMinYPoint.html | 2 +- functions/xyObjectSlotX.html | 2 +- functions/xyObjectSortX.html | 2 +- functions/xyObjectSumY.html | 2 +- functions/xyObjectToXY.html | 2 +- functions/xyPeakInfo-1.html | 2 +- functions/xyRealMaxYPoint.html | 2 +- functions/xyRealMinYPoint.html | 2 +- functions/xyReduce.html | 2 +- functions/xyRolling.html | 2 +- functions/xySetYValue.html | 2 +- functions/xySortX.html | 2 +- functions/xyToXYArray.html | 2 +- functions/xyToXYObject.html | 2 +- functions/xyUniqueX.html | 2 +- functions/xyWeightedMerge.html | 2 +- functions/zonesNormalize.html | 2 +- functions/zonesWithPoints.html | 2 +- interfaces/AutoPhaseCorrectionOptions.html | 12 ++++++------ interfaces/CreateFromToArrayOptions.html | 14 +++++++------- interfaces/CreateRandomArrayOptions.html | 14 +++++++------- interfaces/CreateStepArrayOptions.html | 8 ++++---- interfaces/DataReIm.html | 6 +++--- interfaces/DataXReIm.html | 8 ++++---- interfaces/FromToWithNumberOfPoints.html | 4 ++-- interfaces/GetRescalerOptions.html | 16 ++++++++-------- interfaces/MatrixBoxPlot.html | 4 ++-- interfaces/MatrixCreateEmptyOptions.html | 10 +++++----- interfaces/MatrixHistogramOptions.html | 18 +++++++++--------- interfaces/MatrixPQNOptions.html | 6 +++--- interfaces/MatrixZPivotRescaleOptions.html | 6 +++--- interfaces/MatrixZRescaleOptions.html | 8 ++++---- interfaces/MatrixZRescalePerColumnOptions.html | 6 +++--- interfaces/Point.html | 8 ++++---- interfaces/PointWithIndex.html | 8 ++++---- interfaces/ReimFFTOptions.html | 4 ++-- interfaces/ReimPhaseCorrectionOptions.html | 4 ++-- interfaces/XApplyFunctionStrOptions.html | 6 +++--- interfaces/XAutoCorrelationOptions.html | 6 +++--- interfaces/XBoxPlot.html | 4 ++-- interfaces/XBoxPlotOptions.html | 4 ++-- interfaces/XCheckOptions.html | 4 ++-- interfaces/XCrossCorrelationOptions.html | 6 +++--- interfaces/XDivideOptions.html | 4 ++-- interfaces/XFindClosestIndexOptions.html | 4 ++-- interfaces/XGetFromToIndexOptions.html | 10 +++++----- interfaces/XGetTargetIndexOptions.html | 6 +++--- interfaces/XHilbertTransformOptions.html | 4 ++-- interfaces/XHistogramOptions.html | 18 +++++++++--------- interfaces/XIsEquallySpacedOptions.html | 4 ++-- interfaces/XMultiplyOptions.html | 4 ++-- interfaces/XNoiseSanPlotOptions.html | 18 +++++++++--------- interfaces/XNormedOptions.html | 8 ++++---- interfaces/XPaddingOptions.html | 8 ++++---- interfaces/XRescaleOptions.html | 8 ++++---- interfaces/XRollingOptions.html | 6 +++--- interfaces/XSamplingOptions.html | 4 ++-- interfaces/XSequentialFillOptions.html | 10 +++++----- interfaces/XVarianceOptions.html | 6 +++--- interfaces/XYAlignOptions.html | 8 ++++---- interfaces/XYAlignResult.html | 4 ++-- interfaces/XYArrayAlignOptions.html | 6 +++--- interfaces/XYArrayAlignToFirstOptions.html | 4 ++-- interfaces/XYArrayMergeOptions.html | 4 ++-- interfaces/XYArrayWeightedMergeOptions.html | 4 ++-- interfaces/XYCovarianceOptions.html | 4 ++-- ...CumulativeDistributionStatisticsResult.html | 4 ++-- interfaces/XYEquallySpacedOptions.html | 14 +++++++------- interfaces/XYExtractOptions.html | 4 ++-- interfaces/XYFilterOptions.html | 4 ++-- interfaces/XYFilterXOptions.html | 10 +++++----- interfaces/XYIntegralOptions.html | 12 ++++++------ interfaces/XYJoinXOptions.html | 4 ++-- interfaces/XYMassCenterVectorOptions.html | 4 ++-- interfaces/XYMaxClosestYPointOptions.html | 6 +++--- interfaces/XYMaxYOptions.html | 10 +++++----- interfaces/XYMaxYPointOptions.html | 10 +++++----- interfaces/XYMergeByCentroidsOptions.html | 4 ++-- interfaces/XYMinClosestYPointOptions.html | 6 +++--- interfaces/XYMinYPointOptions.html | 10 +++++----- interfaces/XYObjectBestPointsOptions.html | 14 +++++++------- interfaces/XYObjectJoinXOptions.html | 4 ++-- interfaces/XYObjectSlotXOptions.html | 4 ++-- interfaces/XYPeakInfo.html | 4 ++-- interfaces/XYPeakInfoOptions.html | 4 ++-- interfaces/XYReduceOptions.html | 12 ++++++------ interfaces/XYSetYValueOptions.html | 4 ++-- interfaces/XYUniqueXOptions.html | 6 +++--- interfaces/ZonesNormalizeOptions.html | 8 ++++---- interfaces/ZonesWithPointsOptions.html | 6 +++--- types/DoubleArrayConstructor.html | 2 +- types/DoubleArrayType.html | 2 +- types/DoubleMatrix.html | 2 +- types/RescalerAlgorithm.html | 2 +- 230 files changed, 425 insertions(+), 423 deletions(-) diff --git a/functions/createFromToArray.html b/functions/createFromToArray.html index 41a56a54..0c296c1a 100644 --- a/functions/createFromToArray.html +++ b/functions/createFromToArray.html @@ -6,4 +6,4 @@

Returns Float64Array

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createRandomArray.html b/functions/createRandomArray.html index 850174f3..59520fc5 100644 --- a/functions/createRandomArray.html +++ b/functions/createRandomArray.html @@ -5,4 +5,4 @@

Parameters

Returns Float64Array

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/createStepArray.html b/functions/createStepArray.html index f8e3e890..c4a7eda9 100644 --- a/functions/createStepArray.html +++ b/functions/createStepArray.html @@ -6,4 +6,4 @@

Returns Float64Array

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/getOutputArray.html b/functions/getOutputArray.html index 8bc5b2c8..98cfba3a 100644 --- a/functions/getOutputArray.html +++ b/functions/getOutputArray.html @@ -4,10 +4,10 @@

Function getOutputArray

  • getOutputArray<T>(output, length): T

  • This function

    Type Parameters

    • T extends NumberArray = Float64Array

    Parameters

    • output: T

      undefined or a new array

    • length: number

      length of the output array

      -

    Returns T

  • getOutputArray(output, length): Float64Array

  • This function

    +

Returns T

  • getOutputArray(output, length): Float64Array

  • This function

    Parameters

    • output: undefined

      undefined or a new array

    • length: number

      length of the output array

      -

    Returns Float64Array

  • getOutputArray<T>(output, length): T

  • This function

    +

    • Returns Float64Array

  • getOutputArray<T>(output, length): T

  • This function

    Type Parameters

    • T extends NumberArray = Float64Array

    Parameters

    • output: undefined | T

      undefined or a new array

    • length: number

      length of the output array

      -

    Returns T

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getRescaler.html b/functions/getRescaler.html index 1457d214..39eb40b2 100644 --- a/functions/getRescaler.html +++ b/functions/getRescaler.html @@ -1,4 +1,4 @@ getRescaler | ml-spectra-processing

    Function getRescaler

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Function getRescaler

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/isPowerOfTwo.html b/functions/isPowerOfTwo.html index 2b771774..40c47503 100644 --- a/functions/isPowerOfTwo.html +++ b/functions/isPowerOfTwo.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function isPowerOfTwo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixAbsoluteMedian.html b/functions/matrixAbsoluteMedian.html index 8ad50f7b..2b492233 100644 --- a/functions/matrixAbsoluteMedian.html +++ b/functions/matrixAbsoluteMedian.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixAbsoluteMedian

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixApplyNumericalEncoding.html b/functions/matrixApplyNumericalEncoding.html index e5b8f368..671e0746 100644 --- a/functions/matrixApplyNumericalEncoding.html +++ b/functions/matrixApplyNumericalEncoding.html @@ -7,4 +7,4 @@

    Returns number[][]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixAutoCorrelation.html b/functions/matrixAutoCorrelation.html index f7d1e51e..edb1ef3f 100644 --- a/functions/matrixAutoCorrelation.html +++ b/functions/matrixAutoCorrelation.html @@ -1,4 +1,4 @@ matrixAutoCorrelation | ml-spectra-processing

    Function matrixAutoCorrelation

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Function matrixAutoCorrelation

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixBoxPlot-1.html b/functions/matrixBoxPlot-1.html index 7bc18c8f..b7b75553 100644 --- a/functions/matrixBoxPlot-1.html +++ b/functions/matrixBoxPlot-1.html @@ -1,4 +1,4 @@ matrixBoxPlot | ml-spectra-processing

    Function matrixBoxPlot

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Function matrixBoxPlot

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixCenterZMean.html b/functions/matrixCenterZMean.html index 5bc2319b..63cb324a 100644 --- a/functions/matrixCenterZMean.html +++ b/functions/matrixCenterZMean.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixCenterZMean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixCheck.html b/functions/matrixCheck.html index 9aca7170..d4d99c94 100644 --- a/functions/matrixCheck.html +++ b/functions/matrixCheck.html @@ -1,4 +1,4 @@ matrixCheck | ml-spectra-processing

    Function matrixCheck

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Function matrixCheck

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixClone.html b/functions/matrixClone.html index ec8ad309..0073e4a3 100644 --- a/functions/matrixClone.html +++ b/functions/matrixClone.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixClone

    • matrixClone<ValueType>(matrix): ValueType[][]

    • Clone a matrix.

      -

      Type Parameters

      • ValueType

      Parameters

      • matrix: ValueType[][]

      Returns ValueType[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Parameters

    Returns ValueType[][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixColumnsCorrelation.html b/functions/matrixColumnsCorrelation.html index 8fc01403..540df183 100644 --- a/functions/matrixColumnsCorrelation.html +++ b/functions/matrixColumnsCorrelation.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixColumnsCorrelation

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixCreateEmpty.html b/functions/matrixCreateEmpty.html index a6184b5d..a5ae7eda 100644 --- a/functions/matrixCreateEmpty.html +++ b/functions/matrixCreateEmpty.html @@ -1,5 +1,6 @@ matrixCreateEmpty | ml-spectra-processing

    Function matrixCreateEmpty

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Function matrixCreateEmpty

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixHistogram.html b/functions/matrixHistogram.html index 73e98b99..ce0f47b6 100644 --- a/functions/matrixHistogram.html +++ b/functions/matrixHistogram.html @@ -7,4 +7,4 @@

    Returns DataXY

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixMaxAbsoluteZ.html b/functions/matrixMaxAbsoluteZ.html index 21e8acf8..38873fb4 100644 --- a/functions/matrixMaxAbsoluteZ.html +++ b/functions/matrixMaxAbsoluteZ.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixMaxAbsoluteZ

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixMedian.html b/functions/matrixMedian.html index 7b40507a..65faa041 100644 --- a/functions/matrixMedian.html +++ b/functions/matrixMedian.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixMedian

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixMinMaxAbsoluteZ.html b/functions/matrixMinMaxAbsoluteZ.html index 1022633d..6bbae2f1 100644 --- a/functions/matrixMinMaxAbsoluteZ.html +++ b/functions/matrixMinMaxAbsoluteZ.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixMinMaxAbsoluteZ

    • matrixMinMaxAbsoluteZ(matrix): {
          max: number;
          min: number;
      }

    • Get min and max of the absolute values of Z.

      Parameters

      Returns {
          max: number;
          min: number;
      }

      • max: number
      • min: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        max: number;
        min: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixMinMaxZ.html b/functions/matrixMinMaxZ.html index 8468045f..24876e51 100644 --- a/functions/matrixMinMaxZ.html +++ b/functions/matrixMinMaxZ.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixMinMaxZ

    • matrixMinMaxZ(matrix): {
          max: number;
          min: number;
      }

    • Get min and max Z.

      Parameters

      Returns {
          max: number;
          min: number;
      }

      • max: number
      • min: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        max: number;
        min: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixNoiseStandardDeviation.html b/functions/matrixNoiseStandardDeviation.html index f630f47e..9120be95 100644 --- a/functions/matrixNoiseStandardDeviation.html +++ b/functions/matrixNoiseStandardDeviation.html @@ -8,4 +8,4 @@

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixNumericalDecoding.html b/functions/matrixNumericalDecoding.html index c22afe1a..373edb67 100644 --- a/functions/matrixNumericalDecoding.html +++ b/functions/matrixNumericalDecoding.html @@ -6,4 +6,4 @@

    Returns (string | number)[][]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixNumericalEncoding.html b/functions/matrixNumericalEncoding.html index 422ab4a0..659bda92 100644 --- a/functions/matrixNumericalEncoding.html +++ b/functions/matrixNumericalEncoding.html @@ -6,4 +6,4 @@

    Returns {
        dictCategoricalToNumerical: Record<string, number>;
        matrix: number[][];
    }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixPQN.html b/functions/matrixPQN.html index 445e569c..e1e502ad 100644 --- a/functions/matrixPQN.html +++ b/functions/matrixPQN.html @@ -9,4 +9,4 @@

    Returns {
        data: number[][];
        medianOfQuotients: number[];
    }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixSetSubMatrix.html b/functions/matrixSetSubMatrix.html index 62a5d226..b8b3c504 100644 --- a/functions/matrixSetSubMatrix.html +++ b/functions/matrixSetSubMatrix.html @@ -8,4 +8,4 @@
  • startRow: number

    row index in matrix for the first row in subMatrix.

  • startColumn: number

    column index in matrix for the first column in subMatrix.

    • Returns DoubleMatrix

    The modified matrix.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixToArray.html b/functions/matrixToArray.html index c2bd788e..e524777a 100644 --- a/functions/matrixToArray.html +++ b/functions/matrixToArray.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function matrixToArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixZPivotRescale.html b/functions/matrixZPivotRescale.html index 76e7f06d..b74b9769 100644 --- a/functions/matrixZPivotRescale.html +++ b/functions/matrixZPivotRescale.html @@ -4,4 +4,4 @@

    Function matrixZPivotRescale

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DoubleArrayType<DoubleArrayConstructor>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixZRescale.html b/functions/matrixZRescale.html index 837f63a4..cb17aa30 100644 --- a/functions/matrixZRescale.html +++ b/functions/matrixZRescale.html @@ -4,4 +4,4 @@

    Function matrixZRescale

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DoubleArrayType<DoubleArrayConstructor>[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/matrixZRescalePerColumn.html b/functions/matrixZRescalePerColumn.html index 172db19f..1b24d108 100644 --- a/functions/matrixZRescalePerColumn.html +++ b/functions/matrixZRescalePerColumn.html @@ -4,4 +4,4 @@

    Function matrixZRescalePerColumn

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/nextPowerOfTwo.html b/functions/nextPowerOfTwo.html index fa72abdb..4b836f45 100644 --- a/functions/nextPowerOfTwo.html +++ b/functions/nextPowerOfTwo.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function nextPowerOfTwo

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/reimAbsolute.html b/functions/reimAbsolute.html index b99f34f1..4cb27613 100644 --- a/functions/reimAbsolute.html +++ b/functions/reimAbsolute.html @@ -6,4 +6,4 @@

    Returns Float64Array

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/reimAutoPhaseCorrection.html b/functions/reimAutoPhaseCorrection.html index acc22c2e..782031fe 100644 --- a/functions/reimAutoPhaseCorrection.html +++ b/functions/reimAutoPhaseCorrection.html @@ -5,4 +5,4 @@ correction algorithm for high-resolution NMR data. 10.1002/mrc.4586

    Parameters

    Returns {
        data: DataReIm<Float64Array>;
        ph0: number;
        ph1: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        data: DataReIm<Float64Array>;
        ph0: number;
        ph1: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/reimFFT.html b/functions/reimFFT.html index ab710033..2ec11cc5 100644 --- a/functions/reimFFT.html +++ b/functions/reimFFT.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataReIm<Float64Array>

    FFT of complex spectrum.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/reimPhaseCorrection.html b/functions/reimPhaseCorrection.html index 8983ad45..03221ded 100644 --- a/functions/reimPhaseCorrection.html +++ b/functions/reimPhaseCorrection.html @@ -8,4 +8,4 @@
  • options: ReimPhaseCorrectionOptions = {}

    • Returns DataReIm<Float64Array>

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xAbsolute.html b/functions/xAbsolute.html index da5b5c17..9f55c210 100644 --- a/functions/xAbsolute.html +++ b/functions/xAbsolute.html @@ -6,4 +6,4 @@

    Returns ArrayType

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xAbsoluteMedian.html b/functions/xAbsoluteMedian.html index 1d686cd2..c99db6ce 100644 --- a/functions/xAbsoluteMedian.html +++ b/functions/xAbsoluteMedian.html @@ -6,4 +6,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xAdd.html b/functions/xAdd.html index 3c5c0c7e..ce8e1451 100644 --- a/functions/xAdd.html +++ b/functions/xAdd.html @@ -4,4 +4,4 @@

    Function xAdd

    • xAdd(array1, array2): Float64Array

    • This function xAdd the first array by the second array or a constant value to each element of the first array

      Parameters

      • array1: DoubleArray

        the first array

      • array2: number | DoubleArray

        the second array or number

        -

      Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xApplyFunctionStr.html b/functions/xApplyFunctionStr.html index b3d2ed2f..870c485a 100644 --- a/functions/xApplyFunctionStr.html +++ b/functions/xApplyFunctionStr.html @@ -5,4 +5,4 @@ By default we will use as variable 'x' In front of sequence of lowercase we will add 'Math.'. This allows to write sin(x) + cos(x) and it will be replace internally by (x) => (Math.sin(x) + Math.cos(x))

    -

    Parameters

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xAutoCorrelation.html b/functions/xAutoCorrelation.html index bdccf98b..971f23dc 100644 --- a/functions/xAutoCorrelation.html +++ b/functions/xAutoCorrelation.html @@ -4,4 +4,4 @@

    Function xAutoCorrelation

    • xAutoCorrelation(A, options?): Float64Array

    • Calculates the auto-correlation of an array

      Parameters

      Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xBoxPlot-1.html b/functions/xBoxPlot-1.html index bae0b441..6f690ba3 100644 --- a/functions/xBoxPlot-1.html +++ b/functions/xBoxPlot-1.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xBoxPlot

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • options: XBoxPlotOptions = {}

    • Returns XBoxPlot

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCheck.html b/functions/xCheck.html index fcbcf7ea..98c75b8b 100644 --- a/functions/xCheck.html +++ b/functions/xCheck.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xCheck

    • xCheck(input?, options?): asserts input is NumberArray

    • Checks if input is of type array.

      Parameters

      Returns asserts input is NumberArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • options: XCheckOptions = {}

    • Returns asserts input is NumberArray

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCheckLengths.html b/functions/xCheckLengths.html index df985b65..9966f0d4 100644 --- a/functions/xCheckLengths.html +++ b/functions/xCheckLengths.html @@ -4,4 +4,4 @@

    Function xCheckLengths

    • xCheckLengths(array1, array2): void

    • Check that two arrays have the same length.

      Parameters

      • array1: NumberArray

        First array.

      • array2: NumberArray

        Second array.

        -

      Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCorrelation.html b/functions/xCorrelation.html index 90b41a52..56571338 100644 --- a/functions/xCorrelation.html +++ b/functions/xCorrelation.html @@ -5,4 +5,4 @@ https://en.wikipedia.org/wiki/Correlation_and_dependence

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCostMatrix.html b/functions/xCostMatrix.html index f5470556..9a4559f6 100644 --- a/functions/xCostMatrix.html +++ b/functions/xCostMatrix.html @@ -8,4 +8,4 @@
  • options: XCostMatrixOptions = {}

    • Returns Matrix

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCrossCorrelation.html b/functions/xCrossCorrelation.html index a60931e9..b6c5f189 100644 --- a/functions/xCrossCorrelation.html +++ b/functions/xCrossCorrelation.html @@ -5,4 +5,4 @@

    Parameters

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xCumulative.html b/functions/xCumulative.html index baf8c522..56a2f4ed 100644 --- a/functions/xCumulative.html +++ b/functions/xCumulative.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xCumulative

    • xCumulative(array): Float64Array

    • Calculate an array of the same size that is the cumulative values

      Parameters

      • array: DoubleArray

        initial array

        -

      Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xDivide.html b/functions/xDivide.html index f339f8b7..99c8c95a 100644 --- a/functions/xDivide.html +++ b/functions/xDivide.html @@ -5,4 +5,4 @@

    Type Parameters

    Parameters

    Returns ArrayType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns ArrayType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xDotProduct.html b/functions/xDotProduct.html index 0e6ef943..d677140c 100644 --- a/functions/xDotProduct.html +++ b/functions/xDotProduct.html @@ -4,4 +4,4 @@

    Function xDotProduct

    • xDotProduct(A, B): number

    • Dot product between two arrays.

      Parameters

      • A: DoubleArray

        First array.

      • B: DoubleArray

        Second array.

        -

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xEnsureFloat64.html b/functions/xEnsureFloat64.html index 36ba0f72..cc61a56d 100644 --- a/functions/xEnsureFloat64.html +++ b/functions/xEnsureFloat64.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xEnsureFloat64

    • xEnsureFloat64(array): Float64Array

    • Returns a copy of the data as a Float64Array.

      Parameters

      • array: NumberArray

        array of numbers

        -

      Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xFindClosestIndex.html b/functions/xFindClosestIndex.html index c6a24d9d..5b2516c2 100644 --- a/functions/xFindClosestIndex.html +++ b/functions/xFindClosestIndex.html @@ -7,4 +7,4 @@
  • options: XFindClosestIndexOptions = {}

    • Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xGetFromToIndex.html b/functions/xGetFromToIndex.html index 1d93692a..a73a24f7 100644 --- a/functions/xGetFromToIndex.html +++ b/functions/xGetFromToIndex.html @@ -4,4 +4,4 @@

    Function xGetFromToIndex

    • xGetFromToIndex(x, options?): {
          fromIndex: number;
          toIndex: number;
      }

    • Returns an object with {fromIndex, toIndex} for a specific from / to

      Parameters

      Returns {
          fromIndex: number;
          toIndex: number;
      }

      • fromIndex: number
      • toIndex: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        fromIndex: number;
        toIndex: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xGetTargetIndex.html b/functions/xGetTargetIndex.html index 9b8a4c74..33882d43 100644 --- a/functions/xGetTargetIndex.html +++ b/functions/xGetTargetIndex.html @@ -4,4 +4,4 @@

    Function xGetTargetIndex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xHilbertTransform.html b/functions/xHilbertTransform.html index d62eabd6..308a141d 100644 --- a/functions/xHilbertTransform.html +++ b/functions/xHilbertTransform.html @@ -5,4 +5,4 @@

    Parameters

    Returns Float64Array

    A new vector with 90 degree shift regarding the phase of the original function

    Link

    https://en.wikipedia.org/wiki/Hilbert_transform

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xHistogram.html b/functions/xHistogram.html index 88bd5dca..a224fa8e 100644 --- a/functions/xHistogram.html +++ b/functions/xHistogram.html @@ -7,4 +7,4 @@

    Returns {
        x: DoubleArray;
        y: DoubleArray;
    }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xIsEquallySpaced.html b/functions/xIsEquallySpaced.html index b805acef..0f47d1fe 100644 --- a/functions/xIsEquallySpaced.html +++ b/functions/xIsEquallySpaced.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xIsEquallySpaced

    • xIsEquallySpaced(array, options?): boolean

    • Check if the values are separated always by the same difference

      Parameters

      Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • options: XIsEquallySpacedOptions = {}

    • Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xIsMonotonic.html b/functions/xIsMonotonic.html index 0d318b52..0028e6ab 100644 --- a/functions/xIsMonotonic.html +++ b/functions/xIsMonotonic.html @@ -4,4 +4,4 @@

    Function xIsMonotonic

    • xIsMonotonic(array): -1 | 0 | 1

    • Returns true if x is monotonic.

      Parameters

      • array: DoubleArray

        array of numbers.

      Returns -1 | 0 | 1

      1 if monotonic increasing, -1 if monotonic decreasing, 0 if not monotonic.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMassCenterVectorSimilarity.html b/functions/xMassCenterVectorSimilarity.html index a170c95a..82ffc1fa 100644 --- a/functions/xMassCenterVectorSimilarity.html +++ b/functions/xMassCenterVectorSimilarity.html @@ -2,4 +2,4 @@ window.__typeDocPluginKatexOptions={"delimiters":[{"left":"$","right":"$","display":true}],"fleqn":"true","leqno":"false"}; window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xMassCenterVectorSimilarity

    • xMassCenterVectorSimilarity(array1, array2, options?): number

    • Check the similarity between array created by xyMassCenterVector

      -

      Parameters

      • array1: NumberArray
      • array2: NumberArray
      • options: XMassCenterVectorSimilarityOptions = {}

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMaxAbsoluteValue.html b/functions/xMaxAbsoluteValue.html index 616d2ac6..5025b8a4 100644 --- a/functions/xMaxAbsoluteValue.html +++ b/functions/xMaxAbsoluteValue.html @@ -4,4 +4,4 @@

    Function xMaxAbsoluteValue

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMaxIndex.html b/functions/xMaxIndex.html index 6a125c67..86679828 100644 --- a/functions/xMaxIndex.html +++ b/functions/xMaxIndex.html @@ -7,4 +7,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMaxValue.html b/functions/xMaxValue.html index 8cf55b0f..1942e2ad 100644 --- a/functions/xMaxValue.html +++ b/functions/xMaxValue.html @@ -4,4 +4,4 @@

    Function xMaxValue

    • xMaxValue(array, options?): number

    • Computes the maximal value of an array of values

      Parameters

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMean.html b/functions/xMean.html index e8a62213..b21a9ab1 100644 --- a/functions/xMean.html +++ b/functions/xMean.html @@ -4,4 +4,4 @@

    Function xMean

    • xMean(array, options?): number

    • Computes the mean value of an array of values.

      Parameters

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMeanAbsoluteError.html b/functions/xMeanAbsoluteError.html index 27557e6e..aa176da0 100644 --- a/functions/xMeanAbsoluteError.html +++ b/functions/xMeanAbsoluteError.html @@ -4,4 +4,4 @@

    Function xMeanAbsoluteError

    • xMeanAbsoluteError(array1, array2): number

    • This function calculates the mean absolute error.

      Parameters

      • array1: DoubleArray

        first array

      • array2: DoubleArray

        second array

        -

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMeanSquaredError.html b/functions/xMeanSquaredError.html index ea6ffa05..7ddb5741 100644 --- a/functions/xMeanSquaredError.html +++ b/functions/xMeanSquaredError.html @@ -4,4 +4,4 @@

    Function xMeanSquaredError

    • xMeanSquaredError(array1, array2): number

    • This function calculates the mean squared error.

      Parameters

      • array1: DoubleArray

        first array

      • array2: DoubleArray

        second array

        -

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMeanWeighted.html b/functions/xMeanWeighted.html index 5dcbad84..8eedf78c 100644 --- a/functions/xMeanWeighted.html +++ b/functions/xMeanWeighted.html @@ -5,4 +5,4 @@

    Parameters

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMedian.html b/functions/xMedian.html index e32470f7..6ae4f2df 100644 --- a/functions/xMedian.html +++ b/functions/xMedian.html @@ -6,4 +6,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMedianAbsoluteDeviation.html b/functions/xMedianAbsoluteDeviation.html index 9c8d010f..629cdbce 100644 --- a/functions/xMedianAbsoluteDeviation.html +++ b/functions/xMedianAbsoluteDeviation.html @@ -5,4 +5,4 @@ https://en.wikipedia.org/wiki/Median_absolute_deviation

    Parameters

    Returns {
        mad: number;
        median: number;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMinIndex.html b/functions/xMinIndex.html index 0a311b16..c838bc8d 100644 --- a/functions/xMinIndex.html +++ b/functions/xMinIndex.html @@ -7,4 +7,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMinMaxDelta.html b/functions/xMinMaxDelta.html index 0326c5fb..370b15b3 100644 --- a/functions/xMinMaxDelta.html +++ b/functions/xMinMaxDelta.html @@ -6,4 +6,4 @@

    Returns {
        max: number;
        min: number;
    }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMinMaxValues.html b/functions/xMinMaxValues.html index 2c276b4a..75933daf 100644 --- a/functions/xMinMaxValues.html +++ b/functions/xMinMaxValues.html @@ -6,4 +6,4 @@

    Returns {
        max: number;
        min: number;
    }

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMinValue.html b/functions/xMinValue.html index 01243e2f..687d89bc 100644 --- a/functions/xMinValue.html +++ b/functions/xMinValue.html @@ -4,4 +4,4 @@

    Function xMinValue

    • xMinValue(array, options?): number

    • Computes the minimal value of an array of values.

      Parameters

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMode.html b/functions/xMode.html index a83f79a9..1f676c99 100644 --- a/functions/xMode.html +++ b/functions/xMode.html @@ -6,4 +6,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xMultiply.html b/functions/xMultiply.html index 8c4ab14a..d87f3c52 100644 --- a/functions/xMultiply.html +++ b/functions/xMultiply.html @@ -5,4 +5,4 @@

    Type Parameters

    Parameters

    Returns ArrayType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns ArrayType

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xNoiseSanPlot.html b/functions/xNoiseSanPlot.html index 50f0b380..6fcab5bd 100644 --- a/functions/xNoiseSanPlot.html +++ b/functions/xNoiseSanPlot.html @@ -5,4 +5,4 @@

    Parameters

    Returns {
        negative: number;
        positive: number;
        sanplot: Record<string, DataXY>;
        snr: number;
    }

    noise level

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xNoiseStandardDeviation.html b/functions/xNoiseStandardDeviation.html index 5ea89898..65ea5e20 100644 --- a/functions/xNoiseStandardDeviation.html +++ b/functions/xNoiseStandardDeviation.html @@ -8,4 +8,4 @@

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xNorm.html b/functions/xNorm.html index 4f843951..75266300 100644 --- a/functions/xNorm.html +++ b/functions/xNorm.html @@ -8,4 +8,4 @@

    Example

    xNorm([3, 4]) -> 5
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xNormed.html b/functions/xNormed.html index 41a7e2c0..1a9a045b 100644 --- a/functions/xNormed.html +++ b/functions/xNormed.html @@ -7,4 +7,4 @@

    Returns ArrayType

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xPadding.html b/functions/xPadding.html index e72fe3bb..54c8ce91 100644 --- a/functions/xPadding.html +++ b/functions/xPadding.html @@ -5,4 +5,4 @@ s

    Parameters

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Float64Array

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xParetoNormalization.html b/functions/xParetoNormalization.html index cc2b88a0..561f567c 100644 --- a/functions/xParetoNormalization.html +++ b/functions/xParetoNormalization.html @@ -5,4 +5,4 @@ Noda, I. (2008). Scaling techniques to enhance two-dimensional correlation spectra. Journal of Molecular Structure, 883, 216-227. DOI: 10.1016/j.molstruc.2007.12.026

    Parameters

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRescale.html b/functions/xRescale.html index 546a237f..2b8543cb 100644 --- a/functions/xRescale.html +++ b/functions/xRescale.html @@ -5,4 +5,4 @@

    Type Parameters

    Parameters

    Returns ArrayType

    rescaled data

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRolling.html b/functions/xRolling.html index a1e25afa..f3c5d4d0 100644 --- a/functions/xRolling.html +++ b/functions/xRolling.html @@ -5,4 +5,4 @@

    Parameters

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRollingAverage.html b/functions/xRollingAverage.html index 338f5365..11e9b9ab 100644 --- a/functions/xRollingAverage.html +++ b/functions/xRollingAverage.html @@ -4,4 +4,4 @@

    Function xRollingAverage

    • xRollingAverage(array, options?): number[]

    • This function calculates a rolling average

      Parameters

      Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRollingMax.html b/functions/xRollingMax.html index 317e90ae..8d49d961 100644 --- a/functions/xRollingMax.html +++ b/functions/xRollingMax.html @@ -4,4 +4,4 @@

    Function xRollingMax

    • xRollingMax(array, options?): number[]

    • This function calculates a maximum within a rolling window

      Parameters

      Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRollingMedian.html b/functions/xRollingMedian.html index a91f4579..95faaa1a 100644 --- a/functions/xRollingMedian.html +++ b/functions/xRollingMedian.html @@ -4,4 +4,4 @@

    Function xRollingMedian

    • xRollingMedian(array, options?): number[]

    • This function calculates a rolling average

      Parameters

      Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRollingMin.html b/functions/xRollingMin.html index 3d742f5c..5b18fb64 100644 --- a/functions/xRollingMin.html +++ b/functions/xRollingMin.html @@ -4,4 +4,4 @@

    Function xRollingMin

    • xRollingMin(array, options?): number[]

    • This function calculates a minimum within a rolling window

      Parameters

      Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xRotate.html b/functions/xRotate.html index cdbc70fe..52686e75 100644 --- a/functions/xRotate.html +++ b/functions/xRotate.html @@ -12,4 +12,4 @@

    Example

    xRotate([1,2,3,4],-1) -> [2,3,4,1]
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSampling.html b/functions/xSampling.html index 25b7a570..86082a4a 100644 --- a/functions/xSampling.html +++ b/functions/xSampling.html @@ -8,4 +8,4 @@
  • array with evenly spaced elements

    • Link

    https://en.wikipedia.org/wiki/Sampling_(signal_processing)

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSequentialFill.html b/functions/xSequentialFill.html index 0c345ba3..1e07f712 100644 --- a/functions/xSequentialFill.html +++ b/functions/xSequentialFill.html @@ -5,7 +5,7 @@

    Parameters

    Returns NumberArray

    array with sequential numbers

    -
  • xSequentialFill(options?): NumberArray

  • Fill an array with sequential numbers

    +
  • xSequentialFill(options?): number[]

  • Fill an array with sequential numbers

    Parameters

    Returns NumberArray

    array with sequential numbers

    -

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number[]

    array with sequential numbers

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSortAscending.html b/functions/xSortAscending.html index c4d5c4d2..5649856e 100644 --- a/functions/xSortAscending.html +++ b/functions/xSortAscending.html @@ -1,7 +1,8 @@ xSortAscending | ml-spectra-processing

    Function xSortAscending

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSortDescending.html b/functions/xSortDescending.html index 95f36917..40d84a41 100644 --- a/functions/xSortDescending.html +++ b/functions/xSortDescending.html @@ -4,4 +4,4 @@

    Function xSortDescending

    • xSortDescending<ArrayType>(array): ArrayType

    • Function that sorts arrays or Float64Arrays in descending order

      Type Parameters

      • ArrayType extends DoubleArray

      Parameters

      • array: ArrayType

        array to sort

      Returns ArrayType

      sorted array

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xStandardDeviation.html b/functions/xStandardDeviation.html index ff66234a..01366ca0 100644 --- a/functions/xStandardDeviation.html +++ b/functions/xStandardDeviation.html @@ -5,4 +5,4 @@

    Parameters

    Returns number

    standard deviation

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSubtract.html b/functions/xSubtract.html index 336cd847..9d764e15 100644 --- a/functions/xSubtract.html +++ b/functions/xSubtract.html @@ -5,4 +5,4 @@

    Parameters

    Returns Float64Array

    array after subtraction

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xSum.html b/functions/xSum.html index c4866401..eb1db0ce 100644 --- a/functions/xSum.html +++ b/functions/xSum.html @@ -5,4 +5,4 @@

    Parameters

    Returns number

    XSum value on the specified range.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xUniqueSorted.html b/functions/xUniqueSorted.html index c4d00e14..5526d9f1 100644 --- a/functions/xUniqueSorted.html +++ b/functions/xUniqueSorted.html @@ -6,4 +6,4 @@

    Returns Float64Array

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xVariance.html b/functions/xVariance.html index f00137a0..041be2bd 100644 --- a/functions/xVariance.html +++ b/functions/xVariance.html @@ -5,4 +5,4 @@

    Parameters

    Returns number

    variance

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xreimSortX.html b/functions/xreimSortX.html index 5820d7ea..7eb2a0f7 100644 --- a/functions/xreimSortX.html +++ b/functions/xreimSortX.html @@ -6,4 +6,4 @@

    Returns DataXReIm<ArrayType>

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xreimZeroFilling.html b/functions/xreimZeroFilling.html index a81c60b2..6b4bfa17 100644 --- a/functions/xreimZeroFilling.html +++ b/functions/xreimZeroFilling.html @@ -7,4 +7,4 @@

    Returns DataXReIm

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xy2ToXY.html b/functions/xy2ToXY.html index 4d6966a7..8f1742b4 100644 --- a/functions/xy2ToXY.html +++ b/functions/xy2ToXY.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xy2ToXY

    • xy2ToXY(data): DataXY<number[]>

    • Convert an array of XY arrays to a DataXY object containing x,y arrays

      Parameters

      • data: [number, number][]

        array of arrays [[x,y],[x,y],...]

        -

      Returns DataXY<number[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY<number[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyAlign.html b/functions/xyAlign.html index b63beb4c..8faa6e6d 100644 --- a/functions/xyAlign.html +++ b/functions/xyAlign.html @@ -7,4 +7,4 @@

    Parameters

    Returns XYAlignResult

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns XYAlignResult

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyArrayAlign.html b/functions/xyArrayAlign.html index 7b526b80..9f970cbf 100644 --- a/functions/xyArrayAlign.html +++ b/functions/xyArrayAlign.html @@ -4,4 +4,4 @@

    Function xyArrayAlign

    • xyArrayAlign(data, options?): {
          x: DoubleArray;
          ys: DoubleArray[];
      }

    • Aligns data, can be used for spectra

      Parameters

      Returns {
          x: DoubleArray;
          ys: DoubleArray[];
      }

      • x: DoubleArray
      • ys: DoubleArray[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        x: DoubleArray;
        ys: DoubleArray[];
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyArrayAlignToFirst.html b/functions/xyArrayAlignToFirst.html index e9870e98..4cad779c 100644 --- a/functions/xyArrayAlignToFirst.html +++ b/functions/xyArrayAlignToFirst.html @@ -6,4 +6,4 @@ If some x values are missing in the first spectrum we will add them

    Parameters

    Returns {
        x: DoubleArray;
        ys: DoubleArray[];
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns {
        x: DoubleArray;
        ys: DoubleArray[];
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyArrayMerge.html b/functions/xyArrayMerge.html index aca6ad2e..07fb8376 100644 --- a/functions/xyArrayMerge.html +++ b/functions/xyArrayMerge.html @@ -5,4 +5,4 @@ We have an array of DataXY and the goal is to merge all the values that are the closest possible

    Parameters

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyArrayWeightedMerge.html b/functions/xyArrayWeightedMerge.html index b9bc154e..f69eaa77 100644 --- a/functions/xyArrayWeightedMerge.html +++ b/functions/xyArrayWeightedMerge.html @@ -6,4 +6,4 @@ X values are weighted average

    Parameters

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyCheck.html b/functions/xyCheck.html index 28f8de02..14f0f033 100644 --- a/functions/xyCheck.html +++ b/functions/xyCheck.html @@ -4,4 +4,4 @@

    Function xyCheck

    • xyCheck(data, options?): asserts data is {
          x: AnyArray;
          y: AnyArray;
      }

    • Verify that data is an object of x,y arrays. Throws an error if it's not.

      Parameters

      • data: unknown
      • options: {
            minLength?: number;
        } = {}
        • Optional minLength?: number

          Minimum length.

          -

      Returns asserts data is {
          x: AnyArray;
          y: AnyArray;
      }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns asserts data is {
        x: AnyArray;
        y: AnyArray;
    }

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyCovariance.html b/functions/xyCovariance.html index 487f0950..acd3373c 100644 --- a/functions/xyCovariance.html +++ b/functions/xyCovariance.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyCovariance

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyCumulativeDistributionStatistics.html b/functions/xyCumulativeDistributionStatistics.html index b512e35f..83c8869f 100644 --- a/functions/xyCumulativeDistributionStatistics.html +++ b/functions/xyCumulativeDistributionStatistics.html @@ -4,4 +4,4 @@

    Function xyCumulativeDistributionStatistics

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyEnsureGrowingX.html b/functions/xyEnsureGrowingX.html index 1eaa2ac6..1b6ca560 100644 --- a/functions/xyEnsureGrowingX.html +++ b/functions/xyEnsureGrowingX.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyEnsureGrowingX

    • xyEnsureGrowingX(data): DataXY

    • Filters x,y values to allow strictly growing values in x-axis.

      Parameters

      • data: DataXY<DoubleArray>

        Object that contains property x (an ordered increasing array) and y (an array).

        -

      Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyEquallySpaced.html b/functions/xyEquallySpaced.html index 9e7b0229..98b9687e 100644 --- a/functions/xyEquallySpaced.html +++ b/functions/xyEquallySpaced.html @@ -17,4 +17,4 @@

    Parameters

    Returns DataXY<number[]>

    new object with x / y array with the equally spaced data.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyExtract.html b/functions/xyExtract.html index 04a7f5a3..46a737ef 100644 --- a/functions/xyExtract.html +++ b/functions/xyExtract.html @@ -7,4 +7,4 @@

    Returns DataXY

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFilter.html b/functions/xyFilter.html index ef2a1a36..0f42bf87 100644 --- a/functions/xyFilter.html +++ b/functions/xyFilter.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataXY<number[]>

    filtered array

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFilterMinYValue.html b/functions/xyFilterMinYValue.html index 30e136cb..7f291ded 100644 --- a/functions/xyFilterMinYValue.html +++ b/functions/xyFilterMinYValue.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataXY<DoubleArray>

    filtered data

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFilterTopYValues.html b/functions/xyFilterTopYValues.html index 7485ac9d..f276bd3d 100644 --- a/functions/xyFilterTopYValues.html +++ b/functions/xyFilterTopYValues.html @@ -4,4 +4,4 @@

    Function xyFilterTopYValues

    • xyFilterTopYValues(data, nbPeaks?): DataXY<DoubleArray>

    • Filter an array x/y based on various criteria x points are expected to be sorted

      Parameters

      • data: DataXY<DoubleArray>

        object containing 2 properties x and y

      • Optional nbPeaks: number

      Returns DataXY<DoubleArray>

      filtered data

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFilterX.html b/functions/xyFilterX.html index c81aba48..4e2d82e0 100644 --- a/functions/xyFilterX.html +++ b/functions/xyFilterX.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataXY<number[]>

    filtered array

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFilterXPositive.html b/functions/xyFilterXPositive.html index 64e50115..e9f935d3 100644 --- a/functions/xyFilterXPositive.html +++ b/functions/xyFilterXPositive.html @@ -6,4 +6,4 @@

    Returns DataXY<number[]>

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyFindClosestPoint.html b/functions/xyFindClosestPoint.html index c392937b..d34e46e6 100644 --- a/functions/xyFindClosestPoint.html +++ b/functions/xyFindClosestPoint.html @@ -7,4 +7,4 @@

    Returns PointXY

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyGetNMaxY.html b/functions/xyGetNMaxY.html index 03f60d5e..25170597 100644 --- a/functions/xyGetNMaxY.html +++ b/functions/xyGetNMaxY.html @@ -7,4 +7,4 @@

    Returns DataXY

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyGrowingX.html b/functions/xyGrowingX.html index 6915bf81..bf9b4d9b 100644 --- a/functions/xyGrowingX.html +++ b/functions/xyGrowingX.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyGrowingX

    • xyGrowingX(data): DataXY

    • Order object of array, x has to be monotone. Ensure x is growing

      Parameters

      • data: DataXY<DoubleArray>

        Object of kind {x:[], y:[]}.

        -

      Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyIntegral.html b/functions/xyIntegral.html index 556ebec5..f683bccd 100644 --- a/functions/xyIntegral.html +++ b/functions/xyIntegral.html @@ -7,4 +7,4 @@

    Returns DataXY<number[]>

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyIntegration.html b/functions/xyIntegration.html index 43f906a7..d7206eb9 100644 --- a/functions/xyIntegration.html +++ b/functions/xyIntegration.html @@ -7,4 +7,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyJoinX.html b/functions/xyJoinX.html index 022579e0..ae6750a2 100644 --- a/functions/xyJoinX.html +++ b/functions/xyJoinX.html @@ -8,4 +8,4 @@

    Returns DataXY<number[]>

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMassCenterVector.html b/functions/xyMassCenterVector.html index 1a7b4758..2f48fcab 100644 --- a/functions/xyMassCenterVector.html +++ b/functions/xyMassCenterVector.html @@ -8,4 +8,4 @@
  • options: XYMassCenterVectorOptions = {}

    • Returns Float64Array

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMaxClosestYPoint.html b/functions/xyMaxClosestYPoint.html index e00cdb93..b2478e92 100644 --- a/functions/xyMaxClosestYPoint.html +++ b/functions/xyMaxClosestYPoint.html @@ -7,4 +7,4 @@

    Returns PointWithIndex

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMaxMerge.html b/functions/xyMaxMerge.html index 1a1dac03..9040a471 100644 --- a/functions/xyMaxMerge.html +++ b/functions/xyMaxMerge.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataXY<number[]>

    array of merged and weighted points

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMaxY.html b/functions/xyMaxY.html index 8f18b1e9..a5ed298e 100644 --- a/functions/xyMaxY.html +++ b/functions/xyMaxY.html @@ -7,4 +7,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMaxYPoint.html b/functions/xyMaxYPoint.html index 36840efe..4f28191c 100644 --- a/functions/xyMaxYPoint.html +++ b/functions/xyMaxYPoint.html @@ -4,4 +4,4 @@

    Function xyMaxYPoint

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns PointWithIndex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMaximaY.html b/functions/xyMaximaY.html index 5cdda58b..4f85579a 100644 --- a/functions/xyMaximaY.html +++ b/functions/xyMaximaY.html @@ -8,4 +8,4 @@

    Returns PointWithIndex[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMedian.html b/functions/xyMedian.html index 2042ac7b..7da6d550 100644 --- a/functions/xyMedian.html +++ b/functions/xyMedian.html @@ -6,4 +6,4 @@

    Returns number

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMergeByCentroids.html b/functions/xyMergeByCentroids.html index c9f5582d..e6bb9756 100644 --- a/functions/xyMergeByCentroids.html +++ b/functions/xyMergeByCentroids.html @@ -6,4 +6,4 @@
  • centroids: number[]

    centroids

  • options: XYMergeByCentroidsOptions = {}

    options

    • Returns DataXY<Float64Array>

    merged points

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMinClosestYPoint.html b/functions/xyMinClosestYPoint.html index db84d81b..38cbe81d 100644 --- a/functions/xyMinClosestYPoint.html +++ b/functions/xyMinClosestYPoint.html @@ -7,4 +7,4 @@

    Returns PointWithIndex

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMinYPoint.html b/functions/xyMinYPoint.html index 0e9283e6..5f04d756 100644 --- a/functions/xyMinYPoint.html +++ b/functions/xyMinYPoint.html @@ -4,4 +4,4 @@

    Function xyMinYPoint

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns PointWithIndex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyMinimaY.html b/functions/xyMinimaY.html index f3621055..b69b4b44 100644 --- a/functions/xyMinimaY.html +++ b/functions/xyMinimaY.html @@ -8,4 +8,4 @@

    Returns PointWithIndex[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectBestPoints.html b/functions/xyObjectBestPoints.html index 1f6aeacc..bd911e48 100644 --- a/functions/xyObjectBestPoints.html +++ b/functions/xyObjectBestPoints.html @@ -9,4 +9,4 @@

    Returns Point[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectCheck.html b/functions/xyObjectCheck.html index 35227251..933a2b14 100644 --- a/functions/xyObjectCheck.html +++ b/functions/xyObjectCheck.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectCheck

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns asserts points is Point[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectJoinX.html b/functions/xyObjectJoinX.html index 7a50368b..3e15306f 100644 --- a/functions/xyObjectJoinX.html +++ b/functions/xyObjectJoinX.html @@ -4,4 +4,4 @@

    Function xyObjectJoinX

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectMaxXPoint.html b/functions/xyObjectMaxXPoint.html index eac260d1..cc61e166 100644 --- a/functions/xyObjectMaxXPoint.html +++ b/functions/xyObjectMaxXPoint.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectMaxXPoint

    • xyObjectMaxXPoint(points?): Point

    • Finds the max x value and return a {x,y,index} point

      Parameters

      • points: Point[] = []

        Object that contains property x (an ordered increasing array) and y (an array)

        -

      Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectMaxYPoint.html b/functions/xyObjectMaxYPoint.html index 79770320..26a2f928 100644 --- a/functions/xyObjectMaxYPoint.html +++ b/functions/xyObjectMaxYPoint.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectMaxYPoint

    • xyObjectMaxYPoint(points?): Point

    • Finds the max y value and return a {x,y,index} point

      Parameters

      • points: Point[] = []

        Object that contains property x (an ordered increasing array) and y (an array)

        -

      Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectMinXPoint.html b/functions/xyObjectMinXPoint.html index df7e0bfe..4ed08ea0 100644 --- a/functions/xyObjectMinXPoint.html +++ b/functions/xyObjectMinXPoint.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectMinXPoint

    • xyObjectMinXPoint(points?): Point

    • Finds the min x value and return a {x,y,index} point

      Parameters

      • points: Point[] = []

        Object that contains property x (an ordered increasing array) and y (an array)

        -

      Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectMinYPoint.html b/functions/xyObjectMinYPoint.html index 068f1925..0d516a93 100644 --- a/functions/xyObjectMinYPoint.html +++ b/functions/xyObjectMinYPoint.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectMinYPoint

    • xyObjectMinYPoint(points?): Point

    • Finds the min y value and return a {x,y,index} point

      Parameters

      • points: Point[] = []

        Object that contains property x (an ordered increasing array) and y (an array)

        -

      Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectSlotX.html b/functions/xyObjectSlotX.html index fa2d0871..f202185d 100644 --- a/functions/xyObjectSlotX.html +++ b/functions/xyObjectSlotX.html @@ -4,4 +4,4 @@

    Function xyObjectSlotX

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectSortX.html b/functions/xyObjectSortX.html index 3a8b55f4..b2ceaebb 100644 --- a/functions/xyObjectSortX.html +++ b/functions/xyObjectSortX.html @@ -6,4 +6,4 @@

    Returns Point[]

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectSumY.html b/functions/xyObjectSumY.html index f915c59f..96892352 100644 --- a/functions/xyObjectSumY.html +++ b/functions/xyObjectSumY.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectSumY

    • xyObjectSumY(points?): number

    • Calculate the sum of Y values.

      Parameters

      • points: Point[] = []

        Object that contains property x and y (an array)

        -

      Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyObjectToXY.html b/functions/xyObjectToXY.html index c0a6c49a..564b8b06 100644 --- a/functions/xyObjectToXY.html +++ b/functions/xyObjectToXY.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyObjectToXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY<number[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyPeakInfo-1.html b/functions/xyPeakInfo-1.html index 48e28f00..4b9a1392 100644 --- a/functions/xyPeakInfo-1.html +++ b/functions/xyPeakInfo-1.html @@ -12,4 +12,4 @@

    Returns XYPeakInfo | undefined

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyRealMaxYPoint.html b/functions/xyRealMaxYPoint.html index 67243709..9d677397 100644 --- a/functions/xyRealMaxYPoint.html +++ b/functions/xyRealMaxYPoint.html @@ -7,4 +7,4 @@

    Returns PointWithIndex

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyRealMinYPoint.html b/functions/xyRealMinYPoint.html index 2db3483a..6b480a0b 100644 --- a/functions/xyRealMinYPoint.html +++ b/functions/xyRealMinYPoint.html @@ -4,4 +4,4 @@

    Function xyRealMinYPoint

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns PointWithIndex

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyReduce.html b/functions/xyReduce.html index da458fea..ed85a797 100644 --- a/functions/xyReduce.html +++ b/functions/xyReduce.html @@ -7,4 +7,4 @@ You should rather use ml-xy-equally-spaced to make further processing

    Parameters

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyRolling.html b/functions/xyRolling.html index 5289e32b..fd11623f 100644 --- a/functions/xyRolling.html +++ b/functions/xyRolling.html @@ -6,4 +6,4 @@

    Parameters

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xySetYValue.html b/functions/xySetYValue.html index beaf9ed0..07ae6cff 100644 --- a/functions/xySetYValue.html +++ b/functions/xySetYValue.html @@ -7,4 +7,4 @@

    Returns DataXY

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xySortX.html b/functions/xySortX.html index 66d7671e..8804e042 100644 --- a/functions/xySortX.html +++ b/functions/xySortX.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xySortX

    • xySortX(data): DataXY<Float64Array>

    • This function performs a quick sort of the x array while transforming the y array to preserve the coordinates.

      Parameters

      • data: DataXY<DoubleArray>

        Object that contains property x (Array) and y (Array)

        -

      Returns DataXY<Float64Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY<Float64Array>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyToXYArray.html b/functions/xyToXYArray.html index b6559b3c..3d1a90f7 100644 --- a/functions/xyToXYArray.html +++ b/functions/xyToXYArray.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyToXYArray

    • xyToXYArray(data): [number, number][]

    • Convert a DataXY to an array of array containing x,y.

      Parameters

      • data: DataXY<DoubleArray>

        array of points {x,y}

        -

      Returns [number, number][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns [number, number][]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyToXYObject.html b/functions/xyToXYObject.html index 02213b35..93095d47 100644 --- a/functions/xyToXYObject.html +++ b/functions/xyToXYObject.html @@ -3,4 +3,4 @@ window.addEventListener('load', () => window.renderMathInElement(document.body, window.__typeDocPluginKatexOptions));

    Function xyToXYObject

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns Point[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyUniqueX.html b/functions/xyUniqueX.html index 9efa507c..fa828a3b 100644 --- a/functions/xyUniqueX.html +++ b/functions/xyUniqueX.html @@ -4,4 +4,4 @@

    Function xyUniqueX

    • xyUniqueX(data, options?): DataXY<number[]>

    • Ensure x values are unique

      Parameters

      • data: DataXY<DoubleArray>

        Object that contains property x (Array) and y (Array)

      • options: XYUniqueXOptions = {}

        Object containing a property algorithm (can be 'sum' or 'average', the latter being the default value), and a property isSorted (boolean indicating if the x-array is sorted).

        -

      Returns DataXY<number[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Returns DataXY<number[]>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyWeightedMerge.html b/functions/xyWeightedMerge.html index ec7322d2..8f5154a6 100644 --- a/functions/xyWeightedMerge.html +++ b/functions/xyWeightedMerge.html @@ -5,4 +5,4 @@

    Parameters

    Returns DataXY<number[]>

    array of merged and weighted points

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/zonesNormalize.html b/functions/zonesNormalize.html index 7e771456..3cdd1645 100644 --- a/functions/zonesNormalize.html +++ b/functions/zonesNormalize.html @@ -11,4 +11,4 @@

    Parameters

    Returns FromTo[]

    array of zones

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/zonesWithPoints.html b/functions/zonesWithPoints.html index 33649427..a5040561 100644 --- a/functions/zonesWithPoints.html +++ b/functions/zonesWithPoints.html @@ -6,4 +6,4 @@
  • numberOfPoints: number = 10

    total number of points to distribute between zones

  • options: ZonesWithPointsOptions = {}

    options

    • Returns FromToWithNumberOfPoints[]

    array of zones with points

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/AutoPhaseCorrectionOptions.html b/interfaces/AutoPhaseCorrectionOptions.html index 983e0715..5bf2e3dc 100644 --- a/interfaces/AutoPhaseCorrectionOptions.html +++ b/interfaces/AutoPhaseCorrectionOptions.html @@ -1,7 +1,7 @@ AutoPhaseCorrectionOptions | ml-spectra-processing

    Interface AutoPhaseCorrectionOptions

    interface AutoPhaseCorrectionOptions {
        factorNoise?: number;
        magnitudeMode?: boolean;
        maxDistanceToJoin?: number;
        minRegSize?: number;
        reverse?: boolean;
    }

    Properties

    factorNoise? +

    Interface AutoPhaseCorrectionOptions

    interface AutoPhaseCorrectionOptions {
        factorNoise?: number;
        magnitudeMode?: boolean;
        maxDistanceToJoin?: number;
        minRegSize?: number;
        reverse?: boolean;
    }

    Properties

    factorNoise? magnitudeMode? maxDistanceToJoin? minRegSize? @@ -9,16 +9,16 @@

    Properties

    Optional factorNoise

    factorNoise?: number

    scale the cutoff like factorStd * noiseLevel

    Default

    3
    -

    Optional magnitudeMode

    magnitudeMode?: boolean

    if true it uses magnitude spectrum.boolean

    +

    Optional magnitudeMode

    magnitudeMode?: boolean

    if true it uses magnitude spectrum.boolean

    Default

    true
    -

    Optional maxDistanceToJoin

    maxDistanceToJoin?: number

    max distance between regions (in number of points) to join two regions

    +

    Optional maxDistanceToJoin

    maxDistanceToJoin?: number

    max distance between regions (in number of points) to join two regions

    Default

    256
    -

    Optional minRegSize

    minRegSize?: number

    min number of points to auto phase a region

    +

    Optional minRegSize

    minRegSize?: number

    min number of points to auto phase a region

    Default

    30
    -

    Optional reverse

    reverse?: boolean

    Apply the phase correction from the last element of the array

    +

    Optional reverse

    reverse?: boolean

    Apply the phase correction from the last element of the array

    Default

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CreateFromToArrayOptions.html b/interfaces/CreateFromToArrayOptions.html index def3a36a..e736d374 100644 --- a/interfaces/CreateFromToArrayOptions.html +++ b/interfaces/CreateFromToArrayOptions.html @@ -1,7 +1,7 @@ CreateFromToArrayOptions | ml-spectra-processing

    Interface CreateFromToArrayOptions

    interface CreateFromToArrayOptions {
        distribution?: "uniform" | "log";
        from?: number;
        includeFrom?: boolean;
        includeTo?: boolean;
        length?: number;
        to?: number;
    }

    Properties

    distribution? +

    Interface CreateFromToArrayOptions

    interface CreateFromToArrayOptions {
        distribution?: "uniform" | "log";
        from?: number;
        includeFrom?: boolean;
        includeTo?: boolean;
        length?: number;
        to?: number;
    }

    Properties

    distribution? from? includeFrom? includeTo? @@ -10,19 +10,19 @@

    Properties

    Optional distribution

    distribution?: "uniform" | "log"

    distribution used

    Default

    uniform
    -

    Optional from

    from?: number

    start value of range

    +

    Optional from

    from?: number

    start value of range

    Default

    0
    -

    Optional includeFrom

    includeFrom?: boolean

    include from

    +

    Optional includeFrom

    includeFrom?: boolean

    include from

    Default

    true
    -

    Optional includeTo

    includeTo?: boolean

    include to

    +

    Optional includeTo

    includeTo?: boolean

    include to

    Default

    true
    -

    Optional length

    length?: number

    number of points in range

    +

    Optional length

    length?: number

    number of points in range

    Default

    1000
    -

    Optional to

    to?: number

    end value of range

    +

    Optional to

    to?: number

    end value of range

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CreateRandomArrayOptions.html b/interfaces/CreateRandomArrayOptions.html index 08711c43..776b674e 100644 --- a/interfaces/CreateRandomArrayOptions.html +++ b/interfaces/CreateRandomArrayOptions.html @@ -1,7 +1,7 @@ CreateRandomArrayOptions | ml-spectra-processing

    Interface CreateRandomArrayOptions

    interface CreateRandomArrayOptions {
        distribution?: "normal" | "uniform";
        length?: number;
        mean?: number;
        range?: number;
        seed?: number;
        standardDeviation?: number;
    }

    Properties

    distribution? +

    Interface CreateRandomArrayOptions

    interface CreateRandomArrayOptions {
        distribution?: "normal" | "uniform";
        length?: number;
        mean?: number;
        range?: number;
        seed?: number;
        standardDeviation?: number;
    }

    Properties

    distribution? length? mean? range? @@ -11,19 +11,19 @@ 'uniform' (true random) or 'normal' (gaussian distribution)

    Default

    'normal'
    -

    Optional length

    length?: number

    number of points

    +

    Optional length

    length?: number

    number of points

    Default

    1000
    -

    Optional mean

    mean?: number

    mean

    +

    Optional mean

    mean?: number

    mean

    Default

    0
    -

    Optional range

    range?: number

    range, used in case of uniform distribution

    +

    Optional range

    range?: number

    range, used in case of uniform distribution

    Default

    1
    -

    Optional seed

    seed?: number

    Seed for a deterministic sequence of random numbers.

    +

    Optional seed

    seed?: number

    Seed for a deterministic sequence of random numbers.

    Default

    Date.now()
    -

    Optional standardDeviation

    standardDeviation?: number

    standardDeviation, used in case of normal distribution

    +

    Optional standardDeviation

    standardDeviation?: number

    standardDeviation, used in case of normal distribution

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/CreateStepArrayOptions.html b/interfaces/CreateStepArrayOptions.html index bd6f8b48..b1b03f21 100644 --- a/interfaces/CreateStepArrayOptions.html +++ b/interfaces/CreateStepArrayOptions.html @@ -1,16 +1,16 @@ CreateStepArrayOptions | ml-spectra-processing

    Interface CreateStepArrayOptions

    interface CreateStepArrayOptions {
        from?: number;
        length?: number;
        step?: number;
    }

    Properties

    from? +

    Interface CreateStepArrayOptions

    interface CreateStepArrayOptions {
        from?: number;
        length?: number;
        step?: number;
    }

    Properties

    from? length? step?

    Properties

    Optional from

    from?: number

    start value of range

    Default

    0
    -

    Optional length

    length?: number

    number of points in range

    +

    Optional length

    length?: number

    number of points in range

    Default

    1000
    -

    Optional step

    step?: number

    step value between points

    +

    Optional step

    step?: number

    step value between points

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/DataReIm.html b/interfaces/DataReIm.html index 425d19c3..79a0d35e 100644 --- a/interfaces/DataReIm.html +++ b/interfaces/DataReIm.html @@ -1,8 +1,8 @@ DataReIm | ml-spectra-processing

    Interface DataReIm<ArrayType>

    interface DataReIm {
        im: ArrayType;
        re: ArrayType;
    }

    Type Parameters

    • ArrayType extends DoubleArray = DoubleArray

    Properties

    im +

    Interface DataReIm<ArrayType>

    interface DataReIm {
        im: ArrayType;
        re: ArrayType;
    }

    Type Parameters

    • ArrayType extends DoubleArray = DoubleArray

    Properties

    im re

    Properties

    im

    im: ArrayType

    Array of im values

    -

    re

    re: ArrayType

    Array of re values

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    re

    re: ArrayType

    Array of re values

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/DataXReIm.html b/interfaces/DataXReIm.html index aa171a87..8f05b9ff 100644 --- a/interfaces/DataXReIm.html +++ b/interfaces/DataXReIm.html @@ -1,10 +1,10 @@ DataXReIm | ml-spectra-processing

    Interface DataXReIm<ArrayType>

    interface DataXReIm {
        im: ArrayType;
        re: ArrayType;
        x: ArrayType;
    }

    Type Parameters

    • ArrayType extends DoubleArray = DoubleArray

    Properties

    im +

    Interface DataXReIm<ArrayType>

    interface DataXReIm {
        im: ArrayType;
        re: ArrayType;
        x: ArrayType;
    }

    Type Parameters

    • ArrayType extends DoubleArray = DoubleArray

    Properties

    im re x

    Properties

    im

    im: ArrayType

    Array of im values

    -

    re

    re: ArrayType

    Array of re values

    -

    x

    x: ArrayType

    Array of x values

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    re

    re: ArrayType

    Array of re values

    +

    x

    x: ArrayType

    Array of x values

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/FromToWithNumberOfPoints.html b/interfaces/FromToWithNumberOfPoints.html index f7eba03b..99be74e7 100644 --- a/interfaces/FromToWithNumberOfPoints.html +++ b/interfaces/FromToWithNumberOfPoints.html @@ -1,7 +1,7 @@ FromToWithNumberOfPoints | ml-spectra-processing

    Interface FromToWithNumberOfPoints

    interface FromToWithNumberOfPoints {
        from: number;
        numberOfPoints: number;
        to: number;
    }

    Hierarchy

    • FromTo
      • FromToWithNumberOfPoints

    Properties

    from +

    Interface FromToWithNumberOfPoints

    interface FromToWithNumberOfPoints {
        from: number;
        numberOfPoints: number;
        to: number;
    }

    Hierarchy

    • FromTo
      • FromToWithNumberOfPoints

    Properties

    from numberOfPoints to -

    Properties

    from

    from: number

    numberOfPoints

    numberOfPoints: number

    to

    to: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    from

    from: number

    numberOfPoints

    numberOfPoints: number

    to

    to: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/GetRescalerOptions.html b/interfaces/GetRescalerOptions.html index 6371f957..6808fbce 100644 --- a/interfaces/GetRescalerOptions.html +++ b/interfaces/GetRescalerOptions.html @@ -1,7 +1,7 @@ GetRescalerOptions | ml-spectra-processing

    Interface GetRescalerOptions

    interface GetRescalerOptions {
        algorithm?: RescalerAlgorithm;
        algorithmOptions?: Record<string, number>;
        clamp?: boolean;
        originalMax?: number;
        originalMin?: number;
        targetMax?: number;
        targetMin?: number;
    }

    Properties

    algorithm? +

    Interface GetRescalerOptions

    interface GetRescalerOptions {
        algorithm?: RescalerAlgorithm;
        algorithmOptions?: Record<string, number>;
        clamp?: boolean;
        originalMax?: number;
        originalMin?: number;
        targetMax?: number;
        targetMin?: number;
    }

    Properties

    algorithm? algorithmOptions? clamp? originalMax? @@ -11,22 +11,22 @@

    Properties

    Optional algorithm

    algorithm?: RescalerAlgorithm

    The algorithm to use for the rescaling

    Default

    'linear'
    -

    Optional algorithmOptions

    algorithmOptions?: Record<string, number>

    Options for the algorithm

    +

    Optional algorithmOptions

    algorithmOptions?: Record<string, number>

    Options for the algorithm

    Default

    {}
    -

    Optional clamp

    clamp?: boolean

    If true, the value will be clamp to the target range

    +

    Optional clamp

    clamp?: boolean

    If true, the value will be clamp to the target range

    Default

    true
    -

    Optional originalMax

    originalMax?: number

    The maximum value of the original range

    +

    Optional originalMax

    originalMax?: number

    The maximum value of the original range

    Default

    1
    -

    Optional originalMin

    originalMin?: number

    The minimum value of the original range

    +

    Optional originalMin

    originalMin?: number

    The minimum value of the original range

    Default

    0
    -

    Optional targetMax

    targetMax?: number

    The new maximum value of the target range

    +

    Optional targetMax

    targetMax?: number

    The new maximum value of the target range

    Default

    1
    -

    Optional targetMin

    targetMin?: number

    The new minimum value of the target range

    +

    Optional targetMin

    targetMin?: number

    The new minimum value of the target range

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixBoxPlot.html b/interfaces/MatrixBoxPlot.html index e98fd2f2..4c1dd2c8 100644 --- a/interfaces/MatrixBoxPlot.html +++ b/interfaces/MatrixBoxPlot.html @@ -1,9 +1,9 @@ MatrixBoxPlot | ml-spectra-processing

    Interface MatrixBoxPlot

    interface MatrixBoxPlot {
        max: Float64Array;
        median: Float64Array;
        min: Float64Array;
        q1: Float64Array;
        q3: Float64Array;
    }

    Properties

    max +

    Interface MatrixBoxPlot

    interface MatrixBoxPlot {
        max: Float64Array;
        median: Float64Array;
        min: Float64Array;
        q1: Float64Array;
        q3: Float64Array;
    }

    Properties

    max median min q1 q3 -

    Properties

    max

    max: Float64Array

    median

    median: Float64Array

    min

    min: Float64Array

    q1

    q1: Float64Array

    q3

    q3: Float64Array

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    max

    max: Float64Array

    median

    median: Float64Array

    min

    min: Float64Array

    q1

    q1: Float64Array

    q3

    q3: Float64Array

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixCreateEmptyOptions.html b/interfaces/MatrixCreateEmptyOptions.html index 3dddddf1..cfdbf469 100644 --- a/interfaces/MatrixCreateEmptyOptions.html +++ b/interfaces/MatrixCreateEmptyOptions.html @@ -1,16 +1,16 @@ MatrixCreateEmptyOptions | ml-spectra-processing

    Interface MatrixCreateEmptyOptions<ArrayConstructorType>

    interface MatrixCreateEmptyOptions {
        ArrayConstructor?: ArrayConstructorType;
        matrix?: DoubleMatrix;
        nbColumns?: number;
        nbRows?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? +

    Interface MatrixCreateEmptyOptions<ArrayConstructorType>

    interface MatrixCreateEmptyOptions {
        ArrayConstructor?: ArrayConstructorType;
        matrix?: DoubleMatrix;
        nbColumns?: number;
        nbRows?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? matrix? nbColumns? nbRows?

    Properties

    Optional ArrayConstructor

    ArrayConstructor?: ArrayConstructorType

    Allows to specify the type of array to use

    -

    Optional matrix

    matrix?: DoubleMatrix

    Matrix from which to extract nbRows and nbColumns

    -

    Optional nbColumns

    nbColumns?: number

    Matrix from which to extract nbRows and nbColumns

    +

    Optional matrix

    matrix?: DoubleMatrix

    Matrix from which to extract nbRows and nbColumns

    +

    Optional nbColumns

    nbColumns?: number

    Matrix from which to extract nbRows and nbColumns

    Default

    matrix[0].length || 1
    -

    Optional nbRows

    nbRows?: number

    Matrix from which to extract nbRows and nbColumns

    +

    Optional nbRows

    nbRows?: number

    Matrix from which to extract nbRows and nbColumns

    Default

    matrix.length || 1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixHistogramOptions.html b/interfaces/MatrixHistogramOptions.html index 379ccaae..9bf49141 100644 --- a/interfaces/MatrixHistogramOptions.html +++ b/interfaces/MatrixHistogramOptions.html @@ -1,7 +1,7 @@ MatrixHistogramOptions | ml-spectra-processing

    Interface MatrixHistogramOptions

    interface MatrixHistogramOptions {
        absolute?: boolean;
        centerX?: boolean;
        histogram?: DataXY<DoubleArray>;
        logBaseX?: number;
        logBaseY?: number;
        max?: number;
        min?: number;
        nbSlots?: number;
    }

    Properties

    absolute? +

    Interface MatrixHistogramOptions

    interface MatrixHistogramOptions {
        absolute?: boolean;
        centerX?: boolean;
        histogram?: DataXY<DoubleArray>;
        logBaseX?: number;
        logBaseY?: number;
        max?: number;
        min?: number;
        nbSlots?: number;
    }

    Properties

    absolute? centerX? histogram? logBaseX? @@ -10,19 +10,19 @@ min? nbSlots?

    Properties

    Optional absolute

    absolute?: boolean

    Take the absolute value

    -

    Optional centerX

    centerX?: boolean

    Center the X value. We will enlarge the first and

    +

    Optional centerX

    centerX?: boolean

    Center the X value. We will enlarge the first and

    Default

    true
    -

    Optional histogram

    histogram?: DataXY<DoubleArray>

    histogram

    -

    Optional logBaseX

    logBaseX?: number

    We can first apply a log on the x-axis.

    -

    Optional logBaseY

    logBaseY?: number

    We can apply a log on the resulting histogram

    -

    Optional max

    max?: number

    Maximal value to calculate used to calculate slot size

    +

    Optional histogram

    histogram?: DataXY<DoubleArray>

    histogram

    +

    Optional logBaseX

    logBaseX?: number

    We can first apply a log on the x-axis.

    +

    Optional logBaseY

    logBaseY?: number

    We can apply a log on the resulting histogram

    +

    Optional max

    max?: number

    Maximal value to calculate used to calculate slot size

    Default

    maxValue
    -

    Optional min

    min?: number

    Minimum value to calculate used to calculate slot size

    +

    Optional min

    min?: number

    Minimum value to calculate used to calculate slot size

    Default

    minValue
    -

    Optional nbSlots

    nbSlots?: number

    Number of slots

    +

    Optional nbSlots

    nbSlots?: number

    Number of slots

    Default

    256
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixPQNOptions.html b/interfaces/MatrixPQNOptions.html index c4c3dd48..af9fa25f 100644 --- a/interfaces/MatrixPQNOptions.html +++ b/interfaces/MatrixPQNOptions.html @@ -1,10 +1,10 @@ MatrixPQNOptions | ml-spectra-processing

    Interface MatrixPQNOptions

    interface MatrixPQNOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? +

    Interface MatrixPQNOptions

    interface MatrixPQNOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? min?

    Properties

    Optional max

    max?: number

    Normalization integral constant.

    Default

    100
    -

    Optional min

    min?: number

    min

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional min

    min?: number

    min

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixZPivotRescaleOptions.html b/interfaces/MatrixZPivotRescaleOptions.html index 78d55a94..58b3685b 100644 --- a/interfaces/MatrixZPivotRescaleOptions.html +++ b/interfaces/MatrixZPivotRescaleOptions.html @@ -1,10 +1,10 @@ MatrixZPivotRescaleOptions | ml-spectra-processing

    Interface MatrixZPivotRescaleOptions<ArrayConstructorType>

    interface MatrixZPivotRescaleOptions {
        ArrayConstructor?: ArrayConstructorType;
        max?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? +

    Interface MatrixZPivotRescaleOptions<ArrayConstructorType>

    interface MatrixZPivotRescaleOptions {
        ArrayConstructor?: ArrayConstructorType;
        max?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? max?

    Properties

    Optional ArrayConstructor

    ArrayConstructor?: ArrayConstructorType

    Allows to specify the type of array to use

    -

    Optional max

    max?: number

    max

    +

    Optional max

    max?: number

    max

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixZRescaleOptions.html b/interfaces/MatrixZRescaleOptions.html index 094cf228..b7b0ac8c 100644 --- a/interfaces/MatrixZRescaleOptions.html +++ b/interfaces/MatrixZRescaleOptions.html @@ -1,14 +1,14 @@ MatrixZRescaleOptions | ml-spectra-processing

    Interface MatrixZRescaleOptions<ArrayConstructorType>

    interface MatrixZRescaleOptions {
        ArrayConstructor?: ArrayConstructorType;
        max?: number;
        min?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? +

    Interface MatrixZRescaleOptions<ArrayConstructorType>

    interface MatrixZRescaleOptions {
        ArrayConstructor?: ArrayConstructorType;
        max?: number;
        min?: number;
    }

    Type Parameters

    Properties

    ArrayConstructor? max? min?

    Properties

    Optional ArrayConstructor

    ArrayConstructor?: ArrayConstructorType

    Allows to specify the type of array to use.

    -

    Optional max

    max?: number

    max

    +

    Optional max

    max?: number

    max

    Default

    1
    -

    Optional min

    min?: number

    min

    +

    Optional min

    min?: number

    min

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/MatrixZRescalePerColumnOptions.html b/interfaces/MatrixZRescalePerColumnOptions.html index ad51024e..17e4e782 100644 --- a/interfaces/MatrixZRescalePerColumnOptions.html +++ b/interfaces/MatrixZRescalePerColumnOptions.html @@ -1,12 +1,12 @@ MatrixZRescalePerColumnOptions | ml-spectra-processing

    Interface MatrixZRescalePerColumnOptions

    interface MatrixZRescalePerColumnOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? +

    Interface MatrixZRescalePerColumnOptions

    interface MatrixZRescalePerColumnOptions {
        max?: number;
        min?: number;
    }

    Properties

    max? min?

    Properties

    Optional max

    max?: number

    max

    Default

    1
    -

    Optional min

    min?: number

    min

    +

    Optional min

    min?: number

    min

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/Point.html b/interfaces/Point.html index f7265bef..3ae60d35 100644 --- a/interfaces/Point.html +++ b/interfaces/Point.html @@ -1,10 +1,10 @@ Point | ml-spectra-processing

    Interface Point

    interface Point {
        index?: number;
        x: number;
        y: number;
    }

    Hierarchy

    Properties

    index? +

    Interface Point

    interface Point {
        index?: number;
        x: number;
        y: number;
    }

    Hierarchy

    Properties

    index? x y

    Properties

    Optional index

    index?: number

    point index

    -

    x

    x: number

    x value

    -

    y

    y: number

    y value

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    x

    x: number

    x value

    +

    y

    y: number

    y value

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/PointWithIndex.html b/interfaces/PointWithIndex.html index 1c3fd2e9..d890a0bc 100644 --- a/interfaces/PointWithIndex.html +++ b/interfaces/PointWithIndex.html @@ -1,10 +1,10 @@ PointWithIndex | ml-spectra-processing

    Interface PointWithIndex

    interface PointWithIndex {
        index: number;
        x: number;
        y: number;
    }

    Hierarchy

    Properties

    index +

    Interface PointWithIndex

    interface PointWithIndex {
        index: number;
        x: number;
        y: number;
    }

    Hierarchy

    Properties

    index x y

    Properties

    index

    index: number

    point index

    -

    x

    x: number

    x value

    -

    y

    y: number

    y value

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    x

    x: number

    x value

    +

    y

    y: number

    y value

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/ReimFFTOptions.html b/interfaces/ReimFFTOptions.html index 194c283c..d3897534 100644 --- a/interfaces/ReimFFTOptions.html +++ b/interfaces/ReimFFTOptions.html @@ -1,6 +1,6 @@ ReimFFTOptions | ml-spectra-processing

    Interface ReimFFTOptions

    interface ReimFFTOptions {
        applyZeroShift?: boolean;
        inverse?: boolean;
    }

    Properties

    applyZeroShift? +

    Interface ReimFFTOptions

    interface ReimFFTOptions {
        applyZeroShift?: boolean;
        inverse?: boolean;
    }

    Properties

    applyZeroShift? inverse? -

    Properties

    Optional applyZeroShift

    applyZeroShift?: boolean

    Optional inverse

    inverse?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional applyZeroShift

    applyZeroShift?: boolean

    Optional inverse

    inverse?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/ReimPhaseCorrectionOptions.html b/interfaces/ReimPhaseCorrectionOptions.html index 7105a884..bf434b39 100644 --- a/interfaces/ReimPhaseCorrectionOptions.html +++ b/interfaces/ReimPhaseCorrectionOptions.html @@ -1,5 +1,5 @@ ReimPhaseCorrectionOptions | ml-spectra-processing

    Interface ReimPhaseCorrectionOptions

    interface ReimPhaseCorrectionOptions {
        reverse?: boolean;
    }

    Properties

    reverse? -

    Properties

    Optional reverse

    reverse?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Interface ReimPhaseCorrectionOptions

    interface ReimPhaseCorrectionOptions {
        reverse?: boolean;
    }

    Properties

    reverse? +

    Properties

    Optional reverse

    reverse?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XApplyFunctionStrOptions.html b/interfaces/XApplyFunctionStrOptions.html index da2f642a..ded39a56 100644 --- a/interfaces/XApplyFunctionStrOptions.html +++ b/interfaces/XApplyFunctionStrOptions.html @@ -1,11 +1,11 @@ XApplyFunctionStrOptions | ml-spectra-processing

    Interface XApplyFunctionStrOptions

    interface XApplyFunctionStrOptions {
        fctString?: string;
        variableLabel?: OneLowerCase;
    }

    Properties

    fctString? +

    Interface XApplyFunctionStrOptions

    interface XApplyFunctionStrOptions {
        fctString?: string;
        variableLabel?: OneLowerCase;
    }

    Properties

    fctString? variableLabel?

    Properties

    Optional fctString

    fctString?: string

    Default

    '''
    The function to apply on the array as a string
    -

    Optional variableLabel

    variableLabel?: OneLowerCase

    The variable to use in the fctString (one lower case letter)

    +

    Optional variableLabel

    variableLabel?: OneLowerCase

    The variable to use in the fctString (one lower case letter)

    Default

    'x'
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XAutoCorrelationOptions.html b/interfaces/XAutoCorrelationOptions.html index f559d3a4..10dfc1e5 100644 --- a/interfaces/XAutoCorrelationOptions.html +++ b/interfaces/XAutoCorrelationOptions.html @@ -1,12 +1,12 @@ XAutoCorrelationOptions | ml-spectra-processing

    Interface XAutoCorrelationOptions

    interface XAutoCorrelationOptions {
        lag?: number;
        tau?: number;
    }

    Properties

    lag? +

    Interface XAutoCorrelationOptions

    interface XAutoCorrelationOptions {
        lag?: number;
        tau?: number;
    }

    Properties

    lag? tau?

    Properties

    Optional lag

    lag?: number

    scalar lag parameter

    Default

    A.length-1
    -

    Optional tau

    tau?: number

    sweep increment size (in number of points, min=1, max=A.length)

    +

    Optional tau

    tau?: number

    sweep increment size (in number of points, min=1, max=A.length)

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XBoxPlot.html b/interfaces/XBoxPlot.html index 699e2516..3cdecbbd 100644 --- a/interfaces/XBoxPlot.html +++ b/interfaces/XBoxPlot.html @@ -1,9 +1,9 @@ XBoxPlot | ml-spectra-processing

    Interface XBoxPlot

    interface XBoxPlot {
        max: number;
        median: number;
        min: number;
        q1: number;
        q3: number;
    }

    Properties

    max +

    Interface XBoxPlot

    interface XBoxPlot {
        max: number;
        median: number;
        min: number;
        q1: number;
        q3: number;
    }

    Properties

    max median min q1 q3 -

    Properties

    max

    max: number

    median

    median: number

    min

    min: number

    q1

    q1: number

    q3

    q3: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    max

    max: number

    median

    median: number

    min

    min: number

    q1

    q1: number

    q3

    q3: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XBoxPlotOptions.html b/interfaces/XBoxPlotOptions.html index 3e8116d6..2b997a9a 100644 --- a/interfaces/XBoxPlotOptions.html +++ b/interfaces/XBoxPlotOptions.html @@ -1,8 +1,8 @@ XBoxPlotOptions | ml-spectra-processing

    Interface XBoxPlotOptions

    interface XBoxPlotOptions {
        allowSmallArray?: boolean;
    }

    Properties

    allowSmallArray? +

    Interface XBoxPlotOptions

    interface XBoxPlotOptions {
        allowSmallArray?: boolean;
    }

    Properties

    allowSmallArray?

    Properties

    Optional allowSmallArray

    allowSmallArray?: boolean

    By default there should be at least 5 elements.

    Default

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XCheckOptions.html b/interfaces/XCheckOptions.html index c5f5d49d..b52d808d 100644 --- a/interfaces/XCheckOptions.html +++ b/interfaces/XCheckOptions.html @@ -1,6 +1,6 @@ XCheckOptions | ml-spectra-processing

    Interface XCheckOptions

    interface XCheckOptions {
        minLength?: number;
    }

    Properties

    minLength? +

    Interface XCheckOptions

    interface XCheckOptions {
        minLength?: number;
    }

    Properties

    minLength?

    Properties

    Optional minLength

    minLength?: number

    minimum length

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XCrossCorrelationOptions.html b/interfaces/XCrossCorrelationOptions.html index 61517246..1ca0d3bc 100644 --- a/interfaces/XCrossCorrelationOptions.html +++ b/interfaces/XCrossCorrelationOptions.html @@ -1,12 +1,12 @@ XCrossCorrelationOptions | ml-spectra-processing

    Interface XCrossCorrelationOptions

    interface XCrossCorrelationOptions {
        lag?: number;
        tau?: number;
    }

    Properties

    lag? +

    Interface XCrossCorrelationOptions

    interface XCrossCorrelationOptions {
        lag?: number;
        tau?: number;
    }

    Properties

    lag? tau?

    Properties

    Optional lag

    lag?: number

    scalar lag parameter

    Default

    A.length-1
    -

    Optional tau

    tau?: number

    sweep increment size (in number of points, min=1, max=A.length)

    +

    Optional tau

    tau?: number

    sweep increment size (in number of points, min=1, max=A.length)

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XDivideOptions.html b/interfaces/XDivideOptions.html index 581c7079..00bf9cfb 100644 --- a/interfaces/XDivideOptions.html +++ b/interfaces/XDivideOptions.html @@ -1,6 +1,6 @@ XDivideOptions | ml-spectra-processing

    Interface XDivideOptions<ArrayType>

    interface XDivideOptions {
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    output? +

    Interface XDivideOptions<ArrayType>

    interface XDivideOptions {
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    output?

    Properties

    Optional output

    output?: ArrayType

    output into which the result should be placed if needed. In can be the same as array1 in order to have in-place modification

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XFindClosestIndexOptions.html b/interfaces/XFindClosestIndexOptions.html index 543e40a3..4aebf26b 100644 --- a/interfaces/XFindClosestIndexOptions.html +++ b/interfaces/XFindClosestIndexOptions.html @@ -1,8 +1,8 @@ XFindClosestIndexOptions | ml-spectra-processing

    Interface XFindClosestIndexOptions

    interface XFindClosestIndexOptions {
        sorted?: boolean;
    }

    Properties

    sorted? +

    Interface XFindClosestIndexOptions

    interface XFindClosestIndexOptions {
        sorted?: boolean;
    }

    Properties

    sorted?

    Properties

    Optional sorted

    sorted?: boolean

    Is the array sorted ? This allows to make a dichotomic search that is much faster.

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XGetFromToIndexOptions.html b/interfaces/XGetFromToIndexOptions.html index 5a1187ec..e6696298 100644 --- a/interfaces/XGetFromToIndexOptions.html +++ b/interfaces/XGetFromToIndexOptions.html @@ -1,16 +1,16 @@ XGetFromToIndexOptions | ml-spectra-processing

    Interface XGetFromToIndexOptions

    interface XGetFromToIndexOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? +

    Interface XGetFromToIndexOptions

    interface XGetFromToIndexOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? fromIndex? to? toIndex?

    Properties

    Optional from

    from?: number

    First value for xyIntegration in the X scale

    -

    Optional fromIndex

    fromIndex?: number

    First point for xyIntegration

    +

    Optional fromIndex

    fromIndex?: number

    First point for xyIntegration

    Default

    0
    -

    Optional to

    to?: number

    Last value for xyIntegration in the X scale

    -

    Optional toIndex

    toIndex?: number

    Last point for xyIntegration

    +

    Optional to

    to?: number

    Last value for xyIntegration in the X scale

    +

    Optional toIndex

    toIndex?: number

    Last point for xyIntegration

    Default

    x.length-1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XGetTargetIndexOptions.html b/interfaces/XGetTargetIndexOptions.html index d9dddff6..935c954a 100644 --- a/interfaces/XGetTargetIndexOptions.html +++ b/interfaces/XGetTargetIndexOptions.html @@ -1,8 +1,8 @@ XGetTargetIndexOptions | ml-spectra-processing

    Interface XGetTargetIndexOptions

    interface XGetTargetIndexOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? +

    Interface XGetTargetIndexOptions

    interface XGetTargetIndexOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? targetIndex? -

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
+

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XHilbertTransformOptions.html b/interfaces/XHilbertTransformOptions.html index a9e5809f..600aee39 100644 --- a/interfaces/XHilbertTransformOptions.html +++ b/interfaces/XHilbertTransformOptions.html @@ -1,5 +1,5 @@ XHilbertTransformOptions | ml-spectra-processing

    Interface XHilbertTransformOptions

    interface XHilbertTransformOptions {
        forceFFT?: boolean;
    }

    Properties

    forceFFT? -

    Properties

    Optional forceFFT

    forceFFT?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Interface XHilbertTransformOptions

    interface XHilbertTransformOptions {
        forceFFT?: boolean;
    }

    Properties

    forceFFT? +

    Properties

    Optional forceFFT

    forceFFT?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XHistogramOptions.html b/interfaces/XHistogramOptions.html index de59c953..8f58300f 100644 --- a/interfaces/XHistogramOptions.html +++ b/interfaces/XHistogramOptions.html @@ -1,7 +1,7 @@ XHistogramOptions | ml-spectra-processing

    Interface XHistogramOptions

    interface XHistogramOptions {
        absolute?: boolean;
        centerX?: boolean;
        histogram?: DataXY<DoubleArray>;
        logBaseX?: number;
        logBaseY?: number;
        max?: number;
        min?: number;
        nbSlots?: number;
    }

    Properties

    absolute? +

    Interface XHistogramOptions

    interface XHistogramOptions {
        absolute?: boolean;
        centerX?: boolean;
        histogram?: DataXY<DoubleArray>;
        logBaseX?: number;
        logBaseY?: number;
        max?: number;
        min?: number;
        nbSlots?: number;
    }

    Properties

    absolute? centerX? histogram? logBaseX? @@ -10,21 +10,21 @@ min? nbSlots?

    Properties

    Optional absolute

    absolute?: boolean

    Take the absolute value

    -

    Optional centerX

    centerX?: boolean

    Center the X value. We will enlarge the first and

    +

    Optional centerX

    centerX?: boolean

    Center the X value. We will enlarge the first and

    Default

    true
    -

    Optional histogram

    histogram?: DataXY<DoubleArray>

    Previously existing histogram to continue to fill

    +

    Optional histogram

    histogram?: DataXY<DoubleArray>

    Previously existing histogram to continue to fill

    Default

    {x:[],y:[]}
    -

    Optional logBaseX

    logBaseX?: number

    We can first apply a log on x axis

    -

    Optional logBaseY

    logBaseY?: number

    We can apply a log on the resulting histogram

    -

    Optional max

    max?: number

    Maximal value to calculate used to calculate slot size

    +

    Optional logBaseX

    logBaseX?: number

    We can first apply a log on x axis

    +

    Optional logBaseY

    logBaseY?: number

    We can apply a log on the resulting histogram

    +

    Optional max

    max?: number

    Maximal value to calculate used to calculate slot size

    Default

    maxValue
    -

    Optional min

    min?: number

    Minimum value to calculate used to calculate slot size

    +

    Optional min

    min?: number

    Minimum value to calculate used to calculate slot size

    Default

    minValue
    -

    Optional nbSlots

    nbSlots?: number

    Number of slots

    +

    Optional nbSlots

    nbSlots?: number

    Number of slots

    Default

    256
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XIsEquallySpacedOptions.html b/interfaces/XIsEquallySpacedOptions.html index df96d02f..c88c60f1 100644 --- a/interfaces/XIsEquallySpacedOptions.html +++ b/interfaces/XIsEquallySpacedOptions.html @@ -1,7 +1,7 @@ XIsEquallySpacedOptions | ml-spectra-processing

    Interface XIsEquallySpacedOptions

    interface XIsEquallySpacedOptions {
        tolerance?: number;
    }

    Properties

    tolerance? +

    Interface XIsEquallySpacedOptions

    interface XIsEquallySpacedOptions {
        tolerance?: number;
    }

    Properties

    tolerance?

    Properties

    Optional tolerance

    tolerance?: number

    The tolerance define what is the allowed difference in percent @default: 0.05

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XMultiplyOptions.html b/interfaces/XMultiplyOptions.html index f0ffe617..3688930f 100644 --- a/interfaces/XMultiplyOptions.html +++ b/interfaces/XMultiplyOptions.html @@ -1,6 +1,6 @@ XMultiplyOptions | ml-spectra-processing

    Interface XMultiplyOptions<ArrayType>

    interface XMultiplyOptions {
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    output? +

    Interface XMultiplyOptions<ArrayType>

    interface XMultiplyOptions {
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    output?

    Properties

    Optional output

    output?: ArrayType

    output into which the result should be placed if needed. In can be the same as array1 in order to have in-place modification

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XNoiseSanPlotOptions.html b/interfaces/XNoiseSanPlotOptions.html index 07ca3028..4e333708 100644 --- a/interfaces/XNoiseSanPlotOptions.html +++ b/interfaces/XNoiseSanPlotOptions.html @@ -1,7 +1,7 @@ XNoiseSanPlotOptions | ml-spectra-processing

    Interface XNoiseSanPlotOptions

    interface XNoiseSanPlotOptions {
        considerList?: {
            from: number;
            step: number;
            to: number;
        };
        cutOff?: number;
        factorStd?: number;
        fixOffset?: boolean;
        fromTo?: Record<string, FromTo>;
        logBaseY?: number;
        magnitudeMode?: boolean;
        mask?: DoubleArray;
        refine?: boolean;
        scaleFactor?: number;
    }

    Properties

    considerList? +

    Interface XNoiseSanPlotOptions

    interface XNoiseSanPlotOptions {
        considerList?: {
            from: number;
            step: number;
            to: number;
        };
        cutOff?: number;
        factorStd?: number;
        fixOffset?: boolean;
        fromTo?: Record<string, FromTo>;
        logBaseY?: number;
        magnitudeMode?: boolean;
        mask?: DoubleArray;
        refine?: boolean;
        scaleFactor?: number;
    }

    Properties

    considerList? cutOff? factorStd? fixOffset? @@ -11,21 +11,21 @@ mask? refine? scaleFactor? -

    Properties

    Optional considerList

    considerList?: {
        from: number;
        step: number;
        to: number;
    }

    Type declaration

    • from: number
    • step: number
    • to: number

    Optional cutOff

    cutOff?: number

    percent of positive signal distribution where the noise level will be determined, if it is not defined the program calculate it.

    -

    Optional factorStd

    factorStd?: number

    factor times std to determine what will be marked as signals.

    +

    Properties

    Optional considerList

    considerList?: {
        from: number;
        step: number;
        to: number;
    }

    Type declaration

    • from: number
    • step: number
    • to: number

    Optional cutOff

    cutOff?: number

    percent of positive signal distribution where the noise level will be determined, if it is not defined the program calculate it.

    +

    Optional factorStd

    factorStd?: number

    factor times std to determine what will be marked as signals.

    Default

    5
    -

    Optional fixOffset

    fixOffset?: boolean

    If the baseline is correct, the midpoint of distribution should be zero. if true, the distribution will be centered.

    +

    Optional fixOffset

    fixOffset?: boolean

    If the baseline is correct, the midpoint of distribution should be zero. if true, the distribution will be centered.

    Default

    true
    -

    Optional fromTo

    fromTo?: Record<string, FromTo>

    Optional logBaseY

    logBaseY?: number

    log scale to apply in the intensity axis in order to avoid big numbers.

    +

    Optional fromTo

    fromTo?: Record<string, FromTo>

    Optional logBaseY

    logBaseY?: number

    log scale to apply in the intensity axis in order to avoid big numbers.

    Default

    2
    -

    Optional magnitudeMode

    magnitudeMode?: boolean

    Optional mask

    mask?: DoubleArray

    boolean array to filter data, if the i-th element is true then the i-th element of the distribution will be ignored.

    -

    Optional refine

    refine?: boolean

    true the noise level will be recalculated get out the signals using factorStd.

    +

    Optional magnitudeMode

    magnitudeMode?: boolean

    Optional mask

    mask?: DoubleArray

    boolean array to filter data, if the i-th element is true then the i-th element of the distribution will be ignored.

    +

    Optional refine

    refine?: boolean

    true the noise level will be recalculated get out the signals using factorStd.

    Default

    true
    -

    Optional scaleFactor

    scaleFactor?: number

    factor to scale the data input[i]*=scaleFactor.

    +

    Optional scaleFactor

    scaleFactor?: number

    factor to scale the data input[i]*=scaleFactor.

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XNormedOptions.html b/interfaces/XNormedOptions.html index e9e4cdab..6decd6ce 100644 --- a/interfaces/XNormedOptions.html +++ b/interfaces/XNormedOptions.html @@ -1,14 +1,14 @@ XNormedOptions | ml-spectra-processing

    Interface XNormedOptions<ArrayType>

    interface XNormedOptions {
        algorithm?: "max" | "absolute" | "sum";
        output?: ArrayType;
        value?: number;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    algorithm? +

    Interface XNormedOptions<ArrayType>

    interface XNormedOptions {
        algorithm?: "max" | "absolute" | "sum";
        output?: ArrayType;
        value?: number;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    algorithm? output? value?

    Properties

    Optional algorithm

    algorithm?: "max" | "absolute" | "sum"

    algorithm can be 'sum' 'max' or 'absolute'

    Default

    'absolute'
    -

    Optional output

    output?: ArrayType

    output into which the result should be placed if needed

    -

    Optional value

    value?: number

    max or sum value

    +

    Optional output

    output?: ArrayType

    output into which the result should be placed if needed

    +

    Optional value

    value?: number

    max or sum value

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XPaddingOptions.html b/interfaces/XPaddingOptions.html index 14496683..124d9ebb 100644 --- a/interfaces/XPaddingOptions.html +++ b/interfaces/XPaddingOptions.html @@ -1,13 +1,13 @@ XPaddingOptions | ml-spectra-processing

    Interface XPaddingOptions

    interface XPaddingOptions {
        algorithm?: "value" | "duplicate" | "circular";
        size?: number;
        value?: number;
    }

    Properties

    algorithm? +

    Interface XPaddingOptions

    interface XPaddingOptions {
        algorithm?: "value" | "duplicate" | "circular";
        size?: number;
        value?: number;
    }

    Properties

    algorithm? size? value? -

    Properties

    Optional algorithm

    algorithm?: "value" | "duplicate" | "circular"

    Optional size

    size?: number

    padding size before first element and after last element

    +

    Properties

    Optional algorithm

    algorithm?: "value" | "duplicate" | "circular"

    Optional size

    size?: number

    padding size before first element and after last element

    Default

    0
    -

    Optional value

    value?: number

    value to use for padding (if algorithm='value')

    +

    Optional value

    value?: number

    value to use for padding (if algorithm='value')

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XRescaleOptions.html b/interfaces/XRescaleOptions.html index df442ed4..b5edcadd 100644 --- a/interfaces/XRescaleOptions.html +++ b/interfaces/XRescaleOptions.html @@ -1,14 +1,14 @@ XRescaleOptions | ml-spectra-processing

    Interface XRescaleOptions<ArrayType>

    interface XRescaleOptions {
        max?: number;
        min?: number;
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    max? +

    Interface XRescaleOptions<ArrayType>

    interface XRescaleOptions {
        max?: number;
        min?: number;
        output?: ArrayType;
    }

    Type Parameters

    • ArrayType extends NumberArray = Float64Array

    Properties

    max? min? output?

    Properties

    Optional max

    max?: number

    max used for the scaling

    Default

    1
    -

    Optional min

    min?: number

    min used for the scaling

    +

    Optional min

    min?: number

    min used for the scaling

    Default

    0
    -

    Optional output

    output?: ArrayType

    output into which to placed the data

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional output

    output?: ArrayType

    output into which to placed the data

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XRollingOptions.html b/interfaces/XRollingOptions.html index dffa1686..ba307012 100644 --- a/interfaces/XRollingOptions.html +++ b/interfaces/XRollingOptions.html @@ -1,10 +1,10 @@ XRollingOptions | ml-spectra-processing

    Interface XRollingOptions

    interface XRollingOptions {
        padding?: XPaddingOptions;
        window?: number;
    }

    Properties

    padding? +

    Interface XRollingOptions

    interface XRollingOptions {
        padding?: XPaddingOptions;
        window?: number;
    }

    Properties

    padding? window?

    Properties

    Optional padding

    padding?: XPaddingOptions

    padding

    -

    Optional window

    window?: number

    rolling window

    +

    Optional window

    window?: number

    rolling window

    Default

    5
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XSamplingOptions.html b/interfaces/XSamplingOptions.html index 5f14a7f8..b93efe90 100644 --- a/interfaces/XSamplingOptions.html +++ b/interfaces/XSamplingOptions.html @@ -1,8 +1,8 @@ XSamplingOptions | ml-spectra-processing

    Interface XSamplingOptions

    interface XSamplingOptions {
        length?: number;
    }

    Properties

    length? +

    Interface XSamplingOptions

    interface XSamplingOptions {
        length?: number;
    }

    Properties

    length?

    Properties

    Optional length

    length?: number

    number of points to sample within the array

    Default

    10
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XSequentialFillOptions.html b/interfaces/XSequentialFillOptions.html index c633fb97..5b9b5a45 100644 --- a/interfaces/XSequentialFillOptions.html +++ b/interfaces/XSequentialFillOptions.html @@ -1,18 +1,18 @@ XSequentialFillOptions | ml-spectra-processing

    Interface XSequentialFillOptions

    interface XSequentialFillOptions {
        from?: number;
        size?: number;
        step?: number;
        to?: number;
    }

    Properties

    from? +

    Interface XSequentialFillOptions

    interface XSequentialFillOptions {
        from?: number;
        size?: number;
        step?: number;
        to?: number;
    }

    Properties

    from? size? step? to?

    Properties

    Optional from

    from?: number

    first value in the array

    Default

    0
    -

    Optional size

    size?: number

    size of the array (if not provided calculated from step)

    +

    Optional size

    size?: number

    size of the array (if not provided calculated from step)

    Default

    input.length
    -

    Optional step

    step?: number

    if not provided calculated from size

    -

    Optional to

    to?: number

    last value in the array

    +

    Optional step

    step?: number

    if not provided calculated from size

    +

    Optional to

    to?: number

    last value in the array

    Default

    10
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XVarianceOptions.html b/interfaces/XVarianceOptions.html index baf25a2c..e4ca744a 100644 --- a/interfaces/XVarianceOptions.html +++ b/interfaces/XVarianceOptions.html @@ -1,12 +1,12 @@ XVarianceOptions | ml-spectra-processing

    Interface XVarianceOptions

    interface XVarianceOptions {
        mean?: number;
        unbiased?: boolean;
    }

    Properties

    mean? +

    Interface XVarianceOptions

    interface XVarianceOptions {
        mean?: number;
        unbiased?: boolean;
    }

    Properties

    mean? unbiased?

    Properties

    Optional mean

    mean?: number

    Mean of the data

    Default

    mean calculated
    -

    Optional unbiased

    unbiased?: boolean

    Unbiased option

    +

    Optional unbiased

    unbiased?: boolean

    Unbiased option

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYAlignOptions.html b/interfaces/XYAlignOptions.html index 03f6d851..0e3d545a 100644 --- a/interfaces/XYAlignOptions.html +++ b/interfaces/XYAlignOptions.html @@ -1,16 +1,16 @@ XYAlignOptions | ml-spectra-processing

    Interface XYAlignOptions

    interface XYAlignOptions {
        common?: boolean;
        delta?: number | ((arg) => number);
        x?: "x1" | "x2" | "weighted";
    }

    Properties

    common? +

    Interface XYAlignOptions

    interface XYAlignOptions {
        common?: boolean;
        delta?: number | ((arg) => number);
        x?: "x1" | "x2" | "weighted";
    }

    Properties

    common? delta? x?

    Properties

    Optional common

    common?: boolean

    If true, only the data considered as common to both spectra is kept. If false, the data y arrays are completed with zeroes where no common values are found

    Default

    true
    -

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    +

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Optional x

    x?: "x1" | "x2" | "weighted"

    Defines what x values should be kept (x1 : spectrum 1 x values, x2 spectrum 2 x values, weighted: weighted average of both spectra x values)

    +

    Optional x

    x?: "x1" | "x2" | "weighted"

    Defines what x values should be kept (x1 : spectrum 1 x values, x2 spectrum 2 x values, weighted: weighted average of both spectra x values)

    Default

    "x1"
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYAlignResult.html b/interfaces/XYAlignResult.html index 5b0f989d..d14be471 100644 --- a/interfaces/XYAlignResult.html +++ b/interfaces/XYAlignResult.html @@ -1,7 +1,7 @@ XYAlignResult | ml-spectra-processing

    Interface XYAlignResult

    interface XYAlignResult {
        x: number[];
        y1: number[];
        y2: number[];
    }

    Properties

    x +

    Interface XYAlignResult

    interface XYAlignResult {
        x: number[];
        y1: number[];
        y2: number[];
    }

    Properties

    x y1 y2 -

    Properties

    x

    x: number[]

    y1

    y1: number[]

    y2

    y2: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    x

    x: number[]

    y1

    y1: number[]

    y2

    y2: number[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYArrayAlignOptions.html b/interfaces/XYArrayAlignOptions.html index 3d9ef7de..bb28cb6e 100644 --- a/interfaces/XYArrayAlignOptions.html +++ b/interfaces/XYArrayAlignOptions.html @@ -1,12 +1,12 @@ XYArrayAlignOptions | ml-spectra-processing

    Interface XYArrayAlignOptions

    interface XYArrayAlignOptions {
        delta?: number | ((arg) => number);
        requiredY?: boolean;
    }

    Properties

    delta? +

    Interface XYArrayAlignOptions

    interface XYArrayAlignOptions {
        delta?: number | ((arg) => number);
        requiredY?: boolean;
    }

    Properties

    delta? requiredY?

    Properties

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the data/spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Optional requiredY

    requiredY?: boolean

    If true, the y values must be present everywhere

    +

    Optional requiredY

    requiredY?: boolean

    If true, the y values must be present everywhere

    Default

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYArrayAlignToFirstOptions.html b/interfaces/XYArrayAlignToFirstOptions.html index 5d37cffc..abf2f1be 100644 --- a/interfaces/XYArrayAlignToFirstOptions.html +++ b/interfaces/XYArrayAlignToFirstOptions.html @@ -1,8 +1,8 @@ XYArrayAlignToFirstOptions | ml-spectra-processing

    Interface XYArrayAlignToFirstOptions

    interface XYArrayAlignToFirstOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta? +

    Interface XYArrayAlignToFirstOptions

    interface XYArrayAlignToFirstOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta?

    Properties

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the data/spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYArrayMergeOptions.html b/interfaces/XYArrayMergeOptions.html index 983537d4..74f90b6c 100644 --- a/interfaces/XYArrayMergeOptions.html +++ b/interfaces/XYArrayMergeOptions.html @@ -1,8 +1,8 @@ XYArrayMergeOptions | ml-spectra-processing

    Interface XYArrayMergeOptions

    interface XYArrayMergeOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta? +

    Interface XYArrayMergeOptions

    interface XYArrayMergeOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta?

    Properties

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the data/spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYArrayWeightedMergeOptions.html b/interfaces/XYArrayWeightedMergeOptions.html index 5d45b35a..8f8b95d4 100644 --- a/interfaces/XYArrayWeightedMergeOptions.html +++ b/interfaces/XYArrayWeightedMergeOptions.html @@ -1,8 +1,8 @@ XYArrayWeightedMergeOptions | ml-spectra-processing

    Interface XYArrayWeightedMergeOptions

    interface XYArrayWeightedMergeOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta? +

    Interface XYArrayWeightedMergeOptions

    interface XYArrayWeightedMergeOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta?

    Properties

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the data must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYCovarianceOptions.html b/interfaces/XYCovarianceOptions.html index 138fefd5..6f7aebe9 100644 --- a/interfaces/XYCovarianceOptions.html +++ b/interfaces/XYCovarianceOptions.html @@ -1,8 +1,8 @@ XYCovarianceOptions | ml-spectra-processing

    Interface XYCovarianceOptions

    interface XYCovarianceOptions {
        unbiased?: boolean;
    }

    Properties

    unbiased? +

    Interface XYCovarianceOptions

    interface XYCovarianceOptions {
        unbiased?: boolean;
    }

    Properties

    unbiased?

    Properties

    Optional unbiased

    unbiased?: boolean

    if true, divide by (n-1); if false, divide by n

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYCumulativeDistributionStatisticsResult.html b/interfaces/XYCumulativeDistributionStatisticsResult.html index 9d8fc033..a8921fcd 100644 --- a/interfaces/XYCumulativeDistributionStatisticsResult.html +++ b/interfaces/XYCumulativeDistributionStatisticsResult.html @@ -1,11 +1,11 @@ XYCumulativeDistributionStatisticsResult | ml-spectra-processing

    Interface XYCumulativeDistributionStatisticsResult

    interface XYCumulativeDistributionStatisticsResult {
        x0: number;
        x100: number;
        x25: number;
        x50: number;
        x75: number;
        xMean: number;
        xMode: number;
    }

    Properties

    x0 +

    Interface XYCumulativeDistributionStatisticsResult

    interface XYCumulativeDistributionStatisticsResult {
        x0: number;
        x100: number;
        x25: number;
        x50: number;
        x75: number;
        xMean: number;
        xMode: number;
    }

    Properties

    x0 x100 x25 x50 x75 xMean xMode -

    Properties

    x0

    x0: number

    x100

    x100: number

    x25

    x25: number

    x50

    x50: number

    x75

    x75: number

    xMean

    xMean: number

    xMode

    xMode: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    x0

    x0: number

    x100

    x100: number

    x25

    x25: number

    x50

    x50: number

    x75

    x75: number

    xMean

    xMean: number

    xMode

    xMode: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYEquallySpacedOptions.html b/interfaces/XYEquallySpacedOptions.html index c5bf3200..56827df4 100644 --- a/interfaces/XYEquallySpacedOptions.html +++ b/interfaces/XYEquallySpacedOptions.html @@ -1,7 +1,7 @@ XYEquallySpacedOptions | ml-spectra-processing

    Interface XYEquallySpacedOptions

    interface XYEquallySpacedOptions {
        exclusions?: FromTo[];
        from?: number;
        numberOfPoints?: number;
        to?: number;
        variant?: "smooth" | "slot";
        zones?: FromTo[];
    }

    Properties

    exclusions? +

    Interface XYEquallySpacedOptions

    interface XYEquallySpacedOptions {
        exclusions?: FromTo[];
        from?: number;
        numberOfPoints?: number;
        to?: number;
        variant?: "smooth" | "slot";
        zones?: FromTo[];
    }

    Properties

    exclusions? from? numberOfPoints? to? @@ -10,19 +10,19 @@

    Properties

    Optional exclusions

    exclusions?: FromTo[]

    array of from / to that should be skipped for the generation of the points

    Default

    []
    -

    Optional from

    from?: number

    from

    +

    Optional from

    from?: number

    from

    Default

    x[0]
    -

    Optional numberOfPoints

    numberOfPoints?: number

    number of points

    +

    Optional numberOfPoints

    numberOfPoints?: number

    number of points

    Default

    100
    -

    Optional to

    to?: number

    to

    +

    Optional to

    to?: number

    to

    Default

    x[x.length-1]
    -

    Optional variant

    variant?: "smooth" | "slot"

    variant

    +

    Optional variant

    variant?: "smooth" | "slot"

    variant

    Default

    'smooth'
    -

    Optional zones

    zones?: FromTo[]

    array of from / to that should be kept

    +

    Optional zones

    zones?: FromTo[]

    array of from / to that should be kept

    Default

    []
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYExtractOptions.html b/interfaces/XYExtractOptions.html index 8e59d18a..0c821b07 100644 --- a/interfaces/XYExtractOptions.html +++ b/interfaces/XYExtractOptions.html @@ -1,5 +1,5 @@ XYExtractOptions | ml-spectra-processing

    Interface XYExtractOptions

    interface XYExtractOptions {
        zones?: FromTo[];
    }

    Properties

    zones? -

    Properties

    Optional zones

    zones?: FromTo[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Interface XYExtractOptions

    interface XYExtractOptions {
        zones?: FromTo[];
    }

    Properties

    zones? +

    Properties

    Optional zones

    zones?: FromTo[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYFilterOptions.html b/interfaces/XYFilterOptions.html index 031a4c1e..377edd7b 100644 --- a/interfaces/XYFilterOptions.html +++ b/interfaces/XYFilterOptions.html @@ -1,8 +1,8 @@ XYFilterOptions | ml-spectra-processing

    Interface XYFilterOptions

    interface XYFilterOptions {
        filter?: ((x, y) => boolean);
    }

    Properties

    filter? +

    Interface XYFilterOptions

    interface XYFilterOptions {
        filter?: ((x, y) => boolean);
    }

    Properties

    filter?

    Properties

    Optional filter

    filter?: ((x, y) => boolean)

    Type declaration

      • (x, y): boolean

      • callback

        Parameters

        • x: number
        • y: number

        Returns boolean

        Default

        ()=>true
        -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYFilterXOptions.html b/interfaces/XYFilterXOptions.html index 6c8d6632..0dabef00 100644 --- a/interfaces/XYFilterXOptions.html +++ b/interfaces/XYFilterXOptions.html @@ -1,20 +1,20 @@ XYFilterXOptions | ml-spectra-processing

    Interface XYFilterXOptions

    interface XYFilterXOptions {
        exclusions?: FromTo[];
        from?: number;
        to?: number;
        zones?: FromTo[];
    }

    Properties

    exclusions? +

    Interface XYFilterXOptions

    interface XYFilterXOptions {
        exclusions?: FromTo[];
        from?: number;
        to?: number;
        zones?: FromTo[];
    }

    Properties

    exclusions? from? to? zones?

    Properties

    Optional exclusions

    exclusions?: FromTo[]

    zones to exclude, contains {from, to} pairs

    Default

    []
    -

    Optional from

    from?: number

    filter from

    +

    Optional from

    from?: number

    filter from

    Default

    x[0]
    -

    Optional to

    to?: number

    filter to

    +

    Optional to

    to?: number

    filter to

    Default

    x[x.length - 1]
    -

    Optional zones

    zones?: FromTo[]

    zones to keep

    +

    Optional zones

    zones?: FromTo[]

    zones to keep

    Default

    [{from,to}]
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYIntegralOptions.html b/interfaces/XYIntegralOptions.html index e8f09039..4ffeed66 100644 --- a/interfaces/XYIntegralOptions.html +++ b/interfaces/XYIntegralOptions.html @@ -1,20 +1,20 @@ XYIntegralOptions | ml-spectra-processing

    Interface XYIntegralOptions

    interface XYIntegralOptions {
        from?: number;
        fromIndex?: number;
        reverse?: boolean;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? +

    Interface XYIntegralOptions

    interface XYIntegralOptions {
        from?: number;
        fromIndex?: number;
        reverse?: boolean;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? fromIndex? reverse? to? toIndex?

    Properties

    Optional from

    from?: number

    First value for xyIntegration in the X scale

    -

    Optional fromIndex

    fromIndex?: number

    First point for xyIntegration

    +

    Optional fromIndex

    fromIndex?: number

    First point for xyIntegration

    Default

    0
    -

    Optional reverse

    reverse?: boolean

    Integrate from the larger value to the smallest value

    +

    Optional reverse

    reverse?: boolean

    Integrate from the larger value to the smallest value

    Default

    false
    -

    Optional to

    to?: number

    Last value for xyIntegration in the X scale

    -

    Optional toIndex

    toIndex?: number

    Last point for xyIntegration

    +

    Optional to

    to?: number

    Last value for xyIntegration in the X scale

    +

    Optional toIndex

    toIndex?: number

    Last point for xyIntegration

    Default

    x.length-1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYJoinXOptions.html b/interfaces/XYJoinXOptions.html index fe884dfb..7468bf59 100644 --- a/interfaces/XYJoinXOptions.html +++ b/interfaces/XYJoinXOptions.html @@ -1,8 +1,8 @@ XYJoinXOptions | ml-spectra-processing

    Interface XYJoinXOptions

    interface XYJoinXOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta? +

    Interface XYJoinXOptions

    interface XYJoinXOptions {
        delta?: number | ((arg) => number);
    }

    Properties

    delta?

    Properties

    Optional delta

    delta?: number | ((arg) => number)

    The range in which the two x values of the spectra must be to be placed on the same line. It may also be a function that allows to change delta depending on the X values of the spectrum

    Type declaration

      • (arg): number

      • Parameters

        • arg: number

        Returns number

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMassCenterVectorOptions.html b/interfaces/XYMassCenterVectorOptions.html index a5bb1ee1..8b15b5c8 100644 --- a/interfaces/XYMassCenterVectorOptions.html +++ b/interfaces/XYMassCenterVectorOptions.html @@ -1,5 +1,5 @@ XYMassCenterVectorOptions | ml-spectra-processing

    Interface XYMassCenterVectorOptions

    interface XYMassCenterVectorOptions {
        depth?: number;
    }

    Properties

    depth? -

    Properties

    Optional depth

    depth?: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Interface XYMassCenterVectorOptions

    interface XYMassCenterVectorOptions {
        depth?: number;
    }

    Properties

    depth? +

    Properties

    Optional depth

    depth?: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMaxClosestYPointOptions.html b/interfaces/XYMaxClosestYPointOptions.html index e699acd3..54a13430 100644 --- a/interfaces/XYMaxClosestYPointOptions.html +++ b/interfaces/XYMaxClosestYPointOptions.html @@ -1,8 +1,8 @@ XYMaxClosestYPointOptions | ml-spectra-processing

    Interface XYMaxClosestYPointOptions

    interface XYMaxClosestYPointOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? +

    Interface XYMaxClosestYPointOptions

    interface XYMaxClosestYPointOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? targetIndex? -

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
+

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMaxYOptions.html b/interfaces/XYMaxYOptions.html index 66361a37..fb144579 100644 --- a/interfaces/XYMaxYOptions.html +++ b/interfaces/XYMaxYOptions.html @@ -1,16 +1,16 @@ XYMaxYOptions | ml-spectra-processing

    Interface XYMaxYOptions

    interface XYMaxYOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? +

    Interface XYMaxYOptions

    interface XYMaxYOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? fromIndex? to? toIndex?

    Properties

    Optional from

    from?: number

    First value for xyMaxY in the X scale

    -

    Optional fromIndex

    fromIndex?: number

    First point for xyMaxY

    +

    Optional fromIndex

    fromIndex?: number

    First point for xyMaxY

    Default

    0
    -

    Optional to

    to?: number

    Last value for xyMaxY in the X scale

    -

    Optional toIndex

    toIndex?: number

    Last point for xyMaxY

    +

    Optional to

    to?: number

    Last value for xyMaxY in the X scale

    +

    Optional toIndex

    toIndex?: number

    Last point for xyMaxY

    Default

    x.length-1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMaxYPointOptions.html b/interfaces/XYMaxYPointOptions.html index ac91d5f4..b76ef2ab 100644 --- a/interfaces/XYMaxYPointOptions.html +++ b/interfaces/XYMaxYPointOptions.html @@ -1,16 +1,16 @@ XYMaxYPointOptions | ml-spectra-processing

    Interface XYMaxYPointOptions

    interface XYMaxYPointOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? +

    Interface XYMaxYPointOptions

    interface XYMaxYPointOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? fromIndex? to? toIndex?

    Properties

    Optional from

    from?: number

    First value for xyMaxYPoint in the X scale

    -

    Optional fromIndex

    fromIndex?: number

    First point for xyMaxYPoint

    +

    Optional fromIndex

    fromIndex?: number

    First point for xyMaxYPoint

    Default

    0
    -

    Optional to

    to?: number

    Last value for xyMaxYPoint in the X scale

    -

    Optional toIndex

    toIndex?: number

    Last point for xyMaxYPoint

    +

    Optional to

    to?: number

    Last value for xyMaxYPoint in the X scale

    +

    Optional toIndex

    toIndex?: number

    Last point for xyMaxYPoint

    Default

    x.length-1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMergeByCentroidsOptions.html b/interfaces/XYMergeByCentroidsOptions.html index bd180918..64b58bc7 100644 --- a/interfaces/XYMergeByCentroidsOptions.html +++ b/interfaces/XYMergeByCentroidsOptions.html @@ -1,8 +1,8 @@ XYMergeByCentroidsOptions | ml-spectra-processing

    Interface XYMergeByCentroidsOptions

    interface XYMergeByCentroidsOptions {
        window?: number;
    }

    Properties

    window? +

    Interface XYMergeByCentroidsOptions

    interface XYMergeByCentroidsOptions {
        window?: number;
    }

    Properties

    window?

    Properties

    Optional window

    window?: number

    window size, has to be a positive number

    Default

    0.01
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMinClosestYPointOptions.html b/interfaces/XYMinClosestYPointOptions.html index fc7228b3..80f85f83 100644 --- a/interfaces/XYMinClosestYPointOptions.html +++ b/interfaces/XYMinClosestYPointOptions.html @@ -1,8 +1,8 @@ XYMinClosestYPointOptions | ml-spectra-processing

    Interface XYMinClosestYPointOptions

    interface XYMinClosestYPointOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? +

    Interface XYMinClosestYPointOptions

    interface XYMinClosestYPointOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? targetIndex? -

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
+

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Default

    0
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYMinYPointOptions.html b/interfaces/XYMinYPointOptions.html index bda3cb4e..d4b7bc93 100644 --- a/interfaces/XYMinYPointOptions.html +++ b/interfaces/XYMinYPointOptions.html @@ -1,16 +1,16 @@ XYMinYPointOptions | ml-spectra-processing

    Interface XYMinYPointOptions

    interface XYMinYPointOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? +

    Interface XYMinYPointOptions

    interface XYMinYPointOptions {
        from?: number;
        fromIndex?: number;
        to?: number;
        toIndex?: number;
    }

    Properties

    from? fromIndex? to? toIndex?

    Properties

    Optional from

    from?: number

    First value for xyMinYPoint in the X scale

    -

    Optional fromIndex

    fromIndex?: number

    First point for xyMinYPoint

    +

    Optional fromIndex

    fromIndex?: number

    First point for xyMinYPoint

    Default

    0
    -

    Optional to

    to?: number

    Last value for xyMinYPoint in the X scale

    -

    Optional toIndex

    toIndex?: number

    Last point for xyMinYPoint

    +

    Optional to

    to?: number

    Last value for xyMinYPoint in the X scale

    +

    Optional toIndex

    toIndex?: number

    Last point for xyMinYPoint

    Default

    x.length-1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYObjectBestPointsOptions.html b/interfaces/XYObjectBestPointsOptions.html index 41a88a56..6571b559 100644 --- a/interfaces/XYObjectBestPointsOptions.html +++ b/interfaces/XYObjectBestPointsOptions.html @@ -1,24 +1,24 @@ XYObjectBestPointsOptions | ml-spectra-processing

    Interface XYObjectBestPointsOptions

    interface XYObjectBestPointsOptions {
        from?: number;
        limit?: number;
        numberCloseSlots?: number;
        numberSlots?: number;
        threshold?: number;
        to?: number;
    }

    Properties

    from? +

    Interface XYObjectBestPointsOptions

    interface XYObjectBestPointsOptions {
        from?: number;
        limit?: number;
        numberCloseSlots?: number;
        numberSlots?: number;
        threshold?: number;
        to?: number;
    }

    Properties

    from? limit? numberCloseSlots? numberSlots? threshold? to?

    Properties

    Optional from

    from?: number

    min X value of the window to consider

    -

    Optional limit

    limit?: number

    max number of points

    +

    Optional limit

    limit?: number

    max number of points

    Default

    20
    -

    Optional numberCloseSlots

    numberCloseSlots?: number

    number of slots

    +

    Optional numberCloseSlots

    numberCloseSlots?: number

    number of slots

    Default

    50
    -

    Optional numberSlots

    numberSlots?: number

    define the number of slots and indirectly the slot width

    +

    Optional numberSlots

    numberSlots?: number

    define the number of slots and indirectly the slot width

    Default

    10
    -

    Optional threshold

    threshold?: number

    minimal intensity compare to more intense

    +

    Optional threshold

    threshold?: number

    minimal intensity compare to more intense

    Default

    0.01
    -

    Optional to

    to?: number

    max X value of the window to consider

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional to

    to?: number

    max X value of the window to consider

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYObjectJoinXOptions.html b/interfaces/XYObjectJoinXOptions.html index fd8f5b0e..d9d1088b 100644 --- a/interfaces/XYObjectJoinXOptions.html +++ b/interfaces/XYObjectJoinXOptions.html @@ -1,8 +1,8 @@ XYObjectJoinXOptions | ml-spectra-processing

    Interface XYObjectJoinXOptions

    interface XYObjectJoinXOptions {
        xError?: number;
    }

    Properties

    xError? +

    Interface XYObjectJoinXOptions

    interface XYObjectJoinXOptions {
        xError?: number;
    }

    Properties

    xError?

    Properties

    Optional xError

    xError?: number

    Limit to join the data.

    Default

    Number.EPSILON
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYObjectSlotXOptions.html b/interfaces/XYObjectSlotXOptions.html index f9df3d3b..354aac1e 100644 --- a/interfaces/XYObjectSlotXOptions.html +++ b/interfaces/XYObjectSlotXOptions.html @@ -1,8 +1,8 @@ XYObjectSlotXOptions | ml-spectra-processing

    Interface XYObjectSlotXOptions

    interface XYObjectSlotXOptions {
        slotWidth?: number;
    }

    Properties

    slotWidth? +

    Interface XYObjectSlotXOptions

    interface XYObjectSlotXOptions {
        slotWidth?: number;
    }

    Properties

    slotWidth?

    Properties

    Optional slotWidth

    slotWidth?: number

    Limit to join the dataPoints[].

    Default

    1
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYPeakInfo.html b/interfaces/XYPeakInfo.html index 2fae26ac..682af9fc 100644 --- a/interfaces/XYPeakInfo.html +++ b/interfaces/XYPeakInfo.html @@ -1,9 +1,9 @@ XYPeakInfo | ml-spectra-processing

    Interface XYPeakInfo

    interface XYPeakInfo {
        extrema: {
            x: number;
            y: number;
        };
        inflectionAfter: {
            x: number;
            y: number;
        };
        inflectionBefore: {
            x: number;
            y: number;
        };
        inflectionMiddle: {
            x: number;
            y: number;
        };
        width: number;
    }

    Properties

    extrema +

    Interface XYPeakInfo

    interface XYPeakInfo {
        extrema: {
            x: number;
            y: number;
        };
        inflectionAfter: {
            x: number;
            y: number;
        };
        inflectionBefore: {
            x: number;
            y: number;
        };
        inflectionMiddle: {
            x: number;
            y: number;
        };
        width: number;
    }

    Properties

    extrema inflectionAfter inflectionBefore inflectionMiddle width -

    Properties

    extrema

    extrema: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionAfter

    inflectionAfter: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionBefore

    inflectionBefore: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionMiddle

    inflectionMiddle: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    extrema

    extrema: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionAfter

    inflectionAfter: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionBefore

    inflectionBefore: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    inflectionMiddle

    inflectionMiddle: {
        x: number;
        y: number;
    }

    Type declaration

    • x: number
    • y: number

    width

    width: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYPeakInfoOptions.html b/interfaces/XYPeakInfoOptions.html index acb3b00e..fa1258aa 100644 --- a/interfaces/XYPeakInfoOptions.html +++ b/interfaces/XYPeakInfoOptions.html @@ -1,6 +1,6 @@ XYPeakInfoOptions | ml-spectra-processing

    Interface XYPeakInfoOptions

    interface XYPeakInfoOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? +

    Interface XYPeakInfoOptions

    interface XYPeakInfoOptions {
        target?: number;
        targetIndex?: number;
    }

    Properties

    target? targetIndex? -

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional target

    target?: number

    Optional targetIndex

    targetIndex?: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYReduceOptions.html b/interfaces/XYReduceOptions.html index 2842062e..9df2c793 100644 --- a/interfaces/XYReduceOptions.html +++ b/interfaces/XYReduceOptions.html @@ -1,22 +1,22 @@ XYReduceOptions | ml-spectra-processing

    Interface XYReduceOptions

    interface XYReduceOptions {
        from?: number;
        nbPoints?: number;
        optimize?: boolean;
        to?: number;
        zones?: FromTo[];
    }

    Properties

    from? +

    Interface XYReduceOptions

    interface XYReduceOptions {
        from?: number;
        nbPoints?: number;
        optimize?: boolean;
        to?: number;
        zones?: FromTo[];
    }

    Properties

    from? nbPoints? optimize? to? zones?

    Properties

    Optional from

    from?: number

    Default

    x[0]
    -

    Optional nbPoints

    nbPoints?: number

    Number of points

    +

    Optional nbPoints

    nbPoints?: number

    Number of points

    Default

    4001
    -

    Optional optimize

    optimize?: boolean

    If optimize we may have less than nbPoints at the end

    +

    Optional optimize

    optimize?: boolean

    If optimize we may have less than nbPoints at the end

    Default

    false
    -

    Optional to

    to?: number

    Default

    x[x.length-1]
+

    Optional to

    to?: number

    Default

    x[x.length-1]
    -

    Optional zones

    zones?: FromTo[]

    Array of zones to keep (from/to object)

    +

    Optional zones

    zones?: FromTo[]

    Array of zones to keep (from/to object)

    Default

    []
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYSetYValueOptions.html b/interfaces/XYSetYValueOptions.html index ac77d944..b5f0c2e3 100644 --- a/interfaces/XYSetYValueOptions.html +++ b/interfaces/XYSetYValueOptions.html @@ -1,7 +1,7 @@ XYSetYValueOptions | ml-spectra-processing

    Interface XYSetYValueOptions

    interface XYSetYValueOptions {
        value?: number;
        zones?: FromTo[];
    }

    Properties

    value? +

    Interface XYSetYValueOptions

    interface XYSetYValueOptions {
        value?: number;
        zones?: FromTo[];
    }

    Properties

    value? zones?

    Properties

    Optional value

    value?: number

    data contains x and y values

    -

    Optional zones

    zones?: FromTo[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Optional zones

    zones?: FromTo[]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/XYUniqueXOptions.html b/interfaces/XYUniqueXOptions.html index 1c01e32a..c827dcc1 100644 --- a/interfaces/XYUniqueXOptions.html +++ b/interfaces/XYUniqueXOptions.html @@ -1,12 +1,12 @@ XYUniqueXOptions | ml-spectra-processing

    Interface XYUniqueXOptions

    interface XYUniqueXOptions {
        algorithm?: "sum" | "average";
        isSorted?: boolean;
    }

    Properties

    algorithm? +

    Interface XYUniqueXOptions

    interface XYUniqueXOptions {
        algorithm?: "sum" | "average";
        isSorted?: boolean;
    }

    Properties

    algorithm? isSorted?

    Properties

    Optional algorithm

    algorithm?: "sum" | "average"

    either 'average' or 'sum'

    Default

    'average'
    -

    Optional isSorted

    isSorted?: boolean

    if false the DataXY has to be sorted first

    +

    Optional isSorted

    isSorted?: boolean

    if false the DataXY has to be sorted first

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/ZonesNormalizeOptions.html b/interfaces/ZonesNormalizeOptions.html index b62ad024..0abba1ff 100644 --- a/interfaces/ZonesNormalizeOptions.html +++ b/interfaces/ZonesNormalizeOptions.html @@ -1,14 +1,14 @@ ZonesNormalizeOptions | ml-spectra-processing

    Interface ZonesNormalizeOptions

    interface ZonesNormalizeOptions {
        exclusions?: FromTo[];
        from?: number;
        to?: number;
    }

    Properties

    exclusions? +

    Interface ZonesNormalizeOptions

    interface ZonesNormalizeOptions {
        exclusions?: FromTo[];
        from?: number;
        to?: number;
    }

    Properties

    exclusions? from? to?

    Properties

    Optional exclusions

    exclusions?: FromTo[]

    List of exclusion zones

    -

    Optional from

    from?: number

    specify min value of zones

    +

    Optional from

    from?: number

    specify min value of zones

    Default

    Number.NEGATIVE_INFINITY
    -

    Optional to

    to?: number

    specify max value of zones

    +

    Optional to

    to?: number

    specify max value of zones

    Default

    Number.POSITIVE_INFINITY
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/interfaces/ZonesWithPointsOptions.html b/interfaces/ZonesWithPointsOptions.html index 87d0fdbf..8ffd6320 100644 --- a/interfaces/ZonesWithPointsOptions.html +++ b/interfaces/ZonesWithPointsOptions.html @@ -1,12 +1,12 @@ ZonesWithPointsOptions | ml-spectra-processing

    Interface ZonesWithPointsOptions

    interface ZonesWithPointsOptions {
        from?: number;
        to?: number;
    }

    Properties

    from? +

    Interface ZonesWithPointsOptions

    interface ZonesWithPointsOptions {
        from?: number;
        to?: number;
    }

    Properties

    from? to?

    Properties

    Optional from

    from?: number

    specify min value of zones

    Default

    Number.NEGATIVE_INFINITY
    -

    Optional to

    to?: number

    specify max value of zones

    +

    Optional to

    to?: number

    specify max value of zones

    Default

    Number.POSITIVE_INFINITY
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/types/DoubleArrayConstructor.html b/types/DoubleArrayConstructor.html index 01da3a77..d0d9800c 100644 --- a/types/DoubleArrayConstructor.html +++ b/types/DoubleArrayConstructor.html @@ -1,4 +1,4 @@ DoubleArrayConstructor | ml-spectra-processing

    Type alias DoubleArrayConstructor

    DoubleArrayConstructor: ArrayConstructor | Float64ArrayConstructor

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type alias DoubleArrayConstructor

    DoubleArrayConstructor: ArrayConstructor | Float64ArrayConstructor

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DoubleArrayType.html b/types/DoubleArrayType.html index b8ae8c82..6c6faf52 100644 --- a/types/DoubleArrayType.html +++ b/types/DoubleArrayType.html @@ -1,4 +1,4 @@ DoubleArrayType | ml-spectra-processing

    Type alias DoubleArrayType<ArrayConstructorType>

    DoubleArrayType<ArrayConstructorType>: ArrayConstructorType extends Float64ArrayConstructor
        ? Float64Array
        : number[]

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type alias DoubleArrayType<ArrayConstructorType>

    DoubleArrayType<ArrayConstructorType>: ArrayConstructorType extends Float64ArrayConstructor
        ? Float64Array
        : number[]

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DoubleMatrix.html b/types/DoubleMatrix.html index 59b62009..0bfe7566 100644 --- a/types/DoubleMatrix.html +++ b/types/DoubleMatrix.html @@ -1,4 +1,4 @@ DoubleMatrix | ml-spectra-processing

    Type alias DoubleMatrix

    DoubleMatrix: DoubleArray[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type alias DoubleMatrix

    DoubleMatrix: DoubleArray[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/RescalerAlgorithm.html b/types/RescalerAlgorithm.html index 1f7a6822..70da99a9 100644 --- a/types/RescalerAlgorithm.html +++ b/types/RescalerAlgorithm.html @@ -1,4 +1,4 @@ RescalerAlgorithm | ml-spectra-processing

    Type alias RescalerAlgorithm

    RescalerAlgorithm: "linear" | "logarithmic" | "power"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type alias RescalerAlgorithm

    RescalerAlgorithm: "linear" | "logarithmic" | "power"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file