cImzML Class Reference

imzML parser. More...

#include <cImzML.h>

Public Member Functions
	cImzML ()
	The constructor.
	~cImzML ()
	The destructor.
int	parse (string &filename, int &defaultmaxx, int &defaultmaxy, int &defaultpixelsizex, int &defaultpixelsizey, eVendorType &vendor)
	Parse an imzml file. More...
void	updateRawDataToPeakList (vector< cPeaksList > &peaklists, string &convertedibdfilename)
	Update values after conversion of profile spectra into centroid spectra. More...
vector< cImzMLItem > &	getItems ()
	Get a vector of cImzML items. More...
bool	hasProfileSpectra ()
	Check if the file contains profile spectra. More...
bool	use64BitMzPrecision ()
	Check the precision of mz values. More...
bool	use64BitIntensityPrecision ()
	Check the precision of intensity values. More...
void	write (string &filename)
	Write an imzml file. More...

Detailed Description

imzML parser.

Member Function Documentation

getItems()

vector< cImzMLItem > & cImzML::getItems

(

)

Get a vector of cImzML items.

Return values

vector<cImzMLItem>

a vector of cImzML items

hasProfileSpectra()

bool cImzML::hasProfileSpectra

(

)

Check if the file contains profile spectra.

Return values

bool	true if the file contains profile spectra

parse()

int cImzML::parse	(	string &	filename,
		int &	defaultmaxx,
		int &	defaultmaxy,
		int &	defaultpixelsizex,
		int &	defaultpixelsizey,
		eVendorType &	vendor
	)

Parse an imzml file.

Parameters

filename	imzml filename
defaultmaxx	max count of pixel x - parsed from imzML file
defaultmaxy	max count of pixel y - parsed from imzML file
defaultpixelsizex	pixel size x - parsed from imzML file
defaultpixelsizey	pixel size y - parsed from imzML file
vendor	vendor type

Return values

0	= success; 1 = failed (zlib compression detected)

updateRawDataToPeakList()

void cImzML::updateRawDataToPeakList	(	vector< cPeaksList > &	peaklists,
		string &	convertedibdfilename
	)

Update values after conversion of profile spectra into centroid spectra.

Parameters

peaklists	an updated vector of peaklists
convertedibdfilename	filename of a converted ibd file

use64BitIntensityPrecision()

bool cImzML::use64BitIntensityPrecision

(

)

Check the precision of intensity values.

Return values

bool	if true, 64bit precision is used; if false, 32bit precision is used

use64BitMzPrecision()

bool cImzML::use64BitMzPrecision

(

)

Check the precision of mz values.

Return values

bool	if true, 64bit precision is used; if false, 32bit precision is used

write()

void cImzML::write

(

string &

filename

)

Write an imzml file.

Parameters

filename

an output imzml filename

---

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

• core/cImzML.h
• core/cImzML.cpp