mzxmlinfo - Return information about mzXML file

Syntax

InfoStruct = mzxmlinfo(File) InfoStruct = mzxmlinfo(File, 'NumOfLevels', NumOfLevelsValue)

Arguments

File

String containing a file name, or a path and file name, of an mzXML file that conforms to the mzXML 2.1 specification or earlier specifications.

If you specify only a file name, that file must be on the MATLAB search path or in the current directory.

NumOfLevelsValue

Controls the return of NumOfLevels, an additional field in InfoStruct, that contains the number of mass spectrometry (MS) levels of spectra in File. Choices are true or false (default).

Return Values

InfoStruct

MATLAB structure containing information from an mzXML file. It includes the fields shown in the table below.

Description

InfoStruct = mzxmlinfo(File) returns a MATLAB structure, InfoStruct, containing summary information about an mzXML file, File.

File is a string containing a file name, or a path and file name, of an mzXML file. The file must conform to the mzXML 2.1 specification or earlier specifications. You can view the mzXML 2.1 specification at:

http://sashimi.sourceforge.net/schema_revision/mzXML_2.1/Doc/mzXML_2.1_tutorial.pdf

InfoStruct includes the following fields.

Field	Description
`Filename`	Name of the mzXML file.
`FileModDate`	Modification date of the file.
`FileSize`	Size of the file in bytes.
`NumberOfScans`	Number of scans in the file.*
`StartTime`	Run start time.*
`EndTime`	Run end time.*
`DataProcessingIntensityCutoff`	Minimum mass/charge (m/z) intensity value.*
`DataProcessingCentroided`	Indicates if data is centroided.*
`DataProcessingDeisotoped`	Indicates if data is deisotoped.*
`DataProcessing ChargeDeconvoluted`	Indicates if data is deconvoluted.*
`DataProcessingSpotIntegration`	For LC/MALDI experiments, indicates if peaks eluting over multiple spots have been integrated into a single spot.*

* — These fields contain N/A if the mzXML file does not include the associated attributes. The associated attributes are optional in the mzXML file, per the mzXML 2.1 specification.

InfoStruct = mzxmlinfo(File, 'NumOfLevels', NumOfLevelsValue) controls the return of NumOfLevels, an additional field in mzXMLInfo, that contains the number of mass spectrometry levels of spectra in File. Choices are true or false (default).

Examples

Note In the following example, the file results.mzxml is not provided. Sample mzXML files can be found at:

Return a MATLAB structure containing summary information about an mzXML file.

info = mzxmlinfo('results.mzxml');

info = 

                            Filename: 'results.mzxml'
                         FileModDate: '07-May-2008 13:39:12'
                            FileSize: 10607
                       NumberOfScans: 2
                           StartTime: 'PT0.00683333S'
                             EndTime: 'PT200.036S'
       DataProcessingIntensityCutoff: 'N/A'
            DataProcessingCentroided: 'false'
            DataProcessingDeisotoped: 'N/A'
    DataProcessingChargeDeconvoluted: 'N/A'
       DataProcessingSpotIntegration: 'N/A'

Return a MATLAB structure containing summary information, including the number of mass spectrometry levels, about an mzXML file.

info = mzxmlinfo('results.mzxml','numoflevels',true);

info = 

                            Filename: 'results.mzxml'
                         FileModDate: '07-May-2008 13:39:12'
                            FileSize: 10607
                       NumberOfScans: 2
                           StartTime: 'PT0.00683333S'
                             EndTime: 'PT200.036S'
       DataProcessingIntensityCutoff: 'N/A'
            DataProcessingCentroided: 'false'
            DataProcessingDeisotoped: 'N/A'
    DataProcessingChargeDeconvoluted: 'N/A'
       DataProcessingSpotIntegration: 'N/A'
                    NumberOfMSLevels: 2