mf-matcher

3.2.4
Need help reading this?

generalMatcher

Returns true if the entry containing MF information match

generalMatcher(entry: object, options: object): boolean
Parameters
entry (object = {}) object containing mw, ...
options (object = {})
Name Description
options.minMW number (default 0) Minimal molecular weight
options.maxMW number (default +Infinity) Maximal molecular weight
options.minEM number (default 0) Minimal monoisotopic mass
options.maxEM number (default +Infinity) Maximal monoisotopic mass
options.minCharge number (default -Infinity) Minimal charge
options.maxCharge number (default +Infinity) Maximal charge
options.absoluteCharge boolean (default false) If true, the charge is absolute (so between 0 and +Infinity by default)
options.unsaturation object (default {})
options.unsaturation.min number (default -Infinity) Minimal unsaturation
options.unsaturation.max number (default +Infinity) Maximal unsaturation
options.unsaturation.onlyInteger boolean (default false) Integer unsaturation
options.unsaturation.onlyNonInteger boolean (default false) Non integer unsaturation
options.atoms object? object of atom:{min, max}
Returns
boolean:

unsaturationMatcher

unsaturationMatcher(entry: object, options: object): boolean
Parameters
entry (object = {})
options (object = {})
Name Description
options.min number (default -Infinity) Minimal unsaturation
options.max number (default +Infinity) Maximal unsaturation
options.onlyInteger boolean (default false) Integer unsaturation
options.onlyNonInteger boolean (default false) Non integer unsaturation
Returns
boolean:

MSEMFilterOptions

MSEMFilterOptions

Type: object

Properties
ionization (object?) : ionization method
forceIonization (boolean?) : If true ignore existing ionizations
precision (number?) : The precision on the experimental mass
targetMass (number?) : Target mass, allows to calculate error and filter results
targetMasses (Array<number>?) : Target masses: SORTED array of numbers
targetIntensities (Array<number>?) : Target intensities: SORTED array of numbers
minMW (number?) : Minimal monoisotopic mass
maxMW (number?) : Maximal monoisotopic mass
minEM (number?) : Minimal monoisotopic mass
maxEM (number?) : Maximal monoisotopic mass
minMSEM (number?) : Minimal monoisotopic mass observed by mass
maxMSEM (number?) : Maximal monoisotopic mass observed by mass
minCharge (number?) : Minimal charge
maxCharge (number?) : Maximal charge
absoluteCharge (boolean?) : If true, the charge is absolute (so between 0 and +Infinity by default)
allowNegativeAtoms (boolean?) : Allow to have negative number of atoms
unsaturation (object?)
  • unsaturation.min number?

    Minimal unsaturation

  • unsaturation.max number?

    Maximal unsaturation

  • unsaturation.onlyInteger boolean?

    Integer unsaturation

  • unsaturation.onlyNonInteger boolean?

    Non integer unsaturation

atoms (boolean?) : object of atom:{min, max}
callback (Function?) : a function that contains information about the current MF

msemMatcher

msemMatcher(entry: object, options: MSEMFilterOptions): boolean
Parameters
entry (object = {})
options (MSEMFilterOptions = {})
Returns
boolean:

msemMatcher

We always recalculate msem

msemMatcher(entry: any, options: any)
Parameters
entry (any)
options (any = {})