io.github.msdk.alignment.ransac

Class RansacAlignerMethod

java.lang.Object

io.github.msdk.alignment.ransac.RansacAlignerMethod

All Implemented Interfaces:

MSDKMethod<FeatureTable>

public class RansacAlignerMethod
extends Object
implements MSDKMethod<FeatureTable>

This class aligns feature tables using the RANSAC method.

Constructor Summary

Constructors

Constructor and Description
RansacAlignerMethod(List<FeatureTable> featureTables, MzTolerance mzTolerance, RTTolerance rtTolerance, String featureTableName, double t, boolean linear, double dataPointsRate) Constructor for RansacAlignerMethod.

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

RansacAlignerMethod

public RansacAlignerMethod(@Nonnull
                           List<FeatureTable> featureTables,
                           @Nonnull
                           MzTolerance mzTolerance,
                           @Nonnull
                           RTTolerance rtTolerance,
                           @Nonnull
                           String featureTableName,
                           @Nonnull
                           double t,
                           @Nonnull
                           boolean linear,
                           @Nonnull
                           double dataPointsRate)

Constructor for RansacAlignerMethod.

Parameters:

featureTables - a List object.

dataStore - a io.github.msdk.datamodel.datastore.DataPointStore object.

mzTolerance - a io.github.msdk.util.MZTolerance object.

featureTableName - a String object.

rtTolerance - a io.github.msdk.util.RTTolerance object.

t - a threshold value for determining when a data point fits a mode

linear - a Boolean object.

dataPointsRate - % of datapoints from the data required to assert that a model fits well to data. If it is 0, the variable will be set as 0.1

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>