|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.compomics.util.experiment.filters.massspectrometry.SpectrumFilter
public abstract class SpectrumFilter
This class represent all spectrum filters which will be used to filter spectra.
Field Summary | |
---|---|
protected String |
name
The name of the filter. |
Constructor Summary | |
---|---|
SpectrumFilter()
|
Method Summary | |
---|---|
abstract String |
getDescription()
Returns a description of the validated spectra, typically "containing a peak at m/z 114". |
static String[] |
getElementaryFilters()
Convenience method returning the types of implemented elementary filters. |
static SpectrumFilter |
getFilter(JFrame parentFrame,
Double mzTolerance,
Double intensityQuantile,
Double intensityTolerance,
Boolean isPpm)
Allows the user to design basic filters via a GUI. |
String |
getName()
Returns the name of the filter. |
void |
setName(String name)
Sets the name of the filter. |
abstract boolean |
validateSpectrum(MSnSpectrum spectrum)
Indicates whether a spectrum passed the filter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String name
Constructor Detail |
---|
public SpectrumFilter()
Method Detail |
---|
public String getName()
public void setName(String name)
name
- the name of the filterpublic abstract boolean validateSpectrum(MSnSpectrum spectrum)
spectrum
- the spectrum to inspect
public abstract String getDescription()
public static String[] getElementaryFilters()
public static SpectrumFilter getFilter(JFrame parentFrame, Double mzTolerance, Double intensityQuantile, Double intensityTolerance, Boolean isPpm)
parentFrame
- the parent framemzTolerance
- the mz tolerance, can be nullintensityQuantile
- the intensity quantile, can be nullintensityTolerance
- the intensity tolerance, can be nullisPpm
- a boolean indicating whether the tolerance is in ppm, can be
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |