Kinetica C# API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
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 
10 
11 namespace kinetica
12 {
13 
27  {
28 
46  public struct GenerateImage
47  {
48  public const string TRUE = "true";
49  public const string FALSE = "false";
50  } // end struct GenerateImage
51 
52 
403  public struct StyleOptions
404  {
405 
408  public const string LINE_SIZE = "line_size";
409 
415  public const string COLOR = "color";
416 
421  public const string BG_COLOR = "bg_color";
422 
427  public const string TEXT_COLOR = "text_color";
428 
737  public const string COLORMAP = "colormap";
738  public const string JET = "jet";
739  public const string ACCENT = "accent";
740  public const string AFMHOT = "afmhot";
741  public const string AUTUMN = "autumn";
742  public const string BINARY = "binary";
743  public const string BLUES = "blues";
744  public const string BONE = "bone";
745  public const string BRBG = "brbg";
746  public const string BRG = "brg";
747  public const string BUGN = "bugn";
748  public const string BUPU = "bupu";
749  public const string BWR = "bwr";
750  public const string CMRMAP = "cmrmap";
751  public const string COOL = "cool";
752  public const string COOLWARM = "coolwarm";
753  public const string COPPER = "copper";
754  public const string CUBEHELIX = "cubehelix";
755  public const string DARK2 = "dark2";
756  public const string FLAG = "flag";
757  public const string GIST_EARTH = "gist_earth";
758  public const string GIST_GRAY = "gist_gray";
759  public const string GIST_HEAT = "gist_heat";
760  public const string GIST_NCAR = "gist_ncar";
761  public const string GIST_RAINBOW = "gist_rainbow";
762  public const string GIST_STERN = "gist_stern";
763  public const string GIST_YARG = "gist_yarg";
764  public const string GNBU = "gnbu";
765  public const string GNUPLOT2 = "gnuplot2";
766  public const string GNUPLOT = "gnuplot";
767  public const string GRAY = "gray";
768  public const string GREENS = "greens";
769  public const string GREYS = "greys";
770  public const string HOT = "hot";
771  public const string HSV = "hsv";
772  public const string INFERNO = "inferno";
773  public const string MAGMA = "magma";
774  public const string NIPY_SPECTRAL = "nipy_spectral";
775  public const string OCEAN = "ocean";
776  public const string ORANGES = "oranges";
777  public const string ORRD = "orrd";
778  public const string PAIRED = "paired";
779  public const string PASTEL1 = "pastel1";
780  public const string PASTEL2 = "pastel2";
781  public const string PINK = "pink";
782  public const string PIYG = "piyg";
783  public const string PLASMA = "plasma";
784  public const string PRGN = "prgn";
785  public const string PRISM = "prism";
786  public const string PUBU = "pubu";
787  public const string PUBUGN = "pubugn";
788  public const string PUOR = "puor";
789  public const string PURD = "purd";
790  public const string PURPLES = "purples";
791  public const string RAINBOW = "rainbow";
792  public const string RDBU = "rdbu";
793  public const string RDGY = "rdgy";
794  public const string RDPU = "rdpu";
795  public const string RDYLBU = "rdylbu";
796  public const string RDYLGN = "rdylgn";
797  public const string REDS = "reds";
798  public const string SEISMIC = "seismic";
799  public const string SET1 = "set1";
800  public const string SET2 = "set2";
801  public const string SET3 = "set3";
802  public const string SPECTRAL = "spectral";
803  public const string SPRING = "spring";
804  public const string SUMMER = "summer";
805  public const string TERRAIN = "terrain";
806  public const string VIRIDIS = "viridis";
807  public const string WINTER = "winter";
808  public const string WISTIA = "wistia";
809  public const string YLGN = "ylgn";
810  public const string YLGNBU = "ylgnbu";
811  public const string YLORBR = "ylorbr";
812  public const string YLORRD = "ylorrd";
813  } // end struct StyleOptions
814 
815 
858  public struct SolveOptions
859  {
860 
877  public const string REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions";
878  public const string TRUE = "true";
879  public const string FALSE = "false";
880 
885  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
886 
890  public const string UNIFORM_WEIGHTS = "uniform_weights";
891  } // end struct SolveOptions
892 
893 
1065  public struct ContourOptions
1066  {
1067 
1110  public const string PROJECTION = "projection";
1111  public const string _3857 = "3857";
1112  public const string _102100 = "102100";
1113  public const string _900913 = "900913";
1114  public const string EPSG_4326 = "EPSG:4326";
1115  public const string PLATE_CARREE = "PLATE_CARREE";
1116  public const string EPSG_900913 = "EPSG:900913";
1117  public const string EPSG_102100 = "EPSG:102100";
1118  public const string EPSG_3857 = "EPSG:3857";
1119  public const string WEB_MERCATOR = "WEB_MERCATOR";
1120 
1124  public const string WIDTH = "width";
1125 
1131  public const string HEIGHT = "height";
1132 
1136  public const string SEARCH_RADIUS = "search_radius";
1137 
1142  public const string GRID_SIZE = "grid_size";
1143 
1159  public const string COLOR_ISOLINES = "color_isolines";
1160  public const string TRUE = "true";
1161  public const string FALSE = "false";
1162 
1177  public const string ADD_LABELS = "add_labels";
1178 
1182  public const string LABELS_FONT_SIZE = "labels_font_size";
1183 
1187  public const string LABELS_FONT_FAMILY = "labels_font_family";
1188 
1195  public const string LABELS_SEARCH_WINDOW = "labels_search_window";
1196 
1201  public const string LABELS_INTRALEVEL_SEPARATION = "labels_intralevel_separation";
1202 
1207  public const string LABELS_INTERLEVEL_SEPARATION = "labels_interlevel_separation";
1208 
1212  public const string LABELS_MAX_ANGLE = "labels_max_angle";
1213  } // end struct ContourOptions
1214 
1215 
1331  public struct Options
1332  {
1333 
1339  public const string SOLVE_TABLE = "solve_table";
1340 
1356  public const string IS_REPLICATED = "is_replicated";
1357 
1360  public const string TRUE = "true";
1361 
1364  public const string FALSE = "false";
1365 
1368  public const string DATA_MIN_X = "data_min_x";
1369 
1372  public const string DATA_MAX_X = "data_max_x";
1373 
1376  public const string DATA_MIN_Y = "data_min_y";
1377 
1380  public const string DATA_MAX_Y = "data_max_y";
1381 
1386  public const string CONCAVITY_LEVEL = "concavity_level";
1387 
1407  public const string USE_PRIORITY_QUEUE_SOLVERS = "use_priority_queue_solvers";
1408 
1428  public const string SOLVE_DIRECTION = "solve_direction";
1429 
1432  public const string FROM_SOURCE = "from_source";
1433 
1435  public const string TO_SOURCE = "to_source";
1436  } // end struct Options
1437 
1438 
1441  public string graph_name { get; set; }
1442 
1445  public string source_node { get; set; }
1446 
1450  public double max_solution_radius { get; set; } = -1.0;
1451 
1464  public IList<string> weights_on_edges { get; set; } = new List<string>();
1465 
1481  public IList<string> restrictions { get; set; } = new List<string>();
1482 
1485  public int num_levels { get; set; } = 1;
1486 
1503  public bool generate_image { get; set; } = true;
1504 
1509  public string levels_table { get; set; } = "";
1510 
1859  public IDictionary<string, string> style_options { get; set; } = new Dictionary<string, string>();
1860 
1901  public IDictionary<string, string> solve_options { get; set; } = new Dictionary<string, string>();
1902 
2072  public IDictionary<string, string> contour_options { get; set; } = new Dictionary<string, string>();
2073 
2187  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
2188 
2189 
2193 
2928  string source_node,
2929  double? max_solution_radius,
2930  IList<string> weights_on_edges,
2931  IList<string> restrictions,
2932  int? num_levels,
2933  bool? generate_image,
2934  string levels_table,
2935  IDictionary<string, string> style_options,
2936  IDictionary<string, string> solve_options = null,
2937  IDictionary<string, string> contour_options = null,
2938  IDictionary<string, string> options = null)
2939  {
2940  this.graph_name = graph_name ?? "";
2941  this.source_node = source_node ?? "";
2942  this.max_solution_radius = max_solution_radius ?? -1.0;
2943  this.weights_on_edges = weights_on_edges ?? new List<string>();
2944  this.restrictions = restrictions ?? new List<string>();
2945  this.num_levels = num_levels ?? 1;
2946  this.generate_image = generate_image ?? true;
2947  this.levels_table = levels_table ?? "";
2948  this.style_options = style_options ?? new Dictionary<string, string>();
2949  this.solve_options = solve_options ?? new Dictionary<string, string>();
2950  this.contour_options = contour_options ?? new Dictionary<string, string>();
2951  this.options = options ?? new Dictionary<string, string>();
2952  } // end constructor
2953 
2954  } // end class VisualizeIsochroneRequest
2955 
2956 
2957 
2962  {
2963 
2966  public int width { get; set; }
2967 
2970  public int height { get; set; }
2971 
2974  public long bg_color { get; set; }
2975 
2977  public byte[] image_data { get; set; }
2978 
2980  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
2981 
2983  public IDictionary<string, string> solve_info { get; set; } = new Dictionary<string, string>();
2984 
2986  public IDictionary<string, string> contour_info { get; set; } = new Dictionary<string, string>();
2987 
2988  } // end class VisualizeIsochroneResponse
2989 
2990 
2991 
2992 
2993 } // 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.
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 SOLVE_TABLE: Name of the table to host intermediate solve results containing th...
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, containing levels and their corresponding WKT geometry...
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 &#39;priority_queue&#39; and &#39;inverse_priority_queue&#39; 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 PROJECTION: Spatial Reference System (i.e.
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.
If set to true, generates a PNG image of the isochrones in the response.
const string HEIGHT
When generate_image is set to true, height of the generated image.
Additional parameters SOLVE_TABLE: Name of the table to host intermediate solve results containing th...
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(string,string,double,IList{string},IList{string},int,bool,string,IDictionary{string, string},IDictionary{string, string},IDictionary{string, string},IDictionary{string, string}).
IDictionary< string, string > solve_options
Solver specific parameters REMOVE_PREVIOUS_RESTRICTIONS: Ignore the restrictions applied to the graph...
Various style related options of the isochrone image.
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(string,string,double,IList{string},IList{string},int,bool,string,IDictionary{string, string},IDictionary{string, string},IDictionary{string, string},IDictionary{string, string}).
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 &#39;shortest_path&#39; and &#39;inverse_shortest_path&#39; based on solve_direction...
double max_solution_radius
Extent of the search radius around .
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.
Solver specific parameters PROJECTION: Spatial Reference System (i.e.
const string USE_PRIORITY_QUEUE_SOLVERS
sets the solver methods explicitly if true Supported values: TRUE: uses the solvers scheduled for &#39;sh...
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 containing the position and cost for each vertex...
const string UNIFORM_WEIGHTS
When specified, assigns the given value to all the edges in the graph.
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 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.
Solver specific parameters REMOVE_PREVIOUS_RESTRICTIONS: Ignore the restrictions applied to the graph...
const string COLOR
Color of generated isolines.