Header menu logo BioFSharp.Mz

PeakArray Module

Functions and values

Function or value Description

binToUpperIntergerMass pkarr minMassBoarder maxMassBoarder

Full Usage: binToUpperIntergerMass pkarr minMassBoarder maxMassBoarder

Parameters:
    pkarr : PeakArray<'a>
    minMassBoarder : int
    maxMassBoarder : int

Returns: float array

Bins peaks to their next upperIntegerMass bin

pkarr : PeakArray<'a>
minMassBoarder : int
maxMassBoarder : int
Returns: float array

map f pkarr

Full Usage: map f pkarr

Parameters:
    f : 'a -> 'b
    pkarr : 'a array

Returns: PeakArray<'b>

Builds a new PeakArray whose elements are the results of applying the given function to each of the elements of the PeakArray.

f : 'a -> 'b
pkarr : 'a array
Returns: PeakArray<'b>

peaksToNearestUnitDaltonBin pkarr minMassBoarder maxMassBoarder

Full Usage: peaksToNearestUnitDaltonBin pkarr minMassBoarder maxMassBoarder

Parameters:
    pkarr : PeakArray<'a>
    minMassBoarder : int
    maxMassBoarder : int

Returns: float array

Bins peaks to their nearest 1 Da bin

pkarr : PeakArray<'a>
minMassBoarder : int
maxMassBoarder : int
Returns: float array

peaksToNearestUnitDaltonBinVector pkarr minMassBoarder maxMassBoarder

Full Usage: peaksToNearestUnitDaltonBinVector pkarr minMassBoarder maxMassBoarder

Parameters:
    pkarr : PeakArray<'a>
    minMassBoarder : float
    maxMassBoarder : float

Returns: Vector<float>

Bins peaks to their nearest 1 Da bin. Filters out peaks where the mz < minMassBoarder & > maxMassBoarder

pkarr : PeakArray<'a>
minMassBoarder : float
maxMassBoarder : float
Returns: Vector<float>

unzip pkarr

Full Usage: unzip pkarr

Parameters:
Returns: 'a array * 'a array

Iterates the PeakArray and unzips the value fields of each peak into two seperate arrays, the first containing the mz values, the second the intensities.

pkarr : PeakArray<'a>
Returns: 'a array * 'a array

zip mz intensity

Full Usage: zip mz intensity

Parameters:
    mz : float array
    intensity : float array

Returns: PeakArray<Peak>

Iterates the mz and intensity array and creates a Peak(mz,intensity) for each value pair. Returns a new Peak array.

mz : float array
intensity : float array
Returns: PeakArray<Peak>

zipMzInt mzIntensity

Full Usage: zipMzInt mzIntensity

Parameters:
    mzIntensity : (float * float) array

Returns: PeakArray<Peak>

Creates a Peak(mz,intensity) for each value pair in mzIntensity. Returns a new PeakArray.

mzIntensity : (float * float) array
Returns: PeakArray<Peak>

Type something to start searching.