diff --git a/JuPedSim.tex b/JuPedSim.tex
index 254edbaefff1230df6ce11140cd0c99c9bca602c..edc6d896fb514a2f0971536751ac19505430054b 100644
--- a/JuPedSim.tex
+++ b/JuPedSim.tex
@@ -298,8 +298,8 @@ Some videos are available on our YouTube channel: \url{https://youtube.com/user/
\item Making high quality videos directly from the visualization interface or generating png sequences
\item performance improvements.
\end{itemize}
-
-
+
+
\end{description}
Previous release notes are found in the \autoref{app:release_notes}.
@@ -790,7 +790,7 @@ Concerning this router further specifications are necessary.
\item Sensor : LastDestination : The pedestrians remember the destinations they already walk through. !!Not using this sensor could lead to unrealistic behaviour if their cognitive maps are empty (pedestrian will stay at a crossing)!!
\item Sensor : Jam : A pedestrian will look for an alternative door (route) if a jam (under certain conditions) occurs in front of a door.
!!This sensor is not calibrated yet!!
-\item The Sensor 'DiscoverDoors' is enabled by default as without it the pedestrian with an empty cognitive map couldn't find any exit route. Using a complete cognitive map this sensor won't be used.
+\item The Sensor 'DiscoverDoors' is enabled by default as without it the pedestrian with an empty cognitive map couldn't find any exit route. Using a complete cognitive map this sensor won't be used.
\end{itemize}
\item See \autoref{lst:route_choice_models} to get information about how to specify cognitive map and sensors.
\end{itemize}
@@ -886,10 +886,10 @@ The simulation can be steered from outside using predefined events. At the momen
\begin{lstlisting}[caption = Sample events file, label=lst:event_file]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<JPScore project="with-events" version="0.6"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<JPScore project="with-events" version="0.6"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_events.xsd">
- <events update_time="2" update_radius="1"
+ <events update_time="2" update_radius="1"
agents_color_by_knowledge="true">
<event time="15" id="8" type="door" state="close" caption="left_exit" />
<event time="50" id="8" type="door" state="open" caption="left_exit" />
@@ -912,7 +912,7 @@ The simulation can be steered from outside using predefined events. At the momen
\end{itemize}
Agents notice the state of a door when in the range (actually $0.5m$) of that door.
-That knowledge is then shared with other agents within update\_radius. The process is repeated at a period of update\_time leading to an information propagation speed of
+That knowledge is then shared with other agents within update\_radius. The process is repeated at a period of update\_time leading to an information propagation speed of
$$
v=\frac{update\_radius} {update\_time}\;ms^{-1}
$$
@@ -1637,9 +1637,9 @@ It is still under development.
\chapter{JPSreport}
-This module focuses on the analysis of pedestrian characteristics using trajectories obtained from video recordings as well as simulations.
+This module focuses on the analysis of pedestrian characteristics using trajectories obtained from video recordings as well as simulations.
JPSreport integrates four different measurement methods described in \cite{Zhang2011a}.
-The typical workflow using JPSreport is shown in \autoref{fig-use_JPSreport}.
+The typical workflow using JPSreport is shown in \autoref{fig-use_JPSreport}.
\begin{figure}[H]
@@ -1666,18 +1666,18 @@ For additional build instruction, please consult the wiki at \url{https://cst.ve
A program call looks like this:
\begin{verbatim}
-> JPSreport.exe --inifile="inifile.xml"
+> ./JPSreport.exe inifile.xml
\end{verbatim}
\noindent where $inifile.xml$ contains all the information needed to performs the analysis.
-\subsection{inifile.xml}
+\subsection{Configuration file}
The minimum contain of the initialization file is presented in \autoref{lst:inifile_report}.
\begin{lstlisting} [language=XML, caption=Structure of a project file, label=lst:inifile_report]
<?xml version="1.0" encoding="UTF-8"?>
-<JPSreport project="Sample-Project" version="0.6"
+<JPSreport project="Sample-Project" version="0.6"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_report.xsd">
<!-- geometry file -->
@@ -1689,20 +1689,20 @@ xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_report.xsd">
<file name="bot-360-120-120.xml" />
<path location="../JPSdata/data/BO/BOT360/" />
</trajectories> <!-- all files in the directories will be used -->
- <measurementAreas unit="m">
+ <measurement_areas unit="m">
<area_B id="1" type="BoundingBox">
<vertex x="-4.00" y="0" /> <!-- CCW -->
<vertex x="-4.00" y="3.60" />
<vertex x="4.00" y="3.60" />
<vertex x="4.00" y="0" />
- <Length_in_movement_direction distance="1.0" />
+ <length_in_movement_direction distance="1.0" />
</area_B>
<area_B id="2" type="BoundingBox">
<vertex x="-5.00" y="0" /> <!-- CCW -->
<vertex x="-5.00" y="3.60" />
<vertex x="3.00" y="3.60" />
<vertex x="3.00" y="0" />
- <Length_in_movement_direction distance="1.0" />
+ <length_in_movement_direction distance="1.0" />
</area_B>
<area_L id="3" type="Line">
<start x="4.00" y="0" />
@@ -1712,39 +1712,39 @@ xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_report.xsd">
<start x="0.00" y="0" />
<end x="4.00" y="0" />
</area_L>
- </measurementAreas>
+ </measurement_areas>
<velocity>
- <useXComponent>true</useXComponent>
- <useYComponent>false</useYComponent>
+ <use_x_component>true</use_x_component>
+ <use_y_component>false</use_y_component>
- <!-- half of the time interval that used to calculate instantaneous velocity of ped i [fr] here v_i = (X(t+deltaF) - X(t+deltaF))/(2*deltaF). X is location. -->
- <halfFrameNumberToUse>5</halfFrameNumberToUse>
+ <!-- frame_step (deltaF) in [frame] that used to calculate instantaneous velocity of ped i here v_i = (X(t+deltaF/2) - X(t-deltaF/2))/(deltaF). X is location. -->
+ <frame_step>5</frame_step>
</velocity>
<!-- Method A (Zhang2011a) Flow and Vel -->
<method_A enabled="false">
- <!-- Time interval used to count the flow [fr] -->
- <timeInterval unit="frame">
+ <!-- frame_interval used to count the flow [fr] -->
+ <frame_interval unit="frame">
70
- </timeInterval>
+ </frame_interval>
<!-- The coordinate of the line used to calculate the flow and velocity -->
- <measurementArea id="3" />
- <measurementArea id="4" />
+ <measurement_area id="3" />
+ <measurement_area id="4" />
</method_A>
<!-- Method B (Zhang2011a) Vel and Dens based on Tin and Tout -->
<method_B enabled="false">
- <measurementArea id="1" />
+ <measurement_area id="1" />
</method_B>
<!-- Method C (Zhang2011a) Classical density and Vel -->
<method_C enabled="false">
- <measurementArea id="1" />
- <measurementArea id="2" />
+ <measurement_area id="1" />
+ <measurement_area id="2" />
</method_C>
<!-- Method D (Zhang2011a) Voronoi density and Vel -->
- <method_D enabled="true" outputGraph="false" individualFDdata="true">
- <measurementArea id="1" />
- <measurementArea id="2" />
- <cutByCircle enabled="false" radius ="0.5" edges ="6"/>
- <getProfile enabled="false" scale_x="0.10" scale_y="0.10"/>
+ <method_D enabled="true" output_graph="false" individual_FD="true">
+ <measurement_area id="1" />
+ <measurement_area id="2" />
+ <cut_by_circle enabled="false" radius ="0.5" edges ="6"/>
+ <profiles enabled="false" scale_x="0.10" scale_y="0.10"/>
</method_D>
</JPSreport>
@@ -1754,7 +1754,7 @@ xsi:noNamespaceSchemaLocation="http://xsd.jupedsim.org/0.6/jps_report.xsd">
\paragraph{\textit{\textbf {trajectories}}} \hfill \\
This option specifies the format, name and location of the input trajectories. If a "file name" is given, then only the assigned file will be analysed. Otherwise, all the files with the given format in the assigned location will be analysed. Note that, 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 "/" or contains ":".
-\paragraph{\textit{\textbf {Measurement areas}}} \hfill \\
+\paragraph{\textit{\textbf {measurement\_areas}}} \hfill \\
There are two different types of measurement areas corresponding to the different measurement methods. Several measurement areas (polygons) with different Id number can be supplied. The types are:
\begin{itemize}
@@ -1767,10 +1767,10 @@ The line is only used in Method A (see below).
\paragraph{\textit{\textbf {Velocity}}} %\hfill \\
\begin{itemize}
- \item If only $\langle${\textbf {useXComponent}}$\rangle$ is "\textcolor{blue}{\textbf {true}}", the velocity in x direction is used in analysis.
- \item If only $\langle${\textbf {useYComponent}}$\rangle$ is "\textcolor{blue}{\textbf {true}}", the velocity in y direction is used in analysis.
- \item If both $\langle${\textbf {useXComponent}}$\rangle$ and $\langle${\textbf {useYComponent}}$\rangle$ are "\textcolor{blue}{\textbf {true}}", the velocity in 2D space is used in analysis.
- \item $\langle${\textbf {halfFrameNumberToUse}}$\rangle$is half of the number of frames used to calculate the instantaneous velocity. Since the instantaneous velocity is calculated according to
+ \item If only $\langle${\textbf {use\_x\_component}}$\rangle$ is "\textcolor{blue}{\textbf {true}}", the velocity in x direction is used in analysis.
+ \item If only $\langle${\textbf {use\_y\_component}}$\rangle$ is "\textcolor{blue}{\textbf {true}}", the velocity in y direction is used in analysis.
+ \item If both $\langle${\textbf {use\_x\_component}}$\rangle$ and $\langle${\textbf {use\_y\_component}}$\rangle$ are "\textcolor{blue}{\textbf {true}}", the velocity in 2D space is used in analysis.
+ \item $\langle${\textbf {frame\_step}}$\rangle$is the number of frames ($\Delta t^\prime$) used to calculate the instantaneous velocity. Since the instantaneous velocity is calculated according to
\begin{equation}\label{eq2}
v_i(t)=\frac{{x_i}(t+\Delta t^\prime/2)-{x_i}(t-\Delta
t^\prime/2))}{\Delta t^\prime}
@@ -1801,11 +1801,11 @@ The line is only used in Method A (see below).
\end{figure}
\item $\langle${\textbf {Method B}}$\rangle$\\
- Method B can only be used to analyse one directional pedestrian movement in a corridor.
+ Method B can only be used to analyse one directional pedestrian movement in a corridor.
The speed is defined by the length of the measurement area and the time a pedestrian stay in the area.\\
\textbf {Parameters:}\\
- a) Measurement area (should be rectangle)\\
- b) Length\_in\_movement\_direction
+ a) measurement\_area (should be rectangle)\\
+ b) length\_in\_movement\_direction
\textbf {Output data:} mean density and velocity of each pedestrian ($\rho_i$ and $v_i$).
@@ -1829,21 +1829,21 @@ The speed is defined by the length of the measurement area and the time a pedest
\textbf {Parameters:}
\begin{itemize}
- \item $\langle${\textbf {measurement area$\rangle$}}: the id of the measurement area.
- \item $\langle${\textbf {IsOutputGraph}}$\rangle$: determines whether or not to output data for visualizing
+ \item $\langle${\textbf {measurement\_area$\rangle$}}: the id of the measurement area.
+ \item $\langle${\textbf {output\_graph}}$\rangle$: determines whether or not to output data for visualizing
the Voronoi diagram. If true, files including Voronoi cells, speed and the coordinates of pedestrian
corresponding to each cell will be written in the folder\\
(\footnotesize\textcolor{blue}{\underline{$Output/Fundamental\_Diagram/Classical\_Voronoi/VoronoiCell$}}\normalsize).
- \item $\langle${\textbf {cutbycircle}}$\rangle$: determines whether or not to cut each cell by circle.
+ \item $\langle${\textbf {cut\_by\_circle}}$\rangle$: determines whether or not to cut each cell by circle.
"radius" of the circle and the number of "edges" for approximating the circle should be supplied if this is chosen.
- \item $\langle${\textbf {IndividualFDdata}}$\rangle$: determines whether or not to output the data for individual fundamental diagram,
- which is based on the Voronoi density and velocity and each pedestrian but not averaged value over space.
+ \item $\langle${\textbf {individual\_FD}}$\rangle$: determines whether or not to output the data for individual fundamental diagram,
+ which is based on the Voronoi density and velocity and each pedestrian but not averaged value over space.
If true, the related data will be written in the folder \\
(\footnotesize\textcolor{blue}{\underline{$Output/Fundamental\_Diagram/IndividualFD$}}\normalsize).
- \item $\langle${\textbf {GetProfile}}$\rangle$: determines whether to calculate the profiles over time and space. If yes, the resolution which is decided by the parameters '$\langle${\textbf {scale\_x}}$\rangle$' and '$\langle${\textbf {scale\_y}}$\rangle$' should be set. The data will be in the folder (\footnotesize\textcolor{blue}{\underline{$Output/Fundamental\_Diagram/Classical\_Voronoi/field/$}}\normalsize).
+ \item $\langle${\textbf {profiles}}$\rangle$: determines whether to calculate the profiles over time and space. If yes, the resolution which is decided by the parameters '$\langle${\textbf {scale\_x}}$\rangle$' and '$\langle${\textbf {scale\_y}}$\rangle$' should be set. The data will be in the folder (\footnotesize\textcolor{blue}{\underline{$Output/Fundamental\_Diagram/Classical\_Voronoi/field/$}}\normalsize).
\end{itemize}
@@ -1868,20 +1868,20 @@ The speed is defined by the length of the measurement area and the time a pedest
\includegraphics[width =0.9\textwidth]{figures/Figue4-4-2.png}}
\caption{\label{fig:FD-Voro-cell} Output data from Method D: Voronoi cells.}
\end{figure}
-
+
\begin{figure}[H]
\centering{
\includegraphics[width =0.9\textwidth]{figures/Figue4-4-3.png}}
\caption{\label{fig:Voro-profile} Output data from Method D: Voronoi profiles.}
\end{figure}
-
+
\end{enumerate}
-\subsection{Geometry}
-In JPSreport the geometry is regarded as an unique polygon. Obstacles also defined as polygons are allowed.
+\subsection{Geometry file}
+In JPSreport the geometry is regarded as an unique polygon. Obstacles also defined as polygons are allowed.
Attention should be paid to the following points while creating the file:
\begin{itemize}
@@ -1943,7 +1943,7 @@ For example, The geometry file of the scenario in Figure~\ref{fig-geometry_JPSre
</geometry>
\end{lstlisting}
-\subsection{Trajectory}
+\subsection{Trajectory file}
JPSreport supports the formats $.xml$ and $.txt$ defined in \autoref{sec:trajectories}.
%In current version of JPSreport, $.xml$ and $.txt$ format of trajectory files are used. The trajectories of each pedestrian at each time step are stored in $.xml$ file and should be written as following form:
@@ -2022,7 +2022,7 @@ $ run txt2xml.py -h
There are still a few limitations in the current version of JPSreport:
\begin{itemize}
- \item Not able to analyze trajectories directly from periodic boundary conditions.
+ \item Not able to analyze trajectories directly from periodic boundary conditions.
When a pedestrian enters the scenario for a second time, a new ID should be assigned.
\item Not able to analyze data at complex geometries with more than one polygon.
\item Not able to automatically determine the steady state.
@@ -2520,9 +2520,9 @@ See \autoref{fig:gompertz_func} for the shape of the repulsive force using the a
\chapter{Release notes}
\label{app:release_notes}
\section{Version 0.5 (5 Aug 2014)}
- We are proud to announce the first pre-release of our software \texttt{JuPedSim} for simulating pedestrians evacuations. Please note that it is a pre-release version for developers only. We are working hard towards the final release for this version. Two modules are shipped with this pre-release:\\
+ We are proud to announce the first pre-release of our software \texttt{JuPedSim} for simulating pedestrians evacuations. Please note that it is a pre-release version for developers only. We are working hard towards the final release for this version. Two modules are shipped with this pre-release:\\
\begin{itemize}
- \item[] \textbf{JPScore}: command line simulation core
+ \item[] \textbf{JPScore}: command line simulation core
\item[] \textbf{JPSvis}: visualization module
\end{itemize}
@@ -2645,7 +2645,7 @@ There is no special hardware/software requirements for running \texttt{JuPedSim}
\item
Testing and reporting bugs will be great. If you want to contribute actively to the code, by implementing new models and/or features, you are welcome to do so. Please contact uns per mail at \texttt{info at jupedsim.org} so that we can grant you access to the repositories.
\end{itemize}
-
+
\end{enumerate}
%\section{Version 0.6}