libpappsomspp
Library for mass spectrometry
Loading...
Searching...
No Matches
pappso::Enums Namespace Reference

Enumerations

enum class  TimeUnit { none , s , min , h }
 
enum class  PrecisionUnit {
  none , dalton , ppm , res ,
  mz , last
}
 
enum class  AtomIsotopeSurvey : std::int8_t {
  C , H , O , N ,
  S , P , last
}
 
enum class  Isotope {
  C , C13 , H , H2 ,
  O , O17 , O18 , N ,
  N15 , S , S33 , S34 ,
  S36 , P
}
 
enum class  MsDataFormat : std::int8_t {
  unknown = 0 , mzML = 1 , mzXML = 2 , MGF = 3 ,
  SQLite3 = 4 , xy = 5 , mz5 = 6 , msn = 7 ,
  abSciexWiff = 8 , abSciexT2D = 9 , agilentMassHunter = 10 , thermoRaw = 11 ,
  watersRaw = 12 , brukerFid = 13 , brukerYep = 14 , brukerBaf = 15 ,
  brukerTims = 16 , brukerBafAscii = 17 , mzcbor = 18 , last = 19
}
 
enum class  FileReaderType {
  pwiz , mzcbor , xy , bafascii ,
  tims , tims_frames , tims_ms2 , tims_dia
}
 
enum class  AminoAcidChar : char {
  alanine = 'A' , cysteine = 'C' , aspartic_acid = 'D' , glutamic_acid = 'E' ,
  phenylalanine = 'F' , glycine = 'G' , histidine = 'H' , isoleucine = 'I' ,
  lysine = 'K' , leucine = 'L' , methionine = 'M' , asparagine = 'N' ,
  proline = 'P' , glutamine = 'Q' , arginine = 'R' , serine = 'S' ,
  threonine = 'T' , valine = 'V' , tryptophan = 'W' , tyrosine = 'Y' ,
  selenocysteine = 'U' , pyrrolysine = 'O'
}
 
enum class  SortType : std::int8_t { none = 0 , x = 1 , y = 2 }
 
enum class  SortOrder : std::int8_t { ascending = 0 , descending = 1 }
 
enum class  DataCompression : std::int8_t { unset = -1 , none = 0 , zlib = 1 }
 
enum class  DataKind : std::int8_t { unset = -1 , rt = 0 , dt = 1 , mz = 2 }
 
enum class  Axis : std::int8_t { unset = 0x000 , x = 1 << 0 , y = 1 << 1 , z = 1 << 2 }
 
enum class  AxisScale : std::int8_t { unset = 0 , orig = 1 , log10 = 2 }
 
enum class  XicExtractMethod : std::int8_t { sum = 1 , max = 2 }
 
enum class  PeptideIon : std::int8_t {
  b = 0 , bstar = 1 , bo = 2 , a = 3 ,
  astar = 4 , ao = 5 , bp = 6 , c = 7 ,
  y = 8 , ystar = 9 , yo = 10 , z = 11 ,
  yp = 12 , x = 13
}
 Enums::PeptideIon enum defines all types of ions (Nter or Cter) More...
 

Enumeration Type Documentation

◆ AminoAcidChar

enum class pappso::Enums::AminoAcidChar : char
strong
Enumerator
alanine 
cysteine 
aspartic_acid 
glutamic_acid 
phenylalanine 
glycine 
histidine 
isoleucine 
lysine 
leucine 
methionine 
asparagine 
proline 
glutamine 
arginine 
serine 
threonine 
valine 
tryptophan 
tyrosine 
selenocysteine 
pyrrolysine 

Definition at line 196 of file types.h.

197{
198 alanine = 'A',
199 cysteine = 'C',
200 aspartic_acid = 'D',
201 glutamic_acid = 'E',
202 phenylalanine = 'F',
203 glycine = 'G',
204 histidine = 'H',
205 isoleucine = 'I',
206 lysine = 'K',
207 leucine = 'L',
208 methionine = 'M',
209 asparagine = 'N',
210 proline = 'P',
211 glutamine = 'Q',
212 arginine = 'R',
213 serine = 'S',
214 threonine = 'T',
215 valine = 'V',
216 tryptophan = 'W',
217 tyrosine = 'Y',
218 selenocysteine = 'U',
219 pyrrolysine = 'O',
220};

◆ AtomIsotopeSurvey

enum class pappso::Enums::AtomIsotopeSurvey : std::int8_t
strong
Enumerator
last 

Definition at line 110 of file types.h.

◆ Axis

enum class pappso::Enums::Axis : std::int8_t
strong
Enumerator
unset 

Definition at line 258 of file types.h.

259{
260 unset = 0x000,
261 x = 1 << 0,
262 y = 1 << 1,
263 z = 1 << 2,
264};

◆ AxisScale

enum class pappso::Enums::AxisScale : std::int8_t
strong
Enumerator
unset 
orig 
log10 

Definition at line 267 of file types.h.

268{
269 unset = 0,
270 orig = 1,
271 log10 = 2,
272};

◆ DataCompression

enum class pappso::Enums::DataCompression : std::int8_t
strong
Enumerator
unset 

not net

none 

no compression

zlib 

zlib compresssion

Definition at line 241 of file types.h.

242{
243 unset = -1, ///< not net
244 none = 0, ///< no compression
245 zlib = 1, ///< zlib compresssion
246};

◆ DataKind

enum class pappso::Enums::DataKind : std::int8_t
strong
Enumerator
unset 

not set

rt 

Retention time.

dt 

Drift time.

mz 

m/z

Definition at line 249 of file types.h.

250{
251 unset = -1, ///< not set
252 rt = 0, ///< Retention time
253 dt = 1, ///< Drift time
254 mz = 2, ///< m/z
255};
@ rt
Retention time.

◆ FileReaderType

enum class pappso::Enums::FileReaderType
strong
Enumerator
pwiz 

using libpwizlite

mzcbor 

using homemade mzcbor parser

xy 
bafascii 
tims 

TimsMsRunReader : each scan is returned as a mass spectrum.

tims_frames 

TimsFramesMsRunReader : the whole frame is merged in a single spectrum

tims_ms2 

TimsMsRunReaderMs2 : Spectrum are delivered for each precursor (MS1 or MS2)

tims_dia 

TimsMsRunReaderDia : Spectrum are delivered for DIA window (slice)

Definition at line 176 of file types.h.

177{
178 pwiz, ///< using libpwizlite
179 mzcbor, ///< using homemade mzcbor parser
180 xy,
181 bafascii,
182 tims, ///< TimsMsRunReader : each scan is returned as a mass spectrum
183 tims_frames, ///< TimsFramesMsRunReader : the whole frame is merged in a
184 ///< single spectrum
185 tims_ms2, ///< TimsMsRunReaderMs2 : Spectrum are delivered for each precursor
186 ///< (MS1 or MS2)
187
188 tims_dia, ///< TimsMsRunReaderDia : Spectrum are delivered for DIA window
189 ///< (slice)
190};
@ tims
TimsMsRunReader : each scan is returned as a mass spectrum.

◆ Isotope

enum class pappso::Enums::Isotope
strong
Enumerator
C13 
H2 
O17 
O18 
N15 
S33 
S34 
S36 

Definition at line 126 of file types.h.

◆ MsDataFormat

enum class pappso::Enums::MsDataFormat : std::int8_t
strong
Enumerator
unknown 

unknown format

mzML 

mzML

mzXML 

mzXML

MGF 

Mascot format.

SQLite3 

SQLite3 format.

xy 

(x,y) format

mz5 
msn 
abSciexWiff 
abSciexT2D 
agilentMassHunter 
thermoRaw 
watersRaw 
brukerFid 
brukerYep 
brukerBaf 
brukerTims 
brukerBafAscii 
mzcbor 
last 

Definition at line 148 of file types.h.

149{
150 unknown = 0, ///< unknown format
151 mzML = 1, ///< mzML
152 mzXML = 2, ///< mzXML
153 MGF = 3, ///< Mascot format
154 SQLite3 = 4, ///< SQLite3 format
155 xy = 5, ///< (x,y) format
156 mz5 = 6, //< MZ5 format
157 msn = 7, //< MS_MS2 format
158 abSciexWiff = 8,
159 abSciexT2D = 9,
161 thermoRaw = 11,
162 watersRaw = 12,
163 brukerFid = 13,
164 brukerYep = 14,
165 brukerBaf = 15,
166 brukerTims = 16,
167 brukerBafAscii = 17, // Baf to ascii from Bruker software
168 mzcbor = 18,
169 last = 19
170};
@ SQLite3
SQLite3 format.

◆ PeptideIon

enum class pappso::Enums::PeptideIon : std::int8_t
strong

Enums::PeptideIon enum defines all types of ions (Nter or Cter)

Enumerator

Nter acylium ions.

bstar 

Nter acylium ions + NH3 loss.

bo 

Nter acylium ions + H2O loss.

Nter aldimine ions.

astar 

Nter aldimine ions + NH3 loss.

ao 

Nter aldimine ions + H2O loss.

bp 

Nter amino ions.

Cter amino ions.

ystar 

Cter amino ions + NH3 loss.

yo 

Cter amino ions + H2O loss.

Cter carbocations.

yp 

Cter acylium ions.

Definition at line 286 of file types.h.

287{
288 b = 0, ///< Nter acylium ions
289 bstar = 1, ///< Nter acylium ions + NH3 loss
290 bo = 2, ///< Nter acylium ions + H2O loss
291 a = 3, ///< Nter aldimine ions
292 astar = 4, ///< Nter aldimine ions + NH3 loss
293 ao = 5, ///< Nter aldimine ions + H2O loss
294 bp = 6,
295 c = 7, ///< Nter amino ions
296 y = 8, ///< Cter amino ions
297 ystar = 9, ///< Cter amino ions + NH3 loss
298 yo = 10, ///< Cter amino ions + H2O loss
299 z = 11, ///< Cter carbocations
300 yp = 12,
301 x = 13 ///< Cter acylium ions
302};

◆ PrecisionUnit

enum class pappso::Enums::PrecisionUnit
strong
Enumerator
none 
dalton 
ppm 
res 
mz 
last 

Definition at line 96 of file types.h.

◆ SortOrder

enum class pappso::Enums::SortOrder : std::int8_t
strong
Enumerator
ascending 
descending 

Definition at line 231 of file types.h.

◆ SortType

enum class pappso::Enums::SortType : std::int8_t
strong
Enumerator
none 

Definition at line 223 of file types.h.

224{
225 none = 0,
226 x = 1,
227 y = 2,
228};

◆ TimeUnit

enum class pappso::Enums::TimeUnit
strong
Enumerator
none 
min 

Definition at line 85 of file types.h.

◆ XicExtractMethod

enum class pappso::Enums::XicExtractMethod : std::int8_t
strong
Enumerator
sum 

sum of intensities

max 

maximum of intensities

Definition at line 278 of file types.h.

279{
280 sum = 1, ///< sum of intensities
281 max = 2 ///< maximum of intensities
282};
@ max
maximum of intensities