<!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>Grid a Section in Pressure Space — sectionGrid • 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="Grid a Section in Pressure Space — sectionGrid"><meta name="description" content='Grid a section, by interpolating to fixed pressure levels.  The
"approx", "boxcar" and "lm" methods are described in the
documentation for ctdDecimate(), which is used to do this
processing.'><meta property="og:description" content='Grid a section, by interpolating to fixed pressure levels.  The
"approx", "boxcar" and "lm" methods are described in the
documentation for ctdDecimate(), which is used to do this
processing.'></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>Grid a Section in Pressure Space</h1>
      <small class="dont-index">Source: <a href="https://github.com/dankelley/oce/blob/HEAD/R/section.R" class="external-link"><code>R/section.R</code></a></small>
      <div class="d-none name"><code>sectionGrid.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Grid a section, by interpolating to fixed pressure levels.  The
<code>"approx"</code>, <code>"boxcar"</code> and <code>"lm"</code> methods are described in the
documentation for <code><a href="ctdDecimate.html">ctdDecimate()</a></code>, which is used to do this
processing.</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">sectionGrid</span><span class="op">(</span></span>
<span>  <span class="va">section</span>,</span>
<span>  <span class="va">p</span>,</span>
<span>  method <span class="op">=</span> <span class="st">"approx"</span>,</span>
<span>  trim <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  debug <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"oceDebug"</span><span class="op">)</span>,</span>
<span>  <span class="va">...</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-section">section<a class="anchor" aria-label="anchor" href="#arg-section"></a></dt>
<dd><p>A <code>section</code> object containing the section to be gridded.</p></dd>


<dt id="arg-p">p<a class="anchor" aria-label="anchor" href="#arg-p"></a></dt>
<dd><p>Optional indication of the pressure levels to which interpolation
should be done.  If this is not supplied, the pressure levels will be
calculated based on the typical spacing in the ctd profiles stored within
<code>section</code>.  If <code>p="levitus"</code>, then pressures will be set to be those
of the Levitus atlas, given by <code><a href="standardDepths.html">standardDepths()</a></code>.
If <code>p</code> is a single numerical value,
it is taken as the number of subdivisions to use in a call to <code><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq()</a></code>
that has range from 0 to the maximum pressure in <code>section</code>.  Finally, if a
vector numerical values is provided, perhaps as constructed with <code><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq()</a></code>
or <code><a href="standardDepths.html">standardDepths</a></code><code>(5)</code> (as in the examples),
then it is used as is, after trimming any values that exceed the maximum
pressure in the station data stored within <code>section</code>.</p></dd>


<dt id="arg-method">method<a class="anchor" aria-label="anchor" href="#arg-method"></a></dt>
<dd><p>The method to use to decimate data within the stations; see
<code><a href="ctdDecimate.html">ctdDecimate()</a></code>, which is used for the decimation.</p></dd>


<dt id="arg-trim">trim<a class="anchor" aria-label="anchor" href="#arg-trim"></a></dt>
<dd><p>Logical value indicating whether to trim gridded pressures
to the range of the data in <code>section</code>.</p></dd>


<dt id="arg-debug">debug<a class="anchor" aria-label="anchor" href="#arg-debug"></a></dt>
<dd><p>an integer specifying whether debugging information is
to be printed during the processing. This is a general parameter that
is used by many <code>oce</code> functions. Generally, setting <code>debug=0</code>
turns off the printing, while higher values suggest that more information
be printed. If one function calls another, it usually reduces the value of
<code>debug</code> first, so that a user can often obtain deeper debugging
by specifying higher <code>debug</code> values.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>Optional arguments to be supplied to <code><a href="ctdDecimate.html">ctdDecimate()</a></code>,
e.g. <code>rule</code> controls extrapolation beyond the observed pressure range,
in the case where <code>method</code> equals <code>"approx"</code>.</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>A <a href="section-class.html">section</a> object that contains stations in which
the pressure values match identically, and that has all
flags set to <code>NA</code>.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>The default <code>"approx"</code> method is best for bottle data, the
<code>"boxcar"</code> is best for ctd data, and the <code>"lm"</code> method is probably
too slow to recommend for exploratory work, in which it is common to do trials
with a variety of <code>"p"</code> values.</p>
<p>The stations in the returned value have flags with names that match those
of the corresponding stations in the original <code>section</code>, but the values
of these flags are all set to <code>NA</code>. This recognizes that it makes
no sense to grid flag values, but that there is merit in initializing
a flag system, for possible use in later processing steps.</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 section data:
<code><a href="sub-sub-section-method.html">[[,section-method</a></code>,
<code>[[&lt;-,section-method</code>,
<code><a href="as.section.html">as.section</a>()</code>,
<code><a href="handleFlags-section-method.html">handleFlags,section-method</a></code>,
<code><a href="initializeFlagScheme-section-method.html">initializeFlagScheme,section-method</a></code>,
<code><a href="plot-section-method.html">plot,section-method</a></code>,
<code><a href="read.section.html">read.section</a>()</code>,
<code><a href="section.html">section</a></code>,
<code><a href="section-class.html">section-class</a></code>,
<code><a href="sectionAddStation.html">sectionAddStation</a>()</code>,
<code><a href="sectionSmooth.html">sectionSmooth</a>()</code>,
<code><a href="sectionSort.html">sectionSort</a>()</code>,
<code><a href="subset-section-method.html">subset,section-method</a></code>,
<code><a href="summary-section-method.html">summary,section-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>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># Gulf Stream</span></span></span>
<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dankelley.github.io/oce/">oce</a></span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">section</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">GS</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/subset.html" class="external-link">subset</a></span><span class="op">(</span><span class="va">section</span>, <span class="fl">113</span> <span class="op">&lt;=</span> <span class="va">stationId</span> <span class="op">&amp;</span> <span class="va">stationId</span> <span class="op">&lt;=</span> <span class="fl">129</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">GSg</span> <span class="op">&lt;-</span> <span class="fu">sectionGrid</span><span class="op">(</span><span class="va">GS</span>, p <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq</a></span><span class="op">(</span><span class="fl">0</span>, <span class="fl">5000</span>, <span class="fl">100</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">GSg</span>, which <span class="op">=</span> <span class="st">"temperature"</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="sectionGrid-1.png" alt="" width="700" height="700"></span>
<span class="r-in"><span><span class="co">## Show effects of various depth schemes</span></span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </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>

