1- <?xml version =" 1.0" ?>
2- <doc >
3- <assembly >
4- <name >
5- ChemstationMSFileReader
6- </name >
7- </assembly >
8- <members >
9- <member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.#ctor(System.String)" >
10- <summary >
11- Open the specified data file and read the data headers
12- </summary >
13- <param name =" sDatafilePath" >Path to the file to read</param >
14- <remarks ></remarks >
15- </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.GetSpectrum(System.Int32,ChemstationMSFileReader.clsSpectralRecord@,System.Int32@)" >
16- <summary >
17- Returns the mass spectrum at the specified index
18- </summary >
19- <param name =" intSpectrumIndex" >0-based spectrum index</param >
20- <param name =" oSpectrum" >Spectrum object (output)</param >
21- <param name =" intTotalSignalRawFromIndex" >TIC value as reported by the Index; this value has been scaled down by some sort of polynomial transformation</param >
22- <returns >True if success, false if an error</returns >
23- </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadHeaders(System.String)" >
24- <summary >
25- Open the data file and read the header sections from the data file
26- </summary >
27- <param name =" sDataFilePath" >Path to the file to read</param >
28- <returns >True if success, false if an error</returns >
29- <remarks >The file handle will remain open until this class is disposed of</remarks >
30- </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadIndexRecords(System.IO.FileStream@)" >
31- <summary >
32- Reads the index entries (aka directory records)
33- </summary >
34- <param name =" fsDatafile" ></param >
35- <returns >True if success, false if an error</returns >
36- </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadNormalizationRecords(System.IO.FileStream@)" >
37- <summary >
38- Reads the 10 normalization records from the data file
39- </summary >
40- <param name =" fsDatafile" ></param >
41- <returns >True if success, false if an error</returns >
42- </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.#ctor" >
43- <summary >
44- Instantiate a new spectrum object
45- </summary >
46- <remarks ></remarks >
47- </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.#ctor(System.IO.FileStream@,System.Int32)" >
48- <summary >
49- Populate a spectrum object with the data at the specified byte offset
50- </summary >
51- </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.Clear" >
52- <summary >
53- Initialize the variables and data structures
54- </summary >
55- <remarks ></remarks >
56- </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.ReadFromFile(System.IO.FileStream@,System.Int32)" >
57- <summary >
58- Read the spectrum at the specified byte offset
59- </summary >
60- <param name =" fsDatafile" ></param >
61- <param name =" intByteOffsetStart" ></param >
62- <remarks ></remarks >
63- </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.ReadPackedAbundance(System.IO.FileStream@)" >
64- <summary >
65- Read packed abundance stored as 2-bit scale with 14 bit mantissa
66- </summary >
67- <param name =" fs" >FileStream object</param >
68- <returns >Unpacked abundance</returns >
69- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadInt16SwapBytes(System.IO.FileStream@)" >
70- <summary >
71- Reads an Int16 from the filestream
72- Swaps bytes prior to converting
73- </summary >
74- <param name =" fs" >FileStream object</param >
75- <returns >The value, as an Int16 number</returns >
76- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadUInt16SwapBytes(System.IO.FileStream@)" >
77- <summary >
78- Reads an UInt16 from the filestream
79- Swaps bytes prior to converting
80- </summary >
81- <param name =" fs" >FileStream object</param >
82- <returns >The value, as an Int32 number</returns >
83- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadInt32SwapBytes(System.IO.FileStream@)" >
84- <summary >
85- Reads an Int32 from the filestream
86- Swaps bytes prior to converting
87- </summary >
88- <param name =" fs" >FileStream object</param >
89- <returns >The value, as an Int32 number</returns >
90- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadSingleSwapBytes(System.IO.FileStream@)" >
91- <summary >
92- Reads a 4-byte single (real) from the filestream
93- Swaps bytes prior to converting
94- </summary >
95- <param name =" fs" >FileStream object</param >
96- <returns >The value, as a single-precision number</returns >
97- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadString(System.IO.FileStream@,System.Int32,System.Boolean)" >
98- <summary >
99- Reads a fixed-length string from the filestream
100- Optionally advances the reader one byte after reading the string
101- </summary >
102- <param name =" fs" >FileStream object</param >
103- <param name =" iStringLength" >String length</param >
104- <param name =" bAdvanceExtraByte" >If true, then advances the read an extra byte after reading the string</param >
105- <returns >The string read</returns >
106- </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.WordOffsetToBytes(System.Int32)" >
107- <summary >
108- Convert byte-offset stored in words into bytes
109- </summary >
110- <param name =" iOffsetWords" ></param >
111- <returns >The byte offset, in bytes</returns >
112- </member ><member name =" M:ChemstationMSFileReader.clsDataHeader.#ctor(System.IO.FileStream@)" >
113- <summary >
114- Read header from the specified file
115- </summary >
116- <param name =" fsDatafile" ></param >
117- <remarks ></remarks >
118- </member ><member name =" M:ChemstationMSFileReader.clsDataHeader.ReadFromFile(System.IO.FileStream@)" >
119- <summary >
120- Read header from the specified file
121- </summary >
122- <param name =" fs" >Input file stream</param >
123- <returns >True if success, false if an error</returns >
124- </member >
125- </members >
1+ <?xml version =" 1.0" ?>
2+ <doc >
3+ <assembly >
4+ <name >
5+ ChemstationMSFileReader
6+ </name >
7+ </assembly >
8+ <members >
9+ <member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.#ctor(System.String)" >
10+ <summary >
11+ Open the specified data file and read the data headers
12+ </summary >
13+ <param name =" sDatafilePath" >Path to the file to read</param >
14+ <remarks ></remarks >
15+ </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.GetSpectrum(System.Int32,ChemstationMSFileReader.clsSpectralRecord@,System.Int32@)" >
16+ <summary >
17+ Returns the mass spectrum at the specified index
18+ </summary >
19+ <param name =" intSpectrumIndex" >0-based spectrum index</param >
20+ <param name =" oSpectrum" >Spectrum object (output)</param >
21+ <param name =" intTotalSignalRawFromIndex" >TIC value as reported by the Index; this value has been scaled down by some sort of polynomial transformation</param >
22+ <returns >True if success, false if an error</returns >
23+ </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadHeaders(System.String)" >
24+ <summary >
25+ Open the data file and read the header sections from the data file
26+ </summary >
27+ <param name =" sDataFilePath" >Path to the file to read</param >
28+ <returns >True if success, false if an error</returns >
29+ <remarks >The file handle will remain open until this class is disposed of</remarks >
30+ </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadIndexRecords(System.IO.FileStream@)" >
31+ <summary >
32+ Reads the index entries (aka directory records)
33+ </summary >
34+ <param name =" fsDatafile" ></param >
35+ <returns >True if success, false if an error</returns >
36+ </member ><member name =" M:ChemstationMSFileReader.clsChemstationDataMSFileReader.ReadNormalizationRecords(System.IO.FileStream@)" >
37+ <summary >
38+ Reads the 10 normalization records from the data file
39+ </summary >
40+ <param name =" fsDatafile" ></param >
41+ <returns >True if success, false if an error</returns >
42+ </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.#ctor" >
43+ <summary >
44+ Instantiate a new spectrum object
45+ </summary >
46+ <remarks ></remarks >
47+ </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.#ctor(System.IO.FileStream@,System.Int32)" >
48+ <summary >
49+ Populate a spectrum object with the data at the specified byte offset
50+ </summary >
51+ </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.Clear" >
52+ <summary >
53+ Initialize the variables and data structures
54+ </summary >
55+ <remarks ></remarks >
56+ </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.ReadFromFile(System.IO.FileStream@,System.Int32)" >
57+ <summary >
58+ Read the spectrum at the specified byte offset
59+ </summary >
60+ <param name =" fsDatafile" ></param >
61+ <param name =" intByteOffsetStart" ></param >
62+ <remarks ></remarks >
63+ </member ><member name =" M:ChemstationMSFileReader.clsSpectralRecord.ReadPackedAbundance(System.IO.FileStream@)" >
64+ <summary >
65+ Read packed abundance stored as 2-bit scale with 14 bit mantissa
66+ </summary >
67+ <param name =" fs" >FileStream object</param >
68+ <returns >Unpacked abundance</returns >
69+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadInt16SwapBytes(System.IO.FileStream@)" >
70+ <summary >
71+ Reads an Int16 from the filestream
72+ Swaps bytes prior to converting
73+ </summary >
74+ <param name =" fs" >FileStream object</param >
75+ <returns >The value, as an Int16 number</returns >
76+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadUInt16SwapBytes(System.IO.FileStream@)" >
77+ <summary >
78+ Reads an UInt16 from the filestream
79+ Swaps bytes prior to converting
80+ </summary >
81+ <param name =" fs" >FileStream object</param >
82+ <returns >The value, as an Int32 number</returns >
83+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadInt32SwapBytes(System.IO.FileStream@)" >
84+ <summary >
85+ Reads an Int32 from the filestream
86+ Swaps bytes prior to converting
87+ </summary >
88+ <param name =" fs" >FileStream object</param >
89+ <returns >The value, as an Int32 number</returns >
90+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadSingleSwapBytes(System.IO.FileStream@)" >
91+ <summary >
92+ Reads a 4-byte single (real) from the filestream
93+ Swaps bytes prior to converting
94+ </summary >
95+ <param name =" fs" >FileStream object</param >
96+ <returns >The value, as a single-precision number</returns >
97+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.ReadString(System.IO.FileStream@,System.Int32,System.Boolean)" >
98+ <summary >
99+ Reads a fixed-length string from the filestream
100+ Optionally advances the reader one byte after reading the string
101+ </summary >
102+ <param name =" fs" >FileStream object</param >
103+ <param name =" iStringLength" >String length</param >
104+ <param name =" bAdvanceExtraByte" >If true, then advances the read an extra byte after reading the string</param >
105+ <returns >The string read</returns >
106+ </member ><member name =" M:ChemstationMSFileReader.clsByteConverter.WordOffsetToBytes(System.Int32)" >
107+ <summary >
108+ Convert byte-offset stored in words into bytes
109+ </summary >
110+ <param name =" iOffsetWords" ></param >
111+ <returns >The byte offset, in bytes</returns >
112+ </member ><member name =" M:ChemstationMSFileReader.clsDataHeader.#ctor(System.IO.FileStream@)" >
113+ <summary >
114+ Read header from the specified file
115+ </summary >
116+ <param name =" fsDatafile" ></param >
117+ <remarks ></remarks >
118+ </member ><member name =" M:ChemstationMSFileReader.clsDataHeader.ReadFromFile(System.IO.FileStream@)" >
119+ <summary >
120+ Read header from the specified file
121+ </summary >
122+ <param name =" fs" >Input file stream</param >
123+ <returns >True if success, false if an error</returns >
124+ </member >
125+ </members >
126126</doc >
0 commit comments