> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # visualizeIsochrone

◆ visualizeIsochrone() \[1/2]

VisualizeIsochroneResponse kinetica.Kinetica.visualizeIsochrone ( 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

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

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 source\_node . 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 to, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. The table will contain 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.
solve\_options Solver specific parameters. The default value is an empty Dictionary.
contour\_options Contour specific parameters. The default value is an empty Dictionary.
options Additional parameters.
  • SOLVE\_TABLE: Name of the table to host intermediate solve results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. This table will contain 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: 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'. The minimum allowed value is '0'. The maximum allowed value is '1'.
  • 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.
Returns
Response object containing the result of the operation.

Definition at line 68452 of file KineticaFunctions.cs.

◆ visualizeIsochrone() \[2/2]

VisualizeIsochroneResponse kinetica.Kinetica.visualizeIsochrone ( VisualizeIsochroneRequest request\_ )
inline

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

Parameters
request\_ Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 67502 of file KineticaFunctions.cs.

◆ VisualizeIsochroneAsync() \[1/2]

async System.Threading.Tasks.Task\< VisualizeIsochroneResponse > kinetica.Kinetica.VisualizeIsochroneAsync ( 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,
System.Threading.CancellationToken cancellationToken = default )
inline

Generate an image containing isolines for travel results using an existing graph.

(async)

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.

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 source\_node . 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 to, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. The table will contain 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.
solve\_options Solver specific parameters. The default value is an empty Dictionary.
contour\_options Contour specific parameters. The default value is an empty Dictionary.
options Additional parameters.
  • SOLVE\_TABLE: Name of the table to host intermediate solve results, in \[schema\_name.]table\_name format, using standard name resolution rules and meeting table naming criteria. This table will contain 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: 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'. The minimum allowed value is '0'. The maximum allowed value is '1'.
  • 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.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 69400 of file KineticaFunctions.cs.

◆ VisualizeIsochroneAsync() \[2/2]

async System.Threading.Tasks.Task\< VisualizeIsochroneResponse > kinetica.Kinetica.VisualizeIsochroneAsync ( VisualizeIsochroneRequest request\_,
System.Threading.CancellationToken cancellationToken = default )
inline

Generate an image containing isolines for travel results using an existing graph.

(async)

Isolines represent curves of equal cost, with cost typically referring to the time or distance assigned as the weights of the underlying graph. See Graphs and Solvers for more information on graphs.

Parameters
request\_ Request object containing the parameters for the operation.
cancellationToken Cancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 67523 of file KineticaFunctions.cs.

Member Data Documentation