fplot 1.7.1
A Fortran library providing a convenient interface for plotting with Gnuplot.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
fplot_core::simplify_polyline Interface Reference

Simplifies a 2D or 3D polyline by removing points too close to discern given a specified tolerance. More...

Public Member Functions

 simplify_polyline_2d1
 
 simplify_polyline_3d1
 
 simplify_polyline_mtx
 

Detailed Description

Simplifies a 2D or 3D polyline by removing points too close to discern given a specified tolerance.

Overload 1
Simplifies a 2D polyline by removing points too close to discern given a specified tolerance.
Parameters
[in]xAn N-element array containing the x-coordinates of the vertices making up the polyline.
[in]yAn N-element array containing the y-coordinates of the vertices making up the polyline.
[in]tolThe distance tolerance to use when simplifying the polyline. This value must be positive, and larger than machine epsilon.
[in,out]errAn 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_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available.
  • PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input array sizes are not compatible.
  • PLOT_INVALID_INPUT_ERROR: Occurs if tol is not positive and greater than machine epsilon.
Returns
A matrix containing the simplified polyline vertices. The first column of the matrix contains the x-coordinates, and the second column contains the y-coordinates.
Overload 2
Simplifies a 3D polyline by removing points too close to discern given a specified tolerance.
Parameters
[in]xAn N-element array containing the x-coordinates of the vertices making up the polyline.
[in]yAn N-element array containing the y-coordinates of the vertices making up the polyline.
[in]zAn N-element array containing the z-coordinates of the vertices making up the polyline.
[in]tolThe distance tolerance to use when simplifying the polyline. This value must be positive, and larger than machine epsilon.
[in,out]errAn 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_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available.
  • PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input array sizes are not compatible.
  • PLOT_INVALID_INPUT_ERROR: Occurs if tol is not positive and greater than machine epsilon.
Returns
A matrix containing the simplified polyline vertices. The first column of the matrix contains the x-coordinates, the second column contains the y-coordinates, and the third column contains the z-coordinates.
Overload 3
Simplifies a 2D or 3D polyline by removing points too close to discern given a specified tolerance.
Parameters
[in]xyAn N-by-2 or N-by-3 matrix containing the polyline vertex data.
[in]tolThe distance tolerance to use when simplifying the polyline. This value must be positive, and larger than machine epsilon.
[in,out]errAn 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_OUT_OF_MEMORY_ERROR: Occurs if insufficient memory is available.
  • PLOT_ARRAY_SIZE_MISMATCH_ERROR: Occurs if the input array sizes are not compatible.
  • PLOT_INVALID_INPUT_ERROR: Occurs if tol is not positive and greater than machine epsilon.
Returns
A matrix containing the simplified polyline vertices. The first column of the matrix contains the x-coordinates, the second column contains the y-coordinates, and if necessary, the third column contains the z-coordinates.

Definition at line 7786 of file fplot_core.f90.

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