io.github.msdk.featuredetection.adap3d.algorithms

Class ADAP3DPeakDetectionAlgorithm

java.lang.Object

io.github.msdk.featuredetection.adap3d.algorithms.ADAP3DPeakDetectionAlgorithm

public class ADAP3DPeakDetectionAlgorithm
extends Object

ADAP3DPeakDetectionAlgorithm class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ADAP3DPeakDetectionAlgorithm.GoodPeakInfo GoodPeakInfo class is used to save information of good peaks.

Constructor Summary

Constructors

Constructor and Description
ADAP3DPeakDetectionAlgorithm(SliceSparseMatrix objSliceSparseMatrix) Constructor

Method Summary

Modifier and Type	Method and Description
void	cancel() This method is used to stop adap3d algorithm.
List<ADAP3DPeakDetectionAlgorithm.GoodPeakInfo>	execute(ADAP3DFeatureDetectionParameters objParameters, int roundedFWHM) This method executes the iteration method to find good peaks.
List<ADAP3DPeakDetectionAlgorithm.GoodPeakInfo>	execute(int numOfPeaks, ADAP3DFeatureDetectionParameters objParameters, int roundedFWHM) This method determines the number of good peaks provided by the user.
float	getFinishedPercent() This method tracks progress of algorithm

Methods inherited from class java.lang.Object

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

Constructor Detail

ADAP3DPeakDetectionAlgorithm

public ADAP3DPeakDetectionAlgorithm(SliceSparseMatrix objSliceSparseMatrix)

Constructor

Parameters:

objSliceSparseMatrix - is sparse matrix created from raw data file.

Method Detail

execute

public List<ADAP3DPeakDetectionAlgorithm.GoodPeakInfo> execute(int numOfPeaks,
                                                               ADAP3DFeatureDetectionParameters objParameters,
                                                               int roundedFWHM)

This method determines the number of good peaks provided by the user.

Parameters:

numOfPeaks - a Integer object. This is the maximum number of good peaks method will determine.

roundedFWHM - is full width half max of whole raw data file.

objParameters - a ADAP3DFeatureDetectionParameters object.

Returns:

peakList a list of ADAP3DPeakDetectionAlgorithm.GoodPeakInfo object type. This contains information of good peaks.

execute

public List<ADAP3DPeakDetectionAlgorithm.GoodPeakInfo> execute(ADAP3DFeatureDetectionParameters objParameters,
                                                               int roundedFWHM)

This method executes the iteration method to find good peaks.

Parameters:

roundedFWHM - is full width half max of whole raw data file.

objParameters - a ADAP3DFeatureDetectionParameters object.

Returns:

peakList a list of ADAP3DPeakDetectionAlgorithm.GoodPeakInfo object type. This contains information of good peaks.

cancel

public void cancel()

This method is used to stop adap3d algorithm.

getFinishedPercent

public float getFinishedPercent()

This method tracks progress of algorithm

Returns:

a float.