Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
MzMLHandlerHelper.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2015.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Hannes Roest $
32 // $Authors: Hannes Roest $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_HANDLERS_MZMLHANDLERHELPER_H
36 #define OPENMS_FORMAT_HANDLERS_MZMLHANDLERHELPER_H
37 
41 
42 #include <vector>
43 
44 namespace OpenMS
45 {
46  namespace Internal
47  {
48 
49  class OPENMS_DLLAPI MzMLHandlerHelper
50  {
51 
53  static void warning(int mode, const String & msg, UInt line = 0, UInt column = 0);
54 
55  public:
56 
58  struct BinaryData
59  {
61  enum {PRE_NONE, PRE_32, PRE_64} precision;
63  bool compression; // zlib compression
64  enum {DT_NONE, DT_FLOAT, DT_INT, DT_STRING} data_type;
65  std::vector<float> floats_32;
66  std::vector<double> floats_64;
67  std::vector<Int32> ints_32;
68  std::vector<Int64> ints_64;
69  std::vector<String> decoded_char;
72  };
73 
77  static String getCompressionTerm_(const PeakFileOptions& opt, MSNumpressCoder::NumpressConfig np_compression, bool use_numpress = false);
78 
82  static void writeFooter_(std::ostream& os, const PeakFileOptions& options_,
83  std::vector< std::pair<std::string, long> > & spectra_offsets,
84  std::vector< std::pair<std::string, long> > & chromatograms_offsets
85  );
86 
87  static void decodeBase64Arrays(std::vector<BinaryData> & data_, bool skipXMLCheck = false);
88 
89  static void computeDataProperties_(std::vector<BinaryData>& data_, bool& precision_64, SignedSize& index, String index_name);
90 
91  static bool handleBinaryDataArrayCVParam(std::vector<BinaryData>& data_,
92  const String& accession, const String& value, const String& name);
93  };
94 
95 
96  } // namespace Internal
97 } // namespace OpenMS
98 
99 #endif
A more convenient string class.
Definition: String.h:57
std::vector< float > floats_32
Definition: MzMLHandlerHelper.h:65
std::vector< Int32 > ints_32
Definition: MzMLHandlerHelper.h:67
ptrdiff_t SignedSize
Signed Size type e.g. used as pointer difference.
Definition: Types.h:128
Binary data representation.
Definition: MzMLHandlerHelper.h:58
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:47
Description of the meta data arrays of MSSpectrum.
Definition: MetaInfoDescription.h:49
Configuration class for MSNumpress.
Definition: MSNumpressCoder.h:65
NumpressCompression
Definition: MSNumpressCoder.h:58
Size size
Definition: MzMLHandlerHelper.h:62
std::vector< double > floats_64
Definition: MzMLHandlerHelper.h:66
MetaInfoDescription meta
Definition: MzMLHandlerHelper.h:70
std::vector< String > decoded_char
Definition: MzMLHandlerHelper.h:69
MSNumpressCoder::NumpressCompression np_compression
Definition: MzMLHandlerHelper.h:71
bool compression
Definition: MzMLHandlerHelper.h:63
std::vector< Int64 > ints_64
Definition: MzMLHandlerHelper.h:68
Options for loading files containing peak data.
Definition: PeakFileOptions.h:48
String base64
Definition: MzMLHandlerHelper.h:60
Definition: MzMLHandlerHelper.h:49

OpenMS / TOPP release 2.0.0 Documentation generated on Wed Mar 30 2016 12:49:24 using doxygen 1.8.11