StringDataArray#

class pyopenms.StringDataArray#

Bases: object

Cython implementation of _StringDataArray

Original C++ documentation is available here: – Inherits from [‘MetaInfoDescription’]

The representation of extra string data attached to a spectrum or chromatogram.

__init__()#

Overload:

Overload:

Methods

`__init__`
`clear`(self)
`clearMetaInfo`(self)	Removes all meta values
`getDataProcessing`(self)	Returns a reference to the description of the applied processing
`getKeys`(self, keys)	Fills the given vector with a list of all keys for which a value is set
`getMetaValue`(self, in_0)	Returns the value corresponding to a string, or
`getName`(self)	Returns the name of the peak annotations
`get_data`	Gets the data as a list of Python strings.
`isMetaEmpty`(self)	Returns if the MetaInfo is empty
`metaRegistry`(self)	Returns a reference to the MetaInfoRegistry
`metaValueExists`(self, in_0)	Returns whether an entry with the given name exists
`push_back`(self, in_0)
`removeMetaValue`(self, in_0)	Removes the DataValue corresponding to name if it exists
`resize`(self, n)
`setDataProcessing`(self, in_0)	Sets the description of the applied processing
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setName`(self, name)	Sets the name of the peak annotations
`size`(self)

getDataProcessing(self) → List[DataProcessing]#: Returns a reference to the description of the applied processing

getKeys(self, keys: List[bytes]) → None#: Fills the given vector with a list of all keys for which a value is set

getMetaValue(self, in_0: bytes | str | String) → int | float | bytes | str | List[int] | List[float] | List[bytes]#: Returns the value corresponding to a string, or

getName(self) → bytes | str | String#: Returns the name of the peak annotations

get_data()#

Gets the data as a list of Python strings.

This method creates a copy of the underlying data, so it’s safe to use even after the original StringDataArray object is deleted or modified.

Example usage:

sda = pyopenms.StringDataArray()
sda.push_back('a')
sda.push_back('b')
data = sda.get_data()  # ['a', 'b']

metaRegistry(self) → MetaInfoRegistry#: Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: bytes | str | String) → bool#: Returns whether an entry with the given name exists

removeMetaValue(self, in_0: bytes | str | String) → None#: Removes the DataValue corresponding to name if it exists

setDataProcessing(self, in_0: List[DataProcessing]) → None#: Sets the description of the applied processing

setMetaValue(self, in_0: bytes | str | String, in_1: int | float | bytes | str | List[int] | List[float] | List[bytes]) → None#: Sets the DataValue corresponding to a name

setName(self, name: bytes | str | String) → None#: Sets the name of the peak annotations