Skip to content
Snippets Groups Projects
Commit f6163d58 authored by junzhang's avatar junzhang
Browse files

The parameters' name in the inifile of JPSreport is changed and updated in the manual document.

parent 85363fc7
Branches
No related tags found
No related merge requests found
......@@ -1666,12 +1666,12 @@ 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]
......@@ -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}
......@@ -1804,8 +1804,8 @@ The line is only used in Method A (see below).
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,
\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}
......@@ -1880,7 +1880,7 @@ The speed is defined by the length of the measurement area and the time a pedest
\subsection{Geometry}
\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:
......@@ -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:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment