OpenMS  2.4.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 ()
 desired mass accuracy for linear encoding (-1 no effect, use 0.0001 for 0.2 ppm accuracy @ 500 m/z) More...
 
void setCompression (const std::string &compression)
 set compression using a string mapping to enum NumpressCompression. More...
 

Public Attributes

double numpressFixedPoint
 
double numpressErrorTolerance
 fixed point for numpress algorithms More...
 
NumpressCompression np_compression
 check error tolerance after encoding, guarantee abs(1.0-(encoded/decoded)) <= this, 0=do not guarantee anything More...
 
bool estimate_fixed_point
 which compression schema to use More...
 
double linear_fp_mass_acc
 whether to estimate the fixed point or use the one proved with numpressFixedPoint More...
 

Detailed Description

Configuration class for MSNumpress.

Contains configuration options for ms numpress

Constructor & Destructor Documentation

◆ NumpressConfig()

NumpressConfig ( )
inline

desired mass accuracy for linear encoding (-1 no effect, use 0.0001 for 0.2 ppm accuracy @ 500 m/z)

Member Function Documentation

◆ setCompression()

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

set compression using a string mapping to enum NumpressCompression.

Parameters
compressionA string from NamesOfNumpressCompression[]
Exceptions
Exception::InvalidParameterif compression is unknown.

References seqan::find().

Member Data Documentation

◆ estimate_fixed_point

bool estimate_fixed_point

which compression schema to use

◆ linear_fp_mass_acc

double linear_fp_mass_acc

whether to estimate the fixed point or use the one proved with numpressFixedPoint

◆ np_compression

NumpressCompression np_compression

check error tolerance after encoding, guarantee abs(1.0-(encoded/decoded)) <= this, 0=do not guarantee anything

◆ numpressErrorTolerance

double numpressErrorTolerance

fixed point for numpress algorithms

◆ numpressFixedPoint

double numpressFixedPoint