Updated on 2024-01-04 GMT+08:00

Origin-Destination Betweenness Centrality (2.2.4)

Table 1 parameters parameter description

Parameter

Mandatory

Description

Type

Value Range

Default Value

directed

No

Whether an edge is directed

Boolean

The value can be true or false

true

weight

No

Weight of an edge

String

The value can be an empty string. If this parameter is left blank, the weight and distance of this edge are 1 by default. You can set this parameter to a property of the edge, and the property value will be the weight. If the edge does not have the specified property, the weight is 1 by default.

NOTE:

The weight of an edge must be greater than 0.

-

OD

No

Start vertex and end vertex pair (origin-destination)

String

The value must be in the standard CSV format. The start vertex (origin) and end vertex (destination) are separated by commas (,), and the start and end vertex pairs are separated by newline characters (\n), for example, Alice,Nana\nLily,Amy.

-

seeds

No

ID of the hot spot vertex.

String

If OD is not set, the seeds data will be used.

-

modes

No

Hot spot vertex type.

String

  • IN: The hot spot vertex ID is used as the start vertex ID.
  • OUT: The hot spot vertex ID is used as the end vertex ID.

-

capacity

No

Number of participants at each hot spot in seeds.

Integer

-

-

Either OD_pairs or seeds must be specified. If they are both specified, the OD_pair value prevails.

Table 2 response_data parameter description

Parameter

Type

Description

betweenness

List

Betweenness value of each edge. The format is [{"source":sourceId,"target":targetId,"index":indexValue,"betweenness":betweennessValue}, ...].

  • betweennessValue is of the double type.