io.github.msdk.featuredetection.gridmass

Class GridMassMethod

java.lang.Object

io.github.msdk.featuredetection.gridmass.GridMassMethod

All Implemented Interfaces:

MSDKMethod<FeatureTable>

public class GridMassMethod
extends Object
implements MSDKMethod<FeatureTable>

GridMassMethod class.

Constructor Summary

Constructors

Constructor and Description
GridMassMethod(RawDataFile rawDataFile, List<MsScan> scans, MzTolerance mzTol, Double intensitySimilarity, Double minimumTimeSpan, Double maximumTimeSpan, Double smoothTimeSpan, Double smoothTimeMZ, Double smoothMZ, Double additionTimeMaxPeaksPerScan, Double minimumHeight, Double rtPerScan) Constructor for GridMassMethod.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a running algorithm.
FeatureTable	execute() Performs the algorithm.
Float	getFinishedPercentage() Returns a number in the interval 0 to 1.0, representing the portion of the task that has completed, or null if the algorithm has not yet started.
FeatureTable	getResult() Returns the result of this algorithm, or null.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridMassMethod

public GridMassMethod(@Nonnull
                      RawDataFile rawDataFile,
                      @Nonnull
                      List<MsScan> scans,
                      @Nonnull
                      MzTolerance mzTol,
                      @Nonnull
                      Double intensitySimilarity,
                      @Nonnull
                      Double minimumTimeSpan,
                      @Nonnull
                      Double maximumTimeSpan,
                      @Nonnull
                      Double smoothTimeSpan,
                      @Nonnull
                      Double smoothTimeMZ,
                      @Nonnull
                      Double smoothMZ,
                      @Nonnull
                      Double additionTimeMaxPeaksPerScan,
                      @Nonnull
                      Double minimumHeight,
                      @Nonnull
                      Double rtPerScan)

Constructor for GridMassMethod.

Parameters:

rawDataFile - a RawDataFile object.

scans - a List object.

mzTol - a MzTolerance object.

intensitySimilarity - a Double object.

minimumTimeSpan - a Double object.

maximumTimeSpan - a Double object.

smoothTimeSpan - a Double object.

smoothTimeMZ - a Double object.

smoothMZ - a Double object.

additionTimeMaxPeaksPerScan - a Double object.

minimumHeight - a Double object.

rtPerScan - a Double object.

Method Detail

execute

public FeatureTable execute()
                     throws MSDKException

Performs the algorithm. This method may throw MSDKException or MSDKRuntimeException if error occurs.

Specified by:

execute in interface MSDKMethod<FeatureTable>

Returns:

the result of this algorithm, or null

Throws:

MSDKException - On any error

getFinishedPercentage

@Nullable
public Float getFinishedPercentage()

Returns a number in the interval 0 to 1.0, representing the portion of the task that has completed, or null if the algorithm has not yet started.

Specified by:

getFinishedPercentage in interface MSDKMethod<FeatureTable>

Returns:

Finished percentage (0.0 to 1.0, inclusive), or null.

getResult

@Nullable
public FeatureTable getResult()

Returns the result of this algorithm, or null.

Specified by:

getResult in interface MSDKMethod<FeatureTable>

Returns:

a ResultType object.

cancel

public void cancel()

Cancel a running algorithm. This method can be called from any thread.

Specified by:

cancel in interface MSDKMethod<FeatureTable>