plot_data_error_bars

type, public, extends(plot_data_colored) :: plot_data_error_bars

Defines a 2D error-bar based data set.

Type-Bound Procedures

generic, public :: define_x_error_data => pde_define_x_err, pde_define_x_err_lim

private subroutine pde_define_x_err(this, x, y, xerr, err)

Defines the x error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xerr	An N-element array containing the x errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

private subroutine pde_define_x_err_lim(this, x, y, xmin, xmax, err)

Defines the x error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xmin	An N-element array containing the minimum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	xmax	An N-element array containing the maximum x values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

generic, public :: define_xy_error_data => pde_define_xy_err, pde_define_xy_err_lim

private subroutine pde_define_xy_err(this, x, y, xerr, yerr, err)

Defines x and y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xerr	An N-element array containing the x errors at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	yerr	An N-element array containing the y errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

private subroutine pde_define_xy_err_lim(this, x, y, xmin, xmax, ymin, ymax, err)

Defines the x and y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xmin	An N-element array containing the minimum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	xmax	An N-element array containing the maximum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymin	An N-element array containing the minimum y values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymax	An N-element array containing the maximum x values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

generic, public :: define_y_error_data => pde_define_y_err, pde_define_y_err_lim

private subroutine pde_define_y_err(this, x, y, yerr, err)

Defines the y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	yerr	An N-element array containing the y errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

private subroutine pde_define_y_err_lim(this, x, y, ymin, ymax, err)

Defines the y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	ymin	An N-element array containing the minimum y values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymax	An N-element array containing the maximum y values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public :: get_color_index => pdc_get_color_index

private pure function pdc_get_color_index(this) result(x)

Gets the color index.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_colored),	intent(in)			::	this	The plot_data_colored object.

Return Value integer(kind=int32)

The index value.

procedure, public :: get_command_string => pde_get_cmd

private function pde_get_cmd(this) result(cmd)

Gets the appropriate GNUPLOT command string for the object.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value character(len=:), allocatable

The command string.

procedure, public :: get_count => pde_get_count

private pure function pde_get_count(this) result(x)

Gets the number of stored data points.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value integer(kind=int32)

The number of data points.

procedure, public :: get_data_string => pde_get_data_cmd

private function pde_get_data_cmd(this) result(cmd)

Gets the appropriate GNUPLOT commands to plot the data itself.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value character(len=:), allocatable

The command string.

procedure, public :: get_line_color => pdc_get_line_color

private pure function pdc_get_line_color(this) result(x)

Gets the object color.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_colored),	intent(in)			::	this	The plot_data_colored object.

Return Value type(color)

The color.

procedure, public :: get_name => pd_get_name

private pure function pd_get_name(this) result(txt)

Gets the name to associate with this data set.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data),	intent(in)			::	this	The plot_data object.

Return Value character(len=:), allocatable

The name.

procedure, public :: get_plot_x_error_bars => pde_get_plot_x_err

private pure function pde_get_plot_x_err(this) result(x)

Checks to see if the x error bar data has been defined, and as a result, if the x error data is to be plotted.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value logical

Returns true if the x error bars are to be plotted; else, false.

procedure, public :: get_plot_y_error_bars => pde_get_plot_y_err

private pure function pde_get_plot_y_err(this) result(x)

Checks to see if the y error bar data has been defined, and as a result, if the x error data is to be plotted.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value logical

Returns true if the y error bars are to be plotted; else, false.

procedure, public :: get_use_error_box => pde_get_box

private pure function pde_get_box(this) result(x)

Checks to see if the x and y error boxes should be utilized.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value logical

Returns true if the error boxes are to be plotted; else, false. Notice, the error boxes are only utilized if there is both x and y error data defined, regardless of the value of this property.

procedure, public :: get_use_range => pde_get_use_range

private pure function pde_get_use_range(this) result(x)

Gets a value determining if a defined range is being used to define the error bar extremes.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(in)			::	this	The plot_data_error_bars object.

Return Value logical

True if a defined range is being used; else, false.

procedure, public, :: pde_define_x_err

private subroutine pde_define_x_err(this, x, y, xerr, err)

Defines the x error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xerr	An N-element array containing the x errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public, :: pde_define_x_err_lim

private subroutine pde_define_x_err_lim(this, x, y, xmin, xmax, err)

Defines the x error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xmin	An N-element array containing the minimum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	xmax	An N-element array containing the maximum x values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public, :: pde_define_xy_err

private subroutine pde_define_xy_err(this, x, y, xerr, yerr, err)

Defines x and y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xerr	An N-element array containing the x errors at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	yerr	An N-element array containing the y errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public, :: pde_define_xy_err_lim

private subroutine pde_define_xy_err_lim(this, x, y, xmin, xmax, ymin, ymax, err)

Defines the x and y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	xmin	An N-element array containing the minimum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	xmax	An N-element array containing the maximum x values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymin	An N-element array containing the minimum y values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymax	An N-element array containing the maximum x values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public, :: pde_define_y_err

private subroutine pde_define_y_err(this, x, y, yerr, err)

Defines the y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	yerr	An N-element array containing the y errors at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public, :: pde_define_y_err_lim

private subroutine pde_define_y_err_lim(this, x, y, ymin, ymax, err)

Defines the y error data.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
real(kind=real64),	intent(in),		dimension(:)	::	x	An N-element array containing the x coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	y	An N-element array containing the y coordinates of the data.
real(kind=real64),	intent(in),		dimension(:)	::	ymin	An N-element array containing the minimum y values at each data point.
real(kind=real64),	intent(in),		dimension(:)	::	ymax	An N-element array containing the maximum y values at each data point.
class(errors),	intent(inout),	optional,	target	::	err	An error handling object.

procedure, public :: set_color_index => pdc_set_color_index

private subroutine pdc_set_color_index(this, x)

Sets the color index.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_colored),	intent(inout)			::	this	The plot_data_colored object.
integer(kind=int32),	intent(in)			::	x	The index value.

procedure, public :: set_line_color => pdc_set_line_color

private subroutine pdc_set_line_color(this, x)

Sets the object color.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_colored),	intent(inout)			::	this	The plot_data_colored object.
type(color),	intent(in)			::	x	The color.

procedure, public :: set_name => pd_set_name

private subroutine pd_set_name(this, txt)

Sets the name to associate with this data set.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data),	intent(inout)			::	this	The plot_data object.
character(len=*),	intent(in)			::	txt	The name.

procedure, public :: set_use_error_box => pde_set_box

private subroutine pde_set_box(this, x)

Deterimines if the x and y error boxes should be utilized.

Arguments

Type	Intent	Optional	Attributes		Name
class(plot_data_error_bars),	intent(inout)			::	this	The plot_data_error_bars object.
logical,	intent(in)			::	x	Set to true if the error boxes are to be plotted; else, false. Notice, the error boxes are only utilized if there is both x and y error data defined, regardless of the value of this property.

plot_data_error_bars Derived Type

Contents

Type-Bound Procedures

type, public, extends(plot_data_colored) :: plot_data_error_bars

Contents

Type-Bound Procedures

Type-Bound Procedures

generic, public :: define_x_error_data => pde_define_x_err, pde_define_x_err_lim

private subroutine pde_define_x_err(this, x, y, xerr, err)

Arguments

private subroutine pde_define_x_err_lim(this, x, y, xmin, xmax, err)

Arguments

generic, public :: define_xy_error_data => pde_define_xy_err, pde_define_xy_err_lim

private subroutine pde_define_xy_err(this, x, y, xerr, yerr, err)

Arguments

private subroutine pde_define_xy_err_lim(this, x, y, xmin, xmax, ymin, ymax, err)

Arguments

generic, public :: define_y_error_data => pde_define_y_err, pde_define_y_err_lim

private subroutine pde_define_y_err(this, x, y, yerr, err)

Arguments

private subroutine pde_define_y_err_lim(this, x, y, ymin, ymax, err)

Arguments

procedure, public :: get_color_index => pdc_get_color_index

private pure function pdc_get_color_index(this) result(x)

Arguments

Return Value integer(kind=int32)

procedure, public :: get_command_string => pde_get_cmd

private function pde_get_cmd(this) result(cmd)

Arguments

Return Value character(len=:), allocatable

procedure, public :: get_count => pde_get_count

private pure function pde_get_count(this) result(x)

Arguments

Return Value integer(kind=int32)

procedure, public :: get_data_string => pde_get_data_cmd

private function pde_get_data_cmd(this) result(cmd)

Arguments

Return Value character(len=:), allocatable

procedure, public :: get_line_color => pdc_get_line_color

private pure function pdc_get_line_color(this) result(x)

Arguments

Return Value type(color)

procedure, public :: get_name => pd_get_name

private pure function pd_get_name(this) result(txt)

Arguments

Return Value character(len=:), allocatable

procedure, public :: get_plot_x_error_bars => pde_get_plot_x_err

private pure function pde_get_plot_x_err(this) result(x)

Arguments

Return Value logical

procedure, public :: get_plot_y_error_bars => pde_get_plot_y_err

private pure function pde_get_plot_y_err(this) result(x)

Arguments

Return Value logical

procedure, public :: get_use_error_box => pde_get_box

private pure function pde_get_box(this) result(x)

Arguments

Return Value logical

procedure, public :: get_use_range => pde_get_use_range

private pure function pde_get_use_range(this) result(x)

Arguments

Return Value logical

procedure, public, :: pde_define_x_err

private subroutine pde_define_x_err(this, x, y, xerr, err)

Arguments

procedure, public, :: pde_define_x_err_lim

private subroutine pde_define_x_err_lim(this, x, y, xmin, xmax, err)

Arguments

procedure, public, :: pde_define_xy_err

private subroutine pde_define_xy_err(this, x, y, xerr, yerr, err)

Arguments

procedure, public, :: pde_define_xy_err_lim

private subroutine pde_define_xy_err_lim(this, x, y, xmin, xmax, ymin, ymax, err)

Arguments

procedure, public, :: pde_define_y_err

private subroutine pde_define_y_err(this, x, y, yerr, err)

Arguments

procedure, public, :: pde_define_y_err_lim

private subroutine pde_define_y_err_lim(this, x, y, ymin, ymax, err)

Arguments