File: Example-ntuple-programs.html

package info (click to toggle)
gsl-ref-html 1.16-1
links: PTS
area: non-free
in suites: jessie, jessie-kfreebsd, stretch
size: 5,816 kB
ctags: 4,130
sloc: makefile: 35
file content (213 lines) | stat: -rw-r--r-- 7,016 bytes
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections and no cover texts.  A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Example ntuple programs</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Example ntuple programs">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Example ntuple programs">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="N_002dtuples.html#N_002dtuples" rel="up" title="N-tuples">
<link href="Ntuple-References-and-Further-Reading.html#Ntuple-References-and-Further-Reading" rel="next" title="Ntuple References and Further Reading">
<link href="Histogramming-ntuple-values.html#Histogramming-ntuple-values" rel="previous" title="Histogramming ntuple values">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Example-ntuple-programs"></a>
<div class="header">
<p>
Next: <a href="Ntuple-References-and-Further-Reading.html#Ntuple-References-and-Further-Reading" accesskey="n" rel="next">Ntuple References and Further Reading</a>, Previous: <a href="Histogramming-ntuple-values.html#Histogramming-ntuple-values" accesskey="p" rel="previous">Histogramming ntuple values</a>, Up: <a href="N_002dtuples.html#N_002dtuples" accesskey="u" rel="up">N-tuples</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Examples-15"></a>
<h3 class="section">23.8 Examples</h3>

<p>The following example programs demonstrate the use of ntuples in
managing a large dataset.  The first program creates a set of 10,000
simulated &ldquo;events&rdquo;, each with 3 associated values <em>(x,y,z)</em>.  These
are generated from a Gaussian distribution with unit variance, for
demonstration purposes, and written to the ntuple file <samp>test.dat</samp>.
</p>
<div class="example">
<pre class="verbatim">#include &lt;gsl/gsl_ntuple.h&gt;
#include &lt;gsl/gsl_rng.h&gt;
#include &lt;gsl/gsl_randist.h&gt;

struct data
{
  double x;
  double y;
  double z;
};

int
main (void)
{
  const gsl_rng_type * T;
  gsl_rng * r;

  struct data ntuple_row;
  int i;

  gsl_ntuple *ntuple 
    = gsl_ntuple_create (&quot;test.dat&quot;, &amp;ntuple_row, 
                         sizeof (ntuple_row));

  gsl_rng_env_setup ();

  T = gsl_rng_default; 
  r = gsl_rng_alloc (T);

  for (i = 0; i &lt; 10000; i++)
    {
      ntuple_row.x = gsl_ran_ugaussian (r);
      ntuple_row.y = gsl_ran_ugaussian (r);
      ntuple_row.z = gsl_ran_ugaussian (r);
      
      gsl_ntuple_write (ntuple);
    }
  
  gsl_ntuple_close (ntuple);
  gsl_rng_free (r);

  return 0;
}
</pre></div>

<p>The next program analyses the ntuple data in the file <samp>test.dat</samp>.
The analysis procedure is to compute the squared-magnitude of each
event, <em>E^2=x^2+y^2+z^2</em>, and select only those which exceed a
lower limit of 1.5.  The selected events are then histogrammed using
their <em>E^2</em> values.
</p>
<div class="example">
<pre class="verbatim">#include &lt;math.h&gt;
#include &lt;gsl/gsl_ntuple.h&gt;
#include &lt;gsl/gsl_histogram.h&gt;

struct data
{
  double x;
  double y;
  double z;
};

int sel_func (void *ntuple_data, void *params);
double val_func (void *ntuple_data, void *params);

int
main (void)
{
  struct data ntuple_row;

  gsl_ntuple *ntuple 
    = gsl_ntuple_open (&quot;test.dat&quot;, &amp;ntuple_row,
                       sizeof (ntuple_row));
  double lower = 1.5;

  gsl_ntuple_select_fn S;
  gsl_ntuple_value_fn V;

  gsl_histogram *h = gsl_histogram_alloc (100);
  gsl_histogram_set_ranges_uniform(h, 0.0, 10.0);

  S.function = &amp;sel_func;
  S.params = &amp;lower;

  V.function = &amp;val_func;
  V.params = 0;

  gsl_ntuple_project (h, ntuple, &amp;V, &amp;S);
  gsl_histogram_fprintf (stdout, h, &quot;%f&quot;, &quot;%f&quot;);
  gsl_histogram_free (h);
  gsl_ntuple_close (ntuple);

  return 0;
}

int
sel_func (void *ntuple_data, void *params)
{
  struct data * data = (struct data *) ntuple_data;  
  double x, y, z, E2, scale;
  scale = *(double *) params;
  
  x = data-&gt;x;
  y = data-&gt;y;
  z = data-&gt;z;

  E2 = x * x + y * y + z * z;

  return E2 &gt; scale;
}

double
val_func (void *ntuple_data, void *params)
{
  struct data * data = (struct data *) ntuple_data;  
  double x, y, z;

  x = data-&gt;x;
  y = data-&gt;y;
  z = data-&gt;z;

  return x * x + y * y + z * z;
}
</pre></div>

<p>The following plot shows the distribution of the selected events.
Note the cut-off at the lower bound.
</p>

<hr>
<div class="header">
<p>
Next: <a href="Ntuple-References-and-Further-Reading.html#Ntuple-References-and-Further-Reading" accesskey="n" rel="next">Ntuple References and Further Reading</a>, Previous: <a href="Histogramming-ntuple-values.html#Histogramming-ntuple-values" accesskey="p" rel="previous">Histogramming ntuple values</a>, Up: <a href="N_002dtuples.html#N_002dtuples" accesskey="u" rel="up">N-tuples</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>