OpenMS
Observation Struct Reference

Representation of an observation, e.g. a spectrum or feature, in an input data file. More...

#include <OpenMS/METADATA/ID/Observation.h>

Inheritance diagram for Observation:
[legend]
Collaboration diagram for Observation:
[legend]

Public Member Functions

 Observation (const String &data_id, const InputFileRef &input_file, double rt=std::numeric_limits< double >::quiet_NaN(), double mz=std::numeric_limits< double >::quiet_NaN())
 Constructor. More...
 
Observationmerge (const Observation &other)
 Merge in data from another object. More...
 
- Public Member Functions inherited from MetaInfoInterface
 MetaInfoInterface ()
 Constructor. More...
 
 MetaInfoInterface (const MetaInfoInterface &rhs)
 Copy constructor. More...
 
 MetaInfoInterface (MetaInfoInterface &&) noexcept
 Move constructor. More...
 
 ~MetaInfoInterface ()
 Destructor. More...
 
MetaInfoInterfaceoperator= (const MetaInfoInterface &rhs)
 Assignment operator. More...
 
MetaInfoInterfaceoperator= (MetaInfoInterface &&) noexcept
 Move assignment operator. More...
 
void swap (MetaInfoInterface &rhs)
 Swap contents. More...
 
bool operator== (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
bool operator!= (const MetaInfoInterface &rhs) const
 Equality operator. More...
 
const DataValuegetMetaValue (const String &name) const
 Returns the value corresponding to a string, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (const String &name, const DataValue &default_value) const
 Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found. More...
 
const DataValuegetMetaValue (UInt index) const
 Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
 
DataValue getMetaValue (UInt index, const DataValue &default_value) const
 Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found. More...
 
bool metaValueExists (const String &name) const
 Returns whether an entry with the given name exists. More...
 
bool metaValueExists (UInt index) const
 Returns whether an entry with the given index exists. More...
 
void setMetaValue (const String &name, const DataValue &value)
 Sets the DataValue corresponding to a name. More...
 
void setMetaValue (UInt index, const DataValue &value)
 Sets the DataValue corresponding to an index. More...
 
void removeMetaValue (const String &name)
 Removes the DataValue corresponding to name if it exists. More...
 
void removeMetaValue (UInt index)
 Removes the DataValue corresponding to index if it exists. More...
 
void addMetaValues (const MetaInfoInterface &from)
 function to copy all meta values from one object to this one More...
 
void getKeys (std::vector< String > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
void getKeys (std::vector< UInt > &keys) const
 Fills the given vector with a list of all keys for which a value is set. More...
 
bool isMetaEmpty () const
 Returns if the MetaInfo is empty. More...
 
void clearMetaInfo ()
 Removes all meta values. More...
 

Public Attributes

String data_id
 Spectrum or feature ID (from the file referenced by @t input_file) More...
 
InputFileRef input_file
 Reference to the input file. More...
 
double rt
 
double mz
 

Additional Inherited Members

- Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistrymetaRegistry ()
 Returns a reference to the MetaInfoRegistry. More...
 
- Protected Member Functions inherited from MetaInfoInterface
void createIfNotExists_ ()
 Creates the MetaInfo object if it does not exist. More...
 
- Protected Attributes inherited from MetaInfoInterface
MetaInfometa_
 Pointer to the MetaInfo object (0 by default) More...
 

Detailed Description

Representation of an observation, e.g. a spectrum or feature, in an input data file.

Constructor & Destructor Documentation

◆ Observation()

Observation ( const String data_id,
const InputFileRef input_file,
double  rt = std::numeric_limits<double>::quiet_NaN(),
double  mz = std::numeric_limits<double>::quiet_NaN() 
)
inlineexplicit

Constructor.

Member Function Documentation

◆ merge()

Observation& merge ( const Observation other)
inline

Merge in data from another object.

References MetaInfoInterface::addMetaValues(), Observation::mz, and Observation::rt.

Member Data Documentation

◆ data_id

String data_id

Spectrum or feature ID (from the file referenced by @t input_file)

Referenced by IdentificationDataConverter::exportObservationMatchToMzTab_().

◆ input_file

InputFileRef input_file

Reference to the input file.

Referenced by IdentificationDataConverter::exportObservationMatchToMzTab_().

◆ mz

◆ rt