Kinetica   C#   API  Version 7.2.3.0
VisualizeIsochrone.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
21  {
27  public struct GenerateImage
28  {
29  public const string TRUE = "true";
30  public const string FALSE = "false";
31  } // end struct GenerateImage
32 
37  public struct StyleOptions
38  {
43  public const string LINE_SIZE = "line_size";
44 
51  public const string COLOR = "color";
52 
59  public const string BG_COLOR = "bg_color";
60 
68  public const string TEXT_COLOR = "text_color";
69 
345  public const string COLORMAP = "colormap";
346 
347  public const string JET = "jet";
348  public const string ACCENT = "accent";
349  public const string AFMHOT = "afmhot";
350  public const string AUTUMN = "autumn";
351  public const string BINARY = "binary";
352  public const string BLUES = "blues";
353  public const string BONE = "bone";
354  public const string BRBG = "brbg";
355  public const string BRG = "brg";
356  public const string BUGN = "bugn";
357  public const string BUPU = "bupu";
358  public const string BWR = "bwr";
359  public const string CMRMAP = "cmrmap";
360  public const string COOL = "cool";
361  public const string COOLWARM = "coolwarm";
362  public const string COPPER = "copper";
363  public const string CUBEHELIX = "cubehelix";
364  public const string DARK2 = "dark2";
365  public const string FLAG = "flag";
366  public const string GIST_EARTH = "gist_earth";
367  public const string GIST_GRAY = "gist_gray";
368  public const string GIST_HEAT = "gist_heat";
369  public const string GIST_NCAR = "gist_ncar";
370  public const string GIST_RAINBOW = "gist_rainbow";
371  public const string GIST_STERN = "gist_stern";
372  public const string GIST_YARG = "gist_yarg";
373  public const string GNBU = "gnbu";
374  public const string GNUPLOT2 = "gnuplot2";
375  public const string GNUPLOT = "gnuplot";
376  public const string GRAY = "gray";
377  public const string GREENS = "greens";
378  public const string GREYS = "greys";
379  public const string HOT = "hot";
380  public const string HSV = "hsv";
381  public const string INFERNO = "inferno";
382  public const string MAGMA = "magma";
383  public const string NIPY_SPECTRAL = "nipy_spectral";
384  public const string OCEAN = "ocean";
385  public const string ORANGES = "oranges";
386  public const string ORRD = "orrd";
387  public const string PAIRED = "paired";
388  public const string PASTEL1 = "pastel1";
389  public const string PASTEL2 = "pastel2";
390  public const string PINK = "pink";
391  public const string PIYG = "piyg";
392  public const string PLASMA = "plasma";
393  public const string PRGN = "prgn";
394  public const string PRISM = "prism";
395  public const string PUBU = "pubu";
396  public const string PUBUGN = "pubugn";
397  public const string PUOR = "puor";
398  public const string PURD = "purd";
399  public const string PURPLES = "purples";
400  public const string RAINBOW = "rainbow";
401  public const string RDBU = "rdbu";
402  public const string RDGY = "rdgy";
403  public const string RDPU = "rdpu";
404  public const string RDYLBU = "rdylbu";
405  public const string RDYLGN = "rdylgn";
406  public const string REDS = "reds";
407  public const string SEISMIC = "seismic";
408  public const string SET1 = "set1";
409  public const string SET2 = "set2";
410  public const string SET3 = "set3";
411  public const string SPECTRAL = "spectral";
412  public const string SPRING = "spring";
413  public const string SUMMER = "summer";
414  public const string TERRAIN = "terrain";
415  public const string VIRIDIS = "viridis";
416  public const string WINTER = "winter";
417  public const string WISTIA = "wistia";
418  public const string YLGN = "ylgn";
419  public const string YLGNBU = "ylgnbu";
420  public const string YLORBR = "ylorbr";
421  public const string YLORRD = "ylorrd";
422  } // end struct StyleOptions
423 
427  public struct SolveOptions
428  {
444  public const string REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions";
445 
446  public const string TRUE = "true";
447  public const string FALSE = "false";
448 
454  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
455 
461  public const string UNIFORM_WEIGHTS = "uniform_weights";
462  } // end struct SolveOptions
463 
467  public struct ContourOptions
468  {
516  public const string PROJECTION = "projection";
517 
518  public const string _3857 = "3857";
519  public const string _102100 = "102100";
520  public const string _900913 = "900913";
521  public const string EPSG_4326 = "EPSG:4326";
522  public const string PLATE_CARREE = "PLATE_CARREE";
523  public const string EPSG_900913 = "EPSG:900913";
524  public const string EPSG_102100 = "EPSG:102100";
525  public const string EPSG_3857 = "EPSG:3857";
526  public const string WEB_MERCATOR = "WEB_MERCATOR";
527 
532  public const string WIDTH = "width";
533 
542  public const string HEIGHT = "height";
543 
548  public const string SEARCH_RADIUS = "search_radius";
549 
555  public const string GRID_SIZE = "grid_size";
556 
571  public const string COLOR_ISOLINES = "color_isolines";
572 
573  public const string TRUE = "true";
574  public const string FALSE = "false";
575 
590  public const string ADD_LABELS = "add_labels";
591 
597  public const string LABELS_FONT_SIZE = "labels_font_size";
598 
604  public const string LABELS_FONT_FAMILY = "labels_font_family";
605 
616  public const string LABELS_SEARCH_WINDOW = "labels_search_window";
617 
625  public const string LABELS_INTRALEVEL_SEPARATION = "labels_intralevel_separation";
626 
633  public const string LABELS_INTERLEVEL_SEPARATION = "labels_interlevel_separation";
634 
640  public const string LABELS_MAX_ANGLE = "labels_max_angle";
641  } // end struct ContourOptions
642 
646  public struct Options
647  {
658  public const string SOLVE_TABLE = "solve_table";
659 
674  public const string IS_REPLICATED = "is_replicated";
675 
678  public const string TRUE = "true";
679 
682  public const string FALSE = "false";
683 
687  public const string DATA_MIN_X = "data_min_x";
688 
692  public const string DATA_MAX_X = "data_max_x";
693 
697  public const string DATA_MIN_Y = "data_min_y";
698 
702  public const string DATA_MAX_Y = "data_max_y";
703 
710  public const string CONCAVITY_LEVEL = "concavity_level";
711 
730  public const string USE_PRIORITY_QUEUE_SOLVERS = "use_priority_queue_solvers";
731 
751  public const string SOLVE_DIRECTION = "solve_direction";
752 
755  public const string FROM_SOURCE = "from_source";
756 
758  public const string TO_SOURCE = "to_source";
759  } // end struct Options
760 
763  public string graph_name { get; set; }
764 
767  public string source_node { get; set; }
768 
773  public double max_solution_radius { get; set; } = -1.0;
774 
788  public IList<string> weights_on_edges { get; set; } = new List<string>();
789 
809  public IList<string> restrictions { get; set; } = new List<string>();
810 
814  public int num_levels { get; set; } = 1;
815 
828  public bool generate_image { get; set; } = true;
829 
839  public string levels_table { get; set; } = "";
840 
1195  public IDictionary<string, string> style_options { get; set; } = new Dictionary<string, string>();
1196 
1242  public IDictionary<string, string> solve_options { get; set; } = new Dictionary<string, string>();
1243 
1443  public IDictionary<string, string> contour_options { get; set; } = new Dictionary<string, string>();
1444 
1568  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
1569 
1573 
2361  string source_node,
2362  double? max_solution_radius,
2363  IList<string> weights_on_edges,
2364  IList<string> restrictions,
2365  int? num_levels,
2366  bool? generate_image,
2367  string levels_table,
2368  IDictionary<string, string> style_options,
2369  IDictionary<string, string> solve_options = null,
2370  IDictionary<string, string> contour_options = null,
2371  IDictionary<string, string> options = null)
2372  {
2373  this.graph_name = graph_name ?? "";
2374  this.source_node = source_node ?? "";
2375  this.max_solution_radius = max_solution_radius ?? -1.0;
2376  this.weights_on_edges = weights_on_edges ?? new List<string>();
2377  this.restrictions = restrictions ?? new List<string>();
2378  this.num_levels = num_levels ?? 1;
2379  this.generate_image = generate_image ?? true;
2380  this.levels_table = levels_table ?? "";
2381  this.style_options = style_options ?? new Dictionary<string, string>();
2382  this.solve_options = solve_options ?? new Dictionary<string, string>();
2383  this.contour_options = contour_options ?? new Dictionary<string, string>();
2384  this.options = options ?? new Dictionary<string, string>();
2385  } // end constructor
2386  } // end class VisualizeIsochroneRequest
2387 
2392  {
2396  public int width { get; set; }
2397 
2401  public int height { get; set; }
2402 
2406  public long bg_color { get; set; }
2407 
2409  public byte[] image_data { get; set; }
2410 
2412  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2413 
2415  public IDictionary<string, string> solve_info { get; set; } = new Dictionary<string, string>();
2416 
2418  public IDictionary<string, string> contour_info { get; set; } = new Dictionary<string, string>();
2419  } // end class VisualizeIsochroneResponse
2420 } // end namespace kinetica
const string DATA_MAX_Y
Upper bound for the y values.
IDictionary< string, string > info
Additional information.
byte [] image_data
Generated contour image data.
bool generate_image
If set to TRUE, generates a PNG image of the isochrones in the response.
int height
Height of the image as provided in HEIGHT.
const string GRID_SIZE
When interpolating the graph solution to generate the isochrone, number of subdivisions along the x a...
string graph_name
Name of the graph on which the isochrone is to be computed.
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.
const string REMOVE_PREVIOUS_RESTRICTIONS
Ignore the restrictions applied to the graph during the creation stage and only use the restrictions ...
IDictionary< string, string > options
Additional parameters.
int num_levels
Number of equally-separated isochrones to compute.
IList< string > weights_on_edges
Additional weights to apply to the edges of an existing graph.
string levels_table
Name of the table to output the isochrones to, in [schema_name.
const string SOLVE_DIRECTION
Specify whether we are going to the source node, or starting from it.
long bg_color
Background color of the image as provided in BG_COLOR.
IDictionary< string, string > contour_info
Additional information.
IDictionary< string, string > solve_info
Additional information.
const string LABELS_MAX_ANGLE
When ADD_LABELS is set to TRUE, maximum angle (in degrees) from the vertical to use when adding label...
const string FALSE
uses the solvers 'priority_queue' and 'inverse_priority_queue' based on solve_direction
const string RESTRICTION_THRESHOLD_VALUE
Value-based restriction comparison.
IList< string > restrictions
Additional restrictions to apply to the nodes/edges of an existing graph.
const string PROJECTION
Spatial Reference System (i.e.
IDictionary< string, string > style_options
Various style related options of the isochrone image.
const string COLOR_ISOLINES
Color each isoline according to the colormap; otherwise, use the foreground color.
const string ADD_LABELS
If set to TRUE, add labels to the isolines.
const string WIDTH
When generate_image is set to TRUE, width of the generated image.
const string DATA_MIN_Y
Lower bound for the y values.
const string SEARCH_RADIUS
When interpolating the graph solution to generate the isochrone, neighborhood of influence of sample ...
const string COLORMAP
Colormap for contours or fill-in regions when applicable.
const string TO_SOURCE
Shortest path to source (Dijkstra)
IDictionary< string, string > contour_options
Solver specific parameters.
const string IS_REPLICATED
If set to TRUE, replicate the SOLVE_TABLE.
const string LABELS_SEARCH_WINDOW
When ADD_LABELS is set to TRUE, a search window is used to rate the local quality of each isoline.
const string LINE_SIZE
The width of the contour lines in pixels.
A set of string constants for the parameter generate_image.
const string HEIGHT
When generate_image is set to TRUE, height of the generated image.
A set of string constants for the parameter options.
const string CONCAVITY_LEVEL
Factor to qualify the concavity of the isochrone curves.
const string DATA_MIN_X
Lower bound for the x values.
string source_node
Starting vertex on the underlying graph from/to which the isochrones are created.
VisualizeIsochroneRequest()
Constructs a VisualizeIsochroneRequest object with default parameters.
A set of parameters for Kinetica.visualizeIsochrone.
IDictionary< string, string > solve_options
Solver specific parameters.
A set of string constants for the parameter style_options.
const string LABELS_INTRALEVEL_SEPARATION
When ADD_LABELS is set to TRUE, this value determines the distance (in multiples of the LABELS_FONT_S...
A set of results returned by Kinetica.visualizeIsochrone.
const string LABELS_FONT_SIZE
When ADD_LABELS is set to TRUE, size of the font (in pixels) to use for labels.
const string TRUE
uses the solvers scheduled for 'shortest_path' and 'inverse_shortest_path' based on solve_direction
double max_solution_radius
Extent of the search radius around source_node.
const string BG_COLOR
When generate_image is set to TRUE, background color of the generated image.
int width
Width of the image as provided in WIDTH.
A set of string constants for the parameter contour_options.
const string USE_PRIORITY_QUEUE_SOLVERS
sets the solver methods explicitly if true.
const string LABELS_INTERLEVEL_SEPARATION
When ADD_LABELS is set to TRUE, this value determines the distance (in percent of the total window si...
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string TEXT_COLOR
When ADD_LABELS is set to TRUE, color for the labels.
const string SOLVE_TABLE
Name of the table to host intermediate solve results, in [schema_name.
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
const string DATA_MAX_X
Upper bound for the x values.
const string FROM_SOURCE
Shortest path to get to the source (inverse Dijkstra)
const string LABELS_FONT_FAMILY
When ADD_LABELS is set to TRUE, font name to be used when adding labels.
A set of string constants for the parameter solve_options.
const string COLOR
Color of generated isolines.