ExperimentalDesign#

class pyopenms.ExperimentalDesign#

Bases: object

Cython implementation of _ExperimentalDesign

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1ExperimentalDesign.html

Representation of an experimental design in OpenMS. Instances can be loaded with the ExperimentalDesignFile class

__init__()#

Cython signature: void ExperimentalDesign()
Cython signature: void ExperimentalDesign(ExperimentalDesign &)

Methods

`__init__`	Cython signature: void ExperimentalDesign()
`fromConsensusMap`	Cython signature: ExperimentalDesign fromConsensusMap(ConsensusMap c)
`fromFeatureMap`	Cython signature: ExperimentalDesign fromFeatureMap(FeatureMap f)
`fromIdentifications`	Cython signature: ExperimentalDesign fromIdentifications(libcpp_vector[ProteinIdentification] & proteins)
`getMSFileSection`	Cython signature: libcpp_vector[ExperimentalDesign_MSFileSectionEntry] getMSFileSection()
`getNumberOfFractionGroups`	Cython signature: unsigned int getNumberOfFractionGroups() Allows to group fraction ids and source files.
`getNumberOfFractions`	Cython signature: unsigned int getNumberOfFractions() Returns the number of fractions (= highest fraction index)
`getNumberOfLabels`	Cython signature: unsigned int getNumberOfLabels() Returns the number of labels per file
`getNumberOfMSFiles`	Cython signature: unsigned int getNumberOfMSFiles() Returns the number of MS files (= fractions * fraction_groups)
`getNumberOfSamples`	Cython signature: unsigned int getNumberOfSamples() Returns the number of samples measured (= highest sample index)
`getSample`	Cython signature: unsigned int getSample(unsigned int fraction_group, unsigned int label) Returns sample index (depends on fraction_group and label)
`getSampleSection`	Cython signature: ExperimentalDesign_SampleSection getSampleSection() Returns the Sample Section of the experimental design file
`isFractionated`	Cython signature: bool isFractionated() Returns whether at least one fraction_group in this experimental design is fractionated
`sameNrOfMSFilesPerFraction`	Cython signature: bool sameNrOfMSFilesPerFraction() Returns if each fraction number is associated with the same number of fraction_group
`setMSFileSection`	Cython signature: void setMSFileSection(libcpp_vector[ExperimentalDesign_MSFileSectionEntry] msfile_section)
`setSampleSection`	Cython signature: void setSampleSection(ExperimentalDesign_SampleSection sample_section) Sets the Sample Section of the experimental design file

fromConsensusMap()#: Cython signature: ExperimentalDesign fromConsensusMap(ConsensusMap c)

fromFeatureMap()#: Cython signature: ExperimentalDesign fromFeatureMap(FeatureMap f)

fromIdentifications()#: Cython signature: ExperimentalDesign fromIdentifications(libcpp_vector[ProteinIdentification] & proteins)

getMSFileSection()#: Cython signature: libcpp_vector[ExperimentalDesign_MSFileSectionEntry] getMSFileSection()

getNumberOfFractionGroups()#: Cython signature: unsigned int getNumberOfFractionGroups() Allows to group fraction ids and source files. Return the number of fraction_groups

getNumberOfFractions()#: Cython signature: unsigned int getNumberOfFractions() Returns the number of fractions (= highest fraction index)

getNumberOfLabels()#: Cython signature: unsigned int getNumberOfLabels() Returns the number of labels per file

getNumberOfMSFiles()#: Cython signature: unsigned int getNumberOfMSFiles() Returns the number of MS files (= fractions * fraction_groups)

getNumberOfSamples()#: Cython signature: unsigned int getNumberOfSamples() Returns the number of samples measured (= highest sample index)

getSample()#: Cython signature: unsigned int getSample(unsigned int fraction_group, unsigned int label) Returns sample index (depends on fraction_group and label)

getSampleSection()#: Cython signature: ExperimentalDesign_SampleSection getSampleSection() Returns the Sample Section of the experimental design file

isFractionated()#: Cython signature: bool isFractionated() Returns whether at least one fraction_group in this experimental design is fractionated

sameNrOfMSFilesPerFraction()#: Cython signature: bool sameNrOfMSFilesPerFraction() Returns if each fraction number is associated with the same number of fraction_group

setMSFileSection()#: Cython signature: void setMSFileSection(libcpp_vector[ExperimentalDesign_MSFileSectionEntry] msfile_section)

setSampleSection()#: Cython signature: void setSampleSection(ExperimentalDesign_SampleSection sample_section) Sets the Sample Section of the experimental design file