io.github.msdk.datamodel

Class SimpleIsolationInfo

java.lang.Object

io.github.msdk.datamodel.SimpleIsolationInfo

All Implemented Interfaces:

IsolationInfo

public class SimpleIsolationInfo
extends Object
implements IsolationInfo

Implementation of IsolationInfo

Constructor Summary

Constructors

Constructor and Description
SimpleIsolationInfo(com.google.common.collect.Range<Double> isolationMzRange) Constructor for SimpleIsolationInfo.
SimpleIsolationInfo(com.google.common.collect.Range<Double> isolationMzRange, Float ionInjectTime, Double precursorMz, Integer precursorCharge, ActivationInfo activationInfo, Integer precursorScanNumber) Constructor for SimpleIsolationInfo.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleIsolationInfo

public SimpleIsolationInfo(@Nonnull
                           com.google.common.collect.Range<Double> isolationMzRange)

Constructor for SimpleIsolationInfo.

Parameters:

isolationMzRange - a Range object.

SimpleIsolationInfo

public SimpleIsolationInfo(@Nonnull
                           com.google.common.collect.Range<Double> isolationMzRange,
                           @Nullable
                           Float ionInjectTime,
                           @Nullable
                           Double precursorMz,
                           @Nullable
                           Integer precursorCharge,
                           @Nullable
                           ActivationInfo activationInfo,
                           @Nullable
                           Integer precursorScanNumber)

Constructor for SimpleIsolationInfo.

Parameters:

isolationMzRange - a Range object.

ionInjectTime - a Float object.

precursorMz - a Double object.

precursorCharge - a Integer object.

activationInfo - a ActivationInfo object.

Method Detail

getIsolationMzRange

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

Returns the isolated m/z range.

Specified by:

getIsolationMzRange in interface IsolationInfo

Returns:

Isolated m/z range.

getIonInjectTime

@Nullable
public Float getIonInjectTime()

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

Specified by:

getIonInjectTime in interface IsolationInfo

Returns:

Ion injection time in ms, or null.

getPrecursorMz

@Nullable
public 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).

Specified by:

getPrecursorMz in interface IsolationInfo

Returns:

Precursor m/z, or null.

getPrecursorCharge

@Nullable
public 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.

Specified by:

getPrecursorCharge in interface IsolationInfo

Returns:

Precursor charge (positive integer), or null.

getPrecursorScanNumber

@Nullable
public Integer getPrecursorScanNumber()

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

Specified by:

getPrecursorScanNumber in interface IsolationInfo

Returns:

Precursor scan number (positive integer), or null.

getActivationInfo

@Nullable
public 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.

Specified by:

getActivationInfo in interface IsolationInfo

Returns:

Fragmentation info, or null.