CS 151: Lab 6

### Lab Exercise 6: Strings, Grammars, and Trees

The purpose of this lab is to gain familiarity with simple L-system grammars and how we can use them to represent visual shapes. L-systems were designed to allow computer scientists and biologists to model plants and plant development. As with the last few collage labs, we'll represent an L-system as a list of items and enable reading L-systems from a file using a simple syntax.

The fundamental concepts we'll be implementing in the next several labs are based on a set of techniques described in the book 'The Algorithmic Beauty of Plants'. You can download the entire book from the algorithmic botany site, if you're interested in learning more. The algorithms in the book have proven very successful in modeling plant life and form the basis for commercial plant modeling systems that are used in computer graphics special effects.

The overall concept of the book is that we can represent real plants and how they grow using strings and rules for manipulating them. The theoretical procedure for generating and manipulating the strings is called an L-system, or Lindenmayer-system.

When modeling plants, we can treat each character in the string as equivalent to a physical aspect of a plant. A forward line is like a stem, and a right or left turn is like a junction where a branch forms and grows outwards. In fact, the whole book uses turtle graphics to create models of plants from strings and rules about how to manipulate the strings.

Fortunately, the past several labs have given you the knowledge to build a system that can implement this idea. This project will walk you through the process of building a system that can create some simple plant models, as well as other interesting geometric shapes.

An L-system has three parts.

1. An alphabet of characters
2. A base string
3. One or more replacement rules that substitute a new string for a character in the old string.

The characters we're going to include in our alphabet are as follows.

```F is forward by a certain distance
+ is left by an angle
- is right by an angle
[ is save the turtle state
] is restore the turtle state
```

To give a concrete example, consider the following L-system:

• Alphabet: F, +, -
• Base string: F
• Rule: F -> -F+F-F

The way to apply a rule is to simultaneously replace all cases of the left side of the rule in the base string with the right side of the rule. If the process is repeated, the string will continue to grow, as shown below.

```F
-F+F-F
--F+F-F+-F+F-F--F+F-F
---F+F-F+-F+F-F--F+F-F+--F+F-F+-F+F-F-Y---F+F-F+-F+F-F--F+F-F
```

In this lab we're going to create two files: lsystem.py and turtle_interpreter.py. The lsystem file will contain all of the functions necessary to read an lsystem from a file and generate a string from the lsystem rules. The turtle_interpreter file will contain the code required to convert a string into a sequence of turtle commands. The two files will be completely separate; the lsystem file will not know anything about graphics, and the turtle_interpreter file will not know anything about L-systems. For the project you'll use both files to create an image that contains shapes built from L-system strings.

1. Create a working directory for project 6 on your personal volume (e.g. Proj6). Then begin a new python file called lsystem.py. At the top of the file put your name and version 1 as comments. We will be editing our lsystem file for each of the next 4 weeks, so having a version number at the top of your file will be important.
2. We're going to do top-down design and start with a test function for the lsystem functions. The goal is to be able to read an L-system from a file and generate strings defined by the base string and the rules. Import the sys package, then create a function main with argv as its parameter. The main function needs the following steps.
```import sys

def main(argv):
""" Generate a string using an L-system, and write the string
to a file """
# get the filename, number of iterations, and output filename from argv
# assign to a variable (e.g. lsys) the result of createFromFile(filename)
# assign to a variable (e.g. s) the result of buildString(lsys, iterations)
# open the output file for writing
# write out the string
# close the file

if __name__ == "__main__":
main(sys.argv)
```

The final two lines put a call to main with sys.argv as its argument inside the usual __name__ conditional test.

If we create placeholder functions for createFromFile and buildString, we can test the code right now. Make a function createFromFile that returns 0 and a function buildString( lsys, iterations) that returns some random string. Then test your code.

3. There are obviously two functions in the main program we haven't yet built. Let's modify the placeholder function createFromFile. Above your main function, define a function createFromFile that takes a filename as an argument. This function should read an L-system's base string and rules from a file, create a data structure to hold the information, and return that data structure.

The information we need to read from the file is the base string and the set of rules. While we will use only a single rule this week, we need to design our system so it can read in a file with multiple rules.

We need to decide what format to use to store our L-system in a file. A format that is both human-readable and easy to parse with a program is to have a word at the beginning of the line that indicates what information is on the line and then have the information as the remaining elements of the line. In the case of the base string there will be only a single string, and for a rule there will be two strings (for now).

An example file is given below

```base F-F-F-F
rule F FF-F+F-F-FF
```

The algorithm for reading the file is to open the file, read the lines of the file, then loop over the lines, putting the information in the appropriate location in the lsystem data structure according to the keyword at the beginning of the line.

```def createFromFile( filename ):
""" Create an L-system list by reading in the specified file """
# open the file, storing the file pointer in a variable
# read all of the lines in the file
# close the file
# call the function init() and assign its output (an empty Lsystem) to lsys
# for each line
# split the line on spaces using the split method
# if the first word is 'base'
# set the base of the lsystem using the function setBase
# else if the first word is 'rule'
# return the lsystem list
```

Note that we have three functions--init, setBase, and addRule--that we now need to define. Note also that we still have no need to know exactly how we're storing the information in the lsystem data structure.

4. The init function is the first function that requires us to know how we're going to store the L-system information. The L-system requires two pieces of information: the base string and the list of rules. A simple method of storing this information is in a list with two items; the first item is the base string, the second item is a list of 2-element lists (the rules). For example, the L-system defined in the file above would have the form below in memory.

['F-F-F-F', [ [ 'F', 'FF-F+F-F-FF' ] ] ]

Given this representation, an empty L-system would be a list with two elements: the empty string and an empty list. Have the init function return an empty L-system.

Since all of the functions in this module will take an L-system list with the above format, let's write a comment at the top describing it. That way, we don't need to include too much detail in all of the docstrings. Take the time right now to add a comment at the top of the file describing the format of the list used to represent an L-system.

5. Now we can write the setBase and addRule functions. The setBase function takes in two arguments, an L-system and a base string, and sets the base string field of the L-system list to the new string.

The addRule function is a little more complex because we need to copy the data from the rule passed into the addRule function. The form of the function is given below.

```def addRule( lsys, newrule ):
""" Add a rule to the L-system list stored in lsys.
newrule is a list of 2 strings """
# clone newrule and append it to the L-system's rule list
```
6. Now we need to write three more functions and our lsystem.py file will be complete. Update the placeholder buildString function. It takes in two arguments: an lsystem data structure and the number of iterations of replacement to execute.
```def buildString( lsys, iter ):
""" Return a string generated by applying the L-system rules
for iter iterations """
# assign to a local variable (e.g. nstring) the result of getBase(lsys)
# assign to a local variable (e.g. rule) the result of getRule(lsys, 0)
# assign to a local variable (e.g. symbol) the first element of of the rule
# assign to a local variable (e.g. replacement) the second element of of the rule
# loop iter times
# assign to nstring, the result of nstring.replace( symbol, replacement )
# return nstring
```

The final piece is to write an accessor getBase that returns the base string of an lsystem structure and an accessor getRule that returns the specified rule of an lsystem structure.

First try running systemA1 with the number of iterations being 1 and see if it creates what you expect. Then set the number of iterations to 3 and save the outputs for systemA1, systemA2, and systemB in separate files.

7. Create a new file called turtle_interpreter.py. Put your name and version 1 at the top in comments. The purpose of this file is to convert a string into an image using simple turtle commands.

The primary function in this file is drawString. The drawString function is an turtle_interpreter. It converts information in one form into information in another form. In this case, it converts a string of characters into a series of turtle commands.

The form of the function is to loop through the string and execute a particular action (or nothing) for each character.

```def drawString( dstring, distance, angle ):
""" Interpret the characters in string dstring as a series
of turtle commands. Distance specifies the distance
to travel for each forward command. Angle specifies the
angle (in degrees) for each right or left command. The list of
turtle supported turtle commands is:
F : forward
- : turn right
+ : turn left
"""
# assign to a local variable (e.g. stack) the empty list
# for each character c in dstring
# if c is 'F'
# go forward by distance
# else if c is equal to '-'
# turn right by angle
# else if c is equal to '+'
# turn left by angle
# else if c is equal to '['
# append to stack the position of the turtle
# append to stack the heading of the turtle
# else if c is equal to ']'
# pick up the turtle pen
# set the heading of the turtle to the value popped off state
# set the position of the turtle to the value popped off state
# put down the turtle pen
# call turtle.update()
```
8. The function hold() is given below. It sets up the turtle window to quit if you type 'q' or click in the window. Copy it to your turtle_interpreter.py file.
```def hold():
""" holds the screen open until the user clicks or types 'q' """

# have the turtle listen for events
turtle.listen()

# hide the turtle and update the screen
turtle.ht()
turtle.update()

# have the turtle listen for 'q'
turtle.onkey( turtle.bye, 'q' )
# have the turtle listen for a click
turtle.onscreenclick( lambda x,y: turtle.bye() )

# start the main loop until an event happens, then exit
turtle.mainloop()
exit()
```

Now test your turtle_interpreter.py and lsystem.py programs using testlsimple.py. Use a 90 degree angle for systems A1 and A2 and a 22.5 degree angle for system B. Then try a 120 degree angle for system A1 for a different effect.

9.  System A1 (angle 90) System A1 (angle 120) System A2 System B

You can also try a slightly more complex test program testlsystem.py that draws several copies of a pair of lsystems.

When you are done with the lab exercises, you may begin the project.