veroviz.generateNodes module

createNodesFromLocs(locs=None, initNodes=None, nodeType=None, nodeName=None, startNode=1, incrementName=False, incrementStart=1, snapToRoad=False, dataProvider=None, dataProviderArgs=None, popupText=None, leafletIconPrefix='glyphicon', leafletIconType='info-sign', leafletColor='blue', leafletIconText=None, cesiumIconType='pin', cesiumColor='blue', cesiumIconText=None)[source]

This function generates a “nodes” dataframe from a given collection of [lat, lon], or [lat, lon, alt], coordinates.

Parameters

  • locs (list of lists, Required, default as None) – A list of locations, in the form of [[lat, lon, alt], [lat, lon, alt], …] or [[lat, lon], [lat, lon], …]. If no altitudes are provided, all will be assumed to be 0 meters above ground level.

  • initNodes (Nodes, Optional, default as None) – A Nodes dataframe containing an existing set of nodes. If initNodes is provided, this function will append to that dataframe.

  • nodeType (string, Optional, default as None) – A user-defined text field that can be used to classify nodes. This field is to categorize a batch of nodes (e.g., “warehouses”). If provided, all nodes generated by the generateNodes() function call will be given this value. The nodeType is not used by VeRoViz explicitly.

  • nodeName (string, Optional, default as None) – The name of all nodes that are to be generated by this function call. This field is a more detailed description (e.g., “Buffalo WH” or “Berlin WH”). The nodeName is not used by VeRoViz explicitly. If provided, all nodes will use this nodeName. See the incrementName flag below.

  • startNode (int, Optional, default as 1) – Specifies the starting node number. This will be the maximum of startNode and any id values contained in the id column of the initNodes dataframe (if provided).

  • incrementName (boolean, Optional, default as False) – If this flag is set to True, a unique integer value will be appended to the `nodeName. For example, if nodeName = ‘WH’ and incrementName = True, then the effective node names for 3 nodes would be ‘WH1’, ‘WH2’, and ‘WH3’.

  • incrementStart (int, Optional, default as 1) – The starting number of the nodeName increment. See the nodeName and incrementName parameters above.

  • snapToRoad (boolean, Optional, default as False,) – If True, nodes will be positioned at locations on the road network. This requires the use of a data provider. See Data Providers for a list of data providers that support this option.

  • dataProvider (string, Conditional, default as None) – Specifies the data source to be used for generating nodes on a road network. See Data Providers for options and requirements.

  • dataProviderArgs (dictionary, Conditional, default as None) – For some data providers, additional parameters are required (e.g., API keys or database names). See Data Providers for the additional arguments required for each supported data provider.

  • popupText (string, Optional, default as None) – Text (or HTML) that will be displayed when a user clicks on the node in either Leaflet or Cesium. A value of None will result in the node ID being auto-populated in the popupText column of the nodes dataframe.

  • leafletIconPrefix (string, Optional, default as "glyphicon") – There are a large number of Leaflet icons available. The leafletIconPrefix identifies one of three collections: “glyphicon”, “fa”, or “custom”. See Leaflet Style for more information.

  • leafletIconType (string, Optional, default as "info-sign") – Specifies the particular icon to be used for all generated nodes. The list of available options depends on the choice of leafletIconType. See Leaflet Style for available options.

  • leafletColor (string, Optional, default as "blue") – Specifies the icon color of the generated nodes when displayed in Leaflet. See Leaflet Style for a list of available colors.

  • leafletIconText (string, Optional, default as None) – Text that will be displayed within the node on a Leaflet map. This text will only be shown if leafletIconPrefix is ‘custom’ and leafletIconType includes a font color and font size. A value of None will result in the node ID being displayed in the node. See Leaflet Style.

  • cesiumIconType (string, Optional, default as "pin") – ‘pin’ is current the only option. See Cesium Style.

  • cesiumColor (string, Optional, default as "blue") – The color of the generated nodes when displayed in Cesium. See Cesium Style for all available color options.

  • cesiumIconText (string, Optional, default as None) – Text that will be permanently displayed within the node on a Cesium map. If this field is None, in Cesium the node will be displayed with the id value.

Returns

A Nodes dataframe generated from the given list of coordinates.

Return type

Nodes dataframe

Examples

Import veroviz and check if it is the latest version:
>>> import veroviz as vrv
>>> vrv.checkVersion()
Generate nodes from a list of [lat, lon] pairs (no altitude specified):
>>> nodes2D = vrv.createNodesFromLocs(
...     locs=[
...         [42.1538, -78.4253],
...         [42.3465, -78.6234],
...         [42.6343, -78.1146]])
>>> nodes2D
Generate nodes from a list of [lat, lon, alt] pairs:
>>> nodes3D = vrv.createNodesFromLocs(
...     locs=[
...         [42.1538, -78.4253, 200],
...         [42.3465, -78.6234, 400],
...         [42.6343, -78.1146, 200]])
>>> nodes3D
This example includes all function arguments:
>>> myLocs = [[42.1538, -78.4253],
...           [42.3465, -78.6234],
...           [42.6343, -78.1146]]
>>> myNodes = vrv.createNodesFromLocs(
...     locs              = myLocs,
...     initNodes         = None,
...     nodeType          = 'customers',
...     nodeName          = 'cust',
...     startNode         = 1,
...     incrementName     = True,
...     incrementStart    = 7,
...     snapToRoad        = False,
...     dataProvider      = None,
...     dataProviderArgs  = None,
...     popupText         = None,
...     leafletIconPrefix = 'fa',
...     leafletIconType   = 'user',
...     leafletColor      = 'lightgreen',
...     leafletIconText   = None,
...     cesiumIconType    = 'pin',
...     cesiumColor       = 'lightgreen',
...     cesiumIconText    = None)
>>> myNodes
Display the nodes on a Leaflet map:
>>> vrv.createLeaflet(nodes = nodes2D)
generateNodes(initNodes=None, nodeType=None, nodeName=None, numNodes=None, startNode=1, incrementName=False, incrementStart=1, nodeDistrib=None, nodeDistribArgs=None, snapToRoad=False, popupText=None, leafletIconPrefix='glyphicon', leafletIconType='info-sign', leafletColor='blue', leafletIconText=None, cesiumIconType='pin', cesiumColor='blue', cesiumIconText=None, dataProvider=None, dataProviderArgs=None)[source]

This function generates a collection of nodes (locations).

Parameters

  • initNodes (Nodes, Optional, default as None) – A Nodes dataframe containing an existing set of nodes. If initNodes is provided, this function will append to that dataframe.

  • nodeType (string, Optional, default as None) – A user-defined text field that can be used to classify nodes. This field is to categorize a batch of nodes (e.g., “warehouses”). If provided, all nodes generated by the generateNodes() function call will be given this value. The nodeType is not used by VeRoViz explicitly.

  • nodeName (string, Optional, default as None) – The name of all nodes that are to be generated by this function call. This field is a more detailed description (e.g., “Buffalo WH” or “Berlin WH”). The nodeName is not used by VeRoViz explicitly. If provided, all nodes will use this nodeName. See the incrementName flag below.

  • numNodes (int, Required, default as None) – The number of nodes to be created.

  • startNode (int, Optional, default as 1) – Specifies the starting node number. This will be the maximum of startNode and any id values contained in the id column of the initNodes dataframe (if provided).

  • incrementName (boolean, Optional, default as False) – If this flag is set to True, a unique integer value will be appended to the `nodeName. For example, if nodeName = ‘WH’ and incrementName = True, then the effective node names for 3 nodes would be ‘WH1’, ‘WH2’, and ‘WH3’.

  • incrementStart (int, Optional, default as 1) – The starting number of the nodeName increment. See the nodeName and incrementName parameters above.

  • nodeDistrib (string, Required, default as None) – Specifies a distribution by which the nodes will be generated. See the table in the notes below for more information.

  • nodeDistribArgs (dictionary, Required, default as None) – A dictionary of arguments for the distribution. See the table in the notes below for more information.

  • snapToRoad (boolean, Optional, default as False,) – If True, nodes will be positioned at locations on the road network. This requires the use of a data provider. See Data Providers for a list of data providers that support this option.

  • popupText (string, Optional, default as None) – Text (or HTML) that will be displayed when a user clicks on the node in either Leaflet or Cesium. A value of None will result in the node ID being auto-populated in the popupText column of the nodes dataframe.

  • leafletIconPrefix (string, Optional, default as "glyphicon") – There are a large number of Leaflet icons available. The leafletIconPrefix identifies one of three collections: “glyphicon”, “fa”, or “custom”. See Leaflet Style for more information.

  • leafletIconType (string, Optional, default as "info-sign") – Specifies the particular icon to be used for all generated nodes. The list of available options depends on the choice of leafletIconPrefix. See Leaflet Style for available options.

  • leafletColor (string, Optional, default as "blue") – Specifies the icon color of the generated nodes when displayed in Leaflet. See Leaflet Style for a list of available colors.

  • leafletIconText (string, Optional, default as None) – Text that will be displayed within the node on a Leaflet map. This text will only be shown if leafletIconPrefix is ‘custom’ and leafletIconType includes a font color and font size. A value of None will result in the node ID being displayed in the node. See Leaflet Style.

  • cesiumIconType (string, Optional, default as "pin") – ‘pin’ is current the only option. See Cesium Style.

  • cesiumColor (string, Optional, default as "blue") – The color of the generated nodes when displayed in Cesium. See Cesium Style for all available color options.

  • cesiumIconText (string, Optional, default as None) – Text that will be permanently displayed within the node on a Cesium map. If this field is None, in Cesium the node will be displayed with the id value.

  • dataProvider (string, Conditional, default as None) – Specifies the data source to be used for generating nodes on a road network. See Data Providers for options and requirements.

  • dataProviderArgs (dictionary, Conditional, default as None) – For some data providers, additional parameters are required (e.g., API keys or database names). See Data Providers for the additional arguments required for each supported data provider.

Returns

A Nodes dataframe of generated nodes.

Return type

Nodes

Note

VeRoViz currently supports the following distribution options. For each distribution, specific additional parameters (arguments) must be provided in the nodeDistribArgs Python dictionary.

nodeDistrib Option

Keys in nodeDistribArgs Dictionary

“uniformBB”: Uniformly distributed within a bounding region.

‘boundingRegion’ : A list of [lat,lon] pairs defines the boundary, in the form of [[lat1, lon1], [lat2, lon2], … , [latn, lonn]].

“normal”: Normally distributed with a given center location and standard deviation. This option does not require a bounding region. If a boundary is provided, it will be regarded as

“normalBB”.

‘center’ : Coordinate of center point, in form of [lat, lon].

‘stdDev’ : Standard deviation in meters (70% nodes are within this range)

“normalBB”: Truncated normally distributed with a given center location and standard deviation.

‘center’ : Coordinate of center point, in form of [lat, lon].

‘stdDev’ : Standard deviation, in meters (roughly 70% of nodes are within this range)

‘boundingRegion’ : A list of lat/lon defines the boundary, in the form of [[lat, lon], [lat, lon], … , [lat, lon]]

“unifRoadBasedBB”: Uniformly generate locations that are close to the road (within a certain range). If a location is close to multiple roads (e.g., the location is at the corner of two roads), the probability of it getting chosen will not increase.

‘boundingRegion’: A list of lat/lon coordinates defining the boundary, in the form of [[lat, lon], [lat, lon], … , [lat, lon]]

‘distToRoad’: The maximum distance between the generated location and its nearest road.

Examples

First import veroviz and check if it is the latest version:
>>> import veroviz as vrv
>>> vrv.checkVersion()
This first example will generate 20 nodes, normally distributed. The distribution is centered at lat 42.30, lon 78.00. The distribution has a standard deviation of 1000 meters.
>>> myNodes = vrv.generateNodes(
...     numNodes        = 20,
...     nodeType        = 'depot',
...     nodeDistrib     = 'normal',
...     nodeDistribArgs = {
...         'center' : [42.30, -78.00],
...         'stdDev' : 1000
...     })
>>> myNodes
View the center point, 1 std dev, 3 std devs, and resulting nodes on a Leaflet map:
>>> myMap = vrv.addLeafletMarker(center      = [42.30, -78.00],
...                              fillOpacity = 1)
>>> myMap = vrv.addLeafletCircle(mapObject = myMap,
...                              center    = [42.30, -78.00],
...                              radius    = 1000,
...                              fillColor = 'green')
>>> myMap = vrv.addLeafletCircle(mapObject = myMap,
...                              center    = [42.30, -78.00],
...                              radius    = 3*1000)
>>> myMap = vrv.createLeaflet(mapObject = myMap,
...                           nodes     = myNodes)
>>> myMap
The following examples require a bounding region. For example:
>>> bounding = [
...     [42.98355351219673, -78.90518188476564],
...     [43.04731443361136, -78.83857727050783],
...     [43.02221961002041, -78.7108612060547],
...     [42.92777124914475, -78.68957519531251],
...     [42.866402688514626, -78.75343322753908],
...     [42.874957707517865, -78.82415771484375],
...     [42.90111863978987, -78.86878967285158],
...     [42.92224052343343, -78.8921356201172]]
The second example will give us 20 nodes, normally-distributed, centered at [42.30, 78.00], with a standard deviation of 2000 meters about the center. However, the nodes must also fall within the bounding region.
>>> myNodes2 = vrv.generateNodes(
...     numNodes        = 20,
...     nodeType        = 'depot',
...     nodeDistrib     = 'normal',
...     nodeDistribArgs = {
...         'center' : [42.90, -78.80],
...         'stdDev' : 2000,
...         'boundingRegion' : bounding
...     })
>>> myNodes2
View the center point, 1 std dev, 3 std devs, bounding region, and resulting nodes on a Leaflet map:
>>> myMap2 = vrv.addLeafletMarker(center      = [42.90, -78.80],
...                               fillOpacity = 1)
>>> myMap2 = vrv.addLeafletCircle(mapObject = myMap2,
...                               center    = [42.90, -78.80],
...                               radius    = 4000,
...                               fillColor = 'green')
>>> myMap2 = vrv.addLeafletCircle(mapObject = myMap2,
...                               center    = [42.90, -78.80],
...                               radius    = 3*4000)
>>> myMap2 = vrv.createLeaflet(mapObject      = myMap2,
...                            nodes          = myNodes2,
...                            boundingRegion = bounding)
>>> myMap2
The third example will generate 20 nodes uniformly distributed in a given bounding region:
>>> myNodes3 = vrv.generateNodes(
...     numNodes        = 20,
...     nodeDistrib     = 'uniformBB',
...     nodeDistribArgs = {
...         'boundingRegion' : bounding
...     })
>>> myNodes3
View the bounding region and generated nodes on a Leaflet map:
>>> myMap3 = vrv.createLeaflet(nodes          = myNodes3,
...                            boundingRegion = bounding)
>>> myMap3
The final example includes all available function arguments:
>>> myNodes4 = vrv.generateNodes(
...     initNodes         = None,
...     nodeType          = 'warehouse',
...     nodeName          = 'WH ',
...     numNodes          = 5,
...     startNode         = 101,
...     incrementName     = True,
...     incrementStart    = 1,
...     nodeDistrib       = 'uniformBB',
...     nodeDistribArgs   = {
...         'boundingRegion' : bounding
...     },
...     snapToRoad        = True,
...     popupText         = 'These nodes are used for demo',
...     leafletIconPrefix = 'fa',
...     leafletIconType   = 'star',
...     leafletColor      = 'darkred',
...     leafletIconText   = None,
...     cesiumIconType    = 'pin',
...     cesiumColor       = 'darkred',
...     cesiumIconText    = None,
...     dataProvider      = 'OSRM-online',
...     dataProviderArgs  = None)
>>> myNodes4
View the bounding region and generated nodes on a Leaflet map:
>>> myMap4 = vrv.createLeaflet(nodes          = myNodes4,
...                            boundingRegion = bounding)
>>> myMap4