io.github.msdk.spectra.centroiding

Class MSDKCentroidingMethod

java.lang.Object

io.github.msdk.spectra.centroiding.MSDKCentroidingMethod

All Implemented Interfaces:

MSDKMethod<RawDataFile>

public class MSDKCentroidingMethod
extends Object
implements MSDKMethod<RawDataFile>

MSDKCentroidingMethod class.

Constructor Summary

Constructors

Constructor and Description
MSDKCentroidingMethod(RawDataFile rawDataFile, MSDKCentroidingAlgorithm centroidingAlgorithm) Constructor for MSDKCentroidingMethod.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel a running algorithm.
RawDataFile	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.
RawDataFile	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

MSDKCentroidingMethod

public MSDKCentroidingMethod(@Nonnull
                             RawDataFile rawDataFile,
                             @Nonnull
                             MSDKCentroidingAlgorithm centroidingAlgorithm)

Constructor for MSDKCentroidingMethod.

Parameters:

rawDataFile - a RawDataFile object.

centroidingAlgorithm - a MSDKCentroidingAlgorithm object.

Method Detail

getFinishedPercentage

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<RawDataFile>

Returns:

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

execute

public RawDataFile execute()
                    throws MSDKException

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

Specified by:

execute in interface MSDKMethod<RawDataFile>

Returns:

the result of this algorithm, or null

Throws:

MSDKException - On any error

getResult

public RawDataFile getResult()

Returns the result of this algorithm, or null.

Specified by:

getResult in interface MSDKMethod<RawDataFile>

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<RawDataFile>