Thermo Fisher Scientific MSFileReader 2.2 Reference guide

Type
Reference guide
MSFileReader
Version 2.2
Reference Guide
Revision A August 2011
© 2011 Thermo Fisher Scientific Inc. All rights reserved.
Thermo Fisher Scientific Inc. provides this document to its customers with a product purchase to use in the
product operation. This document is copyright protected and any reproduction of the whole or any part of this
document is strictly prohibited, except with the written authorization of Thermo Fisher Scientific Inc.
The contents of this document are subject to change without notice. All technical information in this
document is for reference purposes only. System configurations and specifications in this document supersede
all previous information received by the purchaser.
Thermo Fisher Scientific Inc. makes no representations that this document is complete, accurate or error-
free and assumes no responsibility and will not be liable for any errors, omissions, damage or loss that might
result from any use of this document, even if the information in the document is followed properly.
This document is not part of any sales contract between Thermo Fisher Scientific Inc. and a purchaser. This
document shall in no way govern or modify any Terms and Conditions of Sale, which Terms and Conditions of
Sale shall govern all conflicting information between the two documents.
Release history: Revision A August 2011
Software Version 2.2
For Research Use Only. Not for use in diagnostic procedures.
Thermo Scientific MSFileReader Reference Guide iii
C
Chapter 1 Library Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Enumerated Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Sample Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Controller Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Cutoff Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chromatogram Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chromatogram Operator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Smoothing Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Error Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Chapter 2 Function Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
Open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
GetFileName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
GetCreatorID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
GetVersionNumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
GetCreationDate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
IsError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
IsNewFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
GetErrorCode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
GetErrorMessage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
GetWarningMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
GetSeqRowNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
GetSeqRowSampleType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
GetSeqRowDataPath. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
GetSeqRowRawFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
GetSeqRowSampleName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
GetSeqRowSampleID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
GetSeqRowComment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
GetSeqRowLevelName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
GetSeqRowUserText. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
GetSeqRowInstrumentMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
GetSeqRowProcessingMethod. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
GetSetRowCalibrationFile. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
GetSeqRowVial. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GetSeqRowInjectionVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Contents
Contents
iv MSFileReader Reference Guide Thermo Scientific
GetSeqRowSampleWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
GetSeqRowSampleVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
GetSeqRowISTDAmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GetSeqRowDilutionFactor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
GetSeqRowUserLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
InAcquisition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
GetNumberOfControllers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
GetNumberOfControllersOfType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
GetControllerType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
SetCurrentController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
GetCurrentController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
GetNumSpectra . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
GetNumStatusLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
GetNumErrorLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
GetNumTuneData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
GetMassResolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
GetExpectedRunTime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
GetNumTrailerExtra. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
GetLowMass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
GetHighMass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
GetStartTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
GetEndTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
GetMaxIntegratedIntensity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
GetMaxIntensity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
GetFirstSpectrumNumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
GetLastSpectrumNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
GetInstrumentID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
GetInletID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
GetErrorFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
GetSampleVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
GetSampleWeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
GetVialNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
GetInjectionVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
GetFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
GetAcquisitionFileName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
GetInstrumentDescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
GetAcquisitionDate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
GetOperator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
GetComment1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
GetComment2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
GetSampleAmountUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
GetInjectionAmountUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
GetSampleVolumeUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
GetInstName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
GetInstModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Contents
Thermo Scientific MSFileReader Reference Guide v
GetInstSerialNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
GetInstSoftwareVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
GetInstHardwareVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
GetInstFlags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
GetInstNumChannelLabels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
GetInstChannelLabel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
GetFilters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
ScanNumFromRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
RTFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
GetFilterForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
GetFilterForScanRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
GetMassListFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
GetMassListFromRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
GetNextMassListFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
GetPrevMassListFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
GetMassListRangeFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
GetMassListRangeFromRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
GetNextMassListRangeFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
GetPrecursorInfoFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
GetPrevMassListRangeFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
GetAverageMassList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
GetAveragedMassSpectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
GetSummedMassSpectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
GetLabelData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
GetAveragedLabelData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
GetNoiseData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
IsProfileScanForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
IsCentroidScanForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
GetScanHeaderInfoForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
GetStatusLogForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
GetStatusLogForRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
GetStatusLogLabelsForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
GetStatusLogLabelsForRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
GetStatusLogValueForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
GetStatusLogValueForRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
GetTrailerExtraForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
GetTrailerExtraForRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
GetTrailerExtraLabelsForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
GetTrailerExtraLabelsForRT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
GetTrailerExtraValueForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
GetTrailerExtraValueForRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
GetErrorLogItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
GetTuneData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
GetTuneDataValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
GetTuneDataLabels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Contents
vi MSFileReader Reference Guide Thermo Scientific
GetNumInstMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
GetInstMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
GetChroData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
GetMassListRangeFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
GetMassListRangeFromRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
GetPrecursorInfoFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
RefreshViewOfFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
ExtractInstMethodFromRaw. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
GetActivationTypeForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
GetMassAnalyzerTypeForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
GetDetectorTypeForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
GetScanTypeForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
GetMSOrderForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
GetPrecursorMassForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
IsThereMSData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
HasExpMethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
GetFilterMassPrecision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
GetStatusLogForPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
GetStatusLogPlottableIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
GetInstMethodNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
SetMassTolerance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
GetChros. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
GetSegmentedMassListFromRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
GetSegmentedMassListFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
GetScanEventForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
GetSeqRowUserTextEx. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
GetSeqRowBarcode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
GetSeqRowBarcodeStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
GetSegmentAndScanEventForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
GetMassPrecisionEstimate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
GetNumberOfMassRangesFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
GetNumberOfMSOrdersFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
GetNumberOfMassCalibratorsFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . 238
GetCycleNumberFromScanNumber. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
GetUniqueCompoundNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
GetCompoundNameFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
GetAValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
GetBValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
GetFValueFromScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
GetKValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
GetRValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
GetVValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
GetMSXMultiplexValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
GetMassCalibrationValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Contents
Thermo Scientific MSFileReader Reference Guide vii
GetFullMSOrderPrecursorDataFromScanNum . . . . . . . . . . . . . . . . . . . . . . . 251
GetMassRangeFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
GetMassTolerance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
GetNumberOfSourceFragmentsFromScanNum . . . . . . . . . . . . . . . . . . . . . . . 256
GetSourceFragmentValueFromScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
GetNumberOfSourceFragmentationMassRangesFromScanNum . . . . . . . . . . 258
GetSourceFragmentationMassRangeFromScanNum. . . . . . . . . . . . . . . . . . . . 259
GetIsolationWidthForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
GetCollisionEnergyForScanNum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
GetPrecursorRangeForScanNum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
GetAllMSOrderData. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
GetChroByCompoundName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
IsQExactive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
Thermo Scientific MSFileReader Reference Guide 1
1
Library Definitions
MSFileReader is designed to support read access to Xcalibur .raw files in a simple-to-use
standard COM object without requiring installation of the Xcalibur data system. It is
designed to be used with C++-based applications, but since it is a COM object, you can use
any language that supports the COM interface.
Most of the functions described in this document are simple data access functions, but the
manual also includes a number of higher-level functions that extract and manipulate the data
in commonly used ways.
The description of each function includes the following information:
The function calling sequence
Return values
Definitions of both input and output parameters
An example using the function
The enumeration types described in this chapter standardize the handling of the following
components: the variables set by the instrument (or instruments) during acquisition, and
algorithms in the post-acquisition processing of data. Using these variables, you can determine
the instrument type (mass spectrometer, analog signal, and so on), and you can select the
number of the instrument (with a multiple instrument configuration) used to generate data to
the raw file. The described enumerators also handle access to selected channels from
multiple-channel data.
All of the described methods provide for systematic error checking and handling. This chapter
also provides descriptions related to the error codes returned as a result of trapped errors.
Enumerated Types
Several functions expect or return a parameter of type “long” that defines, typically, a type
parameter.
Contents
Enumerated Types
Error Codes
1 Library Definitions
Enumerated Types
2MSFileReader Reference Guide Thermo Scientific
Sample Type
Controller Type
Cutoff Type
Chromatogram Type
Chromatogram Operator
Smoothing Type
Sample Type
Sample type is returned in the GetSeqRowSampleType(…) function. The returned value has
the following meaning.
Controller Type
Controller type determines the type of data being accessed. This type is set or returned in the
calls to Get or Set controller information. This value has the following meaning.
Value Sample type
0 Unknown
1Blank
2QC
3Standard Clear (None)
4 Standard Update (None)
5 Standard Bracket (Open)
6 Standard Bracket Start (multiple brackets)
7 Standard Bracket End (multiple brackets)
Value Controller type
-1 No device
0MS
1Analog
2A/D card
3PDA
4UV
1 Library Definitions
Enumerated Types
Thermo Scientific MSFileReader Reference Guide 3
Cutoff Type
Cutoff type is specified in calls to GetMassListXYZ(…). The purpose of this cutoff type is to
determine how the cutoff value is interpreted. This value has the following meaning.
Chromatogram Type
Chromatogram type is specified in the GetChroData(…) function. The value of this field
depends on the current controller and whether or not this is the first chromatogram type
parameter or the second chromatogram type parameter to this function. This value has the
following meaning:
For MS devices (chromatogram trace type values are in parentheses).
For PDA devices (chromatogram trace type values are in parentheses).
Value Cutoff type
0 None (all values returned)
1 Absolute (in intensity units)
2 Relative (to base peak)
Chro type 1 Chro operator Chro type 2
Mass Range (0) + or - Mass Range (0)
TIC (1) - Mass Range (0)
TIC (1) - Base Peak (1)
Base Peak (2) + or - Mass Range (0)
Chro Type 1 Chro Operator Chro Type 2
Wavelength Range (0) + or - Wavelength Range (0)
Total Scan (1) - Wavelength Range (0)
Total Scan (1) - Spectrum Maximum (1)
Spectrum Maximum (2) + or - Wavelength Range (0)
1 Library Definitions
Enumerated Types
4MSFileReader Reference Guide Thermo Scientific
For UV devices (chromatogram trace type values are in parentheses).
For Analog devices (chromatogram trace type values are in parentheses).
Chro Type 1 Chro Operator Chro Type 2
Channel A (0) + or - Channel B (0)
Channel A (0) + or - Channel C (1)
Channel A (0) + or - Channel D (2)
Channel B (1) + or - Channel A (0)
Channel B (1) + or - Channel C (1)
Channel B (1) + or - Channel D (2)
Channel C (2) + or - Channel A (0)
Channel C (2) + or - Channel B (1)
Channel C (2) + or - Channel D (2)
Channel D (3) + or - Channel A (0)
Channel D (3) + or - Channel B (1)
Channel D (3) + or - Channel C (2)
Chro Type 1 Chro Operator Chro Type 2
Analog 1 (0) + or - Analog 2 (0)
Analog 1 (0) + or - Analog 3 (1)
Analog 1 (0) + or - Analog 4 (2)
Analog 2 (1) + or - Analog 1 (0)
Analog 2 (1) + or - Analog 3 (1)
Analog 2 (1) + or - Analog 4 (2)
Analog 3 (2) + or - Analog 1 (0)
Analog 3 (2) + or - Analog 2 (1)
Analog 3 (2) + or - Analog 4 (2)
Analog 4 (3) + or - Analog 1 (0)
Analog 4 (3) + or - Analog 2 (1)
Analog 4 (3) + or - Analog 3 (2)
1 Library Definitions
Enumerated Types
Thermo Scientific MSFileReader Reference Guide 5
For A/D card devices (chromatogram trace type values are in parentheses).
Chromatogram Operator
The chromatogram operator type is specified in the GetChroData(…) function. This value
has the following meaning.
Smoothing Type
The smoothing type is specified in the GetChroData(…) function. This value has the
following meaning.
Chro Type 1 Chro Operator Chro Type 2
A/D Card Ch. 1 (0) + or - A/D Card Ch. 2 (0)
A/D Card Ch. 1 (0) + or - A/D Card Ch. 3 (1)
A/D Card Ch. 1 (0) + or - A/D Card Ch. 4 (2)
A/D Card Ch. 2 (1) + or - A/D Card Ch. 1 (0)
A/D Card Ch. 2 (1) + or - A/D Card Ch. 3 (1)
A/D Card Ch. 2 (1) + or - A/D Card Ch. 4 (2)
A/D Card Ch. 3 (2) + or - A/D Card Ch. 1 (0)
A/D Card Ch. 3 (2) + or - A/D Card Ch. 2 (1)
A/D Card Ch. 3 (2) + or - A/D Card Ch. 4 (2)
A/D Card Ch. 4 (3) + or - A/D Card Ch. 1 (0)
A/D Card Ch. 4 (3) + or - A/D Card Ch. 2 (1)
A/D Card Ch. 4 (3) + or - A/D Card Ch. 3 (2)
Value Chro operator
0 None (single chro only)
1 Minus (subtract chro 2 from chro 1)
2 Plus (add chro 1 and chro 2)
Value Smoothing type
0 None (no smoothing)
1Boxcar
2 Gaussian
1 Library Definitions
Error Codes
6MSFileReader Reference Guide Thermo Scientific
Error Codes
Table 1. Error Codes (Sheet 1 of 5)
List of error codes
clNO_DATA_PRESENT = 0x80002101;
Does not typically indicate an error. This code may be returned
if optional data is not contained in the current raw file.
clSUCCESS = 0;
Indicates that the function call to the dll was processed without error.
clFAILED = 0x80004005;
Indicates that a general error has occurred. This code may be returned
whenever an error of indeterminate origin occurs.
clCOL_INDEX_OUT_OF_RANGE = 0x80002206;
Returns if the column index is out of the range.
clUSER_INDEX_OUT_OF_RANGE = 0x80002205;
Returns if the user index is out of the range.
clSEQ_ROW_INVALID = 0x80002204;
Returns if the sequence row is invalid.
clSEQ_FILE_READONLY = 0x80002203;
Returns if the sequence file is read only.
clNEW_FILE_READONLY = 0x80002202;
Returns if the file to be created is read only.
clSEQ_FILE_INVALID = 0x80002201;
Returns if the sequence file is invalid.
1 Library Definitions
Error Codes
Thermo Scientific MSFileReader Reference Guide 7
clINCOMPLETE_PARAMETER_SET = 0x80002117;
Returns if the parameter set is wrong.
clFILE_CRC_CHECK_FAILED = 0x80002116;
Returns if the CRC check fails.
clFILE_ALREADY_EXISTS = 0x80002115;
Returns if creating a file that already exists.
clFILE_NOT_FOUND = 0x80002114;
Returns if the file specified is not found.
clFILE_INVALID = 0x80002113;
Returns if no valid raw file is currently open.
clMETHOD_SCAN_EVENTS_NOT_INITIALIZED = 0x80002112;
Returns if the scan event in the method file is not initialized.
clTUNE_DATA_HEADER_NOT_INITIALIZED = 0x80002111;
Returns if the tune data header is not initialized.
clSTATUS_LOG_HEADER_NOT_INITIALIZED = 0x80002110;
Returns if the status log header is not initialized.
clTRAILER_HEADER_NOT_INITIALIZED = 0x8000210f;
Returns if the trailer header is not initialized.
clVIRUV_CREATION_FAILED = 0x8000210e;
Returns if the UV file creation fails.
Table 1. Error Codes (Sheet 2 of 5)
List of error codes
1 Library Definitions
Error Codes
8MSFileReader Reference Guide Thermo Scientific
clVIRUV_INVALID = 0x8000210d;
Returns if the UV data is invalid.
clVIRMS_CREATION_FAILED = 0x8000210c;
Returns if the MS data creation fails.
clVIRMS_INVALID = 0x8000210b;
Returns if the MS data is invalid.
clRAW_FILE_SAVE_FAILED = 0x8000210a;
Returns if the raw file saving fails.
clRAW_FILE_CREATION_FAILED = 0x80002109;
Returns if the raw file creation fails.
clMASS_RANGE_FORMAT_INCORRECT = 0x80002108;
Returns if an incorrectly formatted mass range is passed in a function
call. Mass ranges should have the same format as entered in Xcalibur
applications.
clFILTER_FORMAT_INCORRECT = 0x80002107;
Returns if an incorrectly formatted scan filter is passed in a function
call. See the topic scan filters – format, definition in Xcalibur Help
for scan filter format specifications.
clOPERATION_NOT_SUPPORTED_ON_CURRENT_CONTROLLER = 0x80002105;
Returns if the requested action is inappropriate for the currently
defined controller. Some functions only apply to specific controllers.
This code might also be returned if a parameter is passed in a call that
is not supported by the current controller. For example, scan filters
may only be passed in calls when the current controller is of mass
spectrometer type (MS_DEVICE).
Table 1. Error Codes (Sheet 3 of 5)
List of error codes
1 Library Definitions
Error Codes
Thermo Scientific MSFileReader Reference Guide 9
clCURRENT_CONTROLLER_INVALID = 0x80002104;
Returns if no current controller has been specified.
clRAW_FILE_INVALID = 0x80002103;
Returns if the raw file is invalid.
clNO_DATA_PRESENT = 0x80002101;
Returns if there is no data in the specified file.
clRAW_FILE_OPEN_FAIL = 0x80002100;
Returns if the raw file cannot be opened.
clINSTMETHOD_NOT_EMBEDDED = 0x80002099;
Returns if there is no emebedded instrument method in the raw file.
clRAW_FILE_TOOOLDVER = 0x80002098;
Returns if the raw file version is too old that is not supported by Xcalibur.
clINSTMETHOD_CREATE_FAIL = 0x80002097;
Returns if the instrument method file creation fails.
const long clMPE_SCANFILTER = 0x80002117;
Empty scan filters.
const long clMPE_EMPTY_SCANHEADER = 0x80002118;
Scan header is empty.
const long clMPE_FILTER = 0x80002119;
The filter format is not supported.
const long clRAW_FILE_OPEN_FAIL = 0x80002100;
Table 1. Error Codes (Sheet 4 of 5)
List of error codes
1 Library Definitions
Error Codes
10 MSFileReader Reference Guide Thermo Scientific
Failed to open raw file.
const long clMPE_RESOLUTIONERROR = 0x80002101;
The resolution value is wrong with the raw file.
const long clINSTMETHOD_NOT_EMBEDDED = 0x80002099;
In the raw file, the instrument method is not embedded.
const long clRAW_FILE_TOOOLDVER = 0x80002098;
The version of the raw file is too old or is not supported.
const long clINSTMETHOD_CREATE_FAIL = 0x80002097;
Failed to create instrument method extracted from the raw file.
const long clMPE_INVALID_SCANHEADER = 0x8000211a;
Returns when the scan header is invalid.
const long clMPE_INVALID_SCANTRAIL = 0x8000211b;
Returns when the scan trail data is invalid.
const long clMPE_INVALID_RAWDATA = 0x8000211c;
Returns when the raw data is invalid.
const long clMPE_INVALID_LABELDATA = 0x8000211d;
Returns when the label data is invalid.
Table 1. Error Codes (Sheet 5 of 5)
List of error codes
Thermo Scientific MSFileReader Reference Guide 11
2
Function Reference
This chapter provides extensive descriptions on the function or methods available to
programmers using MSFileReader.dll. The examples contained are written using the C
programming language but should also serve experienced programmers of other common
programming languages well.
Open
long Open(LPCTSTR szFileName)
Return Value
0 if successful; otherwise, see Error Codes.
Parameters
szFileName A NULL terminated string containing the fully qualified path name of the
raw file to open.
Remarks
Opens a raw file for reading only. This function must be called before attempting to read any
data from the raw file.
Example
// example for Open
TCHAR* szPathName[] = _T(“c:\\xcalibur\\examples\\data\\steroids15.raw”);
long nRet = XRawfileCtrl.Open( szPathName );
if( nRet != 0 )
{
::MessageBox( NULL, _T(“Error opening file”), _T(“Error”), MB_OK );
}
2 Function Reference
Close
12 MSFileReader Reference Guide Thermo Scientific
Close
long Close()
Return Value
0 if successful; otherwise, see Error Codes.
Parameters
This function has no parameters.
Remarks
Closes a raw file and frees the associated memory.
Example
// example for Close
long nRet = XRawfileCtrl.Close();
if( nRet != 0 )
{
::MessageBox( NULL, _T(“Error closing file”), _T(“Error”), MB_OK );
}
  • Page 1 1
  • Page 2 2
  • Page 3 3
  • Page 4 4
  • Page 5 5
  • Page 6 6
  • Page 7 7
  • Page 8 8
  • Page 9 9
  • Page 10 10
  • Page 11 11
  • Page 12 12
  • Page 13 13
  • Page 14 14
  • Page 15 15
  • Page 16 16
  • Page 17 17
  • Page 18 18
  • Page 19 19
  • Page 20 20
  • Page 21 21
  • Page 22 22
  • Page 23 23
  • Page 24 24
  • Page 25 25
  • Page 26 26
  • Page 27 27
  • Page 28 28
  • Page 29 29
  • Page 30 30
  • Page 31 31
  • Page 32 32
  • Page 33 33
  • Page 34 34
  • Page 35 35
  • Page 36 36
  • Page 37 37
  • Page 38 38
  • Page 39 39
  • Page 40 40
  • Page 41 41
  • Page 42 42
  • Page 43 43
  • Page 44 44
  • Page 45 45
  • Page 46 46
  • Page 47 47
  • Page 48 48
  • Page 49 49
  • Page 50 50
  • Page 51 51
  • Page 52 52
  • Page 53 53
  • Page 54 54
  • Page 55 55
  • Page 56 56
  • Page 57 57
  • Page 58 58
  • Page 59 59
  • Page 60 60
  • Page 61 61
  • Page 62 62
  • Page 63 63
  • Page 64 64
  • Page 65 65
  • Page 66 66
  • Page 67 67
  • Page 68 68
  • Page 69 69
  • Page 70 70
  • Page 71 71
  • Page 72 72
  • Page 73 73
  • Page 74 74
  • Page 75 75
  • Page 76 76
  • Page 77 77
  • Page 78 78
  • Page 79 79
  • Page 80 80
  • Page 81 81
  • Page 82 82
  • Page 83 83
  • Page 84 84
  • Page 85 85
  • Page 86 86
  • Page 87 87
  • Page 88 88
  • Page 89 89
  • Page 90 90
  • Page 91 91
  • Page 92 92
  • Page 93 93
  • Page 94 94
  • Page 95 95
  • Page 96 96
  • Page 97 97
  • Page 98 98
  • Page 99 99
  • Page 100 100
  • Page 101 101
  • Page 102 102
  • Page 103 103
  • Page 104 104
  • Page 105 105
  • Page 106 106
  • Page 107 107
  • Page 108 108
  • Page 109 109
  • Page 110 110
  • Page 111 111
  • Page 112 112
  • Page 113 113
  • Page 114 114
  • Page 115 115
  • Page 116 116
  • Page 117 117
  • Page 118 118
  • Page 119 119
  • Page 120 120
  • Page 121 121
  • Page 122 122
  • Page 123 123
  • Page 124 124
  • Page 125 125
  • Page 126 126
  • Page 127 127
  • Page 128 128
  • Page 129 129
  • Page 130 130
  • Page 131 131
  • Page 132 132
  • Page 133 133
  • Page 134 134
  • Page 135 135
  • Page 136 136
  • Page 137 137
  • Page 138 138
  • Page 139 139
  • Page 140 140
  • Page 141 141
  • Page 142 142
  • Page 143 143
  • Page 144 144
  • Page 145 145
  • Page 146 146
  • Page 147 147
  • Page 148 148
  • Page 149 149
  • Page 150 150
  • Page 151 151
  • Page 152 152
  • Page 153 153
  • Page 154 154
  • Page 155 155
  • Page 156 156
  • Page 157 157
  • Page 158 158
  • Page 159 159
  • Page 160 160
  • Page 161 161
  • Page 162 162
  • Page 163 163
  • Page 164 164
  • Page 165 165
  • Page 166 166
  • Page 167 167
  • Page 168 168
  • Page 169 169
  • Page 170 170
  • Page 171 171
  • Page 172 172
  • Page 173 173
  • Page 174 174
  • Page 175 175
  • Page 176 176
  • Page 177 177
  • Page 178 178
  • Page 179 179
  • Page 180 180
  • Page 181 181
  • Page 182 182
  • Page 183 183
  • Page 184 184
  • Page 185 185
  • Page 186 186
  • Page 187 187
  • Page 188 188
  • Page 189 189
  • Page 190 190
  • Page 191 191
  • Page 192 192
  • Page 193 193
  • Page 194 194
  • Page 195 195
  • Page 196 196
  • Page 197 197
  • Page 198 198
  • Page 199 199
  • Page 200 200
  • Page 201 201
  • Page 202 202
  • Page 203 203
  • Page 204 204
  • Page 205 205
  • Page 206 206
  • Page 207 207
  • Page 208 208
  • Page 209 209
  • Page 210 210
  • Page 211 211
  • Page 212 212
  • Page 213 213
  • Page 214 214
  • Page 215 215
  • Page 216 216
  • Page 217 217
  • Page 218 218
  • Page 219 219
  • Page 220 220
  • Page 221 221
  • Page 222 222
  • Page 223 223
  • Page 224 224
  • Page 225 225
  • Page 226 226
  • Page 227 227
  • Page 228 228
  • Page 229 229
  • Page 230 230
  • Page 231 231
  • Page 232 232
  • Page 233 233
  • Page 234 234
  • Page 235 235
  • Page 236 236
  • Page 237 237
  • Page 238 238
  • Page 239 239
  • Page 240 240
  • Page 241 241
  • Page 242 242
  • Page 243 243
  • Page 244 244
  • Page 245 245
  • Page 246 246
  • Page 247 247
  • Page 248 248
  • Page 249 249
  • Page 250 250
  • Page 251 251
  • Page 252 252
  • Page 253 253
  • Page 254 254
  • Page 255 255
  • Page 256 256
  • Page 257 257
  • Page 258 258
  • Page 259 259
  • Page 260 260
  • Page 261 261
  • Page 262 262
  • Page 263 263
  • Page 264 264
  • Page 265 265
  • Page 266 266
  • Page 267 267
  • Page 268 268
  • Page 269 269
  • Page 270 270
  • Page 271 271
  • Page 272 272
  • Page 273 273
  • Page 274 274
  • Page 275 275
  • Page 276 276
  • Page 277 277
  • Page 278 278
  • Page 279 279
  • Page 280 280
  • Page 281 281
  • Page 282 282
  • Page 283 283
  • Page 284 284

Thermo Fisher Scientific MSFileReader 2.2 Reference guide

Type
Reference guide

Ask a question and I''ll find the answer in the document

Finding information in a document is now easier with AI