File: classOpenMS_1_1DTAFile.html

package info (click to toggle)
openms 1.11.1-5
links: PTS, VCS
area: main
in suites: jessie, jessie-kfreebsd
size: 436,688 kB
ctags: 150,907
sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (203 lines) | stat: -rw-r--r-- 11,254 bytes
<HTML>
<HEAD>
<TITLE>DTAFile Class Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1DTAFile.html">DTAFile</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classOpenMS_1_1DTAFile-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">DTAFile Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for DTA files.  
 <a href="classOpenMS_1_1DTAFile.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="DTAFile_8h_source.html">OpenMS/FORMAT/DTAFile.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a747c368996a72815971efc3d530ebbd7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DTAFile.html#a747c368996a72815971efc3d530ebbd7">DTAFile</a> ()</td></tr>
<tr class="memdesc:a747c368996a72815971efc3d530ebbd7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <a href="#a747c368996a72815971efc3d530ebbd7">More...</a><br/></td></tr>
<tr class="separator:a747c368996a72815971efc3d530ebbd7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a927e5d22e4526ff57da8d0470c18b0bd"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DTAFile.html#a927e5d22e4526ff57da8d0470c18b0bd">~DTAFile</a> ()</td></tr>
<tr class="memdesc:a927e5d22e4526ff57da8d0470c18b0bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#a927e5d22e4526ff57da8d0470c18b0bd">More...</a><br/></td></tr>
<tr class="separator:a927e5d22e4526ff57da8d0470c18b0bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a583280bb0e47a5d57b337d6440c96b73"><td class="memTemplParams" colspan="2">template&lt;typename SpectrumType &gt; </td></tr>
<tr class="memitem:a583280bb0e47a5d57b337d6440c96b73"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DTAFile.html#a583280bb0e47a5d57b337d6440c96b73">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;filename, SpectrumType &amp;spectrum)</td></tr>
<tr class="memdesc:a583280bb0e47a5d57b337d6440c96b73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a DTA file to a spectrum.  <a href="#a583280bb0e47a5d57b337d6440c96b73">More...</a><br/></td></tr>
<tr class="separator:a583280bb0e47a5d57b337d6440c96b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad1400476baaa9e6ff74301f6395c5e8"><td class="memTemplParams" colspan="2">template&lt;typename SpectrumType &gt; </td></tr>
<tr class="memitem:aad1400476baaa9e6ff74301f6395c5e8"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DTAFile.html#aad1400476baaa9e6ff74301f6395c5e8">store</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;filename, const SpectrumType &amp;spectrum) const </td></tr>
<tr class="memdesc:aad1400476baaa9e6ff74301f6395c5e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores a spectrum in a DTA file.  <a href="#aad1400476baaa9e6ff74301f6395c5e8">More...</a><br/></td></tr>
<tr class="separator:aad1400476baaa9e6ff74301f6395c5e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for DTA files. </p>
<p>The first line contains the singly protonated peptide mass (MH+) and the peptide charge state separated by a space. Subsequent lines contain space separated pairs of fragment ion m/z and intensity values.</p>
<p>From precusor mass and charge state the mass-charge-ratio is calculated and stored in the spectrum as precursor mass. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a747c368996a72815971efc3d530ebbd7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classOpenMS_1_1DTAFile.html">DTAFile</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default constructor. </p>

</div>
</div>
<a class="anchor" id="a927e5d22e4526ff57da8d0470c18b0bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="classOpenMS_1_1DTAFile.html">DTAFile</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a583280bb0e47a5d57b337d6440c96b73"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void load </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">SpectrumType &amp;&#160;</td>
          <td class="paramname"><em>spectrum</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Loads a DTA file to a spectrum. </p>
<p>The content of the file is stored in <code>spectrum</code>. <code>spectrum</code> has to be a <a class="el" href="classOpenMS_1_1MSSpectrum.html" title="The representation of a 1D spectrum. ">MSSpectrum</a> or have the same interface.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1FileNotFound.html" title="File not found exception. ">Exception::FileNotFound</a></td><td>is thrown if the file could not be opened </td></tr>
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1ParseError.html" title="Parse Error exception. ">Exception::ParseError</a></td><td>is thrown if an error occurs during parsing </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="classOpenMS_1_1File.html#a6487771c96fec9db032960c91864884e">File::basename()</a>, <a class="el" href="classOpenMS_1_1String.html#a58599d37159ebc08a654fb2d25be92fe">String::has()</a>, <a class="el" href="namespaceOpenMS_1_1Constants.html#a7a25c5ed4c5f83b23ded7014aef42ad4">OpenMS::Constants::PROTON_MASS_U</a>, <a class="el" href="classOpenMS_1_1Precursor.html#aca40a4630f5f8a0568899b74a62dcd4b">Precursor::setCharge()</a>, <a class="el" href="classOpenMS_1_1Peak1D.html#ab9c4ce5d172a75d6de2c6f5f1847c9ab">Peak1D::setMZ()</a>, <a class="el" href="classOpenMS_1_1String.html#ae580d960e12c7f0ebc5c95931cf39ad5">String::split()</a>, and <a class="el" href="classOpenMS_1_1String.html#a86864c88ee12eb322f1645f238c1dbe5">String::trim()</a>.</p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FileHandler.html#a408091416e0e1f6019abd59bdb6a9269">FileHandler::loadExperiment()</a>.</p>

</div>
</div>
<a class="anchor" id="aad1400476baaa9e6ff74301f6395c5e8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void store </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const SpectrumType &amp;&#160;</td>
          <td class="paramname"><em>spectrum</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Stores a spectrum in a DTA file. </p>
<p>The content of <code>spectrum</code> is stored in a file. <code>spectrum</code> has to be a <a class="el" href="classOpenMS_1_1MSSpectrum.html" title="The representation of a 1D spectrum. ">MSSpectrum</a> or have the same interface.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1UnableToCreateFile.html" title="Unable to create file exception. ">Exception::UnableToCreateFile</a></td><td>is thrown if the file could not be created </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="classOpenMS_1_1Precursor.html#ab91109da6782d902c745c771aa85d03d">Precursor::getCharge()</a>, and <a class="el" href="classOpenMS_1_1Peak1D.html#a6fefef82aae7a3208e71648e763d5ea4">Peak1D::getMZ()</a>.</p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:30 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>