What can be achieved with GRPlot? ================================= Plot kinds ---------- barplot ``````` A bar plot is used to display the relation between a numeric variable and a categorical variable. The resulting bars represent the frequency or quantity of the different data categories. It can be easily created from the command line by setting the ``kind`` to ``barplot``. The ``style`` key thereby defines how the bar plot series are placed next to each other, out of three possible options. The left one uses the ``lined`` option, while the right one uses the ``stacked`` option. The following example uses the barplot_ data file. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot barplot.dat kind:barplot style:lined Additional key-value pairs can be included in the data header. The x- and y-columns parameter defines which columns are used for the x- and y-data. .. code-block:: bash # title : Test # x_label : x # y_label : y # x_columns:1 # y_columns:2,3,4 |barplot1| |barplot2| Another example is a ``default`` bar plot that includes the ``bar_width`` parameter, which is used to adjust the width of the bars. In this case the barplot2_ data file is used. .. code-block:: bash grplot barplot2.dat kind:barplot bar_width:1 Additional key-value pairs are included in the data header. The y-labels are applied to specific bars, while the leading number indicate how many labels there are. .. code-block:: bash # title : Default style # y_labels : 7,6,10, ,3, , ,2 |barplot3| Following parameters can be used: :ref:`bar_color `, :ref:`bar_width `, :ref:`bottom `, :ref:`columns `, :ref:`edge_color `, :ref:`edge_width `, :ref:`error `, :ref:`error_bar_style `, :ref:`error_columns `, :ref:`error_type `, :ref:`equal_up_and_down_error `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`kind `, :ref:`left `, :ref:`orientation `, :ref:`right `, :ref:`style `, :ref:`title `, :ref:`top `, :ref:`twin_x `, :ref:`twin_y `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xye_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_labels `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range ` contour ``````` A contour plot displays three-dimensional data over a rectangular grid. Contour lines representing different height values are displayed depending on the specified number of ``levels``. This contour plot uses the sans_ dataset. The title and axis labels are defined in the data header. More information's about the format of these files can be found under data_file_. .. code-block:: bash # title : Neutron scatter plot # x_label : $Q_x (Å^{-1})$ # y_label : $Q_y (Å^{-1})$ To create a contour plot from the command line, set the ``kind`` parameter to ``contour``. The additional ``cmap`` parameter can be used to change the `colormap `_. .. code-block:: bash grplot sans.dat kind:contour cmap:3 |contour1| The following picture shows some other options, where the number of levels is 40 instead of 20. Any ``major_h`` value greater than 1000 results in numbers appearing on the contour lines, while ``x_log`` is used to improve visibility of the numbers. .. code-block:: bash grplot sans.dat kind:contour levels:40 major_h:1003 x_log:1 cmap:3 |contour2| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`consecutive_colorbars `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`levels `, :ref:`major_h `, :ref:`only_square_aspect_ratio `, :ref:`title `, :ref:`use_bins `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` contourf ```````` A contourf plot displays three-dimensional data over a rectangular mesh. Depending on the specified number of levels, contour lines representing different height values are displayed. The space between the contour lines is filled with a colour according to the specified colormap. This contour plot uses the sans_ dataset. The title and axis labels are defined in the data header. More information's about the format of these files can be found under data_file_. .. code-block:: bash # title : Neutron scatter plot # x_label : $Q_x (Å^{-1})$ # y_label : $Q_y (Å^{-1})$ To create a filled contour plot from the command line, the ``kind`` parameter must be set to ``contourf``. .. code-block:: bash grplot sans.dat kind:contourf |contourf| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`consecutive_colorbars `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`levels `, :ref:`major_h `, :ref:`only_square_aspect_ratio `, :ref:`title `, :ref:`use_bins `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` heatmap ``````` A heatmap uses the current colour map to display data. Each data point is represented by a coloured square whose size depends on the amount of data. This heatmap plot uses the sans_ dataset. The title and axis labels are defined in the data header. More information's about the format of these files can be found under data_file_. .. code-block:: bash # title : Neutron scatter plot # x_label : $Q_x (Å^{-1})$ # y_label : $Q_y (Å^{-1})$ To create a heatmap plot from the command line, the ``kind`` parameter must be set to ``heatmap``. Both axes use a logarithmic scale. .. code-block:: bash grplot sans.dat kind:heatmap x_log:1 y_log:1 |heatmap1| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`consecutive_colorbars `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`only_square_aspect_ratio `, :ref:`resample_method `, :ref:`title `, :ref:`use_bins `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` hexbin `````` A hexbin uses hexagonal binning and the current colour map to display the data. Such a plot can be easily created from the command line using the following command: .. code-block:: bash grplot hexbin.dat kind:hexin This example uses the hexbin_ data file. It contains additional key-value pairs in the data header. More information's about the format of these files can be found under data_file_. .. code-block:: bash # title : Test # x_label : x # y_label : y |hexbin| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`consecutive_colorbars `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`num_bins `, :ref:`only_square_aspect_ratio `, :ref:`title `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_range `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_range ` histogram ````````` A histogram provides an approximate representation of the distribution of numerical data. It should have two columns containing the x- and y-data. To create a histogram from the command line, use ``kind`` ``histogram``. The ``num_bins`` parameter defines how many bins are displayed. The data file histogram_ is used. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot histogram.dat kind:histogram num_bins:20 In the right plot, these parameters are extended to include a vertical orientation with ``orientation:vertical``, as well as ranges for the x- and y-data. .. code-block:: bash # x_range : 2,3 # y_range : 5, 8 |histogram1| |histogram2| Following parameters can be used: :ref:`bar_color `, :ref:`bottom `, :ref:`columns `, :ref:`edge_color `, :ref:`error `, :ref:`error_bar_style `, :ref:`error_columns `, :ref:`error_type `, :ref:`equal_up_and_down_error `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`left `, :ref:`num_bins `, :ref:`orientation `, :ref:`right `, :ref:`title `, :ref:`top `, :ref:`twin_x `, :ref:`twin_y `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xye_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log ` imshow `````` An imshow plot displays data as a coloured image, with each data point represented by a coloured rectangle within the image. To create an imshow plot from the command line, ``kind`` must be set to ``imshow``. The data file in this example is sans_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot sans.dat kind:imshow |imshow| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`only_square_aspect_ratio `, :ref:`title `, :ref:`x_columns `, :ref:`x_flip `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`z_lim ` isosurface `````````` An isosurface is a three-dimensional analogue of a contour- or isoline. To create an isosurface from the command line, the ``kind`` parameter must be set to ``isosurface``. In this example, the data file is called volume_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot volume.dat kind:isosurface |isosurface| Following parameters can be used: :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`isovalue `, :ref:`join_plots `, :ref:`kind `, :ref:`rotation `, :ref:`tilt `, :ref:`title `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_grid `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` line ```` A line plot is a simple graph in which data points are joined together by a line. To create a line plot from the command line, the ``kind`` parameter must be set to ``line``. As a data file covid19_ is used. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot covid19.csv kind:line The following example includes parameters defined in the data header, such as the title and axis labels. The parameter ``location`` defines where the legend is placed, while ``x_lim`` sets the minimum and maximum limits of the x-axis. .. code-block:: bash # title : Confirmed SARS–CoV–2 infections # x_label : Day # y_label : Confirmed # x_lim : 0.0, 917 + 1.0 # y_log : 1 # location : 4 The right-hand plot uses command-line arguments and the target_mtl_ data file. .. code-block:: bash grplot target_mtl.1D kind:line y_log:1 |line1| |line2| A line plot can be combined with a scatter plot to mark data points. The ``line_spec`` parameter can be used for this. In this case, the data file is stem_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot stem.dat kind:line line_spec:+- |line3| Following parameters can be used: :ref:`bottom `, :ref:`columns `, :ref:`error `, :ref:`error_bar_style `, :ref:`error_columns `, :ref:`error_type `, :ref:`equal_up_and_down_error `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`int_limits_high `, :ref:`int_limits_low `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`left `, :ref:`legend `, :ref:`legend_line `, :ref:`line_spec `, :ref:`location `, :ref:`marker_type `, :ref:`orientation `, :ref:`right `, :ref:`title `, :ref:`top `, :ref:`twin_x `, :ref:`twin_y `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xye_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range ` line3 ````` A line3 plot is a simple three-dimensional graph in which data points are joined together by a line. To create a three-dimensional line plot from the command line, the ``kind`` parameter must be set to ``line3``. For this example, the data file is called plot3_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot plot3.dat kind:line3 |line3d_1| Following parameters can be used: :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`hkind `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`kind `, :ref:`legend `, :ref:`legend_line `, :ref:`location `, :ref:`title `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_grid `, :ref:`z_label `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` marginal_heatmap ```````````````` A marginal heatmap combines a heatmap with either stair plots or histograms. These additional plots display some of the heatmap data in the vertical and horizontal directions at the margins of the heatmap. To create a marginal heatmap from the command line, use ``kind`` ``marginal_heatmap``. A marginal heatmap is a special type of heatmap where the sum or maximum of each line and column is displayed on the side. The data file is sans_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot sans.dat kind:marginal_heatmap When ``h_kind`` is set to ``line``(right), the values of the row and column at the position of the mouse pointer are displayed. ``use_bins`` specifies that the first row and column in the data file are interpreted as x- and y-ranges. The data file for this example is sample_y_divy_. .. code-block:: bash grplot sample_y_divy.dat kind:marginal_heatmap use_bins:1 h_kind:line |marginal_heatmap1| |marginal_heatmap2| Following parameters can be used: :ref:`algorithm `, :ref:`cmap `, :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`hkind `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_aspect_ratio `, :ref:`kind `, :ref:`only_square_aspect_ratio `, :ref:`resample_method `, :ref:`title `, :ref:`use_bins `, :ref:`x_columns `, :ref:`x_flip `, :ref:`x_grid `, :ref:`x_label `, :ref:`x_lim `, :ref:`x_log `, :ref:`x_range `, :ref:`xyz_file `, :ref:`y_columns `, :ref:`y_flip `, :ref:`y_grid `, :ref:`y_label `, :ref:`y_lim `, :ref:`y_log `, :ref:`y_range `, :ref:`z_lim `, :ref:`z_log `, :ref:`z_range ` pie ``` A pie chart is a circular statistical plot that displays one series of data. The total area of the chart represents the total percentage of the given data. The size of each slice represents the percentage of the data it comprises. To create a pie chart from the command line, the ``kind`` parameter must be set to ``pie``. The data file is called pie_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot pie.dat kind:pie |pie1| Following parameters can be used: :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`kind `, :ref:`legend `, :ref:`legend_line `, :ref:`title ` polar_heatmap ````````````` A polar heatmap uses polar coordinates rather than Cartesian coordinates. To create a polar heatmap plot from the command line, the ``kind`` parameter must be set to ``polar_heatmap``. This example uses the polarheatmap_ data file. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot polarheatmap.dat kind:polar_heatmap With an additional ``theta_lim:70,320`` only a part of the polar heatmap will be displayed. |polar_heatmap1| |polar_heatmap2| Following parameters can be used: :ref:`cmap `, :ref:`columns `, :ref:`consecutive_colorbars `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`kind `, :ref:`r_flip `, :ref:`r_lim `, :ref:`r_log `, :ref:`theta_flip `, :ref:`theta_data_lim `, :ref:`theta_lim `, :ref:`title `, :ref:`x_columns `, :ref:`x_label `, :ref:`y_columns `, :ref:`y_label ` polar_histogram ``````````````` A polar histogram is a histogram that uses polar coordinates. To create a polar histogram plot from the command line, set the ``kind`` parameter to ``polar_histogram``. The corresponding data file is polar_histogram_. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot polar_histogram.dat kind:polar_histogram |polar_histogram1| Additional parameters offer more possibilities such as .. code-block:: bash r_lim:2,8 keep_radii_axes:1 or .. code-block:: bash stairs:1 |polar_histogram2| |polar_histogram3| Following parameters can be used: :ref:`bin_counts `, :ref:`bin_edges `, :ref:`bin_width `, :ref:`columns `, :ref:`draw_edges `, :ref:`edge_color `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`keep_radii_axes `, :ref:`kind `, :ref:`num_bins `, :ref:`normalization `, :ref:`r_flip `, :ref:`r_lim `, :ref:`r_log `, :ref:`stairs `, :ref:`theta_flip `, :ref:`theta_data_lim `, :ref:`theta_lim `, :ref:`title `, :ref:`x_columns `, :ref:`x_label `, :ref:`y_columns `, :ref:`y_label ` polar_line `````````` A polar plot displays a polyline in polar coordinates. The angle in radians is indicated by theta(x), and the radius value for each point is indicated by r(y). To create a polar line plot from the command line, the ``kind`` parameter must be set to ``polar_line``. This example uses the polar_ data file. More information's about the format of these files can be found under data_file_. .. code-block:: bash grplot polar.dat kind:polar_line |polar_line| Following parameters can be used: :ref:`clip_negative `, :ref:`columns `, :ref:`file `, :ref:`grplot `, :ref:`ignore_blank_lines `, :ref:`join_plots `, :ref:`kind `, :ref:`legend `, :ref:`legend_line `, :ref:`line_spec