io.github.msdk.datamodel

Enum SeparationType

java.lang.Object

java.lang.Enum<SeparationType>

io.github.msdk.datamodel.SeparationType

All Implemented Interfaces:

Serializable, Comparable<SeparationType>

public enum SeparationType
extends Enum<SeparationType>

Enum for different separation technologies used as a preprocessing step before the actual data point acquisition.

A separation type will usually provide additional information for acquired MsScan objects. The most common case being a chromatographic separation coupled to a mass spectrometer. Here, the chromatograph would provide the retention time of each acquired data point as additional information.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CE Capillary electrophoresis chromatography.
GC Gas chromatography.
GCxGC Comprehensive two-dimensional gas chromatography.
IMS Ion mobility spectrometry.
LC Liquid chromatography.
LCxLC Comprehensive two-dimensional liquid chromatography.
UNKNOWN Unknown separation method.
UNKNOWN_2D

Method Summary

Modifier and Type	Method and Description
int	getFeatureDimensions() Return the number of additional features linked to an MsScan and to
static SeparationType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SeparationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GC

public static final SeparationType GC

Gas chromatography.

GCxGC

public static final SeparationType GCxGC

Comprehensive two-dimensional gas chromatography.

LC

public static final SeparationType LC

Liquid chromatography.

LCxLC

public static final SeparationType LCxLC

Comprehensive two-dimensional liquid chromatography.

CE

public static final SeparationType CE

Capillary electrophoresis chromatography.

IMS

public static final SeparationType IMS

Ion mobility spectrometry. First dimension is retention time, second dimension is ion drift time.

UNKNOWN

public static final SeparationType UNKNOWN

Unknown separation method. Expect 1 feature dimension, e.g. retention time.

UNKNOWN_2D

public static final SeparationType UNKNOWN_2D

Method Detail

values

public static SeparationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SeparationType c : SeparationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SeparationType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFeatureDimensions

public int getFeatureDimensions()

Return the number of additional features linked to an MsScan and to

For chromatography, the number will be 1 for one-dimensional chromatography, where each data point has a retention time assigned to it.

The number will be 2 for (comprehensive) two-dimensional chromatography, where each data point has two retention times assigned to it.

Returns:

the number of feature dimensions.