io.github.msdk.util.tolerances

Class MaximumMzTolerance

java.lang.Object

io.github.msdk.util.tolerances.MaximumMzTolerance

All Implemented Interfaces:

MzTolerance

@Immutable
public class MaximumMzTolerance
extends Object
implements MzTolerance

This class represents m/z tolerance. Tolerance is set using absolute (m/z) and relative (ppm) values. The tolerance range is calculated as the maximum of the absolute and relative values.

Constructor Summary

Constructors

Constructor and Description
MaximumMzTolerance(Double toleranceMZ, Double tolerancePPM) Constructor for MZTolerance.

Method Summary

Modifier and Type	Method and Description
Double	getMzTolerance() Getter for the field mzTolerance.
Double	getPpmTolerance() Getter for the field ppmTolerance.
com.google.common.collect.Range<Double>	getToleranceRange(Double mzValue) Get a m/z tolerance range for a given m/z.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MaximumMzTolerance

public MaximumMzTolerance(@Nonnull
                          Double toleranceMZ,
                          @Nonnull
                          Double tolerancePPM)

Constructor for MZTolerance.

Parameters:

toleranceMZ - a Double object.

tolerancePPM - a Double object.

Method Detail

getMzTolerance

@Nonnull
public Double getMzTolerance()

Getter for the field mzTolerance.

Returns:

a Double object.

getPpmTolerance

@Nonnull
public Double getPpmTolerance()

Getter for the field ppmTolerance.

Returns:

a Double object.

getToleranceRange

@Nonnull
public com.google.common.collect.Range<Double> getToleranceRange(@Nonnull
                                                                          Double mzValue)

Get a m/z tolerance range for a given m/z.

getToleranceRange.

Specified by:

getToleranceRange in interface MzTolerance

Parameters:

mzValue - a Double object.

Returns:

a Range object.

toString

public String toString()

Overrides:

toString in class Object