<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Coerce Data Into an echosounder Object — as.echosounder • oce</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Coerce Data Into an echosounder Object — as.echosounder"><meta name="description" content="Coerces a dataset into a echosounder dataset."><meta property="og:description" content="Coerces a dataset into a echosounder dataset."></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">oce</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">1.8-4</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/A_oce.html">1. Introduction to Oce</a></li>
    <li><a class="dropdown-item" href="../articles/B_ctd.html">2. Analysis of CTD data</a></li>
    <li><a class="dropdown-item" href="../articles/C_adp.html">3. Analysis of acoustic-Doppler data</a></li>
    <li><a class="dropdown-item" href="../articles/D_map_projections.html">4. Using map projections</a></li>
    <li><a class="dropdown-item" href="../articles/E_flags.html">5. Dealing with data-quality flags</a></li>
    <li><a class="dropdown-item" href="../articles/F_subclassing.html">6. Subclassing oce objects</a></li>
    <li><a class="dropdown-item" href="../articles/G_altering_defaults.html">7. Altering oce Defaults</a></li>
    <li><a class="dropdown-item" href="../articles/H_tides.html">8. Tidal Analysis</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/dankelley/oce/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">

      <h1>Coerce Data Into an echosounder Object</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/echosounder.R" class="external-link"><code>R/echosounder.R</code></a></small>
      <div class="d-none name"><code>as.echosounder.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Coerces a dataset into a echosounder dataset.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">as.echosounder</span><span class="op">(</span></span>
<span>  <span class="va">time</span>,</span>
<span>  <span class="va">depth</span>,</span>
<span>  <span class="va">a</span>,</span>
<span>  src <span class="op">=</span> <span class="st">""</span>,</span>
<span>  sourceLevel <span class="op">=</span> <span class="fl">220</span>,</span>
<span>  receiverSensitivity <span class="op">=</span> <span class="op">-</span><span class="fl">55.4</span>,</span>
<span>  transmitPower <span class="op">=</span> <span class="fl">0</span>,</span>
<span>  pulseDuration <span class="op">=</span> <span class="fl">400</span>,</span>
<span>  beamwidthX <span class="op">=</span> <span class="fl">6.5</span>,</span>
<span>  beamwidthY <span class="op">=</span> <span class="fl">6.5</span>,</span>
<span>  frequency <span class="op">=</span> <span class="fl">41800</span>,</span>
<span>  correction <span class="op">=</span> <span class="fl">0</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-time">time<a class="anchor" aria-label="anchor" href="#arg-time"></a></dt>
<dd><p>times of pings.</p></dd>


<dt id="arg-depth">depth<a class="anchor" aria-label="anchor" href="#arg-depth"></a></dt>
<dd><p>depths of samples within pings.</p></dd>


<dt id="arg-a">a<a class="anchor" aria-label="anchor" href="#arg-a"></a></dt>
<dd><p>matrix of echo amplitudes, as would be stored with
<code><a href="read.echosounder.html">read.echosounder()</a></code>.</p></dd>


<dt id="arg-src">src<a class="anchor" aria-label="anchor" href="#arg-src"></a></dt>
<dd><p>optional string indicating data source.</p></dd>


<dt id="arg-sourcelevel">sourceLevel<a class="anchor" aria-label="anchor" href="#arg-sourcelevel"></a></dt>
<dd><p>source level, in dB (uPa at 1m), denoted <code>sl</code> in
reference 1 p15, where it is in units 0.1dB (uPa at 1m).</p></dd>


<dt id="arg-receiversensitivity">receiverSensitivity<a class="anchor" aria-label="anchor" href="#arg-receiversensitivity"></a></dt>
<dd><p>receiver sensitivity of the main element, in
dB(counts/uPa), denoted <code>rs</code> in reference 1 p15, where it is in units of
0.1dB(counts/uPa)</p></dd>


<dt id="arg-transmitpower">transmitPower<a class="anchor" aria-label="anchor" href="#arg-transmitpower"></a></dt>
<dd><p>transmit power reduction factor, in dB, denoted
<code>tpow</code> in reference 1 p10, where it is in units 0.1 dB.</p></dd>


<dt id="arg-pulseduration">pulseDuration<a class="anchor" aria-label="anchor" href="#arg-pulseduration"></a></dt>
<dd><p>duration of transmitted pulse in us</p></dd>


<dt id="arg-beamwidthx">beamwidthX<a class="anchor" aria-label="anchor" href="#arg-beamwidthx"></a></dt>
<dd><p>x-axis -3dB one-way beamwidth in deg, denoted <code>bwx</code>
in reference 1 p16, where the unit is 0.2 deg</p></dd>


<dt id="arg-beamwidthy">beamwidthY<a class="anchor" aria-label="anchor" href="#arg-beamwidthy"></a></dt>
<dd><p>y-axis -3dB one-way beamwidth in deg, denoted <code>bwx</code>
in reference 1 p16, where the unit is 0.2 deg</p></dd>


<dt id="arg-frequency">frequency<a class="anchor" aria-label="anchor" href="#arg-frequency"></a></dt>
<dd><p>transducer frequency in Hz, denoted <code>fq</code> in reference 1 p16</p></dd>


<dt id="arg-correction">correction<a class="anchor" aria-label="anchor" href="#arg-correction"></a></dt>
<dd><p>user-defined calibration correction in dB, denoted
<code>corr</code> in reference 1 p14, where the unit is 0.01dB.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>An <a href="echosounder-class.html">echosounder</a> object.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Creates an echosounder file.  The defaults for e.g.  <code>transmitPower</code>
are taken from the <code>echosounder</code> dataset, and they are unlikely to make
sense generally.  The first three parameters must be supplied, and the
dimension of <code>a</code> must align with the lengths of <code>time</code> and <code>depths</code>. The
other parameters have defaults that are unlikely to be correct for
arbitrary application, but they are not essential for basic plots,
etc.</p>
<p>Those who use the <a href="https://CRAN.R-project.org/package=readHAC" class="external-link"><span class="pkg">readHAC</span></a> package to read echosounder
data should note that it stores the <code>a</code> matrix in a flipped and
transposed format. See that package's demo code for a function
named <code>flip()</code> that transforms the matrix as required by
<code>as.echosounder()</code>. Indeed, users working with HAC
data ought to study the whole of the <a href="https://CRAN.R-project.org/package=readHAC" class="external-link"><span class="pkg">readHAC</span></a>
documentation, to learn what data are stored, so that
<code><a href="oceSetMetadata.html">oceSetMetadata()</a></code> and <code><a href="oceSetData.html">oceSetData()</a></code> can be used as needed
to flesh out the contents returned by <code>as.echosounder()</code>.</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p>Other things related to echosounder data:
<code><a href="sub-sub-echosounder-method.html">[[,echosounder-method</a></code>,
<code>[[&lt;-,echosounder-method</code>,
<code><a href="echosounder.html">echosounder</a></code>,
<code><a href="echosounder-class.html">echosounder-class</a></code>,
<code><a href="findBottom.html">findBottom</a>()</code>,
<code><a href="plot-echosounder-method.html">plot,echosounder-method</a></code>,
<code><a href="read.echosounder.html">read.echosounder</a>()</code>,
<code><a href="subset-echosounder-method.html">subset,echosounder-method</a></code>,
<code><a href="summary-echosounder-method.html">summary,echosounder-method</a></code></p></div>
    </div>
    <div class="section level2">
    <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
    <p>Dan Kelley</p>
    </div>

  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Dan Kelley, Clark Richards.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.9000.</p>
</div>

    </footer></div>





  </body></html>

