Defines a 2D error bar based data set. More...

Inheritance diagram for fplot_core::plot_data_error_bars:

Public Member Functions
procedure, public	get_command_string pde_get_cmd
	Returns the appropriate GNUPLOT command string to define the plot object properties.

procedure, public	get_data_string pde_get_data_cmd
	Gets the GNUPLOT command string containing the actual data to plot.

generic, public	define_x_error_data pde_define_x_err
	Defines the x error data.

generic, public	define_x_error_data pde_define_x_err_lim
	Defines the x error data.

generic, public	define_y_error_data pde_define_y_err
	Defines the y error data.

generic, public	define_y_error_data pde_define_y_err_lim
	Defines the y error data.

generic, public	define_xy_error_data pde_define_xy_err
	Defines the x and y error data.

generic, public	define_xy_error_data pde_define_xy_err_lim
	Defines the x and y error data.

procedure, public	get_plot_x_error_bars pde_get_plot_x_err
	Tests to see if the x error bar data has been defined, and as a result, if the x error data is to be plotted.

procedure, public	get_plot_y_error_bars pde_get_plot_y_err
	Tests to see if the y error bar data has been defined, and as a result, if the y error data is to be plotted.

procedure, public	get_count pde_get_count
	Gets the number of stored data points.

procedure, public	get_use_error_box pde_get_box
	Tests to see if the x and y error boxes should be utilized.

procedure, public	set_use_error_box pde_set_box
	Deterimines if the x and y error boxes should be utilized.

procedure, public	get_use_range pde_get_use_range
	Gets a value determining if a defined range is being used to define the error bar extremes.

procedure	pde_define_x_err pde_define_x_err

procedure	pde_define_y_err pde_define_y_err

procedure	pde_define_xy_err pde_define_xy_err

procedure	pde_define_x_err_lim pde_define_x_err_lim

procedure	pde_define_y_err_lim pde_define_y_err_lim

procedure	pde_define_xy_err_lim pde_define_xy_err_lim

Public Member Functions inherited from fplot_core::plot_data_colored
procedure, public	get_line_color pdc_get_line_color
	Gets the line color.

procedure, public	set_line_color pdc_set_line_color
	Sets the line color.

Public Member Functions inherited from fplot_core::plot_data
procedure, public	get_name pd_get_name
	Gets the name to associate with this data set.

procedure, public	set_name pd_set_name
	Sets the name to associate with this data set.

Public Attributes
logical	m_xbars = .false.
	Display x error bars?

logical	m_ybars = .false.
	Display y error bars?

real(real64), dimension(:,:), allocatable	m_data
	A matrix containing the raw and error data. Column 1 is for the x coordinate, column 2 for the y coordinate, and the remaining columns are for the error data (x, then y if applicable)

logical	m_box = .false.
	Display an error box for the case where x and y errors are defined.

logical	m_range = .false.
	Plot error bars using a defined range vs. a +/- value.

Public Attributes inherited from fplot_core::plot_data_colored
logical	m_useautocolor = .true.
	Let the object choose colors automatically.

integer(int32)	m_colorindex = 1
	The color index to use, assuming we're using auto color.

Detailed Description

Defines a 2D error bar based data set.

Definition at line 6174 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ define_x_error_data() [1/2]

generic, public fplot_core::plot_data_error_bars::define_x_error_data

Defines the x error data.

Syntax: subroutine define_x_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_x_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xmin(:), real(real64) xmax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	xerr	An N-element array containing the x errors at each data point.
[in]	xmin	= An N-element array containing the minimum x values at each data point.
[in]	xmax	= An N-element array containing the maximum x values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6221 of file fplot_core.f90.

◆ define_x_error_data() [2/2]

generic, public fplot_core::plot_data_error_bars::define_x_error_data

Defines the x error data.

Syntax: subroutine define_x_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_x_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xmin(:), real(real64) xmax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	xerr	An N-element array containing the x errors at each data point.
[in]	xmin	= An N-element array containing the minimum x values at each data point.
[in]	xmax	= An N-element array containing the maximum x values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6221 of file fplot_core.f90.

◆ define_xy_error_data() [1/2]

generic, public fplot_core::plot_data_error_bars::define_xy_error_data

Defines the x and y error data.

Syntax: subroutine define_xy_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xerr(:), real(real64) yerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_xy_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xmin(:), real(real64) xmax(:), real(real64) ymin(:), real(real64) ymax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	xerr	An N-element array containing the x errors at each data point.
[in]	yerr	An N-element array containing the y errors at each data point.
[in]	xmin	= An N-element array containing the minimum x values at each data point.
[in]	xmax	= An N-element array containing the maximum x values at each data point.
[in]	ymin	= An N-element array containing the minimum y values at each data point.
[in]	ymax	= An N-element array containing the maximum y values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6293 of file fplot_core.f90.

◆ define_xy_error_data() [2/2]

generic, public fplot_core::plot_data_error_bars::define_xy_error_data

Defines the x and y error data.

Syntax: subroutine define_xy_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xerr(:), real(real64) yerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_xy_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) xmin(:), real(real64) xmax(:), real(real64) ymin(:), real(real64) ymax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	xerr	An N-element array containing the x errors at each data point.
[in]	yerr	An N-element array containing the y errors at each data point.
[in]	xmin	= An N-element array containing the minimum x values at each data point.
[in]	xmax	= An N-element array containing the maximum x values at each data point.
[in]	ymin	= An N-element array containing the minimum y values at each data point.
[in]	ymax	= An N-element array containing the maximum y values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6293 of file fplot_core.f90.

◆ define_y_error_data() [1/2]

generic, public fplot_core::plot_data_error_bars::define_y_error_data

Defines the y error data.

Syntax: subroutine define_y_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) yerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_y_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) ymin(:), real(real64) ymax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	yerr	An N-element array containing the y errors at each data point.
[in]	ymin	= An N-element array containing the minimum y values at each data point.
[in]	ymax	= An N-element array containing the maximum y values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6254 of file fplot_core.f90.

◆ define_y_error_data() [2/2]

generic, public fplot_core::plot_data_error_bars::define_y_error_data

Defines the y error data.

Syntax: subroutine define_y_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) yerr(:), optional class(errors) err)

Alternative Syntax: subroutine define_y_error_data(class(plot_data_error_bars) this, real(real64) x(:), real(real64) y(:), real(real64) ymin(:), real(real64) ymax(:), optional class(errors) err)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	An N-element array containing the x coordinates of the data.
[in]	y	An N-element array containing the y coordinates of the data.
[in]	yerr	An N-element array containing the y errors at each data point.
[in]	ymin	= An N-element array containing the minimum y values at each data point.
[in]	ymax	= An N-element array containing the maximum y values at each data point.
[in,out]	err	An optional errors-based object that if provided can be used to retrieve information relating to any errors encountered during execution. If not provided, a default implementation of the errors class is used internally to provide error handling. Possible errors and warning messages that may be encountered are as follows. PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input arrays are not the same size. PLOT_OUT_OF_MEMORY_ERROR: Occurs if there is insufficient memory available.

Definition at line 6254 of file fplot_core.f90.

◆ get_command_string()

procedure, public fplot_core::plot_data_error_bars::get_command_string

virtual

Returns the appropriate GNUPLOT command string to define the plot object properties.

Implements fplot_core::plot_object.

Definition at line 6188 of file fplot_core.f90.

◆ get_count()

procedure, public fplot_core::plot_data_error_bars::get_count

Gets the number of stored data points.

Parameters

[in] this The plot_data_error_bars object.

Returns: The number of data points.

Definition at line 6323 of file fplot_core.f90.

◆ get_data_string()

procedure, public fplot_core::plot_data_error_bars::get_data_string

virtual

Gets the GNUPLOT command string containing the actual data to plot.

Implements fplot_core::plot_data.

Definition at line 6189 of file fplot_core.f90.

◆ get_plot_x_error_bars()

procedure, public fplot_core::plot_data_error_bars::get_plot_x_error_bars

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

Syntax: pure logical function get_plot_x_error_bars(class(plot_data_error_bars) this)

Parameters

[in] this The plot_data_error_bars object.

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

Definition at line 6306 of file fplot_core.f90.

◆ get_plot_y_error_bars()

procedure, public fplot_core::plot_data_error_bars::get_plot_y_error_bars

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

Syntax: pure logical function get_plot_y_error_bars(class(plot_data_error_bars) this)

Parameters

[in] this The plot_data_error_bars object.

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

Definition at line 6318 of file fplot_core.f90.

◆ get_use_error_box()

procedure, public fplot_core::plot_data_error_bars::get_use_error_box

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

Syntax: pure logical function get_use_error_box(class(plot_data_error_bars) this)

Parameters

[in] this The plot_data_error_bars object.

Returns: Returns true if the error boxes are to be plotted; else, false.

Remarks: Notice, the error boxes are only utilized if there is both x and y error data defined, regardless of the value of this property.

Definition at line 6338 of file fplot_core.f90.

◆ get_use_range()

procedure, public fplot_core::plot_data_error_bars::get_use_range

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

Syntax: pure logical function get_use_range(class(plot_data_error_bars) this)

Parameters

[in] this The plot_data_error_bars object.

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

Definition at line 6364 of file fplot_core.f90.

◆ pde_define_x_err()

procedure fplot_core::plot_data_error_bars::pde_define_x_err

Definition at line 6366 of file fplot_core.f90.

◆ pde_define_x_err_lim()

procedure fplot_core::plot_data_error_bars::pde_define_x_err_lim

Definition at line 6369 of file fplot_core.f90.

◆ pde_define_xy_err()

procedure fplot_core::plot_data_error_bars::pde_define_xy_err

Definition at line 6368 of file fplot_core.f90.

◆ pde_define_xy_err_lim()

procedure fplot_core::plot_data_error_bars::pde_define_xy_err_lim

Definition at line 6371 of file fplot_core.f90.

◆ pde_define_y_err()

procedure fplot_core::plot_data_error_bars::pde_define_y_err

Definition at line 6367 of file fplot_core.f90.

◆ pde_define_y_err_lim()

procedure fplot_core::plot_data_error_bars::pde_define_y_err_lim

Definition at line 6370 of file fplot_core.f90.

◆ set_use_error_box()

procedure, public fplot_core::plot_data_error_bars::set_use_error_box

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

Syntax: subroutine set_use_error_box(class(plot_data_error_bars) this, logical x)

Parameters

[in,out]	this	The plot_data_error_bars object.
[in]	x	Set to true if the error boxes are to be plotted; else, false.

Remarks: Notice, the error boxes are only utilized if there is both x and y error data defined, regardless of the value of this property.

Definition at line 6353 of file fplot_core.f90.

Member Data Documentation

◆ m_box

logical fplot_core::plot_data_error_bars::m_box = .false.

Display an error box for the case where x and y errors are defined.

Definition at line 6184 of file fplot_core.f90.

◆ m_data

real(real64), dimension(:,:), allocatable fplot_core::plot_data_error_bars::m_data

A matrix containing the raw and error data. Column 1 is for the x coordinate, column 2 for the y coordinate, and the remaining columns are for the error data (x, then y if applicable)

Definition at line 6182 of file fplot_core.f90.

◆ m_range

logical fplot_core::plot_data_error_bars::m_range = .false.

Plot error bars using a defined range vs. a +/- value.

Definition at line 6186 of file fplot_core.f90.

◆ m_xbars

logical fplot_core::plot_data_error_bars::m_xbars = .false.

Display x error bars?

Definition at line 6176 of file fplot_core.f90.

◆ m_ybars

logical fplot_core::plot_data_error_bars::m_ybars = .false.

Display y error bars?

Definition at line 6178 of file fplot_core.f90.

The documentation for this type was generated from the following file:

D:/Code/fplot-1/src/fplot_core.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ define_x_error_data() [1/2]

◆ define_x_error_data() [2/2]

◆ define_xy_error_data() [1/2]

◆ define_xy_error_data() [2/2]

◆ define_y_error_data() [1/2]

◆ define_y_error_data() [2/2]

◆ get_command_string()

◆ get_count()

◆ get_data_string()

◆ get_plot_x_error_bars()

◆ get_plot_y_error_bars()

◆ get_use_error_box()

◆ get_use_range()

◆ pde_define_x_err()

◆ pde_define_x_err_lim()

◆ pde_define_xy_err()

◆ pde_define_xy_err_lim()

◆ pde_define_y_err()

◆ pde_define_y_err_lim()

◆ set_use_error_box()

Member Data Documentation

◆ m_box

◆ m_data

◆ m_range

◆ m_xbars

◆ m_ybars