org.matsim.analysis.LegHistogram Class Reference

Inheritance diagram for org.matsim.analysis.LegHistogram:

Classes
class	DataFrame

Public Member Functions
	LegHistogram (final int binSize, final int nofBins)
	LegHistogram (final int binSize)
void	handleEvent (final PersonDepartureEvent event)
void	handleEvent (final PersonArrivalEvent event)
void	handleEvent (final PersonStuckEvent event)
void	reset (final int iter)
void	write (final String filename)
void	write (final PrintStream stream)
int []	getDepartures ()
int []	getArrivals ()
int []	getStuck ()
Set< String >	getLegModes ()
int []	getDepartures (final String legMode)
int []	getArrivals (final String legMode)
int []	getStuck (final String legMode)

Static Public Attributes
static final int	DEFAULT_END_TIME = 30 * 3600
static final int	DEFAULT_BIN_SIZE = 300

Private Member Functions
int	getBinIndex (final double time)

Private Attributes
Set< Id< Person > >	personIds
int	iteration = 0
final int	binSize
final int	nofBins
final Map< String, DataFrame >	data = new TreeMap<>()

Detailed Description

Author

mrieser

Counts the number of persons departed, arrived or got stuck per time bin based on events.

The chart plotting was moved to its own class. This class could be moved to trafficmonitoring.

Definition at line 57 of file LegHistogram.java.

Constructor & Destructor Documentation

LegHistogram() [1/2]

org.matsim.analysis.LegHistogram.LegHistogram	(	final int	binSize,
		final int	nofBins
	)

Creates a new LegHistogram with the specified binSize and the specified number of bins.

Parameters

binSize	The size of a time bin in seconds.
nofBins	The number of time bins for this analysis.

Definition at line 88 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.binSize, org.matsim.analysis.LegHistogram.nofBins, and org.matsim.analysis.LegHistogram.reset().

                                                              {
        super();
        this.binSize = binSize;
        this.nofBins = nofBins;
        reset(0);
    }

Here is the call graph for this function:

LegHistogram() [2/2]

org.matsim.analysis.LegHistogram.LegHistogram

(

final int

binSize

)

Creates a new LegHistogram with the specified binSize and a default number of bins, such that 30 hours are analyzed.

Parameters

binSize

The size of a time bin in seconds.

Definition at line 100 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.binSize.

                                           {
        this(binSize, DEFAULT_END_TIME / binSize + 1);
    }

Member Function Documentation

handleEvent() [1/3]

void org.matsim.analysis.LegHistogram.handleEvent

(

final PersonDepartureEvent

event

)

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

Definition at line 107 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.getBinIndex(), org.matsim.api.core.v01.events.PersonDepartureEvent.getLegMode(), org.matsim.api.core.v01.events.PersonDepartureEvent.getPersonId(), and org.matsim.api.core.v01.events.Event.getTime().

                                                              {
        int index = getBinIndex(event.getTime());
        if ((this.personIds == null || this.personIds.contains(event.getPersonId())) && event.getLegMode() != null) {
            DataFrame dataFrame = getDataForMode(event.getLegMode());
            dataFrame.countsDep[index]++;
        }
    }

Here is the call graph for this function:

handleEvent() [2/3]

void org.matsim.analysis.LegHistogram.handleEvent

(

final PersonArrivalEvent

event

)

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

Definition at line 116 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.getBinIndex(), org.matsim.api.core.v01.events.PersonArrivalEvent.getLegMode(), org.matsim.api.core.v01.events.PersonArrivalEvent.getPersonId(), and org.matsim.api.core.v01.events.Event.getTime().

                                                            {
        int index = getBinIndex(event.getTime());
        if ((this.personIds == null || this.personIds.contains(event.getPersonId())) && event.getLegMode() != null) {
            DataFrame dataFrame = getDataForMode(event.getLegMode());
            dataFrame.countsArr[index]++;
        }
    }

Here is the call graph for this function:

handleEvent() [3/3]

void org.matsim.analysis.LegHistogram.handleEvent

(

final PersonStuckEvent

event

)

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

Definition at line 125 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.getBinIndex(), org.matsim.api.core.v01.events.PersonStuckEvent.getLegMode(), org.matsim.api.core.v01.events.PersonStuckEvent.getPersonId(), and org.matsim.api.core.v01.events.Event.getTime().

                                                          {
        int index = getBinIndex(event.getTime());
        if ((this.personIds == null || this.personIds.contains(event.getPersonId())) && event.getLegMode() != null) {
            DataFrame dataFrame = getDataForMode(event.getLegMode());
            dataFrame.countsStuck[index]++;
        }
    }

Here is the call graph for this function:

reset()

void org.matsim.analysis.LegHistogram.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 134 of file LegHistogram.java.

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

                                      {
        this.iteration = iter;
        this.data.clear();
    }

write() [1/2]

void org.matsim.analysis.LegHistogram.write

(

final String

filename

)

Writes the gathered data tab-separated into a text file.

Parameters

filename

The name of a file where to write the gathered data.

Definition at line 144 of file LegHistogram.java.

References org.matsim.core.utils.io.IOUtils.getFileUrl(), and org.matsim.core.utils.io.IOUtils.getOutputStream().

                                             {
        try (OutputStream stream = IOUtils.getOutputStream(IOUtils.getFileUrl(filename), false)) {
            write(new PrintStream(stream));
        } catch (IOException e) {
            throw new UncheckedIOException(e);
        }
    }

Here is the call graph for this function:

write() [2/2]

void org.matsim.analysis.LegHistogram.write

(

final PrintStream

stream

)

Writes the gathered data tab-separated into a text stream.

Parameters

stream

The data stream where to write the gathered data.

Definition at line 157 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.binSize, and org.matsim.core.utils.misc.Time.writeTime().

                                                {
        stream.print("time\ttime\tdepartures_all\tarrivals_all\tstuck_all\ten-route_all");
        for (String legMode : this.data.keySet()) {
            stream.print("\tdepartures_" + legMode + "\tarrivals_" + legMode + "\tstuck_" + legMode + "\ten-route_" + legMode);
        }
        stream.print("\n");
        int allEnRoute = 0;
        int[] modeEnRoute = new int[this.data.size()];
                DataFrame allModesData = getAllModesData();
                for (int i = 0; i < allModesData.countsDep.length; i++) {
            // data about all modes
            allEnRoute = allEnRoute + allModesData.countsDep[i] - allModesData.countsArr[i] - allModesData.countsStuck[i];
            stream.print(Time.writeTime(i*this.binSize) + "\t" + i*this.binSize);
            stream.print("\t" + allModesData.countsDep[i] + "\t" + allModesData.countsArr[i] + "\t" + allModesData.countsStuck[i] + "\t" + allEnRoute);

            // data about single modes
            int mode = 0;
            for (DataFrame dataFrame : this.data.values()) {
                modeEnRoute[mode] = modeEnRoute[mode] + dataFrame.countsDep[i] - dataFrame.countsArr[i] - dataFrame.countsStuck[i];
                stream.print("\t" + dataFrame.countsDep[i] + "\t" + dataFrame.countsArr[i] + "\t" + dataFrame.countsStuck[i] + "\t" + modeEnRoute[mode]);
                mode++;
            }

            // new line
            stream.print("\n");
        }
    }

Here is the call graph for this function:

getDepartures() [1/2]

int [] org.matsim.analysis.LegHistogram.getDepartures

(

)

Returns

number of departures per time-bin, for all legs

Definition at line 188 of file LegHistogram.java.

                                 {
        return this.getAllModesData().countsDep;
    }

getArrivals() [1/2]

int [] org.matsim.analysis.LegHistogram.getArrivals

(

)

Returns

number of all arrivals per time-bin, for all legs

Definition at line 195 of file LegHistogram.java.

                               {
        return this.getAllModesData().countsArr;
    }

getStuck() [1/2]

int [] org.matsim.analysis.LegHistogram.getStuck

(

)

Returns

number of all vehicles that got stuck in a time-bin, for all legs

Definition at line 202 of file LegHistogram.java.

                            {
        return this.getAllModesData().countsStuck;
    }

getLegModes()

Set<String> org.matsim.analysis.LegHistogram.getLegModes

(

)

Returns

Set of all transportation modes data is available for

Definition at line 209 of file LegHistogram.java.

                                     {
        return this.data.keySet();
    }

getDepartures() [2/2]

int [] org.matsim.analysis.LegHistogram.getDepartures

(

final String

legMode

)

Parameters

legMode

transport mode

Returns

number of departures per time-bin, for all legs with the specified mode

Definition at line 217 of file LegHistogram.java.

                                                     {
        DataFrame dataFrame = this.data.get(legMode);
        if (dataFrame == null) {
            return new int[0];
        }
        return dataFrame.countsDep.clone();
    }

getArrivals() [2/2]

int [] org.matsim.analysis.LegHistogram.getArrivals

(

final String

legMode

)

Parameters

legMode

transport mode

Returns

number of all arrivals per time-bin, for all legs with the specified mode

Definition at line 229 of file LegHistogram.java.

                                                   {
        DataFrame dataFrame = this.data.get(legMode);
        if (dataFrame == null) {
            return new int[0];
        }
        return dataFrame.countsArr.clone();
    }

getStuck() [2/2]

int [] org.matsim.analysis.LegHistogram.getStuck

(

final String

legMode

)

Parameters

legMode

transport mode

Returns

number of vehicles that got stuck in a time-bin, for all legs with the specified mode

Definition at line 241 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.iteration.

                                                {
        DataFrame dataFrame = this.data.get(legMode);
        if (dataFrame == null) {
            return new int[0];
        }
        return dataFrame.countsStuck.clone();
    }

getBinIndex()

int org.matsim.analysis.LegHistogram.getBinIndex ( final double  time )

private

Definition at line 269 of file LegHistogram.java.

References org.matsim.analysis.LegHistogram.binSize, and org.matsim.analysis.LegHistogram.nofBins.

Referenced by org.matsim.analysis.LegHistogram.handleEvent().

                                               {
        int bin = (int)(time / this.binSize);
        if (bin >= this.nofBins) {
            return this.nofBins;
        }
        return bin;
    }

Member Data Documentation

DEFAULT_END_TIME

final int org.matsim.analysis.LegHistogram.DEFAULT_END_TIME = 30 * 3600

static

Definition at line 59 of file LegHistogram.java.

DEFAULT_BIN_SIZE

final int org.matsim.analysis.LegHistogram.DEFAULT_BIN_SIZE = 300

static

Definition at line 60 of file LegHistogram.java.

personIds

Set<Id<Person> > org.matsim.analysis.LegHistogram.personIds

private

Definition at line 62 of file LegHistogram.java.

iteration

int org.matsim.analysis.LegHistogram.iteration = 0

private

Definition at line 63 of file LegHistogram.java.

Referenced by org.matsim.analysis.LegHistogram.getStuck().

binSize

final int org.matsim.analysis.LegHistogram.binSize

private

Definition at line 64 of file LegHistogram.java.

Referenced by org.matsim.analysis.LegHistogram.getBinIndex(), org.matsim.analysis.LegHistogram.LegHistogram(), and org.matsim.analysis.LegHistogram.write().

nofBins

final int org.matsim.analysis.LegHistogram.nofBins

private

Definition at line 65 of file LegHistogram.java.

Referenced by org.matsim.analysis.LegHistogram.getBinIndex(), and org.matsim.analysis.LegHistogram.LegHistogram().

data

final Map<String, DataFrame> org.matsim.analysis.LegHistogram.data = new TreeMap<>()

private

Definition at line 66 of file LegHistogram.java.

---

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

• analysis/LegHistogram.java