plot_data_2d Derived Type

type, public, extends(scatter_plot_data) :: plot_data_2d

Defines a two-dimensional plot data set.


Contents

Type-Bound Procedures


Type-Bound Procedures

generic, public :: define_data => pd2d_set_data_1, pd2d_set_data_2

  • private subroutine pd2d_set_data_1(this, x, y, c, ps, err)

    Defines the data set to plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    real(kind=real64), intent(in), dimension(:) :: x

    An N-element array containing the x coordinate data.
    real(kind=real64), intent(in), dimension(:) :: y

    An N-element array containing the y coordinate data.
    real(kind=real64), intent(in), optional, dimension(:) :: c

    An N-element array defining how color should vary with the current colormap for each value.
    real(kind=real64), intent(in), optional, dimension(:) :: ps

    An N-element array defining the size of each data point.
    class(errors), intent(inout), optional, target :: err

    An error-handling object.

  • private subroutine pd2d_set_data_2(this, y, err)

    Defines the data set to plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    real(kind=real64), intent(in), dimension(:) :: y

    An N-element array containing the y-coordinate data. This data will be plotted against its own index.
    class(errors), intent(inout), optional, target :: err

    An error-handling object.

procedure, public :: get_axes_string => pd2d_get_axes_cmd

  • private function pd2d_get_axes_cmd(this) result(x)

    Gets the GNUPLOT command string defining which axes the data is to be plotted against.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_color_data => pd2d_get_c_array

  • private function pd2d_get_c_array(this) result(x)

    Gets the stored color scaling data array.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value real(kind=real64), allocatable, dimension(:)

    A copy of the stored data array.

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 IntentOptional 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 => spd_get_cmd

  • private function spd_get_cmd(this) result(x)

    Gets the GNUPLOT command string to represent this scatter_plot_data object.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_count => pd2d_get_data_count

  • private pure function pd2d_get_data_count(this) result(x)

    Gets the number of data points.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value integer(kind=int32)

    The number of data points.

procedure, public :: get_data_string => pd2d_get_data_cmd

  • private function pd2d_get_data_cmd(this) result(x)

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

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_draw_against_y2 => pd2d_get_draw_against_y2

  • private pure function pd2d_get_draw_against_y2(this) result(x)

    Gets a value determining if the data should be plotted against the secondary y-axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value logical

    Returns true if the data should be plotted against the secondary y-axis; else, false to plot against the primary y-axis.

procedure, public :: get_draw_line => spd_get_draw_line

  • private pure function spd_get_draw_line(this) result(x)

    Gets a value determining if a line should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    Returns true if the line should be drawn; else, false.

procedure, public :: get_draw_markers => spd_get_draw_markers

  • private pure function spd_get_draw_markers(this) result(x)

    Gets a value determining if data point markers should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    Returns true if the markers should be drawn; else, false.

procedure, public :: get_fill_curve => spd_get_filled

  • private pure function spd_get_filled(this) result(rst)

    Gets a logical value determining if a filled curve should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    True if the curve should be filled; else, false.

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 IntentOptional Attributes Name
    class(plot_data_colored), intent(in) :: this

    The plot_data_colored object.

    Return Value type(color)

    The color.

procedure, public :: get_line_style => spd_get_line_style

  • private pure function spd_get_line_style(this) result(x)

    Gets the line style.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value integer(kind=int32)

    The line style. The line style must be one of the following.

    • LINE_DASHED

    • LINE_DASH_DOTTED

    • LINE_DASH_DOT_DOT

    • LINE_DOTTED

    • LINE_SOLID

procedure, public :: get_line_width => spd_get_line_width

  • private pure function spd_get_line_width(this) result(x)

    Gets the width of the line, in pixels.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value real(kind=real32)

    The line width.

procedure, public :: get_marker_frequency => spd_get_marker_frequency

  • private pure function spd_get_marker_frequency(this) result(x)

    Gets the marker frequency.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value integer(kind=int32)

    The marker frequency.

procedure, public :: get_marker_scaling => spd_get_marker_scaling

  • private pure function spd_get_marker_scaling(this) result(x)

    Gets the marker scaling.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value real(kind=real32)

    The scaling factor.

procedure, public :: get_marker_style => spd_get_marker_style

  • private pure function spd_get_marker_style(this) result(x)

    Gets the marker style.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value integer(kind=int32)

    The marker type. The marker type must be one of the following:

    • MARKER_ASTERISK

    • MARKER_EMPTY_CIRCLE

    • MARKER_EMPTY_NABLA

    • MARKER_EMPTY_RHOMBUS

    • MARKER_EMPTY_SQUARE

    • MARKER_EMPTY_TRIANGLE

    • MARKER_FILLED_CIRCLE

    • MARKER_FILLED_NABLA

    • MARKER_FILLED_RHOMBUS

    • MARKER_FILLED_SQUARE

    • MARKER_FILLED_TRIANGLE

    • MARKER_PLUS

    • MARKER_X

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 IntentOptional Attributes Name
    class(plot_data), intent(in) :: this

    The plot_data object.

    Return Value character(len=:), allocatable

    The name.

procedure, public :: get_point_size_data => pd2d_get_ps_array

  • private function pd2d_get_ps_array(this) result(x)

    Gets the stored point size data array.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value real(kind=real64), allocatable, dimension(:)

    A copy of the stored data array.

procedure, public :: get_simplification_factor => spd_get_simplify_factor

  • private pure function spd_get_simplify_factor(this) result(x)

    Gets a factor used to establish the simplification tolerance.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value real(kind=real64)

    The scaling factor.

procedure, public :: get_simplify_data => spd_get_simplify_data

  • private pure function spd_get_simplify_data(this) result(x)

    Gets a value determining if the stored data should be simplified (reduced) before passing to GNUPLOT.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    True if the data should be simplified prior to sending to GNUPLOT; else, false to leave the data alone.

procedure, public :: get_use_data_dependent_colors => spd_get_data_dependent_colors

  • private pure function spd_get_data_dependent_colors(this) result(rst)

    Gets a value determing if data-dependent colors should be used.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    True if data-dependent colors should be used; else, false.

procedure, public :: get_use_variable_size_points => spd_get_use_var_point_size

  • private pure function spd_get_use_var_point_size(this) result(rst)

    Gets a logical value determining if variable sized data points should be used. The default is false, such that points will be of a constant size.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(in) :: this

    The scatter_plot_data object.

    Return Value logical

    True if variable size points should be used; else, false.

procedure, public :: get_x => pd2d_get_x_data

  • private pure function pd2d_get_x_data(this, index) result(x)

    Gets the requested X data point.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.
    integer(kind=int32), intent(in) :: index

    The index of the data point to retrieve.

    Return Value real(kind=real64)

    The requested data point.

procedure, public :: get_x_data => pd2d_get_x_array

  • private function pd2d_get_x_array(this) result(x)

    Gets the stored X data array.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value real(kind=real64), allocatable, dimension(:)

    A copy of the stored data array.

procedure, public :: get_y => pd2d_get_y_data

  • private pure function pd2d_get_y_data(this, index) result(x)

    Gets the requested Y data point.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.
    integer(kind=int32), intent(in) :: index

    The index of the data point to retrieve.

    Return Value real(kind=real64)

    The requested data point.

procedure, public :: get_y_data => pd2d_get_y_array

  • private function pd2d_get_y_array(this) result(x)

    Gets the stored Y data array.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(in) :: this

    The plot_data_2d object.

    Return Value real(kind=real64), allocatable, dimension(:)

    A copy of the stored data array.

procedure, public, :: pd2d_set_data_1

  • private subroutine pd2d_set_data_1(this, x, y, c, ps, err)

    Defines the data set to plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    real(kind=real64), intent(in), dimension(:) :: x

    An N-element array containing the x coordinate data.
    real(kind=real64), intent(in), dimension(:) :: y

    An N-element array containing the y coordinate data.
    real(kind=real64), intent(in), optional, dimension(:) :: c

    An N-element array defining how color should vary with the current colormap for each value.
    real(kind=real64), intent(in), optional, dimension(:) :: ps

    An N-element array defining the size of each data point.
    class(errors), intent(inout), optional, target :: err

    An error-handling object.

procedure, public, :: pd2d_set_data_2

  • private subroutine pd2d_set_data_2(this, y, err)

    Defines the data set to plot.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    real(kind=real64), intent(in), dimension(:) :: y

    An N-element array containing the y-coordinate data. This data will be plotted against its own index.
    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 IntentOptional 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_draw_against_y2 => pd2d_set_draw_against_y2

  • private subroutine pd2d_set_draw_against_y2(this, x)

    Sets a value determining if the data should be plotted against the secondary y-axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    logical, intent(in) :: x

    Set to true if the data should be plotted against the secondary y-axis; else, false to plot against the primary y-axis.

procedure, public :: set_draw_line => spd_set_draw_line

  • private subroutine spd_set_draw_line(this, x)

    Sets a value determining if a line should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    Set to true if the line should be drawn; else, false.

procedure, public :: set_draw_markers => spd_set_draw_markers

  • private subroutine spd_set_draw_markers(this, x)

    Sets a value determining if data point markers should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    Set to true if the markers should be drawn; else, false.

procedure, public :: set_fill_curve => spd_set_filled

  • private subroutine spd_set_filled(this, x)

    Sets a logical value determining if a filled curve should be drawn.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    True if the curve should be filled; else, false.

procedure, public :: set_line_color => pdc_set_line_color

  • private subroutine pdc_set_line_color(this, x)

    Sets the object color.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_colored), intent(inout) :: this

    The plot_data_colored object.
    type(color), intent(in) :: x

    The color.

procedure, public :: set_line_style => spd_set_line_style

  • private subroutine spd_set_line_style(this, x)

    Sets the line style.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    integer(kind=int32), intent(in) :: x

    The line style. The line style must be one of the following.

    • LINE_DASHED

    • LINE_DASH_DOTTED

    • LINE_DASH_DOT_DOT

    • LINE_DOTTED

    • LINE_SOLID

procedure, public :: set_line_width => spd_set_line_width

  • private subroutine spd_set_line_width(this, x)

    Sets the width of the line, in pixels.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    real(kind=real32), intent(in) :: x

    The line width.

procedure, public :: set_marker_frequency => spd_set_marker_frequency

  • private subroutine spd_set_marker_frequency(this, x)

    Sets the marker frequency.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    integer(kind=int32), intent(in) :: x

    The marker frequency.

procedure, public :: set_marker_scaling => spd_set_marker_scaling

  • private subroutine spd_set_marker_scaling(this, x)

    Sets the marker scaling.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    real(kind=real32), intent(in) :: x

    The scaling factor.

procedure, public :: set_marker_style => spd_set_marker_style

  • private subroutine spd_set_marker_style(this, x)

    Sets the marker style.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    integer(kind=int32), intent(in) :: x

    The marker type. The marker type must be one of the following:

    • MARKER_ASTERISK

    • MARKER_EMPTY_CIRCLE

    • MARKER_EMPTY_NABLA

    • MARKER_EMPTY_RHOMBUS

    • MARKER_EMPTY_SQUARE

    • MARKER_EMPTY_TRIANGLE

    • MARKER_FILLED_CIRCLE

    • MARKER_FILLED_NABLA

    • MARKER_FILLED_RHOMBUS

    • MARKER_FILLED_SQUARE

    • MARKER_FILLED_TRIANGLE

    • MARKER_PLUS

    • MARKER_X

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 IntentOptional Attributes Name
    class(plot_data), intent(inout) :: this

    The plot_data object.
    character(len=*), intent(in) :: txt

    The name.

procedure, public :: set_simplification_factor => spd_set_simplify_factor

  • private subroutine spd_set_simplify_factor(this, x)

    Sets a factor used to establish the simplification tolerance.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    real(kind=real64), intent(in) :: x

    The scaling factor.

procedure, public :: set_simplify_data => spd_set_simplify_data

  • private subroutine spd_set_simplify_data(this, x)

    Sets a value determining if the stored data should be simplified (reduced) before passing to GNUPLOT.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    True if the data should be simplified prior to sending to GNUPLOT; else, false to leave the data alone.

procedure, public :: set_use_data_dependent_colors => spd_set_data_dependent_colors

  • private subroutine spd_set_data_dependent_colors(this, x)

    Sets a value determing if data-dependent colors should be used.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    True if data-dependent colors should be used; else, false.

procedure, public :: set_use_variable_size_points => spd_set_use_var_point_size

  • private subroutine spd_set_use_var_point_size(this, x)

    Sets a logical value determining if variable sized data points should be used. The default is false, such that points will be of a constant size.

    Arguments

    Type IntentOptional Attributes Name
    class(scatter_plot_data), intent(inout) :: this

    The scatter_plot_data object.
    logical, intent(in) :: x

    True if variable size points should be used; else, false.

procedure, public :: set_x => pd2d_set_x_data

  • private subroutine pd2d_set_x_data(this, index, x)

    Sets the requested X data point.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    integer(kind=int32), intent(in) :: index

    The index of the data point to replace.
    real(kind=real64), intent(in) :: x

    The data point.

procedure, public :: set_y => pd2d_set_y_data

  • private subroutine pd2d_set_y_data(this, index, x)

    Sets the requested Y data point.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_data_2d), intent(inout) :: this

    The plot_data_2d object.
    integer(kind=int32), intent(in) :: index

    The index of the data point to replace.
    real(kind=real64), intent(in) :: x

    The data point.