io.github.msdk.datamodel

Interface IsolationInfo

All Known Implementing Classes:

SimpleIsolationInfo

@Immutable
public interface IsolationInfo

Represents the ion isolation information. Each isolation can be accompanied by MS/MS fragmentation, represented by FragmentationInfo. If no fragmentation occurred or if fragmentation details are unknown, getFragmentationInfo() will return null. For convenience, this interface is immutable, so it can be passed by reference and safely used by multiple threads.

Method Summary

Modifier and Type	Method and Description
ActivationInfo	getActivationInfo() Returns the details about the fragmentation that followed this isolation.
Float	getIonInjectTime() Returns the ion injection time in ms, for ion trap experiments.
com.google.common.collect.Range<Double>	getIsolationMzRange() Returns the isolated m/z range.
Integer	getPrecursorCharge() Returns the precursor charge.
Double	getPrecursorMz() Returns the precursor m/z.
Integer	getPrecursorScanNumber() Returns the precursor scan number.

Method Detail

getIsolationMzRange

@Nonnull
com.google.common.collect.Range<Double> getIsolationMzRange()

Returns the isolated m/z range.

Returns:

Isolated m/z range.

getIonInjectTime

@Nullable
Float getIonInjectTime()

Returns the ion injection time in ms, for ion trap experiments. Shorter time indicates larger amount of ions (trap fills faster).

Returns:

Ion injection time in ms, or null.

getPrecursorMz

@Nullable
Double getPrecursorMz()

Returns the precursor m/z. Null is returned if the precursor information is not specified in the data or if there is no single precursor (such as data-independent acquisition or DIA scans).

Returns:

Precursor m/z, or null.

getPrecursorCharge

@Nullable
Integer getPrecursorCharge()

Returns the precursor charge. Null is returned if the charge is unknown or if the MS/MS scan targets multiple ions (such as data-independent acquisition or DIA scans). Charge is always represented by a positive integer.

Returns:

Precursor charge (positive integer), or null.

getPrecursorScanNumber

@Nullable
Integer getPrecursorScanNumber()

Returns the precursor scan number. Null is returned if the precursor is unknown.

Returns:

Precursor scan number (positive integer), or null.

getActivationInfo

@Nullable
ActivationInfo getActivationInfo()

Returns the details about the fragmentation that followed this isolation. Null is returned if no fragmentation occurred or if the details are unknown.

Returns:

Fragmentation info, or null.