gpudb::VisualizeIsochroneRequest

A set of parameters for GPUdb::visualizeIsochrone. More…

#include <gpudb/protocol/visualize_isochrone.h>

Public Member Functions
	VisualizeIsochroneRequest ()
	Constructs a VisualizeIsochroneRequest object with default parameters.

	VisualizeIsochroneRequest (const std::string &graphName_, const std::string &sourceNode_, const double maxSolutionRadius_, const std::vector< std::string > &weightsOnEdges_, const std::vector< std::string > &restrictions_, const int32_t numLevels_, const bool generateImage_, const std::string &levelsTable_, const std::map< std::string, std::string > &styleOptions_, const std::map< std::string, std::string > &solveOptions_, const std::map< std::string, std::string > &contourOptions_, const std::map< std::string, std::string > &options_)
	Constructs a VisualizeIsochroneRequest object with the specified parameters.

Public Attributes
std::string	graphName
	Name of the graph on which the isochrone is to be computed.

std::string	sourceNode
	Starting vertex on the underlying graph from/to which the isochrones are created.

double	maxSolutionRadius
	Extent of the search radius around sourceNode.

std::vector< std::string >	weightsOnEdges
	Additional weights to apply to the edges of an existing graph.

std::vector< std::string >	restrictions
	Additional restrictions to apply to the nodes/edges of an existing graph.

int32_t	numLevels
	Number of equally-separated isochrones to compute.

bool	generateImage
	If set to true, generates a PNG image of the isochrones in the response.

std::string	levelsTable
	Name of the table to output the isochrones to, in [ schema_name.

std::map< std::string, std::string >	styleOptions
	Various style related options of the isochrone image.

std::map< std::string, std::string >	solveOptions
	Solver specific parameters.

std::map< std::string, std::string >	contourOptions
	Contour specific parameters.

std::map< std::string, std::string >	options
	Additional parameters.

Detailed Description

A set of parameters for GPUdb::visualizeIsochrone.

Generate an image containing isolines for travel results using an existing graph. Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.

Definition at line 23 of file visualize_isochrone.h.

Constructor & Destructor Documentation

◆ VisualizeIsochroneRequest() [1/2]

gpudb::VisualizeIsochroneRequest::VisualizeIsochroneRequest ( )

inline

Constructs a VisualizeIsochroneRequest object with default parameters.

Definition at line 29 of file visualize_isochrone.h.

◆ VisualizeIsochroneRequest() [2/2]

gpudb::VisualizeIsochroneRequest::VisualizeIsochroneRequest	(	const std::string &	graphName_,
		const std::string &	sourceNode_,
		const double	maxSolutionRadius_,
		const std::vector< std::string > &	weightsOnEdges_,
		const std::vector< std::string > &	restrictions_,
		const int32_t	numLevels_,
		const bool	generateImage_,
		const std::string &	levelsTable_,
		const std::map< std::string, std::string > &	styleOptions_,
		const std::map< std::string, std::string > &	solveOptions_,
		const std::map< std::string, std::string > &	contourOptions_,
		const std::map< std::string, std::string > &	options_ )

inline

Constructs a VisualizeIsochroneRequest object with the specified parameters.

Parameters

[in]	graphName_	Name of the graph on which the isochrone is to be computed.
[in]	sourceNode_	Starting vertex on the underlying graph from/to which the isochrones are created.
[in]	maxSolutionRadius_	Extent of the search radius around sourceNode_. Set to ‘-1.0’ for unrestricted search radius. The default value is -1.0.
[in]	weightsOnEdges_	Additional weights to apply to the edges of an existing graph. Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS WEIGHTS_EDGE_ID’, or expressions, e.g., ‘ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED’. Any provided weights will be added (in the case of ‘WEIGHTS_VALUESPECIFIED’) to or multiplied with (in the case of ‘WEIGHTS_FACTORSPECIFIED’) the existing weight(s). The default value is an empty vector.
[in]	restrictions_	Additional restrictions to apply to the nodes/edges of an existing graph. Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS RESTRICTIONS_EDGE_ID’, or expressions, e.g., ‘column/2 AS RESTRICTIONS_VALUECOMPARED’. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of ‘RESTRICTIONS_VALUECOMPARED’) to or replaced (in the case of ‘RESTRICTIONS_ONOFFCOMPARED’). The default value is an empty vector.
[in]	numLevels_	Number of equally-separated isochrones to compute. The default value is 1.
[in]	generateImage_	If set to true, generates a PNG image of the isochrones in the response. Supported values: true false The default value is true.
[in]	levelsTable_	Name of the table to output the isochrones to, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ”.
[in]	styleOptions_	Various style related options of the isochrone image. visualize_isochrone_line_size: The width of the contour lines in pixels. The default value is ‘3’. The minimum allowed value is ‘0’. The maximum allowed value is ‘20’. visualize_isochrone_color: Color of generated isolines. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). If alpha is specified and flooded contours are enabled, it will be used for as the transparency of the latter. The default value is ‘FF696969’. visualize_isochrone_bg_color: When generateImage_ is set to true, background color of the generated image. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is ‘00000000’. visualize_isochrone_text_color: When add_labels is set to true, color for the labels. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is ‘FF000000’. visualize_isochrone_colormap: Colormap for contours or fill-in regions when applicable. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). Supported values: visualize_isochrone_jet visualize_isochrone_accent visualize_isochrone_afmhot visualize_isochrone_autumn visualize_isochrone_binary visualize_isochrone_blues visualize_isochrone_bone visualize_isochrone_brbg visualize_isochrone_brg visualize_isochrone_bugn visualize_isochrone_bupu visualize_isochrone_bwr visualize_isochrone_cmrmap visualize_isochrone_cool visualize_isochrone_coolwarm visualize_isochrone_copper visualize_isochrone_cubehelix visualize_isochrone_dark2 visualize_isochrone_flag visualize_isochrone_gist_earth visualize_isochrone_gist_gray visualize_isochrone_gist_heat visualize_isochrone_gist_ncar visualize_isochrone_gist_rainbow visualize_isochrone_gist_stern visualize_isochrone_gist_yarg visualize_isochrone_gnbu visualize_isochrone_gnuplot2 visualize_isochrone_gnuplot visualize_isochrone_gray visualize_isochrone_greens visualize_isochrone_greys visualize_isochrone_hot visualize_isochrone_hsv visualize_isochrone_inferno visualize_isochrone_magma visualize_isochrone_nipy_spectral visualize_isochrone_ocean visualize_isochrone_oranges visualize_isochrone_orrd visualize_isochrone_paired visualize_isochrone_pastel1 visualize_isochrone_pastel2 visualize_isochrone_pink visualize_isochrone_piyg visualize_isochrone_plasma visualize_isochrone_prgn visualize_isochrone_prism visualize_isochrone_pubu visualize_isochrone_pubugn visualize_isochrone_puor visualize_isochrone_purd visualize_isochrone_purples visualize_isochrone_rainbow visualize_isochrone_rdbu visualize_isochrone_rdgy visualize_isochrone_rdpu visualize_isochrone_rdylbu visualize_isochrone_rdylgn visualize_isochrone_reds visualize_isochrone_seismic visualize_isochrone_set1 visualize_isochrone_set2 visualize_isochrone_set3 visualize_isochrone_spectral visualize_isochrone_spring visualize_isochrone_summer visualize_isochrone_terrain visualize_isochrone_viridis visualize_isochrone_winter visualize_isochrone_wistia visualize_isochrone_ylgn visualize_isochrone_ylgnbu visualize_isochrone_ylorbr visualize_isochrone_ylorrd The default value is visualize_isochrone_jet.
[in]	solveOptions_	Solver specific parameters. visualize_isochrone_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values: visualize_isochrone_true visualize_isochrone_false The default value is visualize_isochrone_false. visualize_isochrone_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a ‘RESTRICTIONS_VALUECOMPARED’ value greater than the restriction_threshold_value will not be included in the solution. visualize_isochrone_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges_ will override this value. The default value is an empty map.
[in]	contourOptions_	Contour specific parameters. visualize_isochrone_projection: Spatial Reference System (i.e. EPSG Code). Supported values: visualize_isochrone_3857 visualize_isochrone_102100 visualize_isochrone_900913 visualize_isochrone_EPSG_4326 visualize_isochrone_PLATE_CARREE visualize_isochrone_EPSG_900913 visualize_isochrone_EPSG_102100 visualize_isochrone_EPSG_3857 visualize_isochrone_WEB_MERCATOR The default value is visualize_isochrone_PLATE_CARREE. visualize_isochrone_width: When generateImage_ is set to true, width of the generated image. The default value is ‘512’. visualize_isochrone_height: When generateImage_ is set to true, height of the generated image. If the default value is used, the height is set to the value resulting from multiplying the aspect ratio by the width. The default value is ‘-1’. visualize_isochrone_search_radius: When interpolating the graph solution to generate the isochrone, neighborhood of influence of sample data (in percent of the image/grid). The default value is ‘20’. visualize_isochrone_grid_size: When interpolating the graph solution to generate the isochrone, number of subdivisions along the x axis when building the grid (the y is computed using the aspect ratio of the output image). The default value is ‘100’. visualize_isochrone_color_isolines: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values: visualize_isochrone_true visualize_isochrone_false The default value is visualize_isochrone_true. visualize_isochrone_add_labels: If set to true, add labels to the isolines. Supported values: visualize_isochrone_true visualize_isochrone_false The default value is visualize_isochrone_false. visualize_isochrone_labels_font_size: When add_labels is set to true, size of the font (in pixels) to use for labels. The default value is ‘12’. visualize_isochrone_labels_font_family: When add_labels is set to true, font name to be used when adding labels. The default value is ‘arial’. visualize_isochrone_labels_search_window: When add_labels is set to true, a search window is used to rate the local quality of each isoline. Smooth, continuous, long stretches with relatively flat angles are favored. The provided value is multiplied by the labels_font_size to calculate the final window size. The default value is ‘4’. visualize_isochrone_labels_intralevel_separation: When add_labels is set to true, this value determines the distance (in multiples of the labels_font_size) to use when separating labels of different values. The default value is ‘4’. visualize_isochrone_labels_interlevel_separation: When add_labels is set to true, this value determines the distance (in percent of the total window size) to use when separating labels of the same value. The default value is ‘20’. visualize_isochrone_labels_max_angle: When add_labels is set to true, maximum angle (in degrees) from the vertical to use when adding labels. The default value is ‘60’. The default value is an empty map.
[in]	options_	Additional parameters. visualize_isochrone_solve_table: Name of the table to host intermediate solve results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will contain the position and cost for each vertex in the graph. If the default value is used, a temporary table is created and deleted once the solution is calculated. The default value is ”. visualize_isochrone_is_replicated: If set to true, replicate the solve_table. Supported values: visualize_isochrone_true visualize_isochrone_false The default value is visualize_isochrone_true. visualize_isochrone_data_min_x: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data. visualize_isochrone_data_max_x: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data. visualize_isochrone_data_min_y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data. visualize_isochrone_data_max_y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data. visualize_isochrone_concavity_level: Factor to qualify the concavity of the isochrone curves. The lower the value, the more convex (with ‘0’ being completely convex and ‘1’ being the most concave). The default value is ‘0.5’. The minimum allowed value is ‘0’. The maximum allowed value is ‘1’. visualize_isochrone_use_priority_queue_solvers: Sets the solver methods explicitly if true. Supported values: visualize_isochrone_true: Uses the solvers scheduled for ‘shortest_path’ and ‘inverse_shortest_path’ based on solve_direction. visualize_isochrone_false: Uses the solvers ‘priority_queue’ and ‘inverse_priority_queue’ based on solve_direction. The default value is visualize_isochrone_false. visualize_isochrone_solve_direction: Specify whether we are going to the source node, or starting from it. Supported values: visualize_isochrone_from_source: Shortest path to get to the source (inverse Dijkstra). visualize_isochrone_to_source: Shortest path to source (Dijkstra). The default value is visualize_isochrone_from_source. The default value is an empty map.

Definition at line 783 of file visualize_isochrone.h.

Member Data Documentation

◆ contourOptions

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::contourOptions

Contour specific parameters.

visualize_isochrone_projection: Spatial Reference System (i.e. EPSG Code). Supported values:
The default value is visualize_isochrone_PLATE_CARREE.
visualize_isochrone_width: When generateImage is set to true, width of the generated image. The default value is ‘512’.
visualize_isochrone_height: When generateImage is set to true, height of the generated image. If the default value is used, the height is set to the value resulting from multiplying the aspect ratio by the width. The default value is ‘-1’.
visualize_isochrone_search_radius: When interpolating the graph solution to generate the isochrone, neighborhood of influence of sample data (in percent of the image/grid). The default value is ‘20’.
visualize_isochrone_grid_size: When interpolating the graph solution to generate the isochrone, number of subdivisions along the x axis when building the grid (the y is computed using the aspect ratio of the output image). The default value is ‘100’.
visualize_isochrone_color_isolines: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values:
- visualize_isochrone_true
- visualize_isochrone_false
The default value is visualize_isochrone_true.
visualize_isochrone_add_labels: If set to true, add labels to the isolines. Supported values:
- visualize_isochrone_true
- visualize_isochrone_false
The default value is visualize_isochrone_false.
visualize_isochrone_labels_font_size: When add_labels is set to true, size of the font (in pixels) to use for labels. The default value is ‘12’.
visualize_isochrone_labels_font_family: When add_labels is set to true, font name to be used when adding labels. The default value is ‘arial’.
visualize_isochrone_labels_search_window: When add_labels is set to true, a search window is used to rate the local quality of each isoline. Smooth, continuous, long stretches with relatively flat angles are favored. The provided value is multiplied by the labels_font_size to calculate the final window size. The default value is ‘4’.
visualize_isochrone_labels_intralevel_separation: When add_labels is set to true, this value determines the distance (in multiples of the labels_font_size) to use when separating labels of different values. The default value is ‘4’.
visualize_isochrone_labels_interlevel_separation: When add_labels is set to true, this value determines the distance (in percent of the total window size) to use when separating labels of the same value. The default value is ‘20’.
visualize_isochrone_labels_max_angle: When add_labels is set to true, maximum angle (in degrees) from the vertical to use when adding labels. The default value is ‘60’.

The default value is an empty map.

Definition at line 1232 of file visualize_isochrone.h.

◆ generateImage

bool gpudb::VisualizeIsochroneRequest::generateImage

If set to true, generates a PNG image of the isochrones in the response.

Supported values:

true
false

The default value is true.

Definition at line 870 of file visualize_isochrone.h.

◆ graphName

std::string gpudb::VisualizeIsochroneRequest::graphName

Name of the graph on which the isochrone is to be computed.

Definition at line 802 of file visualize_isochrone.h.

◆ levelsTable

std::string gpudb::VisualizeIsochroneRequest::levelsTable

Name of the table to output the isochrones to, in [ schema_name.

\ ]table_name format, using standard name resolution rules and meeting table naming criteria. The table will contain levels and their corresponding WKT geometry. If no value is provided, the table is not generated. The default value is ”.

Definition at line 882 of file visualize_isochrone.h.

◆ maxSolutionRadius

double gpudb::VisualizeIsochroneRequest::maxSolutionRadius

Extent of the search radius around sourceNode.

Set to ‘-1.0’ for unrestricted search radius. The default value is -1.0.

Definition at line 814 of file visualize_isochrone.h.

◆ numLevels

int32_t gpudb::VisualizeIsochroneRequest::numLevels

Number of equally-separated isochrones to compute.

The default value is 1.

Definition at line 858 of file visualize_isochrone.h.

◆ options

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::options

Additional parameters.

visualize_isochrone_solve_table: Name of the table to host intermediate solve results, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. This table will contain the position and cost for each vertex in the graph. If the default value is used, a temporary table is created and deleted once the solution is calculated. The default value is ”.
visualize_isochrone_is_replicated: If set to true, replicate the solve_table. Supported values:
- visualize_isochrone_true
- visualize_isochrone_false
The default value is visualize_isochrone_true.
visualize_isochrone_data_min_x: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data.
visualize_isochrone_data_max_x: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data.
visualize_isochrone_data_min_y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data.
visualize_isochrone_data_max_y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data.
visualize_isochrone_concavity_level: Factor to qualify the concavity of the isochrone curves. The lower the value, the more convex (with ‘0’ being completely convex and ‘1’ being the most concave). The default value is ‘0.5’. The minimum allowed value is ‘0’. The maximum allowed value is ‘1’.
visualize_isochrone_use_priority_queue_solvers: Sets the solver methods explicitly if true. Supported values:
- visualize_isochrone_true: Uses the solvers scheduled for ‘shortest_path’ and ‘inverse_shortest_path’ based on solve_direction.
- visualize_isochrone_false: Uses the solvers ‘priority_queue’ and ‘inverse_priority_queue’ based on solve_direction.
The default value is visualize_isochrone_false.
visualize_isochrone_solve_direction: Specify whether we are going to the source node, or starting from it. Supported values:
- visualize_isochrone_from_source: Shortest path to get to the source (inverse Dijkstra).
- visualize_isochrone_to_source: Shortest path to source (Dijkstra).
The default value is visualize_isochrone_from_source.

The default value is an empty map.

Definition at line 1321 of file visualize_isochrone.h.

◆ restrictions

std::vector<std::string> gpudb::VisualizeIsochroneRequest::restrictions

Additional restrictions to apply to the nodes/edges of an existing graph.

Restrictions must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS RESTRICTIONS_EDGE_ID’, or expressions, e.g., ‘column/2 AS RESTRICTIONS_VALUECOMPARED’. If remove_previous_restrictions is set to true, any provided restrictions will replace the existing restrictions. If remove_previous_restrictions is set to false, any provided restrictions will be added (in the case of ‘RESTRICTIONS_VALUECOMPARED’) to or replaced (in the case of ‘RESTRICTIONS_ONOFFCOMPARED’). The default value is an empty vector.

Definition at line 852 of file visualize_isochrone.h.

◆ solveOptions

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::solveOptions

Solver specific parameters.

visualize_isochrone_remove_previous_restrictions: Ignore the restrictions applied to the graph during the creation stage and only use the restrictions specified in this request if set to true. Supported values:
- visualize_isochrone_true
- visualize_isochrone_false
The default value is visualize_isochrone_false.
visualize_isochrone_restriction_threshold_value: Value-based restriction comparison. Any node or edge with a ‘RESTRICTIONS_VALUECOMPARED’ value greater than the restriction_threshold_value will not be included in the solution.
visualize_isochrone_uniform_weights: When specified, assigns the given value to all the edges in the graph. Note that weights provided in weightsOnEdges will override this value.

The default value is an empty map.

Definition at line 1106 of file visualize_isochrone.h.

◆ sourceNode

std::string gpudb::VisualizeIsochroneRequest::sourceNode

Starting vertex on the underlying graph from/to which the isochrones are created.

Definition at line 808 of file visualize_isochrone.h.

◆ styleOptions

std::map<std::string, std::string> gpudb::VisualizeIsochroneRequest::styleOptions

Various style related options of the isochrone image.

visualize_isochrone_line_size: The width of the contour lines in pixels. The default value is ‘3’. The minimum allowed value is ‘0’. The maximum allowed value is ‘20’.
visualize_isochrone_color: Color of generated isolines. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). If alpha is specified and flooded contours are enabled, it will be used for as the transparency of the latter. The default value is ‘FF696969’.
visualize_isochrone_bg_color: When generateImage is set to true, background color of the generated image. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is ‘00000000’.
visualize_isochrone_text_color: When add_labels is set to true, color for the labels. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). The default value is ‘FF000000’.
visualize_isochrone_colormap: Colormap for contours or fill-in regions when applicable. All color values must be in the format RRGGBB or AARRGGBB (to specify the alpha value). Supported values:
The default value is visualize_isochrone_jet.

Definition at line 1071 of file visualize_isochrone.h.

◆ weightsOnEdges

std::vector<std::string> gpudb::VisualizeIsochroneRequest::weightsOnEdges

Additional weights to apply to the edges of an existing graph.

Weights must be specified using identifiers; identifiers are grouped as combinations. Identifiers can be used with existing column names, e.g., ‘table.column AS WEIGHTS_EDGE_ID’, or expressions, e.g., ‘ST_LENGTH(wkt) AS WEIGHTS_VALUESPECIFIED’. Any provided weights will be added (in the case of ‘WEIGHTS_VALUESPECIFIED’) to or multiplied with (in the case of ‘WEIGHTS_FACTORSPECIFIED’) the existing weight(s). The default value is an empty vector.

Definition at line 830 of file visualize_isochrone.h.

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

gpudb/protocol/visualize_isochrone.h

​ Public Member Functions

​ Public Attributes

​Detailed Description

​Constructor & Destructor Documentation

​◆ VisualizeIsochroneRequest() [1/2]

​◆ VisualizeIsochroneRequest() [2/2]

​Member Data Documentation

​◆ contourOptions

​◆ generateImage

​◆ graphName

​◆ levelsTable

​◆ maxSolutionRadius

​◆ numLevels

​◆ options

​◆ restrictions

​◆ solveOptions

​◆ sourceNode

​◆ styleOptions

​◆ weightsOnEdges

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VisualizeIsochroneRequest() [1/2]

◆ VisualizeIsochroneRequest() [2/2]

Member Data Documentation

◆ contourOptions

◆ generateImage

◆ graphName

◆ levelsTable

◆ maxSolutionRadius

◆ numLevels

◆ options

◆ restrictions

◆ solveOptions

◆ sourceNode

◆ styleOptions

◆ weightsOnEdges