| OpenMS 2.5.0

Public Member Functions | Public Attributes | List of all members
MSNumpressCoder::NumpressConfig Struct Reference

Configuration class for MSNumpress. More...

`#include <OpenMS/FORMAT/MSNumpressCoder.h>`

## Public Member Functions

| NumpressConfig ()
void | setCompression (const std::string &compression)
| Set compression using a string mapping to enum NumpressCompression. More...

## Public Attributes

double | numpressFixedPoint
| fixed point for numpress algorithms More...
double | numpressErrorTolerance
| Check error tolerance after encoding. More...
NumpressCompression | np_compression
| Which compression schema to use. More...
bool | estimate_fixed_point
| Whether to estimate the fixed point used for encoding (highly recommended) More...
double | linear_fp_mass_acc
| Desired mass accuracy for *linear* encoding. More...

## Detailed Description

Configuration class for MSNumpress.

Contains configuration options for ms numpress

## Constructor & Destructor Documentation

## ◆ NumpressConfig()

NumpressConfig | ( |  | ) |

inline

## Member Function Documentation

## ◆ setCompression()

void setCompression | ( | const std::string & | compression | ) |

inline

Set compression using a string mapping to enum NumpressCompression.

Parameters

  compression | A string from NamesOfNumpressCompression[]. Valid strings are "none", "linear", "pic" and "slof".

Exceptions

  Exception::InvalidParameter | if compression is unknown.

References seqan::find().

Referenced by TOPPOpenSwathBase::prepareChromOutput().

## Member Data Documentation

## ◆ estimate_fixed_point

bool estimate_fixed_point

Whether to estimate the fixed point used for encoding (highly recommended)

The fixed point determines the accuracy of the encoding and is automatically estimated when estimate_fixed_point is set to true.

Note
  : only change this if you know what you are doing

Referenced by TOPPOpenSwathBase::prepareChromOutput().

## ◆ linear_fp_mass_acc

double linear_fp_mass_acc

Desired mass accuracy for *linear* encoding.

This setting has no effect if set to -1, for example use 0.0001 for 0.2 ppm accuracy @ 500 m/z. Does not affect other encoding schemes (pic or slof).

Referenced by TOPPOpenSwathBase::prepareChromOutput().

## ◆ np_compression

NumpressCompression np_compression

Which compression schema to use.

This is of type NumpressCompression (see there)

## ◆ numpressErrorTolerance

double numpressErrorTolerance

Check error tolerance after encoding.

Check error tolerance after encoding to ensure that the maximum error is abs(1.0-(encoded/decoded)) <= eps which is set here. In case it is set to 0, checking the encoding error is disabled. Note that this will slow down encoding substantially as all data needs to be encoded first and then decoded again.

Referenced by TOPPOpenSwathBase::prepareChromOutput().

## ◆ numpressFixedPoint

double numpressFixedPoint

fixed point for numpress algorithms

Determines the accuracy of the encoding, is automatically estimated when estimate_fixed_point is set (only change this if you know what you are doing).