veroviz.generateArcs module

createArcsFromLocSeq(locSeq=None, initArcs=None, startArc=1, objectID=None, leafletColor='orange', leafletWeight=3, leafletStyle='solid', leafletOpacity=0.8, leafletCurveType='straight', leafletCurvature=0, useArrows=True, cesiumColor='orange', cesiumWeight=3, cesiumStyle='solid', cesiumOpacity=0.8, popupText=None)[source]

Create an “arcs” dataframe from an ordered list of coordinates.

Parameters

  • locSeq (list of lists, Required, default as None) – An ordered list of locations that will be converted into an Arcs dataframe. The list should be formated as [[lat1, lon1], [lat2, lon2], …, [latn, lonn]].

  • initArcs (Arcs, Optional, default as None) – An Arcs dataframe. If provided, the arcs to be created will be appended to this dataframe.

  • startArc (int, Optional, default as 1) – Specifies the starting index number for the arcs. This will be reflected in the odID column of the resulting Arcs dataframe. If startArc is less than the minimum value of the odID found in the dataframe specified by initArcs, the value of startArc will be ignored in favor of the smallest integer greater than the maximum existing odID value.

  • objectID (int/string, Optional, default as None) – A descriptive name or index for a particular vehicle or object (e.g., ‘truck 1’, or ‘red car’).

  • leafletColor (string, Optional, default as "orange") – The color of the arcs when displayed in Leaflet. See Leaflet Style for a list of available colors.

  • leafletWeight (int, Optional, default as 3) – The pixel width of the arcs when displayed in Leaflet.

  • leafletStyle (string, Optional, default as 'solid') – The line style of the arcs when displayed in Leaflet. Valid options are ‘solid’, ‘dotted’, and ‘dashed’. See Leaflet Style for more information.

  • leafletOpacity (float in [0, 1], Optional, default as 0.8) – The opacity of the arcs when displayed in Leaflet. Valid values are in the range from 0 (invisible) to 1 (no transparency).

  • leafletCurveType (string, Optional, default as 'straight') – The type of curve to be shown on leaflet map for :ref:Arc dataframes (curves will not be applied to :ref:Assignments dataframes). The options are ‘Bezier’, ‘greatcircle’, and ‘straight’. If Bezier is provided, the leafletCurvature is also required. If greatcircle is provided, the arc follow the curvature of the Earth.

  • leafletCurvature (float in (-90, 90), Conditional, default as 45) – If leafletCurveType is ‘Bezier’, then leafletCurvature is required; otherwise this argument will not be used. The curvature specifies the angle between a straight line connecting the two nodes and the curved arc emanating from those two nodes. Therefore, this value should be in the open interval (-90, 90), although values in the (-45, 45) range tend to work best.

  • useArrows (bool, Optional, default as True) – Indicates whether arrows should be shown on the arcs when displayed in Leaflet.

  • cesiumColor (string, Optional, default as "orange") – The color of the arcs when displayed in Cesium. See Cesium Style for a list of available colors.

  • cesiumWeight (int, Optional, default as 3) – The pixel width of the arcs when displayed in Cesium.

  • cesiumStyle (string, Optional, default as 'solid') – The line style of the arcs when displayed in Cesium. Valid options are ‘solid’, ‘dotted’, and ‘dashed’. See Cesium Style for more information.

  • cesiumOpacity (float in [0, 1], Optional, default as 0.8) – The opacity of the arcs when displayed in Cesium. Valid values are in the range from 0 (invisible) to 1 (no transparency).

  • popupText (string, Optional, default as None) – Text (or HTML) that will be displayed when a user clicks on the arc in either Leaflet or Cesium.

Returns

An Arcs dataframe

Return type

Arcs

Examples

First import veroviz and check if it is the latest version
>>> import veroviz as vrv
>>> vrv.checkVersion()
Generate arcs from a given ordered list of coordinates:
>>> arcs = vrv.createArcsFromLocSeq(
...     locSeq=[
...         [42.1325, -78.2134],
...         [42.5341, -78.3252],
...         [42.3424, -78.6424]
...     ])
>>> arcs
Display the arcs on a Leaflet map:
>>> vrv.createLeaflet(arcs=arcs)
This example includes all of the available function arguments.
>>> arcs = vrv.createArcsFromLocSeq(
...     locSeq         = [[42.1325, -78.2134],
...                       [42.5341, -78.3252],
...                       [42.3424, -78.6424]],
...     initArcs       = None,
...     startArc       = 1,
...     objectID       = 'car',
...     leafletColor   = 'orange',
...     leafletWeight  = 5,
...     leafletStyle   = 'dashed',
...     leafletOpacity = 0.6,
...     useArrows      = False,
...     cesiumColor    = 'orange',
...     cesiumWeight   = 5,
...     cesiumStyle    = 'dashed',
...     cesiumOpacity  = 0.6,
...     popupText      = 'car route')
>>> vrv.createLeaflet(arcs=arcs)
createArcsFromNodeSeq(nodeSeq=None, nodes=None, initArcs=None, startArc=1, objectID=None, leafletColor='orange', leafletWeight=3, leafletStyle='solid', leafletOpacity=0.8, leafletCurveType='straight', leafletCurvature=0, useArrows=True, cesiumColor='orange', cesiumWeight=3, cesiumStyle='solid', cesiumOpacity=0.8, popupText=None)[source]

Create an “arcs” dataframe from an ordered list of node IDs. The “nodes” dataframe from which these node IDs are drawn must also be specified.

Parameters

  • nodeSeq (list, Required) – An ordered list of node IDs. These IDs must be included in the id column of the Nodes dataframe specified in the nodes input argument to this function. The format for nodeSeq is [node_id_1, node_id_2, …].

  • nodes (Nodes, Required) – A Nodes dataframe, which must contain the individual node IDs specified in the nodeSeq input argument.

  • initArcs (Arcs, Optional, default as None) – An Arcs dataframe. If provided, the arcs to be created will be appended to this dataframe.

  • startArc (int, Optional, default as 1) – Specifies the starting index number for the arcs. This will be reflected in the odID column of the resulting Arcs dataframe. If startArc is less than the minimum value of the odID found in the dataframe specified by initArcs, the value of startArc will be ignored in favor of the smallest integer greater than the maximum existing odID value.

  • objectID (int/string, Optional, default as None) – A descriptive name or index for a particular vehicle or object (e.g., ‘truck 1’, or ‘red car’).

  • leafletColor (string, Optional, default as "orange") – The color of the arcs when displayed in Leaflet. See Leaflet Style for a list of available colors.

  • leafletWeight (int, Optional, default as 3) – The pixel width of the arcs when displayed in Leaflet.

  • leafletStyle (string, Optional, default as 'solid') – The line style of the arcs when displayed in Leaflet. Valid options are ‘solid’, ‘dotted’, and ‘dashed’. See Leaflet Style for more information.

  • leafletOpacity (float in [0, 1], Optional, default as 0.8) – The opacity of the arcs when displayed in Leaflet. Valid values are in the range from 0 (invisible) to 1 (no transparency).

  • leafletCurveType (string, Optional, default as 'straight') – The type of curve to be shown on leaflet map for :ref:Arc dataframes (curves will not be applied to :ref:Assignments dataframes). The options are ‘Bezier’, ‘greatcircle’, and ‘straight’. If Bezier is provided, the leafletCurvature is also required. If greatcircle is provided, the arc follow the curvature of the Earth.

  • leafletCurvature (float in (-90, 90), Conditional, default as 45) – If leafletCurveType is ‘Bezier’, then leafletCurvature is required; otherwise this argument will not be used. The curvature specifies the angle between a straight line connecting the two nodes and the curved arc emanating from those two nodes. Therefore, this value should be in the open interval (-90, 90), although values in the (-45, 45) range tend to work best.

  • useArrows (bool, Optional, default as True) – Indicates whether arrows should be shown on the arcs when displayed in Leaflet.

  • cesiumColor (string, Optional, default as "orange") – The color of the arcs when displayed in Cesium. See Cesium Style for a list of available colors.

  • cesiumWeight (int, Optional, default as 3) – The pixel width of the arcs when displayed in Cesium.

  • cesiumStyle (string, Optional, default as 'solid') – The line style of the arcs when displayed in Cesium. Valid options are ‘solid’, ‘dotted’, and ‘dashed’. See Cesium Style for more information.

  • cesiumOpacity (float in [0, 1], Optional, default as 0.8) – The opacity of the arcs when displayed in Cesium. Valid values are in the range from 0 (invisible) to 1 (no transparency).

  • popupText (string, Optional, default as None) – Text (or HTML) that will be displayed when a user clicks on the arc in either Leaflet or Cesium.

Returns

An Arcs dataframe

Return type

Arcs

Examples

First import veroviz and check if it is the latest version
>>> import veroviz as vrv
>>> vrv.checkVersion()
Create a collection of 20 nodes:
>>> myNodes = vrv.generateNodes(
...     numNodes        = 20,
...     nodeType        = 'depot',
...     nodeDistrib     = 'normal',
...     nodeDistribArgs = {
...         'center' : [42.30, 78.00],
...         'stdDev' : 1000
...     })
>>> myNodes
Generate arcs from nodes 2-to-15 and from 15-to-8. These node IDs are found in the id column of the given Nodes dataframe.
>>> myArcs = vrv.createArcsFromNodeSeq(
...     nodeSeq = [2, 15, 8],
...     nodes   = myNodes)
>>> myArcs
Display the nodes and arcs on a Leaflet map:
>>> myMap = vrv.createLeaflet(arcs=myArcs, nodes=myNodes)
    >>> myMap
This example includes all of the available function arguments:
>>> moreArcs = vrv.createArcsFromNodeSeq(
...     nodeSeq        = [3, 16, 9],
...     nodes          = myNodes,
...     initArcs       = myArcs,
...     startArc       = 7,
...     objectID       = 'car',
...     leafletColor   = 'cadetblue',
...     leafletWeight  = 3,
...     leafletStyle   = 'dotted',
...     leafletOpacity = 0.8,
...     useArrows      = False,
...     cesiumColor    = 'cadetblue',
...     cesiumWeight   = 3,
...     cesiumStyle    = 'dotted',
...     cesiumOpacity  = 0.8,
...     popupText      = 'car route')
>>> moreArcs
Display the nodes and arcs on a Leaflet map:
>>> vrv.createLeaflet(mapObject=myMap, arcs = moreArcs)