plot Interface

public interface plot

Calls

interface~~plot~~CallsGraph interface~plot honeyplots::plot proc~hex_plot honeyplots::hex_plot interface~plot->proc~hex_plot proc~xy_plot honeyplots::xy_plot interface~plot->proc~xy_plot add_plot add_plot proc~hex_plot->add_plot filename filename proc~hex_plot->filename initialize initialize proc~hex_plot->initialize options options proc~hex_plot->options plot plot proc~hex_plot->plot proc~hex2corner xy_coordinates::hex2corner proc~hex_plot->proc~hex2corner savefig savefig proc~hex_plot->savefig showfig showfig proc~hex_plot->showfig xlabel xlabel proc~hex_plot->xlabel ylabel ylabel proc~hex_plot->ylabel proc~xy_plot->add_plot proc~xy_plot->filename proc~xy_plot->initialize proc~xy_plot->options proc~xy_plot->plot proc~get_sublattice xy_coordinates::get_sublattice proc~xy_plot->proc~get_sublattice proc~xy_plot->savefig proc~xy_plot->showfig proc~xy_plot->xlabel proc~xy_plot->ylabel proc~hex2center xy_coordinates::hex2center proc~hex2corner->proc~hex2center proc~ith_corner_offset xy_coordinates::ith_corner_offset proc~hex2corner->proc~ith_corner_offset

Module Procedures

public subroutine xy_plot(lattice, nn_mask, nnn_mask, backend, figure_name, script_name, set_terminal)

CURRENTLY GNUPLOT DOES NOT SUPPORT NN AND NNN LINKS, HELP IS WELCOME! Simple plotter for class(xy_lattice) objects. If optional argument nn_mask is passed it draws the nearest-neighbor bonds too. Similarly, if optional argument nnn_mask is passed a dashed link to next-nearest neighbors would be drawed. Otherwise only lallice sites. It features two backends, giving access to either matplotlib(pyplot) or gnuplot internal machinery. Either library needs to be installed in your system for hex_plot to work. You can specify a figure_name to save the plot to disk. If not specified the plot would be just displayed in a popup window (or the terminal with suitable configuration of the gnuplot backend) and a corresponding script saved, aiming at fast reproduction (the script will all contain data). The script has a default name (hex_plot.{py,gp}), but you can optionally give your own custom string, do not forget the appropriate file extension. Regarding output formats instead, the two backends have slightly different behavior: pyplot would infer the format from the given file extension in figure_name, whilst gnuplot does need a proper "output terminal" to be set. You can do that by passing the optional set_parameter variable. Refer to original gnuplot documentation for the list of available terminals and how they should be chosen. For convenience we report that you can get the list of (system dependent) available terminals in your console by executing the gnuplot -e "set terminal" command in your shell. Furthermore all systems should be compatible with the "dumb" terminal option, which would direct the plot to the terminal itself, in the form of ASCII art. This can be very useful for HPC workflows.

Read more…

Arguments

Type IntentOptional Attributes Name
type(xy_lattice), intent(in) :: lattice
logical, intent(in), optional, allocatable :: nn_mask(:,:)
logical, intent(in), optional, allocatable :: nnn_mask(:,:)
character(len=*), intent(in), optional :: backend

default: "pyplot" (or "gnuplot")
character(len=*), intent(in), optional :: figure_name
character(len=*), intent(in), optional :: script_name
character(len=*), intent(in), optional :: set_terminal

relevant to gnuplot backend

public subroutine hex_plot(layout, hexagons, backend, figure_name, script_name, set_terminal)

Simple plotter for arrays of type(hex). It features two backends, giving access to either matplotlib(pyplot) or gnuplot internal machinery. Either library needs to be installed in your system for hex_plot to work. You can specify a figure_name to save the plot to disk. If not specified the plot would be just displayed in a popup window (or the terminal with suitable configuration of the gnuplot backend) and a corresponding script saved, aiming at fast reproduction (the script will all contain data). The script has a default name (hex_plot.{py,gp}), but you can optionally give your own custom string, do not forget the appropriate file extension. Regarding output formats instead, the two backends have slightly different behavior: pyplot would infer the format from the given file extension in figure_name, whilst gnuplot does need a proper "output terminal" to be set. You can do that by passing the optional set_parameter variable. Refer to original gnuplot documentation for the list of available terminals and how they should be chosen. For convenience we report that you can get the list of (system dependent) available terminals in your console by executing the gnuplot -e "set terminal" command in your shell. Furthermore all systems should be compatible with the "dumb" terminal option, which would direct the plot to the terminal itself, in the form of ASCII art. This can be very useful for HPC workflows.

Arguments

Type IntentOptional Attributes Name
type(unit_cell), intent(in) :: layout
type(hex), intent(in) :: hexagons(:)
character(len=*), intent(in), optional :: backend

default: "pyplot" (or "gnuplot")
character(len=*), intent(in), optional :: figure_name
character(len=*), intent(in), optional :: script_name
character(len=*), intent(in), optional :: set_terminal

relevant to gnuplot backend