1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>Function crop</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Chapter 1. Boost.Histogram"> 8<link rel="up" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_hpp" title="Header <boost/histogram/algorithm/reduce.hpp>"> 9<link rel="prev" href="project_idm45503931164992.html" title="Function template project"> 10<link rel="next" href="crop_idm45503931151424.html" title="Function crop"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="project_idm45503931164992.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="crop_idm45503931151424.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="refentry"> 26<a name="boost.histogram.algorithm.crop_idm45503931157904"></a><div class="titlepage"></div> 27<div class="refnamediv"> 28<h2><span class="refentrytitle">Function crop</span></h2> 29<p>boost::histogram::algorithm::crop — Crop command to be used in <code class="computeroutput">reduce</code>.</p> 30</div> 31<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 32<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_hpp" title="Header <boost/histogram/algorithm/reduce.hpp>">boost/histogram/algorithm/reduce.hpp</a>> 33 34</span> 35<span class="identifier">reduce_command</span> <span class="identifier">crop</span><span class="special">(</span><span class="keyword">unsigned</span> iaxis<span class="special">,</span> <span class="keyword">double</span> lower<span class="special">,</span> <span class="keyword">double</span> upper<span class="special">)</span><span class="special">;</span></pre></div> 36<div class="refsect1"> 37<a name="idm45113195164592"></a><h2>Description</h2> 38<p>Command is applied to axis with given index.</p> 39<p>Works like <code class="computeroutput">shrink</code> (see shrink documentation for details), but counts in removed bins are always discarded, whether underflow and overflow bins are present or not.</p> 40<p> 41</p> 42<div class="variablelist"><table border="0" class="variablelist compact"> 43<colgroup> 44<col align="left" valign="top"> 45<col> 46</colgroup> 47<tbody><tr> 48<td><p><span class="term">Parameters:</span></p></td> 49<td><div class="variablelist"><table border="0" class="variablelist compact"> 50<colgroup> 51<col align="left" valign="top"> 52<col> 53</colgroup> 54<tbody> 55<tr> 56<td><p><span class="term"><code class="computeroutput">iaxis</code></span></p></td> 57<td><p>which axis to operate on. </p></td> 58</tr> 59<tr> 60<td><p><span class="term"><code class="computeroutput">lower</code></span></p></td> 61<td><p>bin which contains lower is first to be kept. </p></td> 62</tr> 63<tr> 64<td><p><span class="term"><code class="computeroutput">upper</code></span></p></td> 65<td><p>bin which contains upper is last to be kept, except if upper is equal to the lower edge. </p></td> 66</tr> 67</tbody> 68</table></div></td> 69</tr></tbody> 70</table></div> 71</div> 72</div> 73<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 74<td align="left"></td> 75<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Hans 76 Dembinski<p> 77 Distributed under the Boost Software License, Version 1.0. (See accompanying 78 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 79 </p> 80</div></td> 81</tr></table> 82<hr> 83<div class="spirit-nav"> 84<a accesskey="p" href="project_idm45503931164992.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../histogram/reference.html#header.boost.histogram.algorithm.reduce_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="crop_idm45503931151424.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 85</div> 86</body> 87</html> 88
