Data Types

Trajectory

Module handling the trajectory data of the analysis.

class TrajectoryData

Trajectory Data.

Wrapper around the trajectory data, holds the data as a data frame.

Note

The coordinate data is stored in meter (‘m’)!

Parameters:

• data (pandas.DataFrame) – data frame containing the data in the form: “id”, “frame”, “x”, “y”

• frame_rate (float) – frame rate of the trajectory file

data

data frame containing the trajectory data with the columns: “id”, “frame”, “x”, “y”, “point”

Type:

pandas.DataFrame

frame_rate

frame rate of the trajectory data

Type:

float

property bounds

Minimum bounding region of all points in the trajectory.

Returns:

Minimum bounding region (minx, miny, maxx, maxy)

Return type:

tuple[float, float, float, float]

data

property frame_range

Min and max frame of the trajectory data.

Returns:

Min and max frame of the trajectory data (min, max)

Return type:

tuple[int, int]

frame_rate

property number_pedestrians

Number of pedestrians in the trajectory data.

Returns:

Number of pedestrians in the trajectory data.

Return type:

int

Geometry

Module handling the geometrical environment of the analysis.

exception GeometryError(message)

Class reflecting errors when creating PedPy geometry objects.

Create GeometryError with the given message.

Parameters:

message – Error message

class MeasurementArea(coordinates)

Areas to study pedestrian dynamics.

A measurement area is defined as an area, which is convex, simple, and covers a non-zero area.

Create a measurement area from the given input.

The measurement area may be a convex, simple area which covers a non-zero area.

Parameters:

coordinates (Any) – A sequence of (x, y) numeric coordinate pairs, or an array-like with shape (N, 2). Also, can be a sequence of shapely.Point objects. Passing a wkt representation of a polygon is also allowed.

property area

Area of the measurement area.

Returns:

Areas of the measurement area

property coords

Coordinates of the measurement area’s points.

Returns:

Coordinates of the points on the measurement area

property polygon

Measurement area as shapely.Polygon.

Returns:

Measurement area as shapely.Polygon.

class MeasurementLine(coordinates)

Line segments, which are used to analyze pedestrian dynamics.

A measurement line is defined as line segment between two given points with a non-zero distance.

Create a measurement line from the given input.

The measurement line may only consist of two points with a non-zero distance.

Parameters:

coordinates (Any) – A sequence of (x, y) numeric coordinate pairs, or an array-like with shape (N, 2). Also, can be a sequence of shapely.Point objects. Passing a wkt representation of a LineString is also allowed.

property coords

Coordinates of the measurement line’s points.

Returns:

Coordinates of the points on the measurement line

property length

Length of the measurement line.

Returns:

Length of the measurement line

property line

Measurement line as shapely.LineString.

Returns:

Measurement line as shapely.LineString.

property xy

Separate arrays of X and Y coordinate values.

Returns:

Separate arrays of X and Y coordinate values

class WalkableArea(polygon, obstacles=None)

Class holding the geometry information of the analysis.

The walkable area is the area in which the pedestrians can walk, only pedestrians inside this area are considered in the analysis. Parts which are obstructed and/or can not be reached by the pedestrians can be excluded.

Walkable area need to be simple and cover a non-zero area.

Creates a walkable area.

Parameters:

• polygon (Any) – A sequence of (x, y) numeric coordinate pairs, or an array-like with shape (N, 2). Also, can be a sequence of shapely.Point objects. Passing a wkt representation of a polygon is also allowed.

• obstacles (Optional) – list of sequences of (x, y) numeric coordinate pairs, or an array-like with shape (N, 2). Also, can be a sequence of shapely.Point objects.

property area

Area of the walkable area.

Returns:

Areas of the walkable area

property bounds

Minimum bounding region (minx, miny, maxx, maxy).

Returns:

Minimum bounding region (minx, miny, maxx, maxy)

property coords

Coordinates of the walkable area’s points.

Returns:

Coordinates of the points on the walkable area

property polygon

Walkable area as shapely.Polygon.

Returns:

Walkable area as shapely.Polygon.