org.expasy.mzjava.core.ms

Class Tolerance

java.lang.Object

org.expasy.mzjava.core.ms.Tolerance

Direct Known Subclasses:

AbsoluteTolerance, PpmTolerance

public abstract class Tolerance
extends Object

Interface for specifying a tolerance

Version:

1.0

Author:

Oliver Horlacher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tolerance.Location

Constructor Summary

Constructors

Constructor and Description
Tolerance()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Tolerance.Location	check(double expected, double actual)
Tolerance.Location	check(double expectedMz, double actualMz, int charge)
abstract double	getError(double expectedMr, double actualMr)
abstract double	getMax(double mass)
abstract double	getMin(double mass)
abstract boolean	withinTolerance(double expected, double actual) Returns true if the actual is within tolerance of the expected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Tolerance

public Tolerance()

Method Detail

withinTolerance

public abstract boolean withinTolerance(double expected,
                      double actual)

Returns true if the actual is within tolerance of the expected

Parameters:

expected - the expected m/z

actual - the actual m/z

Returns:

true if the actual is within tolerance of the expected

getError

public abstract double getError(double expectedMr,
              double actualMr)

check

public abstract Tolerance.Location check(double expected,
                       double actual)

check

public Tolerance.Location check(double expectedMz,
                       double actualMz,
                       int charge)

getMin

public abstract double getMin(double mass)

getMax

public abstract double getMax(double mass)