<?xml version="1.0" encoding="utf-8"?>
<section version="5.0"
         xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
         xml:id="particles.modifiers.scatter_plot"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:xs="http://www.w3.org/2001/XMLSchema"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:ns="http://docbook.org/ns/docbook">
  <title>Scatter plot</title>

  <para>
  
    <informalfigure><screenshot><mediaobject><imageobject>
       <imagedata fileref="images/modifiers/scatter_plot_panel.png" format="PNG" />
    </imageobject></mediaobject></screenshot></informalfigure>
  
    This modifier computes and displays a scatter plot for two particle properties.
    This type of plot can be used to study possible correlations between two particle properties.    
    A scatter plot consists of one data point per input particle. The first property determines
    the X-coordinates and the second property the Y-coordinates of the points.
  </para>
  
  <para>
    Optionally, the modifier can be used to select particles within a specified X- or Y-range.
  </para>
  
  <simplesect>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>X-axis property</term>
        <listitem>
          <para>The per-particle property that serves as data source for the x-coordinates of data points.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Y-axis property</term>
        <listitem>
          <para>The per-particle property that serves as data source for the y-coordinates of data points.</para>
        </listitem>
      </varlistentry>
      
    </variablelist>
    
  </simplesect>

  <simplesect>
    <title>Acknowledgment</title>
    <para>
      The code for this modifier has been contributed by Lars Pastewka.
    </para>
  </simplesect>
    
    
</section>
