Skip to content

Commit

Permalink
Adding user documentation for Algorithm A and indentation in Algorithm B
Browse files Browse the repository at this point in the history
  • Loading branch information
Raghavdata authored and sahil21 committed Jun 30, 2017
1 parent 3e748f9 commit 0b9fae4
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions libmaven/mzMassSlicer.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,24 @@ class MassSlices {
mzSlice* sliceExists(float mz,float rt);

/**
* [algorithmA ]
* [This is function is called when mass Slicing using
* AlgorithmB returns no slices. The slices here are created using the filterLine
* in Mzml and Mzxml files.]
* @method algorithmA
*/
void algorithmA();

/**
* [This is the main function that does the peakdetection
* This does not need a DB to check the peaks. The function essentially loops over
* every observation in every scan in every sample. Every observation is checked if
* it is already present in a slice or not. If present in a slice MZmax, MZmin, RTmin,
* RTmax, intensity, MZ and RT are modified and the slice then put back into cache. If
* not then then a new slice is created and added to the slice.]
* @method AlgorithmB
* @param userPPM The user defined PPM for MZ range
* @param rtStep Minimum RT range for RT window
*/
* [This is the main function that does the peakdetection
* This does not need a DB to check the peaks. The function essentially loops over
* every observation in every scan in every sample. Every observation is checked if
* it is already present in a slice or not. If present in a slice MZmax, MZmin, RTmin,
* RTmax, intensity, MZ and RT are modified and the slice then put back into cache. If
* not then then a new slice is created and added to the slice.]
* @method AlgorithmB
* @param userPPM The user defined PPM for MZ range
* @param rtStep Minimum RT range for RT window
*/
void algorithmB(float ppm, int step);


Expand Down

0 comments on commit 0b9fae4

Please sign in to comment.