pyplot_module Module Reference

Interface for plots in python (x-y plots). More...

Data Types
type	pyplot
	Main python plot class. More...

Functions/Subroutines
subroutine	destroy (me)
	Destroys an instance of pyplot. More...
subroutine	add_str (me, str)
	Add a string to the string buffer. More...
subroutine	initialize (me, grid, xlabel, ylabel, zlabel, title, legend, use_numpy, figsize, font_size, axes_labelsize, xtick_labelsize, ytick_labelsize, ztick_labelsize, legend_fontsize, mplot3d, axis_equal, polar, real_fmt, use_oo_api, axisbelow, tight_layout, istat)
	Initializes curve plots. More...
subroutine	add_plot (me, x, y, label, linestyle, markersize, linewidth, xlim, ylim, xscale, yscale, color, istat)
	Add an x,y plot. More...
subroutine	add_hist (me, x, label, xlim, ylim, xscale, yscale, bins, normed, cumulative, istat)
	Add an histogram plot. More...
subroutine	add_contour (me, x, y, z, label, linestyle, linewidth, levels, color, filled, cmap, colorbar, istat)
	Add a contour plot. More...
subroutine	add_3d_plot (me, x, y, z, label, linestyle, markersize, linewidth, istat)
	Add a 3D x, y, z plot. More...
subroutine	add_sphere (me, r, xc, yc, zc, n_facets, linewidth, antialiased, color, istat)
	Add a sphere to a 3D x,y,z plot. More...
subroutine	add_bar (me, x, height, label, width, bottom, color, yerr, align, xlim, ylim, xscale, yscale, istat)
	Add a bar plot. More...
subroutine	add_imshow (me, x, xlim, ylim, exValues, istat)
	Add an image plot using imshow More...
subroutine	optional_int_to_string (int_value, string_value, default_value)
	Integer to string, specifying the default value if the optional argument is not present. More...
subroutine	optional_logical_to_string (logical_value, string_value, default_value)
	Logical to string, specifying the default value if the optional argument is not present. More...
subroutine	integer_to_string (i, s)
	Integer to string conversion. More...
subroutine	real_to_string (v, fmt, str)
	Integer to string conversion. More...
subroutine	vec_to_string (v, fmt, str, use_numpy, is_tuple)
	Real vector to string. More...
subroutine	matrix_to_string (v, fmt, str, use_numpy)
	Real matrix (rank 2) to string. More...
subroutine	execute (me, pyfile, istat)
	Write the buffer to a specified file, then execute it with Python. More...
subroutine	finish_ops (me)
	Some final things to add before saving or showing the figure. More...
subroutine	savefig (me, figfile, pyfile, dpi, transparent, facecolor, edgecolor, orientation, istat)
	Save the figure. More...
subroutine	showfig (me, pyfile, istat)
	Show the figure. More...

Variables
integer, parameter	max_int_len = 10
	max string length for integers More...
integer, parameter	max_real_len = 30
	max string length for reals More...

Detailed Description

Interface for plots in python (x-y plots).

Function/Subroutine Documentation

add_3d_plot()

subroutine pyplot_module::add_3d_plot ( class(pyplot), intent(inout)  me, real(dp), dimension(:), intent(in)  x, real(dp), dimension(:), intent(in)  y, real(dp), dimension(:), intent(in)  z, character(len=*), intent(in)  label, character(len=*), intent(in)  linestyle, integer, intent(in), optional  markersize, integer, intent(in), optional  linewidth, integer, intent(out)  istat  )

private

Add a 3D x, y, z plot.

Note

Must initialize the class with mplot3d=.true.

Parameters

[in,out]	me	class handler
[in]	x	x values
[in]	y	y values
[in]	z	z values
[in]	label	plot label
[in]	linestyle	style of the plot line
[in]	markersize	size of the plot markers
[in]	linewidth	width of the plot line
[out]	istat	status output

add_bar()

subroutine pyplot_module::add_bar ( class(pyplot), intent(inout)  me, real(dp), dimension(:), intent(in)  x, real(dp), dimension(:), intent(in)  height, character(len=*), intent(in)  label, real(dp), dimension(:), intent(in), optional  width, real(dp), dimension(:), intent(in), optional  bottom, character(len=*), intent(in), optional  color, real(dp), dimension(:), intent(in), optional  yerr, character(len=*), intent(in), optional  align, real(dp), dimension(2), intent(in), optional  xlim, real(dp), dimension(2), intent(in), optional  ylim, character(len=*), intent(in), optional  xscale, character(len=*), intent(in), optional  yscale, integer, intent(out)  istat  )

private

Add a bar plot.

Parameters

[in,out]	me	class handler
[in]	x	x bar values
[in]	height	height bar values
[in]	label	plot label
[in]	width	width values
[in]	bottom	bottom values
[in]	color	plot color
[in]	yerr	yerr values
[in]	align	default: 'center'
[in]	xlim	x-axis range
[in]	ylim	y-axis range
[in]	xscale	example: 'linear' (default), 'log'
[in]	yscale	example: 'linear' (default), 'log'
[out]	istat	status output (0 means no problems)

add_contour()

subroutine pyplot_module::add_contour ( class(pyplot), intent(inout)  me, real(dp), dimension(:), intent(in)  x, real(dp), dimension(:), intent(in)  y, real(dp), dimension(:,:), intent(in)  z, character(len=*), intent(in)  label, character(len=*), intent(in)  linestyle, integer, intent(in), optional  linewidth, real(dp), dimension(:), intent(in), optional  levels, character(len=*), intent(in), optional  color, logical, intent(in), optional  filled, character(len=*), intent(in), optional  cmap, logical, intent(in), optional  colorbar, integer, intent(out)  istat  )

private

Add a contour plot.

Note

This requires use_numpy to be True.

Parameters

[in,out]	me	class handler
[in]	x	x values
[in]	y	y values
[in]	z	z values
[in]	label	plot label
[in]	linestyle	style of the plot line
[in]	linewidth	width of the plot line
[in]	levels	contour levels to plot
[in]	color	color of the contour line
[in]	filled	use filled control (default=False)
[in]	cmap	colormap if filled=True (examples: 'jet', 'bone')
[in]	colorbar	add a colorbar (default=False)
[out]	istat	status output

add_hist()

subroutine pyplot_module::add_hist ( class(pyplot), intent(inout)  me, real(dp), dimension(:), intent(in)  x, character(len=*), intent(in)  label, real(dp), dimension(2), intent(in), optional  xlim, real(dp), dimension(2), intent(in), optional  ylim, character(len=*), intent(in), optional  xscale, character(len=*), intent(in), optional  yscale, integer, intent(in), optional  bins, logical, intent(in), optional  normed, logical, intent(in), optional  cumulative, integer, intent(out)  istat  )

private

Add an histogram plot.

Parameters

[in,out]	me	class handler
[in]	x	x values
[in]	label	plot label
[in]	xlim	x-axis range
[in]	ylim	y-axis range
[in]	xscale	example: 'linear' (default), 'log'
[in]	yscale	example: 'linear' (default), 'log'
[in]	bins	number of bins
[in]	normed	boolean flag that determines whether bin counts are normalized
[in]	cumulative	boolean flag that determines whether histogram represents the cumulative density of dataset
[out]	istat	status output

add_imshow()

subroutine pyplot_module::add_imshow ( class(pyplot), intent(inout)  me, real(dp), dimension(:,:), intent(in)  x, real(dp), dimension(2), intent(in), optional  xlim, real(dp), dimension(2), intent(in), optional  ylim, real(dp), dimension(4), intent(in), optional  exValues, integer, intent(out)  istat  )

private

Add an image plot using imshow

Parameters

[in,out]	me	class handler
[in]	x	x values
[in]	xlim	x-axis range
[in]	ylim	y-axis range
[in]	exValues	array values to extent
[out]	istat	status output (0 means no problems)

add_plot()

subroutine pyplot_module::add_plot	(	class(pyplot), intent(inout)	me,
		real(dp), dimension(:), intent(in)	x,
		real(dp), dimension(:), intent(in)	y,
		character(len=*), intent(in)	label,
		character(len=*), intent(in)	linestyle,
		integer, intent(in), optional	markersize,
		integer, intent(in), optional	linewidth,
		real(dp), dimension(2), intent(in), optional	xlim,
		real(dp), dimension(2), intent(in), optional	ylim,
		character(len=*), intent(in), optional	xscale,
		character(len=*), intent(in), optional	yscale,
		real(dp), dimension(:), intent(in), optional	color,
		integer, intent(out)	istat
	)

Add an x,y plot.

Parameters

[in,out]	me	class handler
[in]	x	x values
[in]	y	y values
[in]	label	plot label
[in]	linestyle	style of the plot line
[in]	markersize	size of the plot markers
[in]	linewidth	width of the plot line
[in]	xlim	x-axis range
[in]	ylim	y-axis range
[in]	xscale	example: 'linear' (default), 'log'
[in]	yscale	example: 'linear' (default), 'log'
[in]	color	RGB color tuple
[out]	istat	status output

add_sphere()

subroutine pyplot_module::add_sphere ( class(pyplot), intent(inout)  me, real(dp), intent(in)  r, real(dp), intent(in)  xc, real(dp), intent(in)  yc, real(dp), intent(in)  zc, integer, intent(in), optional  n_facets, integer, intent(in), optional  linewidth, logical, intent(in), optional  antialiased, character(len=*), intent(in), optional  color, integer, intent(out)  istat  )

private

Add a sphere to a 3D x,y,z plot.

Note

Must initialize the class with mplot3d=.true. and use_numpy=.true..

Parameters

[in,out]	me	class handler
[in]	r	radius of the sphere
[in]	xc	x value of sphere center
[in]	yc	y value of sphere center
[in]	zc	z value of sphere center
[in]	n_facets	[default is 100]
[in]	linewidth	line width
[in]	antialiased	enabled anti-aliasing
[in]	color	color of the contour line
[out]	istat	status output (0 means no problems)

add_str()

subroutine pyplot_module::add_str ( class(pyplot), intent(inout)  me, character(len=*), intent(in)  str  )

private

Add a string to the string buffer.

Parameters

[in]	me	class handler
[in]	str	string buffer

destroy()

subroutine pyplot_module::destroy

(

class(pyplot), intent(inout)

me

)

Destroys an instance of pyplot.

Parameters

[in]

me

class handler

execute()

subroutine pyplot_module::execute ( class(pyplot), intent(in)  me, character(len=*), intent(in)  pyfile, integer, intent(out)  istat  )

private

Write the buffer to a specified file, then execute it with Python.

Parameters

[in]	me	python plot handler
[in]	pyfile	name of the python script to generate
[out]	istat	status output (0 means no problems)

finish_ops()

subroutine pyplot_module::finish_ops

(

class(pyplot), intent(inout)

me

)

Some final things to add before saving or showing the figure.

Parameters

[in,out]

me

pytplot handler

initialize()

subroutine pyplot_module::initialize ( class(pyplot), intent(inout)  me, logical, intent(in), optional  grid, character(len=*), intent(in), optional  xlabel, character(len=*), intent(in), optional  ylabel, character(len=*), intent(in), optional  zlabel, character(len=*), intent(in), optional  title, logical, intent(in), optional  legend, logical, intent(in), optional  use_numpy, integer, dimension(2), intent(in), optional  figsize, integer, intent(in), optional  font_size, integer, intent(in), optional  axes_labelsize, integer, intent(in), optional  xtick_labelsize, integer, intent(in), optional  ytick_labelsize, integer, intent(in), optional  ztick_labelsize, integer, intent(in), optional  legend_fontsize, logical, intent(in), optional  mplot3d, logical, intent(in), optional  axis_equal, logical, intent(in), optional  polar, character(len=*), intent(in), optional  real_fmt, logical, intent(in), optional  use_oo_api, logical, intent(in), optional  axisbelow, logical, intent(in), optional  tight_layout, integer, intent(out)  istat  )

private

Initializes curve plots.

Parameters

[in,out]	me	class handler
[in]	grid	flag for grid drawing
[in]	xlabel	x axis label
[in]	ylabel	y axis label
[in]	zlabel	z axis label
[in]	title	drawing title
[in]	legend	drawing legend
[in]	use_numpy	flag for using numpy
[in]	figsize	figure dimesnion
[in]	font_size	font size
[in]	axes_labelsize	axis label size
[in]	xtick_labelsize	size of x axis tick lables
[in]	ytick_labelsize	size of y axis tick lables
[in]	ztick_labelsize	size of z axis tick lables
[in]	legend_fontsize	size of legend font
[in]	mplot3d	set true for 3d plots
[in]	axis_equal	set true for axis = 'equal'
[in]	polar	set true for polar plots
[in]	real_fmt	format string for real numbers
[in]	use_oo_api	avoid matplotlib's GUI by using the OO interface
[in]	axisbelow	to put the grid lines below the other chart elements
[in]	tight_layout	enable tight layout
[out]	istat	Non-zero if python cannot be invoked

integer_to_string()

subroutine pyplot_module::integer_to_string ( integer, intent(in), optional  i, character(len=*), intent(out)  s  )

private

Integer to string conversion.

Parameters

[in]	i	integer
[out]	s	integer value stringified

matrix_to_string()

subroutine pyplot_module::matrix_to_string ( real(dp), dimension(:,:), intent(in)  v, character(len=*), intent(in)  fmt, character(len=:), intent(out), allocatable  str, logical, intent(in)  use_numpy  )

private

Real matrix (rank 2) to string.

Parameters

[in]	v	real
[in]	fmt	real format string
[out]	str	real values stringified
[in]	use_numpy	activate numpy python module usage

optional_int_to_string()

subroutine pyplot_module::optional_int_to_string ( integer, intent(in), optional  int_value, character(len=*), intent(out)  string_value, character(len=*), intent(in)  default_value  )

private

Integer to string, specifying the default value if the optional argument is not present.

Parameters

[in]	int_value	integer
[out]	string_value	integer value stringified
[in]	default_value	default integer value

optional_logical_to_string()

subroutine pyplot_module::optional_logical_to_string ( logical, intent(in), optional  logical_value, character(len=:), intent(out), allocatable  string_value, character(len=*), intent(in)  default_value  )

private

Logical to string, specifying the default value if the optional argument is not present.

Parameters

[in]	logical_value	logical value
[out]	string_value	integer value stringified
[in]	default_value	default integer value

real_to_string()

subroutine pyplot_module::real_to_string ( real(dp), intent(in)  v, character(len=*), intent(in)  fmt, character(len=:), intent(out), allocatable  str  )

private

Integer to string conversion.

Parameters

[in]	v	real
[in]	fmt	real format string
[out]	str	real values stringified

savefig()

subroutine pyplot_module::savefig ( class(pyplot), intent(inout)  me, character(len=*), intent(in)  figfile, character(len=*), intent(in), optional  pyfile, character(len=*), intent(in), optional  dpi, logical, intent(in), optional  transparent, character(len=*), intent(in), optional  facecolor, character(len=*), intent(in), optional  edgecolor, character(len=*), intent(in), optional  orientation, integer, intent(out)  istat  )

private

Save the figure.

Parameters

[in,out]	me	pytplot handler
[in]	figfile	file name for the figure
[in]	pyfile	name of the Python script to generate
[in]	dpi	resolution of the figure for png
[in]	transparent	transparent background (T/F)
[in]	facecolor	the colors of the figure rectangle
[in]	edgecolor	the colors of the figure rectangle
[in]	orientation	'landscape' or 'portrait'
[out]	istat	status output (0 means no problems)

showfig()

subroutine pyplot_module::showfig	(	class(pyplot), intent(inout)	me,
		character(len=*), intent(in), optional	pyfile,
		integer, intent(out)	istat
	)

Show the figure.

Parameters

[in,out]	me	pytplot handler
[in]	pyfile	name of the Python script to generate
[out]	istat	status output (0 means no problems)

vec_to_string()

subroutine pyplot_module::vec_to_string ( real(dp), dimension(:), intent(in)  v, character(len=*), intent(in)  fmt, character(len=:), intent(out), allocatable  str, logical, intent(in)  use_numpy, logical, intent(in), optional  is_tuple  )

private

Real vector to string.

Parameters

[in]	v	real
[out]	fmt	real format string
[out]	str	real values stringified
[in]	use_numpy	activate numpy python module usage
[in]	is_tuple	if true [default], use '()', if false use '[]'

Variable Documentation

max_int_len

integer, parameter pyplot_module::max_int_len = 10

private

max string length for integers

max_real_len

integer, parameter pyplot_module::max_real_len = 30

private

max string length for reals