Manual: short notice of Method D

chraibi commented 5 years ago

In Gitlab by @gjaeger on Oct 9, 2018, 20:38 [origin]

issue #87:

When to use method D and when not is an important question. I hope it can be discussed in a publication. However, a short notice to warn users can be written in the documentation of method D.

chraibi commented 5 years ago

In Gitlab by @chraibi on Mar 23, 2019, 00:53

@gjaeger close?

chraibi commented 5 years ago

In Gitlab by @gjaeger on Mar 23, 2019, 01:07

@chraibi no

chraibi commented 5 years ago

In Gitlab by @chraibi on Mar 23, 2019, 01:11

What's the progress then?

chraibi commented 5 years ago

In Gitlab by @gjaeger on Mar 23, 2019, 10:48

short note for editing (for me):

github

gitlab

gitlab - manuals: https://gitlab.version.fz-juelich.de/jupedsim/manuals/blob/master/JuPedSim.tex (last update 3 years ago)

chraibi commented 5 years ago

In Gitlab by @gjaeger on Jun 4, 2019, 20:04

Proposal for Modification of Method I based on documentation (WIP):

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"
        plot_time_series="false"
         get_individual_FD="false"/>
   <one_dimensional enabled="false"/>
   <cut_by_circle enabled="false" radius="1.0" edges="10"/>
   <output_voronoi_cells enabled="false" plot_graphs="false"/>
   <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 and stop_frame give the starting and ending frame for data analysis. The default values of these two parameters are None. If you plan to analysis the whole run from beginning to the end, set both of start_frame and stop_frame as None; If start_frame =None but stop_frame is not, then analysis will be performed from beginning of the trajectory to the stop_frame. If start_frame is not None but stop_frame = None, it will analyze from the start_frame to the end of the movement. plot_time_series specifies whether output the $$\rho-t$$ and $$v-t$$-diagram. 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 $$\rho_i$$ and velocity $$v_i$$ of each pedestrian $$i$$ 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/

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 options radius of the circle and the number of edges have to be supplied for approximating the circle if enabled is true.
output_voronoi_cells specifies whether or not to output data for visualizing the Voronoi diagram. Two options enabled and plot_graphs have to be set. If both of them are true, 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 is false, only the data will be created but the figures will not be plotted. When enable is false, nothing will be created.
profiles indicates whether to calculate the profiles over time and space. If enabled is true, the resolution which is decided by the parameters grid_size_x and grid_size_x should be set. The data will be in the folder ./Output/Fundamental_ Diagram/Classical_Voronoi/field/.
Output data: Mean density and velocity over time $$\rho(t)$$ and $$v(t)$$. Sample data for plotting the Voronoi cells. Data for plotting profiles. Data of individual Fundamental diagram.

chraibi commented 5 years ago

In Gitlab by @gjaeger on Jun 4, 2019, 20:25

Proposal for general based on documentation (WIP):

Methods

Five different methods method_A to method_D and Method_I are integrated in the current version of JPSreport and can be chosen for the analysis. Method_I can use for time-series analysis of individual data. The four methods method_A to method_D are used to analyze the steady state.

chraibi commented 5 years ago

In Gitlab by @gjaeger on Jun 11, 2019, 13:12

A few images (based on Bodenstein 2015) for documentation (WIP) of Method A to D:

Method A
jpsreport_Method_A.tex