<!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.0"><title>Detect forages — detect_forages • sen2rts</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/yeti/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Detect forages — detect_forages"><meta property="og:description" content='Experimental function to detect forages (time series characterised
by a high "instability").
Already detected cycles are labelled as "forage" (adjacent ones are dissolved)
basing on arguments diff_thr and ncuts_thr (see).'><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
    

    <div class="container template-reference-topic">
      <header><div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">sen2rts</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.4.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav"></ul><ul class="nav navbar-nav navbar-right"><li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">
    <span class="fa fa-file-code"></span>
     
     Reference
  </a>
</li>
<li>
  <a href="../articles/workflow.html">
    <span class="fa fa-book"></span>
     
     The sen2rts workflow
  </a>
</li>
<li>
  <a href="../news/index.html">
    <span class="fa fa-newspaper"></span>
     
     Changelog
  </a>
</li>
<li>
  <a href="http://luigi.ranghetti.info" class="external-link">
    <span class="fa fa-user"></span>
     
  </a>
</li>
<li>
  <a href="https://github.com/ranghetti/sen2rts/" class="external-link">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul></div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      

      </header><div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Detect forages</h1>
    <small class="dont-index">Source: <a href="https://github.com/ranghetti/sen2rts/blob/HEAD/R/detect_forages.R" class="external-link"><code>R/detect_forages.R</code></a></small>
    <div class="hidden name"><code>detect_forages.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Experimental function to detect forages (time series characterised
by a high "instability").
Already detected cycles are labelled as "forage" (adjacent ones are dissolved)
basing on arguments <code>diff_thr</code> and <code>ncuts_thr</code> (see).</p>
    </div>

    <div id="ref-usage">
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">detect_forages</span><span class="op">(</span>
  <span class="va">ts</span>,
  <span class="va">pheno</span>,
  win <span class="op">=</span> <span class="cn">NULL</span>,
  diff_thr <span class="op">=</span> <span class="fl">10</span>,
  ncuts_thr <span class="op">=</span> <span class="fl">10</span>,
  sliding <span class="op">=</span> <span class="fl">90</span>,
  reldiff <span class="op">=</span> <span class="cn">TRUE</span>,
  byyear <span class="op">=</span> <span class="cn">TRUE</span>
<span class="op">)</span></code></pre></div>
    </div>

    <div id="arguments">
    <h2>Arguments</h2>
    <dl><dt>ts</dt>
<dd><p>Time series in <code>s2ts</code> format (generated using <code><a href="fill_s2ts.html">fill_s2ts()</a></code>).</p></dd>
<dt>pheno</dt>
<dd><p>Cycle allocation (data table generated by <code><a href="extract_pheno.html">extract_pheno()</a></code>
or <code><a href="cut_cycles.html">cut_cycles()</a></code>).</p></dd>
<dt>win</dt>
<dd><p>List with the allowed ranges for the dates of
start of cycle (see <code>pop_seasons</code> for details about the format).</p></dd>
<dt>diff_thr</dt>
<dd><p>First threshold to detect forages (TODO improve description)</p></dd>
<dt>ncuts_thr</dt>
<dd><p>Second threshold to detect forages (TODO improve description)</p></dd>
<dt>sliding</dt>
<dd><p>Length (in days) of the sliding window in which <code>diff_thr</code>
and <code>ncuts_thr</code> must be evaluated.</p></dd>
<dt>reldiff</dt>
<dd><p>Logical: should argument <code>diff_thr</code> refer to relative (default)
or absolute values?</p></dd>
<dt>byyear</dt>
<dd><p>Logical: compute aggregation by year (default) or globally
(this should make sense in case of permanent crops).</p></dd>
</dl></div>
    <div id="value">
    <h2>Value</h2>
    <p>A data table in the format of the input <code>pheno</code>,
in which adjacent forage cycles are merged.
An additional logical field <code>forage</code> discriminates forages from non-forages.</p>
    </div>
    <div id="author">
    <h2>Author</h2>
    <p>Luigi Ranghetti, PhD (2021) <a href="mailto:luigi@ranghetti.info">luigi@ranghetti.info</a></p>
    </div>

  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
    </nav></div>
</div>


      <footer><div class="copyright">
  <p></p><p>Developed by Luigi Ranghetti.</p>
</div>

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

      </footer></div>

  


  

  </body></html>

