com.compomics.util.experiment.filters.massspectrometry.spectrumfilters
Class CombFilter

java.lang.Object
  extended by com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
      extended by com.compomics.util.experiment.filters.massspectrometry.spectrumfilters.CombFilter
All Implemented Interfaces:
Serializable

public class CombFilter
extends SpectrumFilter

This filter looks for a specific m/z comb in the spectrum.

Author:
Marc Vaudel
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
name
 
Constructor Summary
CombFilter(ArrayList<Double> mzComb, double mzTolerance, boolean isPpm, double intensityQuartile)
          Constructor.
 
Method Summary
 String getDescription()
          Returns a description of the validated spectra, typically "containing a peak at m/z 114".
 boolean validateSpectrum(MSnSpectrum spectrum)
          Returns a boolean indicating whether the filter m/z comb was found in the spectrum.
 
Methods inherited from class com.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
getElementaryFilters, getFilter, getName, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CombFilter

public CombFilter(ArrayList<Double> mzComb,
                  double mzTolerance,
                  boolean isPpm,
                  double intensityQuartile)
Constructor.

Parameters:
mzComb - the m/z comb to look for
mzTolerance - the m/z tolerance
isPpm - a boolean indicating whether the m/z tolerance is in ppm
intensityQuartile - the intensity quantile to look into
Method Detail

validateSpectrum

public boolean validateSpectrum(MSnSpectrum spectrum)
Returns a boolean indicating whether the filter m/z comb was found in the spectrum.

Specified by:
validateSpectrum in class SpectrumFilter
Parameters:
spectrum - the spectrum to inspect
Returns:
a boolean indicating whether the filter m/z comb was found in the spectrum

getDescription

public String getDescription()
Description copied from class: SpectrumFilter
Returns a description of the validated spectra, typically "containing a peak at m/z 114".

Specified by:
getDescription in class SpectrumFilter
Returns:
a description of the validated spectra


Copyright © 2013. All Rights Reserved.