ProteoWizard
Public Member Functions | Public Attributes | List of all members
pwiz::msdata::Reader::Config Struct Reference

Reader configuration. More...

#include <Reader.hpp>

Inheritance diagram for pwiz::msdata::Reader::Config:
pwiz::util::ReaderTestConfig

Public Member Functions

 Config ()
 
 Config (const Config &rhs)
 

Public Attributes

bool simAsSpectra
 when true, sets certain vendor readers to produce SIM transitions as spectra instead of chromatograms
 
bool srmAsSpectra
 when true, sets certain vendor readers to produce SRM transitions as spectra instead of chromatograms
 
bool acceptZeroLengthSpectra
 when true, allows for skipping 0 length checks (and thus skip re-reading data for Sciex)
 
bool ignoreZeroIntensityPoints
 when true, allows certain vendor readers to produce profile data without zero intensity samples flanking each peak profile
 
bool combineIonMobilitySpectra
 when true, all drift bins/scans in a frame/block are written in combined form instead of as individual spectra
 
bool unknownInstrumentIsError
 when true, if a reader cannot identify an instrument, an exception will be thrown asking users to report it
 
bool adjustUnknownTimeZonesToHostTimeZone
 when true, if a reader does not know what time zone was used to record a time, it will assume the time refers to the host's local time; when false, the reader will treat times with unknown time zone as UTC
 
pwiz::util::IterationListenerRegistryiterationListenerRegistry
 progress listener for when initializing a file takes a long time, or the reader has to run a long process before continuing, such as centroiding all spectra at once instead of one at a time
 
int preferOnlyMsLevel
 when nonzero, if reader can enumerate only spectra of ms level, it will (currently only supported by Bruker TDF)
 

Detailed Description

Reader configuration.

Definition at line 44 of file Reader.hpp.

Constructor & Destructor Documentation

◆ Config() [1/2]

pwiz::msdata::Reader::Config::Config ( )

◆ Config() [2/2]

pwiz::msdata::Reader::Config::Config ( const Config rhs)

Member Data Documentation

◆ simAsSpectra

bool pwiz::msdata::Reader::Config::simAsSpectra

when true, sets certain vendor readers to produce SIM transitions as spectra instead of chromatograms

Definition at line 47 of file Reader.hpp.

◆ srmAsSpectra

bool pwiz::msdata::Reader::Config::srmAsSpectra

when true, sets certain vendor readers to produce SRM transitions as spectra instead of chromatograms

Definition at line 50 of file Reader.hpp.

◆ acceptZeroLengthSpectra

bool pwiz::msdata::Reader::Config::acceptZeroLengthSpectra

when true, allows for skipping 0 length checks (and thus skip re-reading data for Sciex)

Definition at line 53 of file Reader.hpp.

◆ ignoreZeroIntensityPoints

bool pwiz::msdata::Reader::Config::ignoreZeroIntensityPoints

when true, allows certain vendor readers to produce profile data without zero intensity samples flanking each peak profile

Definition at line 56 of file Reader.hpp.

◆ combineIonMobilitySpectra

bool pwiz::msdata::Reader::Config::combineIonMobilitySpectra

when true, all drift bins/scans in a frame/block are written in combined form instead of as individual spectra

Definition at line 59 of file Reader.hpp.

Referenced by main().

◆ unknownInstrumentIsError

bool pwiz::msdata::Reader::Config::unknownInstrumentIsError

when true, if a reader cannot identify an instrument, an exception will be thrown asking users to report it

Definition at line 62 of file Reader.hpp.

◆ adjustUnknownTimeZonesToHostTimeZone

bool pwiz::msdata::Reader::Config::adjustUnknownTimeZonesToHostTimeZone

when true, if a reader does not know what time zone was used to record a time, it will assume the time refers to the host's local time; when false, the reader will treat times with unknown time zone as UTC

Definition at line 66 of file Reader.hpp.

◆ iterationListenerRegistry

pwiz::util::IterationListenerRegistry* pwiz::msdata::Reader::Config::iterationListenerRegistry

progress listener for when initializing a file takes a long time, or the reader has to run a long process before continuing, such as centroiding all spectra at once instead of one at a time

Definition at line 71 of file Reader.hpp.

◆ preferOnlyMsLevel

int pwiz::msdata::Reader::Config::preferOnlyMsLevel

when nonzero, if reader can enumerate only spectra of ms level, it will (currently only supported by Bruker TDF)

Definition at line 74 of file Reader.hpp.

Referenced by main().


The documentation for this struct was generated from the following file: