Script Doctor 3: Barcelona, Clooney

Passeig de Gràcia 12
08007 Barcelona (Spain)
Tel. (+34) 933 171 693
Fax. (+34) 933 171 716

If you have been in Barcelona you will for sure remember Las Ramblas, one of the most popular tourist attractions in town. Seems that George Clooney has been in Barcelona too and was so impressed by this area that has decided to open a hotel and casino in Las Vegas called, guess it, Las Ramblas. A nice idea from a fine actor and director (have you seen Good Night, and Good Luck?).

Todays example continues with the O/D matrix manipulations. This time we will import, export and copy a matrix to Excel.

Out

The code that we will present is more on Pythons file management than on AIMSUN Scripting. Basically you can adapt the example from the last column (Script Doctor 2) and add this code:

file = open('c:/tmp/matrices.txt', 'w' ) centroids = matrix.getCentroidConfiguration().getCentroidsInOrder() for origin in centroids: for destination in centroids: if origin != destination: trips = matrix.getTrips( origin, destination ) if trips > 0: file.write( '%u %u %f\n' % (origin.getId(), destination.getId(), trips) ) file.write( '\n' ) file.close()

The code writes all the trips in a matrix in a three columns ASCII file. The first column has the origin centroid identifier, the second the destination centroid identifier and the last one the trips.

You can also write, before the trips, any extra information as, for example, the vehicle type:

if matrix.getVehicle() != None: file.write( '%u %s\n' % (matrix.getVehicle().getId(), matrix.getVehicle().getName()) ) else: file.write( '0 None\n' )

or the initial time and duration:

file.write( '%s\n' % matrix.getFrom().toString( Qt.ISODate ) ) file.write( '%s\n' % matrix.getDuration().toString() )

You can put all the code in a function and export more than one matrix at the same time. In this case you will open the file before calling these functions and you will close it after exporting all the matrices. For example, to export all the matrices in a Traffic Demand:

file = open('c:/tmp/matrices.txt', 'w' ) for demandItem in trafficDemand.getSchedule(): if demandItem.getTrafficDemand().isA( "GKODMatrix" ): exportMatrix( file, demandItem.getTrafficDemand() ) file.close()

or all the matrices in a Centroid Configuration:

odMats = config.getODMatrices() if odMats != None: for matrix in odMats: if matrix.isA( "GKODMatrix" ): exportMatrix( file, matrix )

You can change the format from a list of trips to a matrix, you can add more information, etc.

In

We will also code functions to read back matrices as exported from the previous example. We will only present the more relevant part of the code. Look in the References for the complete script.

The reader function will be programmed as a state machine with five states. In the first state it looks for the matrix name, in the second one looks for the vehicle name, then for the initial time, then for the duration and then for all the trips until it founds an empty line. Then it goes back to the first state, looking for a new matrix.

The matrix is located using the id. If the id does not correspond to an existing matrix, a new matrix is created. Note that, in this case, the matrix id will be different from the specified in the file.

def importMatrix( fileName, config ) state = 0 for line in open( fileName, "r" ).readlines(): if line.len() == 0: state = 0 else: if state == 0 : state = 1 # read identifier and name matrixId = int( line[:line.index(' ')] ) matrixName = line[line.index(' ')+1:] matrix = config.getModel().getCatalog().find( matrixId ) if matrix == None or matrix.isA( "GKODMatrix" ) == False: matrix = GKSystem.getSystem().newObject( "GKODMatrix", model ) matrix.setName( matrixName ) config.addODMatrix( matrix ) elif state == 1: state = 2 # read vehicle id and name vehId = int( line[:line.index(' ')] ) vehName = line[line.index(' ')+1:] vehicle = config.getModel().getCatalog().find( vehId ) if vehicle == None: vehicle = config.getModel().getCatalog().findByName( vehName ) elif state == 2: state = 3 # Initial Time matrix.setFrom( QTime.fromString( line, Qt.ISODate ) ) elif state == 3: state = 4 # Duration matrix.setDuration( GKTimeDuration.fromString( line ) ) elif state == 4 # Trips tokens = line.split( " " ) if len( tokens ) == 3: fromCentroid = centroidConf.getModel().getCatalog().find( int(tokens[0]) ) toCentroid = centroidConf.getModel().getCatalog().find( int(tokens[1]) ) trips = float(tokens[2]) # Set the value if the section is valid if fromCentroid != None and toCentroid != None: matrix.setTrips( fromCentroid, toCentroid, trips )

The more tricky part is the split of a line in different parts. To split the line with the identifier and name we look for the first space (line.index(' ')) and then we take the initial part as the identifier (int( line[:line.index(' ')] )) and the remain as the name (line[line.index(' ')+1:]).

Python includes a nice function to split a line using a token (line.split( " " )) that can be used to separate in three strings the trips line but cannot be used for the identifier and name lanes, as the separator, is a space and the name can contains spaces too.

Note the use of int and float methods to convert a string to a number (int( line[:line.index(' ')] ) and trips = float(entry) ).

Excel

What makes Python great is not only the quality as a programming language but also the big catalog of solutions that are available: from numerical manipulation to database access. One nice available module allows Python to talk with Windows applications that support COM as Microsoft Excel, its called PyWin32.

Using PyWin32 we can launch Excel and write a matrix into it. The code is:

from win32com.client import Dispatch # Variables used to configure this script # # Identifier of the matrix matrixId = 266 # Copy the matrix def copyMatrix( matrix, excelSheet ): # Get the centroid configuration, config = matrix.getCentroidConfiguration() # List of centroids centroids = config.getCentroidsInOrder() # Read the trips... i = 1 for origin in centroids: j = 1 for destination in centroids: trips = matrix.getTrips( origin, destination ) # and copy them to excel excelSheet.Cells( i,j ).Value = trips j = j + 1 i = i + 1 matrix = model.getCatalog().find( matrixId ) if matrix != None and matrix.isA( "GKODMatrix" ): xlApp = Dispatch("Excel.Application") xlApp.Visible = 1 xlApp.Workbooks.Add() copyMatrix( matrix, xlApp.ActiveWorkbook.ActiveSheet ) print "Done"