ecl-logo Documentation
ECL`

AnalyzeDownsampling

AnalyzeDownsampling[DataObject,Field]AnalysisObject

downsamples and compresses the numerical data in a Field of DataObject, storing the downsampled result in AnalysisObject.

Details

  • N-dimensional data is assumed to have one dependent variable and N-1 independent variables. The dependent variable is assumed to be the last dimension.
  • Data is downsampled onto an evenly spaced grid in the independent variables.
  • If input data is unevenly sampled in its second-to-last dimension (last independent variable), data will be resampled along this dimension onto a regularly spaced grid using linear interpolation.
  • Input data which is unevenly sampled in more than one independent variable cannot be downsampled with this function.
  • Input
    Output
    General Options
    Method Options

Examples

open allclose all

Basic Examples  (2)

Downsample the IonAbundance3D field in a ChromatographyMassSpectra data object and extract the sparse array and sampling points directly into the notebook:

Downsample the IonAbundance3D field in a ChromatographyMassSpectra data object and store the result in a Downsampling analysis object:

Options  (11)

DownsamplingFunction  (1)

Specify what function to use when reducing data points which get downsampled to the same point:

DownsamplingRate  (1)

Specify the downsampling rate to use, using None to specify no downsampling should be done in a dimension. Data will be downsampled so that the spacing of the downsampled data is greater than or equal to these specifications:

LoadingBars  (1)

True indicates that loading bars should be shown during evaluation. Note that for very long computations, loading bars may have a small negative impact on performance:

NoiseThreshold  (3)

Setting NoiseThreshold->Automatic is equivalent to using OtsuThreshold, which uses a threshold which clusters log-intensity values into noise and non-noise groups:

Setting NoiseThreshold->None disables replacing values close to zero by zero:

Specify a threshold for sparsification. Input data with a downsapmled Z-value (dependent variable, e.g intensity) smaller than this threshold will be treated as zero:

Parallel  (1)

When raw data file is large, downsampling can be carried out on manifold in parallel:

ReorderDimensions  (1)

Swap the X and Y dimensions in a data object containing 3D data as a list of {x,y,z} data points:

Streaming  (1)

When raw data is large, use Streaming option to stream data during downsampling:

Template  (1)

Set the Template option to use the resolved options from an existing downsampling analysis:

Threads  (1)

The number of parallel processing threads can be specified:

Messages  (12)

DebugEcho  (1)

Developer error messages used only when downsampling jobs are run remotely on Manifold:

DownsamplingRateTooLarge  (1)

Show a warning and default to no downsampling if the provided downsampling rate is larger the span of data in that dimension:

DownsamplingRateTooSmall  (1)

Show a warning and default to no downsampling if the provided downsampling rate is smaller than the data spacing in that dimension:

FieldNotFound  (1)

Show an error and return $Failed if the requested field to downsample either cannot be downloaded:

IncompatibleUnits  (1)

Show a warning and strip units if the provided downsampling rate has incompatible units with the input data:

InvalidDataFormat  (1)

Show an error and return $Failed if the requested field to downsample was downloaded, but did not resolve to a list of data points:

InvalidDownsamplingSpec  (2)

Show and error and return $Failed if the downsampling function specification is not a list of length n-1, where n is the dimensionality of input data:

Show and error and return $Failed if the downsampling rate specification is not a list of length n-1, where n is the dimensionality of input data:

InvalidReordering  (1)

Show an error and return $Failed if the indices requested for reordering dimension are not consecutive indices in range (e.g. for 3 dimensional data, some permutation of {1,2,3}):

LongComputation  (1)

Show a warning if the input data object is large and the calculation is expected to take more than a few minutes:

UnevenData3D  (1)

The resolved input data must be evenly spaced in its first dimension. If it is not, additional pre-processing is required before downsampling can be performed:

UnsupportedDimension  (1)

AnalyzeDownsampling only suppors two- and three-dimensional data:

Last modified on Wed 17 Sep 2025 18:52:12