In the configuration file, the following sections should be defined:
Header
<?xml version="1.0" encoding="UTF-8" ?>
<JPSreport project="JPS-Project" version="0.8" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://github.com/JuPedSim/jpsreport/blob/develop/xsd/jps_report.xsd">
Logfile
It might be useful to precise a logfile (for debugging purposes):
<logfile>log.txt</logfile>
Geometry
indicates the file name corresponding to the trajectory files to analyze.
<geometry file = "geo_KO_240_050_240.xml" />
The location can be either absolute path or relative path to the location of the inifile. A path is considered absolute if it starts with “/” (Linux system) or contains “:” (Windows system).
<geometry file = "geo/geo_KO_240_050_240.xml" />
Output
indicates the location of the output files based on the location of inifile or the absolute path.
<output location="Output/"/>
A path is considered absolute if it starts with “/” (Linux system) or contains “:” (Windows system).
Trajectories
indicates the location and the name of the trajectory files that will be analyzed.
The format of trajectory files should be .txt
or .xml
.
The supported unit of the trajectories is m
.
Two other sub-options file
and path
can be supplied.
If only path
is given, then all files with the corresponding format in
the given folder will be considered as the upcoming trajectories
and JPSreport
will try to load them one by one.
If both file
and path
are given, then only the given trajectories
will be considered (several file
tags can be given at the same time).
The location can be either absolute path or relative path to the location of the inifile. A path is considered absolute if it starts with “/” (Linux system) or contains “:” (Windows system).
For example:
<trajectories format="txt" unit="m">
<file name="traj_KO_240_050_240.txt" />
<file name="traj_KO_240_060_240.txt" />
<path location="./" />
</trajectories>
Scripts [removed since 0.8.5]
gives relative path based on the location of inifile or the absolute path.
<scripts location="../../scripts/"/>
Measurement area
Indicates the types and location of the measurement areas you plan to use for analysis. Mainly two kind of measurement areas can be defined:
area_B
: a 2D area and can be polygon (the orientation of its points is clockwise)area_L
: a reference segment line defined by two points.
area_L
is only used in method A, while area_B
is used for method B, method C and method D.
Several measurement areas can be given and distinguished with different id
.
The parameter zPos
is used to indicate the position of measurement area in z axis. zPos
is useful for geometry with several stories.
Notes:
- the option
length_in_movement_direction
is only used in method B and the value will be ignored in other methods. - If not given in method_B, the effective distance between entrance point to the measurement area and the exit point from the measurement area will be used.
<measurement_areas unit="m">
<area_B id="1" type="BoundingBox" zPos="None">
<vertex x="-2.40" y="1.00" /> <!-- Clockwise -->
<vertex x="-2.40" y="3.00" />
<vertex x="0" y="3.00" />
<vertex x="0" y="1.00" />
<length_in_movement_direction distance="2.0" />
</area_B>
<area_L id="2" type="Line" zPos="None">
<start x="-2.40" y="1.00" />
<end x="0" y="1.00" />
</area_L>
<area_L id="3" type="Line" zPos="None">
<start x="-2.40" y="2.00" />
<end x="0" y="2.00" />
</area_L>
</measurement_areas>
Velocity
precises the method for calculating the instantaneous velocity of pedestrian at time from trajectories:
<velocity frame_step="10" set_movement_direction="None"
ignore_backward_movement="false"/>
Possible parameters are
frame_step
gives the size of time interval for calculating the velocity. The default value is 10.set_movement_direction
indicates in which direction the velocity will be projected. The value ofset_movement_direction
can be:None
, which means that you don’t consider the movement direction and calculate the velocity by the real distance. This is the default value.- Any real number from
0
to360
which represents the angular information of the direction in the coordination system. Note that the axis can be represented either byX+
,Y+
,X-
,Y-
or by 0, 90, 180, 270. SeeTraj
. For complex trajectories with several times of direction change, you can indicate the detailed direction using the angular information in the trajectory file (By adding a new column in.txt
file or adding a new variable in.xml
file with the indicatorVD
).
ignore_backward_movement
indicates whether you want to ignore the movement opposite to the direction fromset_movement_direction
. The default value isfalse
.
Methods
Indicates the parameters related to each measurement method.
Six different methods method_A
to method_D
and Method_I
to Method_J
are integrated in the current
version of JPSreport
and can be chosen for the analysis. The five methods method_A
to method_D
and method_J
are used to analyze the steady state.
Method | measurement area | output data |
---|---|---|
A | and | |
B | and | |
C | and | |
D | and | |
J | and |
Further information relating to each method can be found in Pedestrian fundamental diagrams: Comparative analysis of experiments in different geometries.
Method_I
can be used for time-series analysis of individual data.
Method A
For definition see Method A. Method A is used to analyze the steady state.
<method_A enabled="true">
<measurement_area id="2" frame_interval="100"/>
<measurement_area id="3" frame_interval="100"/>
</method_A>
Possible parameters are:
-
id
specifies the location of the reference line. several measurement areas can be set in one inifile with different id-numbers. -
frame_interval
specifies the size of time interval (in frame) for calculating flow rate. -
up to version 0.8.5:
plot_time_series
specifies whether output the ()-Diagram.
Possible output data are:
/Fundamental_Diagram/FlowVelocity/
: the output filesFlow_NT_traj_
andFDFlowVelocity_traj_
.
Method B
For definition see Method B. Method B is used to analyze the steady state.
<method_B enabled="false">
<measurement_area id="1" />
</method_B>
This method can only be used to analyze one directional (or part of one directional) pedestrian movement in corridors. The speed is defined by the length of the measurement area length_in_movement_direction
and the time a pedestrian stays in the area.
Possible parameters are:
measurement_area
given by anid
number. Note that the measurement area for method_B should be rectangle based on the definition of the method.
Possible output data are:
/Fundamental_Diagram/TinTout/
: output fileFDTinTout_traj_
with mean density and velocity of each pedestrian (PersID, and ).
Method C
For definition see Method C. Method C is used to analyze the steady state.
<method_C enabled="true">
<measurement_area id="1"/>
</method_C>
Possible parameters are:
-
id
indicates the size and location of the measurement_area. Several measurement areas can be set in one inifile. -
up to version 0.8.5:
plot_time_series
specifies whether output the () and () diagrams.
Possible output data are:
/Fundamental_Diagram/Classical_Voronoi/
: output filerho_v_Classic_traj_
with mean density and velocity of over time (frame, , ).
Method D
For definition see Method D. Method D is used to analyze the steady state.
<method_D enabled="true">
<measurement_area id="1" start_frame="None" stop_frame="None"
get_individual_FD="false"/>
<one_dimensional enabled="false"/>
<cut_by_circle enabled="false" radius="1.0" edges="10"/>
<profiles enabled="false" grid_size_x="0.20" grid_size_y="0.20"/>
</method_D>
Possible parameters are:
-
For each
measurement_area
, several id numbers can be set in one inifile.start_frame
andstop_frame
give the starting and ending frame for data analysis. The default values of these two parameters areNone
. If you plan to analysis the whole run from beginning to the end, set both ofstart_frame
andstop_frame
asNone
; Ifstart_frame =None
butstop_frame
is not, then analysis will be performed from beginning of the trajectory to thestop_frame
. Ifstart_frame
is notNone
butstop_frame = None
, it will analyze from thestart_frame
to the end of the movement.get_individual_FD
determines whether or not to output the data for individual fundamental diagram in the given measurement area, which is based on the Voronoi density , velocity , position (, and ) and Voronoi polygon of each pedestrian in a given measurement area but not mean value over space. If true, the related data will be written in the folder./Output/Fundamental_Diagram/IndividualFD/
in the output fileIFD_D_
. -
up to version 0.8.5:
plot_time_series
specifies whether output the and -diagram. -
one_dimensional
should be used when pedestrians move on a line single-file experiment. -
cut_by_circle
determines whether to cut each cell by circle or not. Two optionsradius
of the circle and the number ofedges
have to be supplied for approximating the circle ifenabled
is true. -
up to version 0.8.5:
output_voronoi_cells
specifies whether or not to output data for visualizing the Voronoi diagram. Two optionsenabled
andplot_graphs
have to be set. If both of them aretrue
, files including Voronoi cells, speed and the coordinates of pedestrian corresponding to each cell as well as the figures of Voronoi cells will be created in the folder./Output/Fundamental_Diagram/Classical_Voronoi/VoronoiCell/
. If the latter isfalse
, only the data will be created but the figures will not be plotted. Whenenable
isfalse
, nothing will be created. -
profiles
indicates whether to calculate the profiles over time and space. Ifenabled
is true, the resolution which is decided by the parametersgrid_size_x
andgrid_size_x
should be set. The data will be in the folder.
Possible output data are:
/Fundamental_Diagram/Classical_Voronoi/
: output filerho_v_Voronoi_
with mean density and velocity of over time (frame, , )./Fundamental_Diagram/IndividualFD/
: output fileIFD_D_
with Voronoi density , velocity , position (, and ) and Voronoi polygon of each pedestrian ../Output/Fundamental_ Diagram/Classical_Voronoi/field/
:- output file
Prf_d_
contains the profile data for density. - output file
Prf_v_
contains the profile data for velocity.
- output file
- The output folder
./Output/Fundamental_ Diagram/Classical_Voronoi/VoronoiCell/
contains the data for plotting the Voronoi cells.
Method I
Method I use the definition of Method D. For definition see Method D. Method I can be used for time-series analysis of individual data.
<method_I enabled="true">
<measurement_area id="1" start_frame="None" stop_frame="None"/>
<cut_by_circle enabled="true" radius="1.0" edges="10"/>
</method_I>
Possible parameters are:
-
For each
measurement_area
, several id numbers can be set in one inifile.start_frame
andstop_frame
give the starting and ending frame for data analysis. The default values of these two parameters areNone
. If you plan to analysis the whole run from beginning to the end, set both ofstart_frame
andstop_frame
asNone
; Ifstart_frame = None
butstop_frame
is not, then analysis will be performed from beginning of the trajectory to thestop_frame
. Ifstart_frame
is notNone
butstop_frame = None
, it will analyze from thestart_frame
to the end of the movement. -
cut_by_circle
determines whether to cut each cell by circle or not. Two optionsradius
of the circle and the number ofedges
have to be supplied for approximating the circle ifenabled
is true.
The data are saved in the output folder: /Fundamental_Diagram/IndividualFD/
in the output file IFD_I_
with
Voronoi density , velocity , position (, and ) and Voronoi polygon of each pedestrian .
Method J
For definition see Method J. Method J is used to analyze the steady state.
<method_J enabled="true">
<measurement_area id="1" start_frame="None" stop_frame="None"
get_individual_FD="false"/>
<one_dimensional enabled="false"/>
<cut_by_circle enabled="false" radius="1.0" edges="10"/>
<profiles enabled="false" grid_size_x="0.20" grid_size_y="0.20"/>
</method_J>
Possible parameters are:
- For each
measurement_area
, several id numbers can be set in one inifile.-
start_frame
andstop_frame
give the starting and ending frame for data analysis. The default values of these two parameters areNone
. If you plan to analysis the whole run from beginning to the end, set both ofstart_frame
andstop_frame
asNone
; Ifstart_frame =None
butstop_frame
is not, then analysis will be performed from beginning of the trajectory to thestop_frame
. Ifstart_frame
is notNone
butstop_frame = None
, it will analyze from thestart_frame
to the end of the movement. -
get_individual_FD
determines whether or not to output the data for individual fundamental diagram in the given measurement area, which is based on the Voronoi density , velocity , position (, and ) and Voronoi polygon of each pedestrian in a given measurement area but not mean value over space. If true, the related data will be written in the folder./Output/Fundamental_Diagram/IndividualFD/
in the output fileIFD_J_
.
-
-
one_dimensional
should be used when pedestrians move on a line single-file experiment. -
cut_by_circle
determines whether to cut each cell by circle or not. Two optionsradius
of the circle and the number ofedges
have to be supplied for approximating the circle ifenabled
is true. profiles
indicates whether to calculate the profiles over time and space. Ifenabled
is true, the resolution which is decided by the parametersgrid_size_x
andgrid_size_x
should be set.
Possible output data are:
/Fundamental_Diagram/Classical_Voronoi/
: output filerho_v_Voronoi_J_
with mean density and velocity of over time (frame, , )./Fundamental_Diagram/IndividualFD/
: output fileIFD_J_
with Voronoi density , velocity , position (, and ) and Voronoi polygon of each pedestrian ../Output/Fundamental_ Diagram/Classical_Voronoi/field/
:- output file
Prf_d_
contains the profile data for density. - output file
Prf_v_
contains the profile data for velocity.
- output file
- The output folder
./Output/Fundamental_ Diagram/Classical_Voronoi/VoronoiCell/
contains the data for plotting the Voronoi cells.