Kinetica C# API  Version 7.1.10.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 
28  {
29 
47  public struct GenerateImage
48  {
49  public const string TRUE = "true";
50  public const string FALSE = "false";
51  } // end struct GenerateImage
52 
53 
404  public struct StyleOptions
405  {
406 
409  public const string LINE_SIZE = "line_size";
410 
416  public const string COLOR = "color";
417 
422  public const string BG_COLOR = "bg_color";
423 
428  public const string TEXT_COLOR = "text_color";
429 
738  public const string COLORMAP = "colormap";
739  public const string JET = "jet";
740  public const string ACCENT = "accent";
741  public const string AFMHOT = "afmhot";
742  public const string AUTUMN = "autumn";
743  public const string BINARY = "binary";
744  public const string BLUES = "blues";
745  public const string BONE = "bone";
746  public const string BRBG = "brbg";
747  public const string BRG = "brg";
748  public const string BUGN = "bugn";
749  public const string BUPU = "bupu";
750  public const string BWR = "bwr";
751  public const string CMRMAP = "cmrmap";
752  public const string COOL = "cool";
753  public const string COOLWARM = "coolwarm";
754  public const string COPPER = "copper";
755  public const string CUBEHELIX = "cubehelix";
756  public const string DARK2 = "dark2";
757  public const string FLAG = "flag";
758  public const string GIST_EARTH = "gist_earth";
759  public const string GIST_GRAY = "gist_gray";
760  public const string GIST_HEAT = "gist_heat";
761  public const string GIST_NCAR = "gist_ncar";
762  public const string GIST_RAINBOW = "gist_rainbow";
763  public const string GIST_STERN = "gist_stern";
764  public const string GIST_YARG = "gist_yarg";
765  public const string GNBU = "gnbu";
766  public const string GNUPLOT2 = "gnuplot2";
767  public const string GNUPLOT = "gnuplot";
768  public const string GRAY = "gray";
769  public const string GREENS = "greens";
770  public const string GREYS = "greys";
771  public const string HOT = "hot";
772  public const string HSV = "hsv";
773  public const string INFERNO = "inferno";
774  public const string MAGMA = "magma";
775  public const string NIPY_SPECTRAL = "nipy_spectral";
776  public const string OCEAN = "ocean";
777  public const string ORANGES = "oranges";
778  public const string ORRD = "orrd";
779  public const string PAIRED = "paired";
780  public const string PASTEL1 = "pastel1";
781  public const string PASTEL2 = "pastel2";
782  public const string PINK = "pink";
783  public const string PIYG = "piyg";
784  public const string PLASMA = "plasma";
785  public const string PRGN = "prgn";
786  public const string PRISM = "prism";
787  public const string PUBU = "pubu";
788  public const string PUBUGN = "pubugn";
789  public const string PUOR = "puor";
790  public const string PURD = "purd";
791  public const string PURPLES = "purples";
792  public const string RAINBOW = "rainbow";
793  public const string RDBU = "rdbu";
794  public const string RDGY = "rdgy";
795  public const string RDPU = "rdpu";
796  public const string RDYLBU = "rdylbu";
797  public const string RDYLGN = "rdylgn";
798  public const string REDS = "reds";
799  public const string SEISMIC = "seismic";
800  public const string SET1 = "set1";
801  public const string SET2 = "set2";
802  public const string SET3 = "set3";
803  public const string SPECTRAL = "spectral";
804  public const string SPRING = "spring";
805  public const string SUMMER = "summer";
806  public const string TERRAIN = "terrain";
807  public const string VIRIDIS = "viridis";
808  public const string WINTER = "winter";
809  public const string WISTIA = "wistia";
810  public const string YLGN = "ylgn";
811  public const string YLGNBU = "ylgnbu";
812  public const string YLORBR = "ylorbr";
813  public const string YLORRD = "ylorrd";
814  } // end struct StyleOptions
815 
816 
859  public struct SolveOptions
860  {
861 
878  public const string REMOVE_PREVIOUS_RESTRICTIONS = "remove_previous_restrictions";
879  public const string TRUE = "true";
880  public const string FALSE = "false";
881 
886  public const string RESTRICTION_THRESHOLD_VALUE = "restriction_threshold_value";
887 
891  public const string UNIFORM_WEIGHTS = "uniform_weights";
892  } // end struct SolveOptions
893 
894 
1066  public struct ContourOptions
1067  {
1068 
1111  public const string PROJECTION = "projection";
1112  public const string _3857 = "3857";
1113  public const string _102100 = "102100";
1114  public const string _900913 = "900913";
1115  public const string EPSG_4326 = "EPSG:4326";
1116  public const string PLATE_CARREE = "PLATE_CARREE";
1117  public const string EPSG_900913 = "EPSG:900913";
1118  public const string EPSG_102100 = "EPSG:102100";
1119  public const string EPSG_3857 = "EPSG:3857";
1120  public const string WEB_MERCATOR = "WEB_MERCATOR";
1121 
1125  public const string WIDTH = "width";
1126 
1132  public const string HEIGHT = "height";
1133 
1137  public const string SEARCH_RADIUS = "search_radius";
1138 
1143  public const string GRID_SIZE = "grid_size";
1144 
1160  public const string COLOR_ISOLINES = "color_isolines";
1161  public const string TRUE = "true";
1162  public const string FALSE = "false";
1163 
1178  public const string ADD_LABELS = "add_labels";
1179 
1183  public const string LABELS_FONT_SIZE = "labels_font_size";
1184 
1188  public const string LABELS_FONT_FAMILY = "labels_font_family";
1189 
1196  public const string LABELS_SEARCH_WINDOW = "labels_search_window";
1197 
1202  public const string LABELS_INTRALEVEL_SEPARATION = "labels_intralevel_separation";
1203 
1208  public const string LABELS_INTERLEVEL_SEPARATION = "labels_interlevel_separation";
1209 
1213  public const string LABELS_MAX_ANGLE = "labels_max_angle";
1214  } // end struct ContourOptions
1215 
1216 
1336  public struct Options
1337  {
1338 
1349  public const string SOLVE_TABLE = "solve_table";
1350 
1366  public const string IS_REPLICATED = "is_replicated";
1367 
1370  public const string TRUE = "true";
1371 
1374  public const string FALSE = "false";
1375 
1378  public const string DATA_MIN_X = "data_min_x";
1379 
1382  public const string DATA_MAX_X = "data_max_x";
1383 
1386  public const string DATA_MIN_Y = "data_min_y";
1387 
1390  public const string DATA_MAX_Y = "data_max_y";
1391 
1396  public const string CONCAVITY_LEVEL = "concavity_level";
1397 
1417  public const string USE_PRIORITY_QUEUE_SOLVERS = "use_priority_queue_solvers";
1418 
1438  public const string SOLVE_DIRECTION = "solve_direction";
1439 
1442  public const string FROM_SOURCE = "from_source";
1443 
1445  public const string TO_SOURCE = "to_source";
1446  } // end struct Options
1447 
1448 
1451  public string graph_name { get; set; }
1452 
1455  public string source_node { get; set; }
1456 
1460  public double max_solution_radius { get; set; } = -1.0;
1461 
1474  public IList<string> weights_on_edges { get; set; } = new List<string>();
1475 
1491  public IList<string> restrictions { get; set; } = new List<string>();
1492 
1495  public int num_levels { get; set; } = 1;
1496 
1513  public bool generate_image { get; set; } = true;
1514 
1524  public string levels_table { get; set; } = "";
1525 
1874  public IDictionary<string, string> style_options { get; set; } = new Dictionary<string, string>();
1875 
1916  public IDictionary<string, string> solve_options { get; set; } = new Dictionary<string, string>();
1917 
2087  public IDictionary<string, string> contour_options { get; set; } = new Dictionary<string, string>();
2088 
2206  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
2207 
2208 
2212 
2956  string source_node,
2957  double? max_solution_radius,
2958  IList<string> weights_on_edges,
2959  IList<string> restrictions,
2960  int? num_levels,
2961  bool? generate_image,
2962  string levels_table,
2963  IDictionary<string, string> style_options,
2964  IDictionary<string, string> solve_options = null,
2965  IDictionary<string, string> contour_options = null,
2966  IDictionary<string, string> options = null)
2967  {
2968  this.graph_name = graph_name ?? "";
2969  this.source_node = source_node ?? "";
2970  this.max_solution_radius = max_solution_radius ?? -1.0;
2971  this.weights_on_edges = weights_on_edges ?? new List<string>();
2972  this.restrictions = restrictions ?? new List<string>();
2973  this.num_levels = num_levels ?? 1;
2974  this.generate_image = generate_image ?? true;
2975  this.levels_table = levels_table ?? "";
2976  this.style_options = style_options ?? new Dictionary<string, string>();
2977  this.solve_options = solve_options ?? new Dictionary<string, string>();
2978  this.contour_options = contour_options ?? new Dictionary<string, string>();
2979  this.options = options ?? new Dictionary<string, string>();
2980  } // end constructor
2981 
2982  } // end class VisualizeIsochroneRequest
2983 
2984 
2985 
2990  {
2991 
2994  public int width { get; set; }
2995 
2998  public int height { get; set; }
2999 
3002  public long bg_color { get; set; }
3003 
3005  public byte[] image_data { get; set; }
3006 
3008  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
3009 
3011  public IDictionary<string, string> solve_info { get; set; } = new Dictionary<string, string>();
3012 
3014  public IDictionary<string, string> contour_info { get; set; } = new Dictionary<string, string>();
3015 
3016  } // end class VisualizeIsochroneResponse
3017 
3018 
3019 
3020 
3021 } // 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, in [schema_name.
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 &#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, in [schema_name.
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, in [schema_name.
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.