module Mspire::Mzml::Convenience

Public Instance Methods

'[]'(arg)
Alias for: spectrum
chromatogram(arg) click to toggle source

@param [Object] arg an index number (Integer) or id string (String) @return [Mspire::Mzml::Chromatogram] a spectrum object

# File lib/mspire/mzml.rb, line 234
def chromatogram(arg)
  run.chromatogram_list[arg]
end
each(&block)
Alias for: each_spectrum
each_chromatogram(&block) click to toggle source
# File lib/mspire/mzml.rb, line 215
def each_chromatogram(&block)
  @run.chromatogram_list.each(&block)
end
each_spectrum(&block) click to toggle source
# File lib/mspire/mzml.rb, line 219
def each_spectrum(&block)
  @run.spectrum_list.each(&block)
end
Also aliased as: each
length() click to toggle source

returns the number of spectra

# File lib/mspire/mzml.rb, line 243
def length
  run.spectrum_list.size
end
Also aliased as: size
num_chromatograms() click to toggle source
# File lib/mspire/mzml.rb, line 238
def num_chromatograms
  run.chromatogram_list.size
end
size()
Alias for: length
spectrum(arg) click to toggle source

@param [Object] arg an index number (Integer) or id string (String) @return [Mspire::Mzml::Spectrum] a spectrum object

# File lib/mspire/mzml.rb, line 227
def spectrum(arg)
  run.spectrum_list[arg]
end
Also aliased as: '[]'
spectrum_from_scan_num(scan_num) click to toggle source

@param [Integer] scan_num the scan number @return [Mspire::Spectrum] a spectrum object, or nil if not found @raise [ScanNumbersNotUnique] if scan numbers are not unique @raise [ScanNumbersNotFound] if spectra exist but scan numbers were not

found
# File lib/mspire/mzml.rb, line 253
def spectrum_from_scan_num(scan_num)
  @scan_to_index ||= @index_list[0].create_scan_to_index
  raise ScanNumbersNotUnique if @scan_to_index == false
  raise ScanNumbersNotFound if @scan_to_index == nil
  spectrum(@scan_to_index[scan_num])
end