gpudb::VisualizeIsochroneRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/visualize_isochrone.h>

Public Member Functions
	VisualizeIsochroneRequest ()
	Constructs a VisualizeIsochroneRequest object with default parameter values. More...
	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. More...

Public Attributes
std::string	graphName
std::string	sourceNode
double	maxSolutionRadius
std::vector< std::string >	weightsOnEdges
std::vector< std::string >	restrictions
int32_t	numLevels
bool	generateImage
std::string	levelsTable
std::map< std::string, std::string >	styleOptions
std::map< std::string, std::string >	solveOptions
std::map< std::string, std::string >	contourOptions
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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 Network Graphs & Solvers for more information on graphs.

Definition at line 25 of file visualize_isochrone.h.

Constructor & Destructor Documentation

gpudb::VisualizeIsochroneRequest::VisualizeIsochroneRequest ( )

inline

Constructs a VisualizeIsochroneRequest object with default parameter values.

Definition at line 32 of file visualize_isochrone.h.

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.
[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).
[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').
[in]	numLevels_	Number of equally-separated isochrones to compute.
[in]	generateImage_	If set to true, generates a PNG image of the isochrones in the response. gpudb::visualize_isochrone_true gpudb::visualize_isochrone_false The default value is gpudb::visualize_isochrone_true.
[in]	levelsTable_	Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. If no value is provided, the table is not generated.
[in]	styleOptions_	Various style related options of the isochrone image. gpudb::visualize_isochrone_line_size: The width of the contour lines in pixels. The default value is '3'. gpudb::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'. gpudb::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'. gpudb::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'. gpudb::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) gpudb::visualize_isochrone_jet gpudb::visualize_isochrone_accent gpudb::visualize_isochrone_afmhot gpudb::visualize_isochrone_autumn gpudb::visualize_isochrone_binary gpudb::visualize_isochrone_blues gpudb::visualize_isochrone_bone gpudb::visualize_isochrone_brbg gpudb::visualize_isochrone_brg gpudb::visualize_isochrone_bugn gpudb::visualize_isochrone_bupu gpudb::visualize_isochrone_bwr gpudb::visualize_isochrone_cmrmap gpudb::visualize_isochrone_cool gpudb::visualize_isochrone_coolwarm gpudb::visualize_isochrone_copper gpudb::visualize_isochrone_cubehelix gpudb::visualize_isochrone_dark2 gpudb::visualize_isochrone_flag gpudb::visualize_isochrone_gist_earth gpudb::visualize_isochrone_gist_gray gpudb::visualize_isochrone_gist_heat gpudb::visualize_isochrone_gist_ncar gpudb::visualize_isochrone_gist_rainbow gpudb::visualize_isochrone_gist_stern gpudb::visualize_isochrone_gist_yarg gpudb::visualize_isochrone_gnbu gpudb::visualize_isochrone_gnuplot2 gpudb::visualize_isochrone_gnuplot gpudb::visualize_isochrone_gray gpudb::visualize_isochrone_greens gpudb::visualize_isochrone_greys gpudb::visualize_isochrone_hot gpudb::visualize_isochrone_hsv gpudb::visualize_isochrone_inferno gpudb::visualize_isochrone_magma gpudb::visualize_isochrone_nipy_spectral gpudb::visualize_isochrone_ocean gpudb::visualize_isochrone_oranges gpudb::visualize_isochrone_orrd gpudb::visualize_isochrone_paired gpudb::visualize_isochrone_pastel1 gpudb::visualize_isochrone_pastel2 gpudb::visualize_isochrone_pink gpudb::visualize_isochrone_piyg gpudb::visualize_isochrone_plasma gpudb::visualize_isochrone_prgn gpudb::visualize_isochrone_prism gpudb::visualize_isochrone_pubu gpudb::visualize_isochrone_pubugn gpudb::visualize_isochrone_puor gpudb::visualize_isochrone_purd gpudb::visualize_isochrone_purples gpudb::visualize_isochrone_rainbow gpudb::visualize_isochrone_rdbu gpudb::visualize_isochrone_rdgy gpudb::visualize_isochrone_rdpu gpudb::visualize_isochrone_rdylbu gpudb::visualize_isochrone_rdylgn gpudb::visualize_isochrone_reds gpudb::visualize_isochrone_seismic gpudb::visualize_isochrone_set1 gpudb::visualize_isochrone_set2 gpudb::visualize_isochrone_set3 gpudb::visualize_isochrone_spectral gpudb::visualize_isochrone_spring gpudb::visualize_isochrone_summer gpudb::visualize_isochrone_terrain gpudb::visualize_isochrone_viridis gpudb::visualize_isochrone_winter gpudb::visualize_isochrone_wistia gpudb::visualize_isochrone_ylgn gpudb::visualize_isochrone_ylgnbu gpudb::visualize_isochrone_ylorbr gpudb::visualize_isochrone_ylorrd The default value is gpudb::visualize_isochrone_jet.
[in]	solveOptions_	Solver specific parameters gpudb::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. gpudb::visualize_isochrone_true gpudb::visualize_isochrone_false The default value is gpudb::visualize_isochrone_false. gpudb::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. gpudb::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.
[in]	contourOptions_	Solver specific parameters gpudb::visualize_isochrone_projection: Spatial Reference System (i.e. EPSG Code). gpudb::visualize_isochrone_3857 gpudb::visualize_isochrone_102100 gpudb::visualize_isochrone_900913 gpudb::visualize_isochrone_EPSG_4326 gpudb::visualize_isochrone_PLATE_CARREE gpudb::visualize_isochrone_EPSG_900913 gpudb::visualize_isochrone_EPSG_102100 gpudb::visualize_isochrone_EPSG_3857 gpudb::visualize_isochrone_WEB_MERCATOR The default value is gpudb::visualize_isochrone_PLATE_CARREE. gpudb::visualize_isochrone_width: When generateImage is set to true, width of the generated image. The default value is '512'. gpudb::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'. gpudb::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'. gpudb::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'. gpudb::visualize_isochrone_color_isolines: Color each isoline according to the colormap; otherwise, use the foreground color. gpudb::visualize_isochrone_true gpudb::visualize_isochrone_false The default value is gpudb::visualize_isochrone_true. gpudb::visualize_isochrone_add_labels: If set to true, add labels to the isolines. gpudb::visualize_isochrone_true gpudb::visualize_isochrone_false The default value is gpudb::visualize_isochrone_false. gpudb::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'. gpudb::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'. gpudb::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'. gpudb::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'. gpudb::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'. gpudb::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'.
[in]	options_	Additional parameters gpudb::visualize_isochrone_solve_table: Name of the table to host intermediate solve results containing 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 ''. gpudb::visualize_isochrone_is_replicated: If set to true, replicate the solve_table. gpudb::visualize_isochrone_true gpudb::visualize_isochrone_false The default value is gpudb::visualize_isochrone_true. gpudb::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. gpudb::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. gpudb::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. gpudb::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. gpudb::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'. gpudb::visualize_isochrone_use_priority_queue_solvers: sets the solver methods explicitly if true gpudb::visualize_isochrone_true: uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction gpudb::visualize_isochrone_false: uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction The default value is gpudb::visualize_isochrone_false. gpudb::visualize_isochrone_solve_direction: Specify whether we are going to the source node, or starting from it. gpudb::visualize_isochrone_from_source: Shortest path to get to the source (inverse Dijkstra) gpudb::visualize_isochrone_to_source: Shortest path to source (Dijkstra) The default value is gpudb::visualize_isochrone_from_source.

Definition at line 537 of file visualize_isochrone.h.

Member Data Documentation

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

Definition at line 563 of file visualize_isochrone.h.

bool gpudb::VisualizeIsochroneRequest::generateImage

Definition at line 559 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::graphName

Definition at line 553 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::levelsTable

Definition at line 560 of file visualize_isochrone.h.

double gpudb::VisualizeIsochroneRequest::maxSolutionRadius

Definition at line 555 of file visualize_isochrone.h.

int32_t gpudb::VisualizeIsochroneRequest::numLevels

Definition at line 558 of file visualize_isochrone.h.

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

Definition at line 564 of file visualize_isochrone.h.

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

Definition at line 557 of file visualize_isochrone.h.

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

Definition at line 562 of file visualize_isochrone.h.

std::string gpudb::VisualizeIsochroneRequest::sourceNode

Definition at line 554 of file visualize_isochrone.h.

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

Definition at line 561 of file visualize_isochrone.h.

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

Definition at line 556 of file visualize_isochrone.h.

---

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

• gpudb/protocol/visualize_isochrone.h