A set of parameters for Kinetica.visualizeIsochrone(string,string,double,IList{string},IList{string},int,bool,string,IDictionary{string, string},IDictionary{string, string},IDictionary{string, string},IDictionary{string, string}). More...

Inheritance diagram for kinetica.VisualizeIsochroneRequest:

Collaboration diagram for kinetica.VisualizeIsochroneRequest:

Classes
struct	ContourOptions
	Solver specific parameters PROJECTION: Spatial Reference System (i.e. More...

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

struct	Options
	Additional parameters SOLVE_TABLE: Name of the table to host intermediate solve results containing the position and cost for each vertex in the graph. More...

struct	SolveOptions
	Solver specific parameters 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. More...

struct	StyleOptions
	Various style related options of the isochrone image. More...

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

	VisualizeIsochroneRequest (string graph_name, string source_node, double?max_solution_radius, IList< string > weights_on_edges, IList< string > restrictions, int?num_levels, bool?generate_image, string levels_table, IDictionary< string, string > style_options, IDictionary< string, string > solve_options=null, IDictionary< string, string > contour_options=null, IDictionary< string, string > options=null)
	Constructs a VisualizeIsochroneRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	graph_name `[get, set]`
	Name of the graph on which the isochrone is to be computed. More...

string	source_node `[get, set]`
	Starting vertex on the underlying graph from/to which the isochrones are created. More...

double	max_solution_radius `[get, set]`
	Extent of the search radius around . More...

IList< string >	weights_on_edges = -1.0 `[get, set]`
	Additional weights to apply to the edges of an existing graph. More...

IList< string >	restrictions = new List<string>() `[get, set]`
	Additional restrictions to apply to the nodes/edges of an existing graph. More...

int	num_levels = new List<string>() `[get, set]`
	Number of equally-separated isochrones to compute. More...

bool	generate_image = 1 `[get, set]`
	If set to true, generates a PNG image of the isochrones in the response. More...

string	levels_table = true `[get, set]`
	Name of the table to output the isochrones, containing levels and their corresponding WKT geometry. More...

IDictionary< string, string >	style_options = "" `[get, set]`
	Various style related options of the isochrone image. More...

IDictionary< string, string >	solve_options = new Dictionary<string, string>() `[get, set]`
	Solver specific parameters 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. More...

IDictionary< string, string >	contour_options = new Dictionary<string, string>() `[get, set]`
	Solver specific parameters PROJECTION: Spatial Reference System (i.e. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Additional parameters SOLVE_TABLE: Name of the table to host intermediate solve results containing the position and cost for each vertex in the graph. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static RecordSchema	SchemaFromType (System.Type t, KineticaType ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.visualizeIsochrone(string,string,double,IList{string},IList{string},int,bool,string,IDictionary{string, string},IDictionary{string, string},IDictionary{string, string},IDictionary{string, string}).

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 26 of file VisualizeIsochrone.cs.

Constructor & Destructor Documentation

kinetica.VisualizeIsochroneRequest.VisualizeIsochroneRequest ( )

inline

Constructs a VisualizeIsochroneRequest object with default parameters.

Definition at line 2192 of file VisualizeIsochrone.cs.

kinetica.VisualizeIsochroneRequest.VisualizeIsochroneRequest	(	string	graph_name,
		string	source_node,
		double?	max_solution_radius,
		IList< string >	weights_on_edges,
		IList< string >	restrictions,
		int?	num_levels,
		bool?	generate_image,
		string	levels_table,
		IDictionary< string, string >	style_options,
		IDictionary< string, string >	solve_options = `null`,
		IDictionary< string, string >	contour_options = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a VisualizeIsochroneRequest object with the specified parameters.

Parameters

graph_name	Name of the graph on which the isochrone is to be computed.
source_node	Starting vertex on the underlying graph from/to which the isochrones are created.
max_solution_radius	Extent of the search radius around . Set to '-1.0' for unrestricted search radius. The default value is -1.0.
weights_on_edges	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 List.
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 List.
num_levels	Number of equally-separated isochrones to compute. The default value is 1.
generate_image	If set to true, generates a PNG image of the isochrones in the response. Supported values: TRUE FALSE The default value is TRUE.
levels_table	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. The default value is ''.
style_options	Various style related options of the isochrone image. LINE_SIZE: The width of the contour lines in pixels. The default value is '3'. 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'. BG_COLOR: When 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'. 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'. 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: JET ACCENT AFMHOT AUTUMN BINARY BLUES BONE BRBG BRG BUGN BUPU BWR CMRMAP COOL COOLWARM COPPER CUBEHELIX DARK2 FLAG GIST_EARTH GIST_GRAY GIST_HEAT GIST_NCAR GIST_RAINBOW GIST_STERN GIST_YARG GNBU GNUPLOT2 GNUPLOT GRAY GREENS GREYS HOT HSV INFERNO MAGMA NIPY_SPECTRAL OCEAN ORANGES ORRD PAIRED PASTEL1 PASTEL2 PINK PIYG PLASMA PRGN PRISM PUBU PUBUGN PUOR PURD PURPLES RAINBOW RDBU RDGY RDPU RDYLBU RDYLGN REDS SEISMIC SET1 SET2 SET3 SPECTRAL SPRING SUMMER TERRAIN VIRIDIS WINTER WISTIA YLGN YLGNBU YLORBR YLORRD The default value is JET.
solve_options	Solver specific parameters 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: TRUE FALSE The default value is FALSE. 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. UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in will override this value. The default value is an empty Dictionary.
contour_options	Solver specific parameters PROJECTION: Spatial Reference System (i.e. EPSG Code). Supported values: _3857 _102100 _900913 EPSG_4326 PLATE_CARREE EPSG_900913 EPSG_102100 EPSG_3857 WEB_MERCATOR The default value is PLATE_CARREE. WIDTH: When is set to true, width of the generated image. The default value is '512'. HEIGHT: When 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'. 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'. 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'. COLOR_ISOLINES: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values: TRUE FALSE The default value is TRUE. ADD_LABELS: If set to true, add labels to the isolines. Supported values: TRUE FALSE The default value is FALSE. 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'. LABELS_FONT_FAMILY: When add_labels is set to true, font name to be used when adding labels. The default value is 'arial'. 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'. 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'. 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'. 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 Dictionary.
options	Additional parameters 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 ''. IS_REPLICATED: If set to true, replicate the solve_table. Supported values: TRUE FALSE The default value is TRUE. DATA_MIN_X: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data. DATA_MAX_X: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data. DATA_MIN_Y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data. DATA_MAX_Y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data. 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'. USE_PRIORITY_QUEUE_SOLVERS: sets the solver methods explicitly if true Supported values: TRUE: uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction FALSE: uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction The default value is FALSE. SOLVE_DIRECTION: Specify whether we are going to the source node, or starting from it. Supported values: FROM_SOURCE: Shortest path to get to the source (inverse Dijkstra) TO_SOURCE: Shortest path to source (Dijkstra) The default value is FROM_SOURCE. The default value is an empty Dictionary.

Definition at line 2927 of file VisualizeIsochrone.cs.

Property Documentation

IDictionary<string, string> kinetica.VisualizeIsochroneRequest.contour_options = new Dictionary<string, string>()

getset

Solver specific parameters

PROJECTION: Spatial Reference System (i.e.

EPSG Code). Supported values:

The default value is PLATE_CARREE. WIDTH: When is set to true, width of the generated image. The default value is '512'. HEIGHT: When 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'. 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'. 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'. COLOR_ISOLINES: Color each isoline according to the colormap; otherwise, use the foreground color. Supported values:

TRUE
FALSE

The default value is TRUE. ADD_LABELS: If set to true, add labels to the isolines. Supported values:

TRUE
FALSE

The default value is FALSE. 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'. LABELS_FONT_FAMILY: When add_labels is set to true, font name to be used when adding labels. The default value is 'arial'. 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'. 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'. 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'. 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 Dictionary.

Definition at line 2072 of file VisualizeIsochrone.cs.

bool kinetica.VisualizeIsochroneRequest.generate_image = 1

getset

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 1503 of file VisualizeIsochrone.cs.

string kinetica.VisualizeIsochroneRequest.graph_name

getset

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

Definition at line 1441 of file VisualizeIsochrone.cs.

string kinetica.VisualizeIsochroneRequest.levels_table = true

getset

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. The default value is ''.

Definition at line 1509 of file VisualizeIsochrone.cs.

double kinetica.VisualizeIsochroneRequest.max_solution_radius

getset

Extent of the search radius around .

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

Definition at line 1450 of file VisualizeIsochrone.cs.

int kinetica.VisualizeIsochroneRequest.num_levels = new List<string>()

getset

Number of equally-separated isochrones to compute.

The default value is 1.

Definition at line 1485 of file VisualizeIsochrone.cs.

IDictionary<string, string> kinetica.VisualizeIsochroneRequest.options = new Dictionary<string, string>()

getset

Additional parameters

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 ''. IS_REPLICATED: If set to true, replicate the solve_table. Supported values:

TRUE
FALSE

The default value is TRUE. DATA_MIN_X: Lower bound for the x values. If not provided, it will be computed from the bounds of the input data. DATA_MAX_X: Upper bound for the x values. If not provided, it will be computed from the bounds of the input data. DATA_MIN_Y: Lower bound for the y values. If not provided, it will be computed from the bounds of the input data. DATA_MAX_Y: Upper bound for the y values. If not provided, it will be computed from the bounds of the input data. 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'. USE_PRIORITY_QUEUE_SOLVERS: sets the solver methods explicitly if true Supported values:

TRUE: uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction
FALSE: uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction

The default value is FALSE. SOLVE_DIRECTION: Specify whether we are going to the source node, or starting from it. Supported values:

FROM_SOURCE: Shortest path to get to the source (inverse Dijkstra)
TO_SOURCE: Shortest path to source (Dijkstra)

The default value is FROM_SOURCE.

The default value is an empty Dictionary.

Definition at line 2187 of file VisualizeIsochrone.cs.

IList<string> kinetica.VisualizeIsochroneRequest.restrictions = new List<string>()

getset

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 List.

Definition at line 1481 of file VisualizeIsochrone.cs.

IDictionary<string, string> kinetica.VisualizeIsochroneRequest.solve_options = new Dictionary<string, string>()

getset

Solver specific parameters

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:

TRUE
FALSE

The default value is FALSE. 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. UNIFORM_WEIGHTS: When specified, assigns the given value to all the edges in the graph. Note that weights provided in will override this value.

The default value is an empty Dictionary.

Definition at line 1901 of file VisualizeIsochrone.cs.

string kinetica.VisualizeIsochroneRequest.source_node

getset

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

Definition at line 1445 of file VisualizeIsochrone.cs.

IDictionary<string, string> kinetica.VisualizeIsochroneRequest.style_options = ""

getset

Various style related options of the isochrone image.

LINE_SIZE: The width of the contour lines in pixels. The default value is '3'.
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'.
BG_COLOR: When 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'.
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'.
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:
- JET
- ACCENT
- AFMHOT
- AUTUMN
- BINARY
- BLUES
- BONE
- BRBG
- BRG
- BUGN
- BUPU
- BWR
- CMRMAP
- COOL
- COOLWARM
- COPPER
- CUBEHELIX
- DARK2
- FLAG
- GIST_EARTH
- GIST_GRAY
- GIST_HEAT
- GIST_NCAR
- GIST_RAINBOW
- GIST_STERN
- GIST_YARG
- GNBU
- GNUPLOT2
- GNUPLOT
- GRAY
- GREENS
- GREYS
- HOT
- HSV
- INFERNO
- MAGMA
- NIPY_SPECTRAL
- OCEAN
- ORANGES
- ORRD
- PAIRED
- PASTEL1
- PASTEL2
- PINK
- PIYG
- PLASMA
- PRGN
- PRISM
- PUBU
- PUBUGN
- PUOR
- PURD
- PURPLES
- RAINBOW
- RDBU
- RDGY
- RDPU
- RDYLBU
- RDYLGN
- REDS
- SEISMIC
- SET1
- SET2
- SET3
- SPECTRAL
- SPRING
- SUMMER
- TERRAIN
- VIRIDIS
- WINTER
- WISTIA
- YLGN
- YLGNBU
- YLORBR
- YLORRD
The default value is JET.

Definition at line 1859 of file VisualizeIsochrone.cs.

IList<string> kinetica.VisualizeIsochroneRequest.weights_on_edges = -1.0

getset

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 List.

Definition at line 1464 of file VisualizeIsochrone.cs.

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

Kinetica/Protocol/VisualizeIsochrone.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation