io.github.msdk.isotopes.isotopegrouper

Class IsotopeGrouperMethod

java.lang.Object

io.github.msdk.isotopes.isotopegrouper.IsotopeGrouperMethod

All Implemented Interfaces:

MSDKMethod<FeatureTable>

public class IsotopeGrouperMethod
extends Object
implements MSDKMethod<FeatureTable>

This class searches through a feature table and groups isotopes under a single feature.

Constructor Summary

Constructors

Constructor and Description
IsotopeGrouperMethod(FeatureTable featureTable, MzTolerance mzTolerance, RTTolerance rtTolerance, Integer maximumCharge, Boolean requireMonotonicShape) Constructor for IsotopeGrouperMethod.

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

IsotopeGrouperMethod

public IsotopeGrouperMethod(@Nonnull
                            FeatureTable featureTable,
                            @Nonnull
                            MzTolerance mzTolerance,
                            @Nonnull
                            RTTolerance rtTolerance,
                            @Nonnull
                            Integer maximumCharge,
                            @Nonnull
                            Boolean requireMonotonicShape)

Constructor for IsotopeGrouperMethod.

Parameters:

featureTable - a FeatureTable object.

featureTableName - a String object.

mzTolerance - a MzTolerance object.

rtTolerance - a RTTolerance object.

maximumCharge - a Integer object.

requireMonotonicShape - a Boolean 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>