SiriusExportAlgorithm#
- class pyopenms.SiriusExportAlgorithm#
Bases:
DefaultParamHandlerOpenMS class SiriusExportAlgorithm
- __init__() None#
- __init__(arg: pyopenms.SiriusExportAlgorithm, /) None
Methods
__init__()Returns the default parameters
getName()Returns the name
Returns the parameters
logFeatureSpectraNumber(featureinfo, ...)Logs number of features and spectra used
preprocessing(featureinfo, spectra, ...)Preprocessing needed for SIRIUS
run(mzML_files, featureXML_files, out_ms, ...)Runs SiriusExport with mzML and featureXML (optional) files as input.
setName(name)Sets the name
setParameters(param)Sets the parameters
- getDefaults() pyopenms.Param#
Returns the default parameters
- getFilterByNumMassTraces() int#
- getIsotopePatternIterations() int#
- getName() str#
Returns the name
- getParameters() pyopenms.Param#
Returns the parameters
- getPrecursorMzTolerance() float#
- getPrecursorRtTolerance() float#
- getSubsections() list[str]#
- isFeatureOnly() bool#
- isNoMasstraceInfoIsotopePattern() bool#
- logFeatureSpectraNumber(featureinfo: str, feature_ms2_indices: pyopenms.FeatureMapping_FeatureToMs2Indices, spectra: pyopenms.MSExperiment) None#
Logs number of features and spectra used
Prints the number of features and spectra used (OPENMS_LOG_INFO)
- Parameters:
featureinfo – Path to featureXML
feature_ms2_indices – FeatureToMs2Indices with feature mapping
spectra – Input of MSExperiment with spectra information
- precursorMzToleranceUnitIsPPM() bool#
- preprocessing(featureinfo: str, spectra: pyopenms.MSExperiment, feature_mapping_info: pyopenms.FeatureMapping_FeatureMappingInfo, feature_ms2_indices: pyopenms.FeatureMapping_FeatureToMs2Indices) None#
Preprocessing needed for SIRIUS
Filter number of masstraces and perform feature mapping
- Parameters:
featureinfo – Path to featureXML
spectra – Input of MSExperiment with spectra information
feature_mapping_info – Empty - stores FeatureMaps and KDTreeMaps internally
feature_ms2_indices – Empty FeatureToMs2Indices
- run(mzML_files: list[str], featureXML_files: list[str], out_ms: str, out_compoundinfo: str) None#
Runs SiriusExport with mzML and featureXML (optional) files as input.
Generates a SIRIUS .ms file and compound info table (optional).
- Parameters:
mzML_files – List with paths to mzML files
featureXML_files – List with paths to featureXML files
out_ms – Output file name for SIRIUS .ms file
out_compoundinfo – Output file name for tsv file with compound info
- setName(name: str) None#
Sets the name
- setParameters(param: pyopenms.Param) None#
Sets the parameters