io.github.msdk.datamodel

Interface Feature

All Known Subinterfaces:

GroupedFeature

All Known Implementing Classes:

SimpleFeature

public interface Feature

A feature represents a single three-dimensional peak in an LC-MS or GC-MS dataset. It must have at least an m/z value and a retention time. In addition, it can contain more detailed data about the peak, such as S/N ratio or raw data points that constitute the feature (Chromatogram).

Since:

0.0.8

Method Summary

Modifier and Type	Method and Description
Float	getArea() getArea.
Chromatogram	getChromatogram() getChromatogram.
Float	getHeight() getHeight.
IonAnnotation	getIonAnnotation() getIonAnnotation.
List<MsScan>	getMSMSSpectra() getMSMSSpectra.
Double	getMz() getMz.
Float	getRetentionTime() getRetentionTime.
Float	getScore() Returns arbitrary, dimension-less quality score for the feature
Float	getSNRatio() Returns signal to noise ratio.

Method Detail

getMz

@Nonnull
Double getMz()

getMz.

Returns:

a Double object.

getRetentionTime

@Nonnull
Float getRetentionTime()

getRetentionTime.

Returns:

a Float object.

getArea

@Nullable
Float getArea()

getArea.

Returns:

a Float object.

getHeight

@Nullable
Float getHeight()

getHeight.

Returns:

a Float object.

getSNRatio

@Nullable
Float getSNRatio()

Returns signal to noise ratio.

Returns:

S/N ratio, null if the method does not estimate it, NaN if noise was estimated to 0

getScore

@Nullable
Float getScore()

Returns arbitrary, dimension-less quality score for the feature

Returns:

Score

getChromatogram

@Nullable
Chromatogram getChromatogram()

getChromatogram.

Returns:

a Chromatogram object.

getMSMSSpectra

@Nullable
List<MsScan> getMSMSSpectra()

getMSMSSpectra.

Returns:

a List object.

getIonAnnotation

@Nullable
IonAnnotation getIonAnnotation()

getIonAnnotation.

Returns:

a IonAnnotation object.