libpappsomspp
Library for mass spectrometry
pappso::PrecisionFactory Class Reference

#include <precision.h>

Static Public Member Functions

static PrecisionPtr fromString (const QString &str)
 get a precision pointer from a string More...
 
static PrecisionPtr getDaltonInstance (pappso_double value)
 get a Dalton precision pointer More...
 
static PrecisionPtr getPpmInstance (pappso_double value)
 get a ppm precision pointer More...
 
static PrecisionPtr getResInstance (pappso_double value)
 get a resolution precision pointer More...
 
static PrecisionPtr getPrecisionPtrFractionInstance (PrecisionPtr origin, double fraction)
 get the fraction of an existing precision pointer More...
 
static PrecisionPtr getPrecisionPtrInstance (PrecisionUnit unit, double value)
 get a precision pointer instance More...
 

Private Types

using MapDaltonPrecision = std::map< pappso_double, DaltonPrecision * >
 
using MapPpmPrecision = std::map< pappso_double, PpmPrecision * >
 
using MapResPrecision = std::map< pappso_double, ResPrecision * >
 

Static Private Attributes

static MapDaltonPrecision m_mapDalton
 
static MapPpmPrecision m_mapPpm
 
static MapResPrecision m_mapRes
 

Detailed Description

Definition at line 126 of file precision.h.

Member Typedef Documentation

◆ MapDaltonPrecision

Definition at line 128 of file precision.h.

◆ MapPpmPrecision

Definition at line 129 of file precision.h.

◆ MapResPrecision

Definition at line 130 of file precision.h.

Member Function Documentation

◆ fromString()

PrecisionPtr pappso::PrecisionFactory::fromString ( const QString &  str)
static

get a precision pointer from a string

Parameters
stris of the form : "nominal_value unit", example : "0.02 dalton"

Definition at line 71 of file precision.cpp.

72 {
73 
74  // The format of the string is <number><space *><string> with string either
75  // "ppm" or "dalton" or "res".
76  //
77  // If there only once component, that is, <string> is omitted and charge is
78  // not provided, then "dalton" is considered.
79 
80  QStringList list = str.split(QRegExp("\\s+"), Qt::SkipEmptyParts);
81 
82  if(list.size() > 0)
83  {
84  bool ok;
85  pappso_double value = list[0].toDouble(&ok);
86  if(!ok)
87  {
88  throw ExceptionNotPossible(
89  QObject::tr("ERROR getting precision from string :\nunable to "
90  "convert %1 to number in %2")
91  .arg(value)
92  .arg(str));
93  }
94  if(list.size() == 1)
95  {
97  }
98  else if(list.size() == 2)
99  {
100  if(list[1].toLower() == "dalton")
101  {
103  }
104 
105  if(list[1].toLower() == "ppm")
106  {
107  return PrecisionFactory::getPpmInstance(value);
108  }
109 
110  if(list[1].toLower() == "res")
111  {
112  return PrecisionFactory::getResInstance(value);
113  }
114 
115  throw ExceptionNotPossible(
116  QObject::tr("ERROR getting precision from string :\nprecision "
117  "unit %1 to not known in %2")
118  .arg(list[1])
119  .arg(str));
120  }
121  }
122 
123  throw ExceptionNotPossible(QObject::tr("ERROR getting precision from string "
124  ":\nunable to convert %1 to precision")
125  .arg(str));
126 }
static PrecisionPtr getResInstance(pappso_double value)
get a resolution precision pointer
Definition: precision.cpp:176
static PrecisionPtr getPpmInstance(pappso_double value)
get a ppm precision pointer
Definition: precision.cpp:149
static PrecisionPtr getDaltonInstance(pappso_double value)
get a Dalton precision pointer
Definition: precision.cpp:129
double pappso_double
A type definition for doubles.
Definition: types.h:48

References getDaltonInstance(), getPpmInstance(), and getResInstance().

Referenced by pappso::FilterChargeDeconvolution::buildFilterFromString(), pappso::FilterComplementIonEnhancer::buildFilterFromString(), and pappso::FilterMzExclusion::buildFilterFromString().

◆ getDaltonInstance()

PrecisionPtr pappso::PrecisionFactory::getDaltonInstance ( pappso_double  value)
static

get a Dalton precision pointer

Parameters
valuethe precision value in dalton

Definition at line 129 of file precision.cpp.

130 {
131  MapDaltonPrecision::iterator it = m_mapDalton.find(value);
132  if(it == m_mapDalton.end())
133  {
134  // not found
135  std::pair<MapDaltonPrecision::iterator, bool> insert_res =
136  m_mapDalton.insert(std::pair<pappso_double, DaltonPrecision *>(
137  value, new DaltonPrecision(value)));
138  it = insert_res.first;
139  }
140  else
141  {
142  // found
143  }
144  return it->second;
145 }
static MapDaltonPrecision m_mapDalton
Definition: precision.h:133

References m_mapDalton.

Referenced by pappso::PrecisionWidget::PrecisionWidget(), fromString(), pappso::AaModification::getInstanceXtandemMod(), getPrecisionPtrInstance(), pappso::XtandemSpectrumProcess::process(), pappso::PrecisionWidget::setDaltonValueChanged(), and pappso::MzIntegrationParams::setPrecision().

◆ getPpmInstance()

PrecisionPtr pappso::PrecisionFactory::getPpmInstance ( pappso_double  value)
static

get a ppm precision pointer

Parameters
valuethe precision value in ppm

Definition at line 149 of file precision.cpp.

150 {
151  if(!value)
152  throw ExceptionNotPossible(
153  QObject::tr("Fatal error at precision.cpp "
154  "-- ERROR trying to set a Resolution precision value of 0. "
155  "Program aborted."));
156 
157  MapPpmPrecision::iterator it = m_mapPpm.find(value);
158 
159  if(it == m_mapPpm.end())
160  {
161  // Not found.
162  std::pair<MapPpmPrecision::iterator, bool> insert_res =
163  m_mapPpm.insert(std::pair<pappso_double, PpmPrecision *>(
164  value, new PpmPrecision(value)));
165  it = insert_res.first;
166  }
167  else
168  {
169  // found
170  }
171  return it->second;
172 }
static MapPpmPrecision m_mapPpm
Definition: precision.h:134

References m_mapPpm.

Referenced by pappso::MzIntegrationParams::MzIntegrationParams(), pappso::PrecisionWidget::PrecisionWidget(), pappso::MassSpectrum::equals(), fromString(), getPrecisionPtrInstance(), pappso::MzIntegrationParams::operator=(), pappso::MzIntegrationParams::reset(), and pappso::PrecisionWidget::setPpmValueChanged().

◆ getPrecisionPtrFractionInstance()

PrecisionPtr pappso::PrecisionFactory::getPrecisionPtrFractionInstance ( PrecisionPtr  origin,
double  fraction 
)
static

get the fraction of an existing precision pointer

Parameters
originthe original precision pointer
fractionthe fraction to apply on the original precision

Definition at line 202 of file precision.cpp.

204 {
205  PrecisionUnit unit = origin->unit();
206  double value = origin->getNominal() * fraction;
207 
208 
209  return getPrecisionPtrInstance(unit, value);
210 }
static PrecisionPtr getPrecisionPtrInstance(PrecisionUnit unit, double value)
get a precision pointer instance
Definition: precision.cpp:213
PrecisionUnit
Definition: types.h:63

References pappso::PrecisionBase::getNominal(), getPrecisionPtrInstance(), and pappso::PrecisionBase::unit().

Referenced by pappso::FilterChargeDeconvolution::FilterChargeDeconvolution(), and pappso::FilterChargeDeconvolution::buildFilterFromString().

◆ getPrecisionPtrInstance()

PrecisionPtr pappso::PrecisionFactory::getPrecisionPtrInstance ( PrecisionUnit  unit,
double  value 
)
static

get a precision pointer instance

Parameters
unitthe precision unit
valuethe precision value

Definition at line 213 of file precision.cpp.

214 {
215 
216  switch(unit)
217  {
219  return getDaltonInstance(value);
220  case PrecisionUnit::ppm:
221  return getPpmInstance(value);
222  case PrecisionUnit::res:
223  return getResInstance(value);
224  case PrecisionUnit::mz:
225  return getDaltonInstance(value);
226  case PrecisionUnit::none:
227  throw ExceptionNotPossible(QObject::tr("Unknown precision unit"));
228 
229  default:
230  throw ExceptionNotPossible(QObject::tr("Unknown precision unit"));
231  break;
232  }
233 
234  return nullptr;
235 }

References pappso::dalton, getDaltonInstance(), getPpmInstance(), getResInstance(), pappso::mz, pappso::none, pappso::ppm, and pappso::res.

Referenced by pappso::XtandemPresetReader::getMs2FiltersOptions(), and getPrecisionPtrFractionInstance().

◆ getResInstance()

PrecisionPtr pappso::PrecisionFactory::getResInstance ( pappso_double  value)
static

get a resolution precision pointer

Parameters
valuethe precision value in resolution

Definition at line 176 of file precision.cpp.

177 {
178  if(!value)
179  throw ExceptionNotPossible(
180  QObject::tr("Fatal error at precision.cpp "
181  "-- ERROR trying to set a Resolution precision value of 0. "
182  "Program aborted."));
183 
184  MapResPrecision::iterator it = m_mapRes.find(value);
185 
186  if(it == m_mapRes.end())
187  {
188  // not found
189  std::pair<MapResPrecision::iterator, bool> insert_res =
190  m_mapRes.insert(std::pair<pappso_double, ResPrecision *>(
191  value, new ResPrecision(value)));
192  it = insert_res.first;
193  }
194  else
195  {
196  // found
197  }
198  return it->second;
199 }
static MapResPrecision m_mapRes
Definition: precision.h:135

References m_mapRes.

Referenced by pappso::PrecisionWidget::PrecisionWidget(), fromString(), getPrecisionPtrInstance(), and pappso::PrecisionWidget::setResValueChanged().

Member Data Documentation

◆ m_mapDalton

PrecisionFactory::MapDaltonPrecision pappso::PrecisionFactory::m_mapDalton
staticprivate
Initial value:
= [] {
return ret;
}()
std::map< pappso_double, DaltonPrecision * > MapDaltonPrecision
Definition: precision.h:128

Definition at line 133 of file precision.h.

Referenced by getDaltonInstance().

◆ m_mapPpm

PrecisionFactory::MapPpmPrecision pappso::PrecisionFactory::m_mapPpm
staticprivate
Initial value:
= [] {
return ret;
}()
std::map< pappso_double, PpmPrecision * > MapPpmPrecision
Definition: precision.h:129

Definition at line 134 of file precision.h.

Referenced by getPpmInstance().

◆ m_mapRes

PrecisionFactory::MapResPrecision pappso::PrecisionFactory::m_mapRes
staticprivate
Initial value:
= [] {
return ret;
}()
std::map< pappso_double, ResPrecision * > MapResPrecision
Definition: precision.h:130

Definition at line 135 of file precision.h.

Referenced by getResInstance().


The documentation for this class was generated from the following files: