Inheritance diagram for org.matsim.analysis.VolumesAnalyzer:

[legend]

Public Member Functions
	VolumesAnalyzer (final int timeBinSize, final int maxTime, final Network network)

	VolumesAnalyzer (final int timeBinSize, final int maxTime, final Network network, boolean observeModes)

void	handleEvent (VehicleEntersTrafficEvent event)

void	handleEvent (final LinkLeaveEvent event)

int []	getVolumesForLink (final Id< Link > linkId)

int []	getVolumesForLink (final Id< Link > linkId, String mode)

int	getVolumesArraySize ()

double []	getVolumesPerHourForLink (final Id< Link > linkId)

double []	getVolumesPerHourForLink (final Id< Link > linkId, String mode)

Set< String >	getModes ()

Set< Id< Link > >	getLinkIds ()

void	reset (final int iteration)

Private Member Functions
int	getTimeSlotIndex (final double time)

Private Attributes
final int	timeBinSize

final int	maxTime

final int	maxSlotIndex

final IdMap< Link, int[]>	links

final boolean	observeModes

final IdMap< Vehicle, String >	enRouteModes

final IdMap< Link, Map< String, int[]> >	linksPerMode

Static Private Attributes
static final Logger	log = LogManager.getLogger(VolumesAnalyzer.class)

Detailed Description

Counts the number of vehicles leaving a link, aggregated into time bins of a specified size.

Author: mrieser

Definition at line 47 of file VolumesAnalyzer.java.

Constructor & Destructor Documentation

◆ VolumesAnalyzer() [1/2]

org.matsim.analysis.VolumesAnalyzer.VolumesAnalyzer	(	final int	timeBinSize,
		final int	maxTime,
		final Network	network
	)

Definition at line 66 of file VolumesAnalyzer.java.

References org.matsim.analysis.VolumesAnalyzer.maxTime, and org.matsim.analysis.VolumesAnalyzer.timeBinSize.

                                                                                             {
         this(timeBinSize, maxTime, network, true);
     }

◆ VolumesAnalyzer() [2/2]

org.matsim.analysis.VolumesAnalyzer.VolumesAnalyzer	(	final int	timeBinSize,
		final int	maxTime,
		final Network	network,
		boolean	observeModes
	)

Definition at line 70 of file VolumesAnalyzer.java.

References org.matsim.analysis.VolumesAnalyzer.maxTime, org.matsim.analysis.VolumesAnalyzer.observeModes, and org.matsim.analysis.VolumesAnalyzer.timeBinSize.

                                                                                                                   {
         this.timeBinSize = timeBinSize;
         this.maxTime = maxTime;
         this.maxSlotIndex = (this.maxTime / this.timeBinSize) + 1;
         this.links = new IdMap<>(Link.class);
 
         this.observeModes = observeModes;
         if (this.observeModes) {
             this.enRouteModes = new IdMap<>(Vehicle.class);
             this.linksPerMode = new IdMap<>(Link.class);
         } else {
             this.enRouteModes = null;
             this.linksPerMode = null;
         }
     }

Member Function Documentation

◆ handleEvent() [1/2]

void org.matsim.analysis.VolumesAnalyzer.handleEvent ( VehicleEntersTrafficEvent event )

Implements org.matsim.api.core.v01.events.handler.VehicleEntersTrafficEventHandler.

Definition at line 87 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.events.VehicleEntersTrafficEvent.getVehicleId(), and org.matsim.api.core.v01.IdMap< T, V >.put().

                                                              {
         if (this.observeModes) {
             this.enRouteModes.put(event.getVehicleId(), event.getNetworkMode());
         }
     }

Here is the call graph for this function:

◆ handleEvent() [2/2]

void org.matsim.analysis.VolumesAnalyzer.handleEvent ( final LinkLeaveEvent event )

Implements org.matsim.api.core.v01.events.handler.LinkLeaveEventHandler.

Definition at line 94 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.get(), org.matsim.api.core.v01.events.LinkLeaveEvent.getLinkId(), org.matsim.api.core.v01.events.Event.getTime(), org.matsim.analysis.VolumesAnalyzer.getTimeSlotIndex(), org.matsim.api.core.v01.events.LinkLeaveEvent.getVehicleId(), and org.matsim.api.core.v01.IdMap< T, V >.put().

                                                         {
         int[] volumes = this.links.get(event.getLinkId());
         if (volumes == null) {
             volumes = new int[this.maxSlotIndex + 1]; // initialized to 0 by default, according to JVM specs
             this.links.put(event.getLinkId(), volumes);
         }
         int timeslot = getTimeSlotIndex(event.getTime());
         volumes[timeslot]++;
 
         if (this.observeModes) {
             Map<String, int[]> modeVolumes = this.linksPerMode.get(event.getLinkId());
             if (modeVolumes == null) {
                 modeVolumes = new HashMap<>();
                 this.linksPerMode.put(event.getLinkId(), modeVolumes);
             }
             String mode = this.enRouteModes.get(event.getVehicleId());
             volumes = modeVolumes.get(mode);
             if (volumes == null) {
                 volumes = new int[this.maxSlotIndex + 1]; // initialized to 0 by default, according to JVM specs
                 modeVolumes.put(mode, volumes);
             }
             volumes[timeslot]++;
         }
     }

Here is the call graph for this function:

◆ getTimeSlotIndex()

int org.matsim.analysis.VolumesAnalyzer.getTimeSlotIndex ( final double time )

private

Definition at line 119 of file VolumesAnalyzer.java.

References org.matsim.analysis.VolumesAnalyzer.maxSlotIndex.

Referenced by org.matsim.analysis.VolumesAnalyzer.getVolumesPerHourForLink(), and org.matsim.analysis.VolumesAnalyzer.handleEvent().

                                                     {
         if (time > this.maxTime) {
             return this.maxSlotIndex;
         }
         return ((int) time / this.timeBinSize);
     }

◆ getVolumesForLink() [1/2]

int [] org.matsim.analysis.VolumesAnalyzer.getVolumesForLink ( final Id< Link > linkId )

Parameters

linkId

Returns: Array containing the number of vehicles leaving the link linkId per time bin, starting with time bin 0 from 0 seconds to (timeBinSize-1)seconds.

Definition at line 131 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.get().

Referenced by org.matsim.analysis.VolumesAnalyzer.getVolumesPerHourForLink().

                                                           {
         return this.links.get(linkId);
     }

Here is the call graph for this function:

◆ getVolumesForLink() [2/2]

int [] org.matsim.analysis.VolumesAnalyzer.getVolumesForLink	(	final Id< Link >	linkId,
		String	mode
	)

Parameters

linkId
mode

Returns: Array containing the number of vehicles using the specified mode leaving the link linkId per time bin, starting with time bin 0 from 0 seconds to (timeBinSize-1)seconds.

Definition at line 141 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.get().

                                                                        {
         if (observeModes) {
             Map<String, int[]> modeVolumes = this.linksPerMode.get(linkId);
             if (modeVolumes != null) return modeVolumes.get(mode);
         }
         return null;
     }

Here is the call graph for this function:

◆ getVolumesArraySize()

int org.matsim.analysis.VolumesAnalyzer.getVolumesArraySize ( )

Returns: The size of the arrays returned by calls to the getVolumesForLink(Id) and the getVolumesForLink(Id, String) methods.

Definition at line 153 of file VolumesAnalyzer.java.

                                      {
         return this.maxSlotIndex + 1;
     }

◆ getVolumesPerHourForLink() [1/2]

double [] org.matsim.analysis.VolumesAnalyzer.getVolumesPerHourForLink ( final Id< Link > linkId )

Definition at line 177 of file VolumesAnalyzer.java.

References org.matsim.analysis.VolumesAnalyzer.getTimeSlotIndex(), org.matsim.analysis.VolumesAnalyzer.getVolumesForLink(), and org.matsim.analysis.VolumesAnalyzer.timeBinSize.

Referenced by org.matsim.analysis.CalcLinkStats.addData(), and org.matsim.counts.algorithms.CountsComparisonAlgorithm.CountsComparisonAlgorithm().

                                                                     {
         if (3600.0 % this.timeBinSize != 0) log.error("Volumes per hour and per link probably not correct!");
 
         double[] volumes = new double[24];
 
         int[] volumesForLink = this.getVolumesForLink(linkId);
         if (volumesForLink == null) return volumes;
 
         int slotsPerHour = (int) (3600.0 / this.timeBinSize);
         for (int hour = 0; hour < 24; hour++) {
             double time = hour * 3600.0;
             for (int i = 0; i < slotsPerHour; i++) {
                 volumes[hour] += volumesForLink[this.getTimeSlotIndex(time)];
                 time += this.timeBinSize;
             }
         }
         return volumes;
     }

Here is the call graph for this function:

◆ getVolumesPerHourForLink() [2/2]

double [] org.matsim.analysis.VolumesAnalyzer.getVolumesPerHourForLink	(	final Id< Link >	linkId,
		String	mode
	)

Definition at line 196 of file VolumesAnalyzer.java.

References org.matsim.analysis.VolumesAnalyzer.getTimeSlotIndex(), org.matsim.analysis.VolumesAnalyzer.getVolumesForLink(), and org.matsim.analysis.VolumesAnalyzer.timeBinSize.

                                                                                  {
         if (observeModes) {
             if (3600.0 % this.timeBinSize != 0) log.error("Volumes per hour and per link probably not correct!");
 
             double[] volumes = new double[24];
             for (int hour = 0; hour < 24; hour++) {
                 volumes[hour] = 0.0;
             }
 
             int[] volumesForLink = this.getVolumesForLink(linkId, mode);
             if (volumesForLink == null) return volumes;
 
             int slotsPerHour = (int) (3600.0 / this.timeBinSize);
             for (int hour = 0; hour < 24; hour++) {
                 double time = hour * 3600.0;
                 for (int i = 0; i < slotsPerHour; i++) {
                     volumes[hour] += volumesForLink[this.getTimeSlotIndex(time)];
                     time += this.timeBinSize;
                 }
             }
             return volumes;
         }
         return null;
     }

Here is the call graph for this function:

◆ getModes()

Set<String> org.matsim.analysis.VolumesAnalyzer.getModes ( )

Returns: Set of Strings containing all modes for which counting-values are available.

Definition at line 224 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.values().

                                   {
         Set<String> modes = new TreeSet<>();
 
         for (Map<String, int[]> map : this.linksPerMode.values()) {
             try {
                 modes.addAll(map.keySet());
             } catch (NullPointerException ex) {
                 // Fails on initialized entries, which can happen during tests
                 // will just be ignored here
             }
         }
 
         return modes;
     }

Here is the call graph for this function:

◆ getLinkIds()

Set<Id<Link> > org.matsim.analysis.VolumesAnalyzer.getLinkIds ( )

Returns: Set of Strings containing all link ids for which counting-values are available.

Definition at line 242 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.keySet().

                                       {
         return this.links.keySet();
     }

Here is the call graph for this function:

◆ reset()

void org.matsim.analysis.VolumesAnalyzer.reset ( final int iteration )

Gives the event handler the possibility to clean up its internal state. Within a Controler-Simulation, this is called before the mobsim starts.

Parameters

iteration the up-coming iteration from which up-coming events will be from.

Implements org.matsim.core.events.handler.EventHandler.

Definition at line 247 of file VolumesAnalyzer.java.

References org.matsim.api.core.v01.IdMap< T, V >.clear().

                                            {
         this.links.clear();
         if (observeModes) {
             this.linksPerMode.clear();
             this.enRouteModes.clear();
         }
     }

Here is the call graph for this function:

Member Data Documentation

◆ log

final Logger org.matsim.analysis.VolumesAnalyzer.log = LogManager.getLogger(VolumesAnalyzer.class)

staticprivate

Definition at line 49 of file VolumesAnalyzer.java.

◆ timeBinSize

final int org.matsim.analysis.VolumesAnalyzer.timeBinSize

private

Definition at line 50 of file VolumesAnalyzer.java.

Referenced by org.matsim.analysis.VolumesAnalyzer.getVolumesPerHourForLink(), and org.matsim.analysis.VolumesAnalyzer.VolumesAnalyzer().

◆ maxTime

final int org.matsim.analysis.VolumesAnalyzer.maxTime

private

Definition at line 51 of file VolumesAnalyzer.java.

Referenced by org.matsim.analysis.VolumesAnalyzer.VolumesAnalyzer().

◆ maxSlotIndex

final int org.matsim.analysis.VolumesAnalyzer.maxSlotIndex

private

Definition at line 52 of file VolumesAnalyzer.java.

Referenced by org.matsim.analysis.VolumesAnalyzer.getTimeSlotIndex().

◆ links

final IdMap<Link, int[]> org.matsim.analysis.VolumesAnalyzer.links

private

Definition at line 53 of file VolumesAnalyzer.java.

◆ observeModes

final boolean org.matsim.analysis.VolumesAnalyzer.observeModes

private

Definition at line 56 of file VolumesAnalyzer.java.

Referenced by org.matsim.analysis.VolumesAnalyzer.VolumesAnalyzer().

◆ enRouteModes

final IdMap<Vehicle, String> org.matsim.analysis.VolumesAnalyzer.enRouteModes

private

Definition at line 57 of file VolumesAnalyzer.java.

◆ linksPerMode

final IdMap<Link, Map<String, int[]> > org.matsim.analysis.VolumesAnalyzer.linksPerMode

private

Definition at line 58 of file VolumesAnalyzer.java.

The documentation for this class was generated from the following file:

analysis/VolumesAnalyzer.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VolumesAnalyzer() [1/2]

◆ VolumesAnalyzer() [2/2]

Member Function Documentation

◆ handleEvent() [1/2]

◆ handleEvent() [2/2]

◆ getTimeSlotIndex()

◆ getVolumesForLink() [1/2]

◆ getVolumesForLink() [2/2]

◆ getVolumesArraySize()

◆ getVolumesPerHourForLink() [1/2]

◆ getVolumesPerHourForLink() [2/2]

◆ getModes()

◆ getLinkIds()

◆ reset()

Member Data Documentation

◆ log

◆ timeBinSize

◆ maxTime

◆ maxSlotIndex

◆ links

◆ observeModes

◆ enRouteModes

◆ linksPerMode