io.github.msdk.featuredetection.targeted

Class TargetedDetectionMethod

java.lang.Object

io.github.msdk.featuredetection.targeted.TargetedDetectionMethod

All Implemented Interfaces:

MSDKMethod<List<Chromatogram>>

public class TargetedDetectionMethod
extends Object
implements MSDKMethod<List<Chromatogram>>

This class creates a list of Chromatograms from a RawDataFile based on a list of IonAnnotations.

Constructor Summary

Constructors

Constructor and Description
TargetedDetectionMethod(List<IonAnnotation> ionAnnotations, RawDataFile rawDataFile, MzTolerance mzTolerance, RTTolerance rtTolerance, Double intensityTolerance, Double noiseLevel) Constructor for TargetedDetectionMethod.

Method Summary

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

TargetedDetectionMethod

public TargetedDetectionMethod(@Nonnull
                               List<IonAnnotation> ionAnnotations,
                               @Nonnull
                               RawDataFile rawDataFile,
                               @Nonnull
                               MzTolerance mzTolerance,
                               @Nonnull
                               RTTolerance rtTolerance,
                               @Nonnull
                               Double intensityTolerance,
                               @Nonnull
                               Double noiseLevel)

Constructor for TargetedDetectionMethod.

Parameters:

ionAnnotations - a List object.

rawDataFile - a RawDataFile object.

mzTolerance - an object

rtTolerance - a RTTolerance object.

intensityTolerance - a Double object.

noiseLevel - a Double object.

Method Detail

execute

public List<Chromatogram> execute()
                           throws MSDKException

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

Specified by:

execute in interface MSDKMethod<List<Chromatogram>>

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<List<Chromatogram>>

Returns:

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

getResult

@Nullable
public List<Chromatogram> getResult()

Returns the result of this algorithm, or null.

Specified by:

getResult in interface MSDKMethod<List<Chromatogram>>

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<List<Chromatogram>>