Contents
Python Scientific lecture notes
Release 2013.2 beta (euroscipy 2013)
I One document to learn numerics, science, and data with Python
EuroScipy tutorial team
Editors: Valentin Haenel, Emmanuelle Gouillart, Gaël Varoquaux
http://scipy-lectures.github.com
1 Getting started with Python for science
1.1 Scientific computing with tools and workflow . . .
1.2 The Python language . . . . . . . . . . . . . . . .
1.3 NumPy: creating and manipulating numerical data
1.4 Matplotlib: plotting . . . . . . . . . . . . . . . .
1.5 Scipy : high-level scientific computing . . . . . .
1.6 Getting help and finding documentation . . . . . .
1
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
3
.
3
.
9
. 42
. 81
. 103
. 137
2 Advanced topics
2.1 Advanced Python Constructs . . . . . . . . . . . . . . . . .
2.2 Advanced Numpy . . . . . . . . . . . . . . . . . . . . . .
2.3 Debugging code . . . . . . . . . . . . . . . . . . . . . . .
2.4 Optimizing code . . . . . . . . . . . . . . . . . . . . . . .
2.5 Sparse Matrices in SciPy . . . . . . . . . . . . . . . . . . .
2.6 Image manipulation and processing using Numpy and Scipy
2.7 Mathematical optimization: finding minima of functions . .
2.8 Interfacing with C . . . . . . . . . . . . . . . . . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
139
139
155
187
197
203
222
239
252
3 Packages and applications
3.1 Statistics in Python . . . . . . . . . . . . .
3.2 Sympy : Symbolic Mathematics in Python
3.3 Scikit-image: image processing . . . . . .
3.4 Traits: building interactive dialogs . . . . .
3.5 3D plotting with Mayavi . . . . . . . . . .
3.6 scikit-learn: machine learning in Python . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
271
271
318
324
338
357
369
Index
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
379
September 26, 2015 (2013.2-beta-328-g3cd80a5)
i
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Part I
One document to learn numerics, science,
and data with Python
1
2
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
CHAPTER 1
Existing solutions
Which solutions do scientists use to work?
Compiled languages: C, C++, Fortran, etc.
• Advantages:
Getting started with Python for science
– Very fast. Very optimized compilers. For heavy computations, it’s difficult to outperform these languages.
– Some very optimized scientific libraries have been written for these languages. Example: BLAS
(vector/matrix operations)
• Drawbacks:
This part of the Scipy lecture notes is a self-contained introduction to everything that is needed to use Python for
science, from the language itself, to numerical computing or plotting.
– Painful usage: no interactivity during development, mandatory compilation steps, verbose syntax (&,
::, }}, ; etc.), manual memory management (tricky in C). These are difficult languages for non computer scientists.
Scripting languages: Matlab
• Advantages:
– Very rich collection of libraries with numerous algorithms, for many different domains. Fast execution
because these libraries are often written in a compiled language.
1.1 Scientific computing with tools and workflow
– Pleasant development environment: comprehensive and well organized help, integrated editor, etc.
– Commercial support is available.
Authors: Fernando Perez, Emmanuelle Gouillart, Gaël Varoquaux, Valentin Haenel
• Drawbacks:
– Base language is quite poor and can become restrictive for advanced users.
1.1.1 Why Python?
– Not free.
The scientist’s needs
Other scripting languages: Scilab, Octave, Igor, R, IDL, etc.
• Advantages:
• Get data (simulation, experiment control),
– Open-source, free, or at least cheaper than Matlab.
• Manipulate and process data,
– Some features can be very advanced (statistics in R, figures in Igor, etc.)
• Visualize results (to understand what we are doing!),
• Drawbacks:
• Communicate results: produce figures for reports or publications, write presentations.
– Fewer available algorithms than in Matlab, and the language is not more advanced.
– Some software are dedicated to one domain. Ex: Gnuplot or xmgrace to draw curves. These programs
are very powerful, but they are restricted to a single type of usage, such as plotting.
Specifications
• Rich collection of already existing bricks corresponding to classical numerical methods or basic actions: we
don’t want to re-program the plotting of a curve, a Fourier transform or a fitting algorithm. Don’t reinvent
the wheel!
• Easy to learn: computer science is neither our job nor our education. We want to be able to draw a curve,
smooth a signal, do a Fourier transform in a few minutes.
• Easy communication with collaborators, students, customers, to make the code live within a lab or a company: the code should be as readable as a book. Thus, the language should contain as few syntax symbols or
unneeded routines as possible that would divert the reader from the mathematical or scientific understanding
of the code.
• Efficient code that executes quickly... but needless to say that a very fast code becomes useless if we spend
too much time writing it. So, we need both a quick development time and a quick execution time.
• A single environment/language for everything, if possible, to avoid learning a new software for each new
problem.
3
What about Python?
• Advantages:
– Very rich scientific computing libraries (a bit less than Matlab, though)
– Well thought out language, allowing to write very readable and well structured code: we “code what
we think”.
– Many libraries for other tasks than scientific computing (web server management, serial port access,
etc.)
– Free and open-source software, widely spread, with a vibrant community.
• Drawbacks:
– less pleasant development environment than, for example, Matlab. (More geek-oriented).
– Not all the algorithms that can be found in more specialized software or toolboxes.
1.1. Scientific computing with tools and workflow
4
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.1.2 Scientific Python building blocks
1.1.3 The interactive workflow: IPython and a text editor
Unlike Matlab, Scilab or R, Python does not come with a pre-bundled set of modules for scientific computing.
Below are the basic building blocks that can be combined to obtain a scientific computing environment:
Interactive work to test and understand algorithms: In this section, we describe an interactive workflow with
IPython that is handy to explore and understand algorithms.
• Python, a generic and modern computing language
– Python language: data types (string, int), flow control, data collections (lists, dictionaries), patterns, etc.
– Modules of the standard library.
Python is a general-purpose language. As such, there is not one blessed environment to work in, and not only one
way of using it. Although this makes it harder for beginners to find their way, it makes it possible for Python to be
used to write programs, in web servers, or embedded devices.
Reference document for this section:
– A large number of specialized modules or applications written in Python: web protocols, web framework, etc. ... and scientific computing.
IPython user manual: http://ipython.org/ipython-doc/dev/index.html
– Development tools (automatic testing, documentation generation)
Command line interaction
Start ipython:
In [1]: print('Hello world')
Hello world
Getting help by using the ? operator after an object:
• IPython, an advanced Python shell http://ipython.org/
• Numpy : provides powerful numerical arrays objects, and routines to manipulate them.
http://www.numpy.org/
• Scipy :
high-level data processing routines.
http://www.scipy.org/
Optimization,
regression,
interpolation,
etc
In [2]: print?
Type:
builtin_function_or_method
Base Class:
<type 'builtin_function_or_method'>
String Form:
<built-in function print>
Namespace:
Python builtin
Docstring:
print(value, ..., sep=' ', end='\n', file=sys.stdout)
Prints the values to a stream, or to sys.stdout by default.
Optional keyword arguments:
file: a file-like object (stream); defaults to the current sys.stdout.
sep: string inserted between values, default a space.
end: string appended after the last value, default a newline.
Elaboration of the algorithm in an editor
• Matplotlib : 2-D visualization, “publication-ready” plots http://matplotlib.org/
Create a file my_file.py in a text editor. Under EPD (Enthought Python Distribution), you can use Scite,
available from the start menu. Under Python(x,y), you can use Spyder. Under Ubuntu, if you don’t already have
your favorite editor, we would advise installing Stani’s Python editor. In the file, add the following
lines:
s = 'Hello world'
print(s)
Now, you can run it in IPython and explore the resulting variables:
In [1]: %run my_file.py
Hello world
In [2]: s
Out[2]: 'Hello world'
In [3]: %whos
Variable
Type
Data/Info
---------------------------s
str
Hello world
• Mayavi : 3-D visualization http://code.enthought.com/projects/mayavi/
1.1. Scientific computing with tools and workflow
5
1.1. Scientific computing with tools and workflow
6
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In [8]: debug
> /.../IPython/core/compilerop.py (87)ast_parse()
86
and are passed to the built-in compile function."""
---> 87
return compile(source, filename, symbol, self.flags | PyCF_ONLY_AST, 1)
88
From a script to functions
While it is tempting to work only with scripts, that is a file full of instructions following each other, do plan
to progressively evolve the script to a set of functions:
• A script is not reusable, functions are.
• Thinking in terms of functions helps breaking the problem in small blocks.
ipdb>locals()
{'source': u'x === 10\n', 'symbol': 'exec', 'self':
<IPython.core.compilerop.CachingCompiler instance at 0x2ad8ef0>,
'filename': '<ipython-input-6-12fd421b5f28>'}
IPython Tips and Tricks
The IPython user manual contains a wealth of information about using IPython, but to get you started we want to
give you a quick introduction to four useful features: history, magic functions, aliases and tab completion.
Like a UNIX shell, IPython supports command history. Type up and down to navigate previously typed commands:
IPython help
• The built-in IPython cheat-sheet is accessible via the %quickref magic function.
• A list of all available magic functions is shown when typing %magic.
In [1]: x = 10
Furthermore IPython ships with various aliases which emulate common UNIX command line tools such as ls to
list files, cp to copy files and rm to remove files. A list of aliases is shown when typing alias:
In [2]: <UP>
In [2]: x = 10
IPython supports so called magic functions by prefixing a command with the % character. For example, the run
and whos functions from the previous section are magic functions. Note that, the setting automagic, which is
enabled by default, allows you to omit the preceding % sign. Thus, you can just type the magic function and it will
work.
Other useful magic functions are:
• %cd to change the current directory.
In [2]: cd /tmp
/tmp
• %timeit allows you to time the execution of short snippets using the timeit module from the standard
library:
In [3]: timeit x = 10
10000000 loops, best of 3: 39 ns per loop
• %cpaste allows you to paste code, especially code from websites which has been prefixed with the standard Python prompt (e.g. >>>) or with an ipython prompt, (e.g. in [3]):
In [5]: cpaste
Pasting code; enter '--' alone on the line to stop or use Ctrl-D.
:In [3]: timeit x = 10
:-10000000 loops, best of 3: 85.9 ns per loop
In [6]: cpaste
Pasting code; enter '--' alone on the line to stop or use Ctrl-D.
:>>> timeit x = 10
:-10000000 loops, best of 3: 86 ns per loop
| grep /$'),
grep ^-'),
grep ^l'),
grep ^-..x'),
Lastly, we would like to mention the tab completion feature, whose description we cite directly from the IPython
manual:
Tab completion, especially for attributes, is a convenient way to explore the structure of any object you’re dealing
with. Simply type object_name.<TAB> to view the object’s attributes. Besides Python objects and keywords, tab
completion also works on file and directory names.
In [1]: x = 10
In [2]: x.<TAB>
x.bit_length
x.conjugate
x.real
• %debug allows you to enter post-mortem debugging. That is to say, if the code you try to execute, raises
an exception, using %debug will enter the debugger at the point where the exception was thrown.
In [7]: x === 10
File "<ipython-input-6-12fd421b5f28>", line 1
x === 10
^
SyntaxError: invalid syntax
1.1. Scientific computing with tools and workflow
In [1]: alias
Total number of aliases: 16
Out[1]:
[('cat', 'cat'),
('clear', 'clear'),
('cp', 'cp -i'),
('ldir', 'ls -F -o --color %l
('less', 'less'),
('lf', 'ls -F -o --color %l |
('lk', 'ls -F -o --color %l |
('ll', 'ls -F -o --color'),
('ls', 'ls -F --color'),
('lx', 'ls -F -o --color %l |
('man', 'man'),
('mkdir', 'mkdir'),
('more', 'more'),
('mv', 'mv -i'),
('rm', 'rm -i'),
('rmdir', 'rmdir')]
In [3]: x.real.
x.real.bit_length
x.real.conjugate
x.denominator
x.real.denominator
x.real.imag
x.imag
x.numerator
x.real.numerator
x.real.real
In [4]: x.real.
7
1.1. Scientific computing with tools and workflow
8
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.2 The Python language
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> print("Hello, world!")
Hello, world!
Authors: Chris Burns, Christophe Combelles, Emmanuelle Gouillart, Gaël Varoquaux
Tip: The message “Hello, world!” is then displayed. You just executed your first Python instruction, congratulations!
Python for scientific computing
To get yourself started, type the following stack of instructions
We introduce here the Python language. Only the bare minimum necessary for getting started with Numpy
and Scipy is addressed here. To learn more about the language, consider going through the excellent tutorial
http://docs.python.org/tutorial. Dedicated books are also available, such as http://diveintopython.net/.
Tip: Python is a programming language, as are C, Fortran, BASIC, PHP, etc. Some specific features of Python
are as follows:
• an interpreted (as opposed to compiled) language. Contrary to e.g. C or Fortran, one does not compile
Python code before executing it. In addition, Python can be used interactively: many Python interpreters
are available, from which commands and scripts can be executed.
• a free software released under an open-source license: Python can be used and distributed free of charge,
even for building commercial software.
• multi-platform: Python is available for all major operating systems, Windows, Linux/Unix, MacOS X,
most likely your mobile phone OS, etc.
• a very readable language with clear non-verbose syntax
• a language for which a large variety of high-quality packages are available for various applications, from
web frameworks to scientific computing.
>>> a = 3
>>> b = 2*a
>>> type(b)
<type 'int'>
>>> print(b)
6
>>> a*b
18
>>> b = 'hello'
>>> type(b)
<type 'str'>
>>> b + b
'hellohello'
>>> 2*b
'hellohello'
Tip: Two variables a and b have been defined above. Note that one does not declare the type of an variable
before assigning its value. In C, conversely, one should write:
int a = 3;
In addition, the type of a variable may change, in the sense that at one point in time it can be equal to a value of
a certain type, and a second point in time, it can be equal to a value of a different type. b was first equal to an
integer, but it became equal to a string when it was assigned the value ’hello’. Operations on integers (b=2*a)
are coded natively in Python, and so are some operations on strings such as additions and multiplications, which
amount respectively to concatenation and repetition.
• a language very easy to interface with other languages, in particular C and C++.
• Some other features of the language are illustrated just below. For example, Python is an object-oriented
language, with dynamic typing (the same variable can contain objects of different types during the course
of a program).
1.2.2 Basic types
Numerical types
See http://www.python.org/about/ for more information about distinguishing features of Python.
Tip: Python supports the following numerical, scalar types:
Integer
1.2.1 First steps
>>> 1 + 1
2
>>> a = 4
>>> type(a)
<type 'int'>
Start the Ipython shell (an enhanced interactive Python shell):
• by typing “ipython” from a Linux/Mac terminal, or from the Windows cmd shell,
• or by starting the program from a menu, e.g. in the Python(x,y) or EPD menu if you have installed one of
these scientific-Python suites.
Tip: If you don’t have Ipython installed on your computer, other Python shells are available, such as the plain
Python shell started by typing “python” in a terminal, or the Idle interpreter. However, we advise to use the Ipython
shell because of its enhanced features, especially for interactive scientific computing.
Floats
>>> c = 2.1
>>> type(c)
<type 'float'>
Complex
Once you have started the interpreter, type
1.2. The Python language
>>> a = 1.5 + 0.5j
>>> a.real
9
1.2. The Python language
10
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Warning: Integer division
In Python 2:
1.5
>>> a.imag
0.5
>>> type(1. + 0j)
<type 'complex'>
>>> 3 / 2
1
In Python 3:
Booleans
>>> 3 > 4
False
>>> test = (3 > 4)
>>> test
False
>>> type(test)
<type 'bool'>
>>> 3 / 2
1.5
To be safe: use floats:
>>> 3 / 2.
1.5
Tip: A Python shell can therefore replace your pocket calculator, with the basic arithmetic operations +, -, *, /,
% (modulo) natively implemented
>>> 7 * 3.
21.0
>>> 2**10
1024
>>> 8 % 3
2
>>>
>>>
>>>
1
>>>
1.5
a = 3
b = 2
a / b # In Python 2
a / float(b)
Future behavior: to always get the behavior of Python3
>>> from __future__ import division
>>> 3 / 2
1.5
Type conversion (casting):
>>> float(1)
1.0
Tip: If you explicitly want integer division use //:
>>> 3.0 // 2
1.0
Note: The behaviour of the division operator has changed in Python 3.
Containers
Tip: Python provides many efficient types of containers, in which collections of objects can be stored.
Lists
Tip: A list is an ordered collection of objects, that may have different types. For example:
>>> l = ['red', 'blue', 'green', 'black', 'white']
>>> type(l)
<type 'list'>
Indexing: accessing individual objects contained in the list:
>>> l[2]
'green'
Counting from the end with negative indices:
1.2. The Python language
11
1.2. The Python language
12
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> l[-1]
'white'
>>> l[-2]
'black'
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> L = ['red', 'blue', 'green', 'black', 'white']
>>> L.append('pink')
>>> L
['red', 'blue', 'green', 'black', 'white', 'pink']
>>> L.pop() # removes and returns the last item
'pink'
>>> L
['red', 'blue', 'green', 'black', 'white']
>>> L.extend(['pink', 'purple']) # extend L, in-place
>>> L
['red', 'blue', 'green', 'black', 'white', 'pink', 'purple']
>>> L = L[:-2]
>>> L
['red', 'blue', 'green', 'black', 'white']
Warning: Indexing starts at 0 (as in C), not at 1 (as in Fortran or Matlab)!
Slicing: obtaining sublists of regularly-spaced elements:
>>> l
['red', 'blue', 'green', 'black', 'white']
>>> l[2:4]
['green', 'black']
Warning: Note that l[start:stop] contains the elements with indices i such as start<= i < stop
(i ranging from start to stop-1). Therefore, l[start:stop] has (stop - start) elements.
Slicing syntax: l[start:stop:stride]
Tip: All slicing parameters are optional:
>>> l
['red', 'blue', 'green', 'black', 'white']
>>> l[3:]
['black', 'white']
>>> l[:3]
['red', 'blue', 'green']
>>> l[::2]
['red', 'green', 'white']
Reverse:
>>> r = L[::-1]
>>> r
['white', 'black', 'green', 'blue', 'red']
>>> r2 = list(L)
>>> r2
['red', 'blue', 'green', 'black', 'white']
>>> r2.reverse() # in-place
>>> r2
['white', 'black', 'green', 'blue', 'red']
Concatenate and repeat lists:
>>> r + L
['white', 'black', 'green', 'blue', 'red', 'red', 'blue', 'green', 'black', 'white']
>>> r * 2
['white', 'black', 'green', 'blue', 'red', 'white', 'black', 'green', 'blue', 'red']
Lists are mutable objects and can be modified:
>>> l[0] =
>>> l
['yellow',
>>> l[2:4]
>>> l
['yellow',
'yellow'
Tip: Sort:
>>> sorted(r) # new object
['black', 'blue', 'green', 'red', 'white']
>>> r
['white', 'black', 'green', 'blue', 'red']
>>> r.sort() # in-place
>>> r
['black', 'blue', 'green', 'red', 'white']
'blue', 'green', 'black', 'white']
= ['gray', 'purple']
'blue', 'gray', 'purple', 'white']
Note: The elements of a list may have different types:
>>> l = [3, -200, 'hello']
>>> l
[3, -200, 'hello']
>>> l[1], l[2]
(-200, 'hello')
Methods and Object-Oriented Programming
Tip: For collections of numerical data that all have the same type, it is often more efficient to use the array
type provided by the numpy module. A NumPy array is a chunk of memory containing fixed-sized items. With
NumPy arrays, operations on elements can be faster because elements are regularly spaced in memory and more
operations are performed through specialized C functions instead of Python loops.
The notation r.method() (e.g. r.append(3) and L.pop()) is our first example of object-oriented
programming (OOP). Being a list, the object r owns the method function that is called using the
notation .. No further knowledge of OOP than understanding the notation . is necessary for going through
this tutorial.
Tip: Python offers a large panel of functions to modify lists, or query them. Here are a few examples; for more
details, see http://docs.python.org/tutorial/datastructures.html#more-on-lists
Add and remove elements:
1.2. The Python language
13
1.2. The Python language
14
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Discovering methods:
>>>
'lo
>>>
'hl
Reminder: in Ipython: tab-completion (press tab)
In [28]: r.<TAB>
r.__add__
r.__class__
r.__contains__
r.__delattr__
r.__delitem__
r.__delslice__
r.__doc__
r.__eq__
r.__format__
r.__ge__
r.__getattribute__
r.__getitem__
r.__getslice__
r.__gt__
r.__hash__
r.__iadd__
r.__imul__
r.__init__
r.__iter__
r.__le__
r.__len__
r.__lt__
r.__mul__
r.__ne__
r.__new__
r.__reduce__
r.__reduce_ex__
r.__repr__
r.__reversed__
r.__rmul__
r.__setattr__
r.__setitem__
r.__setslice__
r.__sizeof__
r.__str__
r.__subclasshook__
r.append
r.count
r.extend
r.index
r.insert
r.pop
r.remove
r.reverse
r.sort
a[2:10:2] # Syntax: a[start:stop:step]
o'
a[::3] # every three characters, from beginning to end
r!'
Tip:
Accents and special characters can also be
http://docs.python.org/tutorial/introduction.html#unicode-strings).
handled
in
Unicode
strings
(see
A string is an immutable object and it is not possible to modify its contents. One may however create new strings
from the original one.
In [53]: a = "hello, world!"
In [54]: a[2] = 'z'
--------------------------------------------------------------------------Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: 'str' object does not support item assignment
In [55]:
Out[55]:
In [56]:
Out[56]:
Strings
a.replace('l', 'z', 1)
'hezlo, world!'
a.replace('l', 'z')
'hezzo, worzd!'
Tip: Strings have many useful methods, such as a.replace as seen above. Remember the a. object-oriented
notation and use tab completion or help(str) to search for new methods.
Different string syntaxes (simple, double or triple quotes):
s = 'Hello, how are you?'
s = "Hi, what's up"
s = '''Hello,
how are you'''
s = """Hi,
what's up?"""
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
See also:
# tripling the quotes allows the
# the string to span more than one line
Python offers advanced possibilities for manipulating strings, looking for patterns or formatting.
The interested reader is referred to http://docs.python.org/library/stdtypes.html#string-methods and
http://docs.python.org/library/string.html#new-string-formatting
String formatting:
In [1]: 'Hi, what's up?'
-----------------------------------------------------------File "<ipython console>", line 1
'Hi, what's up?'
^
SyntaxError: invalid syntax
>>> 'An integer: %i; a float: %f; another string: %s' % (1, 0.1, 'string')
'An integer: 1; a float: 0.100000; another string: string'
>>> i = 102
>>> filename = 'processing_of_dataset_%d.txt' % i
>>> filename
'processing_of_dataset_102.txt'
The newline character is \n, and the tab character is \t.
Tip: Strings are collections like lists. Hence they can be indexed and sliced, using the same syntax and rules.
Dictionaries
Indexing:
>>>
>>>
'h'
>>>
'e'
>>>
'o'
a = "hello"
a[0]
Tip: A dictionary is basically an efficient table that maps keys to values. It is an unordered container
>>> tel = {'emmanuelle': 5752, 'sebastian': 5578}
>>> tel['francis'] = 5915
>>> tel
{'sebastian': 5578, 'francis': 5915, 'emmanuelle': 5752}
>>> tel['sebastian']
5578
>>> tel.keys()
['sebastian', 'francis', 'emmanuelle']
>>> tel.values()
[5578, 5915, 5752]
>>> 'francis' in tel
True
a[1]
a[-1]
Tip: (Remember that negative indices correspond to counting from the right end.)
Slicing:
>>> a = "hello, world!"
>>> a[3:6] # 3rd to 6th (excluded) elements: elements 3, 4, 5
'lo,'
1.2. The Python language
15
1.2. The Python language
16
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Tip: It can be used to conveniently store and retrieve values associated with a name (a string for a date, a name,
etc.). See http://docs.python.org/tutorial/datastructures.html#dictionaries for more information.
In [1]:
In [3]:
Out[3]:
In [4]:
In [5]:
Out[5]:
In [6]:
Out[6]:
In [7]:
In [8]:
Out[8]:
In [9]:
Out[9]:
A dictionary can have keys (resp. values) with different types:
>>> d = {'a':1, 'b':2, 3:'hello'}
>>> d
{'a': 1, 3: 'hello', 'b': 2}
More container types
Tuples
Tuples are basically immutable lists. The elements of a tuple are written between parentheses, or just separated
by commas:
>>> t = 12345, 54321, 'hello!'
>>> t[0]
12345
>>> t
(12345, 54321, 'hello!')
>>> u = (0, 2)
• the key concept here is mutable vs. immutable
– mutable objects can be changed in place
– immutable objects cannot be modified once created
See also:
A very good and detailed explanation of the above issues can be found in David M. Beazley’s article Types and
Objects in Python.
Sets: unordered, unique items:
1.2.3 Control Flow
>>> s = set(('a', 'b', 'c', 'a'))
>>> s
set(['a', 'c', 'b'])
>>> s.difference(('a', 'b'))
set(['c'])
Controls the order in which the code is executed.
if/elif/else
>>> if 2**2 == 4:
...
print('Obvious!')
...
Obvious!
Assignment operator
Tip: Python library reference says:
Assignment statements are used to (re)bind names to values and to modify attributes or items of
mutable objects.
Blocks are delimited by indentation
Tip: Type the following lines in your Python interpreter, and be careful to respect the indentation depth. The
Ipython shell automatically increases the indentation depth after a column : sign; to decrease the indentation
depth, go four spaces to the left with the Backspace key. Press the Enter key twice to leave the logical block.
In short, it works as follows (simple assignment):
1. an expression on the right hand side is evaluated, the corresponding object is created/obtained
2. a name on the left hand side is assigned, or bound, to the r.h.s. object
>>> a = 10
Things to note:
>>> if a == 1:
...
print(1)
... elif a == 2:
...
print(2)
... else:
...
print('A lot')
A lot
• a single object can have several names bound to it:
In [1]:
In [2]:
In [3]:
Out[3]:
In [4]:
Out[4]:
In [5]:
Out[5]:
In [6]:
In [7]:
Out[7]:
a = [1, 2, 3]
a
[1, 2, 3]
a = ['a', 'b', 'c'] # Creates another object.
a
['a', 'b', 'c']
id(a)
138641676
a[:] = [1, 2, 3] # Modifies object in place.
a
[1, 2, 3]
id(a)
138641676 # Same as in Out[6], yours will differ...
a = [1, 2, 3]
b = a
a
[1, 2, 3]
b
[1, 2, 3]
a is b
True
b[1] = 'hi!'
a
[1, 'hi!', 3]
Indentation is compulsory in scripts as well. As an exercise, re-type the previous lines with the same indentation
in a script condition.py, and execute the script with run condition.py in Ipython.
for/range
Iterating with an index:
• to change a list in place, use indexing/slices:
1.2. The Python language
17
1.2. The Python language
18
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> 1 == 1.
True
>>> for i in range(4):
...
print(i)
0
1
2
3
a is b Tests identity: both sides are the same object:
>>> 1 is 1.
False
But most often, it is more readable to iterate over values:
>>> a = 1
>>> b = 1
>>> a is b
True
>>> for word in ('cool', 'powerful', 'readable'):
...
print('Python is %s' % word)
Python is cool
Python is powerful
Python is readable
a in b For any collection b: b contains a
>>> b = [1, 2, 3]
>>> 2 in b
True
>>> 5 in b
False
while/break/continue
Typical C-style while loop (Mandelbrot problem):
>>> z = 1 + 1j
>>> while abs(z) < 100:
...
z = z**2 + 1
>>> z
(-134+352j)
If b is a dictionary, this tests that a is a key of b.
Advanced iteration
Iterate over any sequence
More advanced features
break out of enclosing for/while loop:
You can iterate over any sequence (string, list, keys in a dictionary, lines in a file, ...):
>>> z = 1 + 1j
>>> vowels = 'aeiouy'
>>> while abs(z) < 100:
...
if z.imag == 0:
...
break
...
z = z**2 + 1
>>> for i in 'powerful':
...
if i in vowels:
...
print(i)
o
e
u
continue the next iteration of a loop.:
>>> a =
>>> for
...
...
...
1.0
0.5
0.25
[1, 0, 2, 4]
element in a:
if element == 0:
continue
print(1. / element)
>>> message = "Hello how are you?"
>>> message.split() # returns a list
['Hello', 'how', 'are', 'you?']
>>> for word in message.split():
...
print(word)
...
Hello
how
are
you?
Conditional Expressions
Tip: Few languages (in particular, languages for scientific computing) allow to loop over anything but integers/indices. With Python it is possible to loop exactly over the objects of interest without bothering with indices
you often don’t care about. This feature can often be used to make code more readable.
if <OBJECT>
Evaluates to False:
• any number equal to zero (0, 0.0, 0+0j)
Warning: Not safe to modify the sequence you are iterating over.
• an empty container (list, tuple, set, dictionary, ...)
• False, None
Evaluates to True:
Keeping track of enumeration number
• everything else
Common task is to iterate over a sequence while keeping track of the item number.
a == b Tests equality, with logics:
1.2. The Python language
19
1.2. The Python language
20
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Could use while loop with a counter as above. Or a for loop:
>>>
>>>
...
(0,
(1,
(2,
Warning: Function blocks must be indented as other control-flow blocks.
words = ('cool', 'powerful', 'readable')
for i in range(0, len(words)):
print((i, words[i]))
'cool')
'powerful')
'readable')
Return statement
Functions can optionally return values.
In [6]: def disk_area(radius):
...:
return 3.14 * radius * radius
...:
• But, Python provides a built-in function - enumerate - for this:
>>>
...
(0,
(1,
(2,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
for index, item in enumerate(words):
print((index, item))
'cool')
'powerful')
'readable')
In [8]: disk_area(1.5)
Out[8]: 7.0649999999999995
Note: By default, functions return None.
Looping over a dictionary
Note: Note the syntax to define a function:
Use items:
• the def keyword;
>>> d = {'a': 1, 'b':1.2, 'c':1j}
• is followed by the function’s name, then
• the arguments of the function are given between parentheses followed by a colon.
>>> for key, val in sorted(d.items()):
...
print('Key: %s has value: %s' % (key, val))
Key: a has value: 1
Key: b has value: 1.2
Key: c has value: 1j
• the function body;
• and return object for optionally returning values.
Note: The ordering of a dictionary in random, thus we use sorted() which will sort on the keys.
Parameters
Mandatory parameters (positional arguments)
List Comprehensions
In [81]: def double_it(x):
....:
return x * 2
....:
>>> [i**2 for i in range(4)]
[0, 1, 4, 9]
In [82]: double_it(3)
Out[82]: 6
In [83]: double_it()
--------------------------------------------------------------------------Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: double_it() takes exactly 1 argument (0 given)
Exercise
Compute the decimals of Pi using the Wallis formula:
π=2
∞
︁
4i2
2−1
4i
i=1
Optional parameters (keyword or named arguments)
In [84]: def double_it(x=2):
....:
return x * 2
....:
1.2.4 Defining functions
Function definition
In [85]: double_it()
Out[85]: 4
In [56]: def test():
....:
print('in test function')
....:
....:
In [86]: double_it(3)
Out[86]: 6
Keyword arguments allow you to specify default values.
In [57]: test()
in test function
1.2. The Python language
21
1.2. The Python language
22
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Warning: Default values are evaluated when the function is defined, not when it is called. This can be
problematic when using mutable types (e.g. dictionary or list) and modifying them in the function body, since
the modifications will be persistent across invocations of the function.
Using an immutable type in a keyword argument:
In [107]: slicer(rhyme, step=2, start=1, stop=4)
Out[107]: ['fish,', 'fish,']
In [124]: bigx = 10
Keyword arguments are a very convenient feature for defining functions with a variable number of arguments,
especially when default values are to be used in most calls to the function.
In [125]: def double_it(x=bigx):
.....:
return x * 2
.....:
In [126]: bigx = 1e9
but it is good practice to use the same ordering as the function’s definition.
Passing by value
# Now really big
Tip: Can you modify the value of a variable inside a function? Most languages (C, Java, ...) distinguish “passing
by value” and “passing by reference”. In Python, such a distinction is somewhat artificial, and it is a bit subtle
whether your variables are going to be modified or not. Fortunately, there exist clear rules.
In [128]: double_it()
Out[128]: 20
Using an mutable type in a keyword argument (and modifying it inside the function body):
Parameters to functions are references to objects, which are passed by value. When you pass a variable to a
function, python passes the reference to the object to which the variable refers (the value). Not the variable itself.
In [2]: def add_to_dict(args={'a': 1, 'b': 2}):
...:
for i in args.keys():
...:
args[i] += 1
...:
print args
...:
If the value passed in a function is immutable, the function does not modify the caller’s variable. If the value is
mutable, the function may modify the caller’s variable in-place:
In [98]: def slicer(seq, start=None, stop=None, step=None):
....:
"""Implement basic python slicing."""
....:
return seq[start:stop:step]
....:
>>> def try_to_modify(x, y, z):
...
x = 23
...
y.append(42)
...
z = [99] # new reference
...
print(x)
...
print(y)
...
print(z)
...
# immutable variable
>>> a = 77
>>> b = [99] # mutable variable
>>> c = [28]
>>> try_to_modify(a, b, c)
23
[99, 42]
[99]
>>> print(a)
77
>>> print(b)
[99, 42]
>>> print(c)
[28]
In [101]: rhyme = 'one fish, two fish, red fish, blue fish'.split()
Functions have a local variable table called a local namespace.
In [102]: rhyme
Out[102]: ['one', 'fish,', 'two', 'fish,', 'red', 'fish,', 'blue', 'fish']
The variable x only exists within the function try_to_modify.
In [3]: add_to_dict
Out[3]: <function __main__.add_to_dict>
In [4]: add_to_dict()
{'a': 2, 'b': 3}
In [5]: add_to_dict()
{'a': 3, 'b': 4}
In [6]: add_to_dict()
{'a': 4, 'b': 5}
Tip: More involved example implementing python’s slicing:
Global variables
In [103]: slicer(rhyme)
Out[103]: ['one', 'fish,', 'two', 'fish,', 'red', 'fish,', 'blue', 'fish']
Variables declared outside the function can be referenced within the function:
In [104]: slicer(rhyme, step=2)
Out[104]: ['one', 'two', 'red', 'blue']
In [114]: x = 5
In [105]: slicer(rhyme, 1, step=2)
Out[105]: ['fish,', 'fish,', 'fish,', 'fish']
In [115]: def addx(y):
.....:
return x + y
.....:
In [106]: slicer(rhyme, start=1, stop=4, step=2)
Out[106]: ['fish,', 'fish,']
In [116]: addx(10)
Out[116]: 15
The order of the keyword arguments does not matter:
1.2. The Python language
But these “global” variables cannot be modified within the function, unless declared global in the function.
23
1.2. The Python language
24
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
This doesn’t work:
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
String Form:
<function funcname at 0xeaa0f0>
Namespace:
Interactive
File:
<ipython console>
Definition:
funcname(params)
Docstring:
Concise one-line sentence describing the function.
In [117]: def setx(y):
.....:
x = y
.....:
print('x is %d' % x)
.....:
.....:
Extended summary which can contain multiple paragraphs.
In [118]: setx(10)
x is 10
Note: Docstring guidelines
In [120]: x
Out[120]: 5
For the sake of standardization, the Docstring Conventions webpage documents the semantics and conventions
associated with Python docstrings.
This works:
Also, the Numpy and Scipy modules have defined a precise standard for documenting scientific functions, that you may want to follow for your own functions, with a Parameters section, an
Examples section, etc. See http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines#docstring-standard
and http://projects.scipy.org/numpy/browser/trunk/doc/example.py#L37
In [121]: def setx(y):
.....:
global x
.....:
x = y
.....:
print('x is %d' % x)
.....:
.....:
Functions are objects
In [122]: setx(10)
x is 10
Functions are first-class objects, which means they can be:
• assigned to a variable
In [123]: x
Out[123]: 10
• an item in a list (or any collection)
• passed as an argument to another function.
Variable number of parameters
In [38]: va = variable_args
Special forms of parameters:
In [39]: va('three', x=1, y=2)
args is ('three',)
kwargs is {'y': 2, 'x': 1}
• *args: any number of positional arguments packed into a tuple
• **kwargs: any number of keyword arguments packed into a dictionary
In [35]: def variable_args(*args, **kwargs):
....:
print 'args is', args
....:
print 'kwargs is', kwargs
....:
Methods
Methods are functions attached to objects. You’ve seen these in our examples on lists, dictionaries, strings, etc...
In [36]: variable_args('one', 'two', x=1, y=2, z=3)
args is ('one', 'two')
kwargs is {'y': 2, 'x': 1, 'z': 3}
Exercises
Exercise: Fibonacci sequence
Docstrings
Write a function that displays the n first terms of the Fibonacci sequence, defined by:
• u_0 = 1; u_1 = 1
• u_(n+2) = u_(n+1) + u_n
Documentation about what the function does and its parameters. General convention:
In [67]: def funcname(params):
....:
"""Concise one-line sentence describing the function.
....:
Extended summary which can contain multiple paragraphs.
....:
....:
"""
....:
# function body
....:
pass
....:
Exercise: Quicksort
Implement the quicksort algorithm, as defined by wikipedia:
function quicksort(array) var list less, greater if length(array) < 2
return array
select and remove a pivot value pivot from array for each x in array
if x < pivot + 1 then append x to less else append x to greater
return concatenate(quicksort(less), pivot, quicksort(greater))
In [68]: funcname?
Type:
function
Base Class:
type 'function'>
1.2. The Python language
25
1.2. The Python language
26
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.2.5 Reusing code: scripts and modules
For now, we have typed all instructions in the interpreter. For longer sets of instructions we need to change track
and write the code in text files (using a text editor), that we will call either scripts or modules. Use your favorite
text editor (provided it offers syntax highlighting for Python), or the editor that comes with the Scientific Python
Suite you may be using (e.g., Scite with Python(x,y)).
Scripts
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Warning:
docopt.
Don’t implement option parsing yourself. Use modules such as optparse, argparse or
Importing objects from modules
In [1]: import os
Tip: Let us first write a script, that is a file with a sequence of instructions that are executed each time the script
is called. Instructions may be e.g. copied-and-pasted from the interpreter (but take care to respect indentation
rules!).
The extension for Python files is .py. Write or copy-and-paste the following lines in a file called test.py
message = "Hello how are you?"
for word in message.split():
print word
Tip: Let us now execute the script interactively, that is inside the Ipython interpreter. This is maybe the most
common use of scripts in scientific computing.
Note: in Ipython, the syntax to execute a script is %run script.py. For example,
In [2]: os
Out[2]: <module 'os' from '/usr/lib/python2.6/os.pyc'>
In [3]: os.listdir('.')
Out[3]:
['conf.py',
'basic_types.rst',
'control_flow.rst',
'functions.rst',
'python_language.rst',
'reusing.rst',
'file_io.rst',
'exceptions.rst',
'workflow.rst',
'index.rst']
And also:
In [4]: from os import listdir
In [1]: %run test.py
Hello
how
are
you?
Importing shorthands:
In [5]: import numpy as np
Warning:
In [2]: message
Out[2]: 'Hello how are you?'
from os import *
The script has been executed. Moreover the variables defined in the script (such as message) are now available
inside the interpreter’s namespace.
Tip: Other interpreters also offer the possibility to execute scripts (e.g., execfile in the plain Python interpreter, etc.).
It is also possible In order to execute this script as a standalone program, by executing the script inside a shell
terminal (Linux/Mac console or cmd Windows console). For example, if we are in the same directory as the test.py
file, we can execute this in a console:
This is called the star import and please, Use it with caution
• Makes the code harder to read and understand: where do symbols come from?
• Makes it impossible to guess the functionality by the context and the name (hint: os.name is the name
of the OS), and to profit usefully from tab completion.
• Restricts the variable names you can use: os.name might override name, or vise-versa.
• Creates possible name clashes between modules.
• Makes the code impossible to statically check for undefined symbols.
Tip: Modules are thus a good way to organize code in a hierarchical way. Actually, all the scientific computing
tools we are going to use are modules:
$ python test.py
Hello
how
are
you?
>>> import numpy as np # data arrays
>>> np.linspace(0, 10, 6)
array([ 0.,
2.,
4.,
6.,
8., 10.])
>>> import scipy # scientific computing
Tip: Standalone scripts may also take command-line arguments
In file.py:
In Python(x,y), Ipython(x,y) executes the following imports at startup:
import sys
print sys.argv
>>>
>>>
>>>
>>>
$ python file.py test arguments
['file.py', 'test', 'arguments']
import numpy
import numpy as np
from pylab import *
import scipy
and it is not necessary to re-import these modules.
1.2. The Python language
27
1.2. The Python language
28
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Creating modules
Tip: If we want to write larger and better organized programs (compared to simple scripts), where some objects
are defined, (variables, functions, classes) and that we want to reuse several times, we have to create our own
modules.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
'__file__',
'__name__',
'__package__',
'c',
'd',
'print_a',
'print_b']
Let us create a module demo contained in the file demo.py:
"A demo module."
In [8]: demo.
demo.__builtins__
demo.__class__
demo.__delattr__
demo.__dict__
demo.__doc__
demo.__file__
demo.__format__
demo.__getattribute__
demo.__hash__
def print_b():
"Prints b."
print 'b'
def print_a():
"Prints a."
print 'a'
c = 2
d = 2
demo.__init__
demo.__name__
demo.__new__
demo.__package__
demo.__reduce__
demo.__reduce_ex__
demo.__repr__
demo.__setattr__
demo.__sizeof__
demo.__str__
demo.__subclasshook__
demo.c
demo.d
demo.print_a
demo.print_b
demo.py
demo.pyc
Importing objects from modules into the main namespace
In [9]: from demo import print_a, print_b
Tip: In this file, we defined two functions print_a and print_b. Suppose we want to call the print_a
function from the interpreter. We could execute the file as a script, but since we just want to have access to the
function print_a, we are rather going to import it as a module. The syntax is as follows.
In [1]: import demo
In [2]: demo.print_a()
a
In [10]: whos
Variable
Type
Data/Info
-------------------------------demo
module
<module 'demo' from 'demo.py'>
print_a
function
<function print_a at 0xb7421534>
print_b
function
<function print_b at 0xb74214c4>
In [11]: print_a()
a
In [3]: demo.print_b()
b
Importing the module gives access to its objects, using the module.object syntax. Don’t forget to put the
module’s name before the object’s name, otherwise Python won’t recognize the instruction.
Warning: Module caching
Modules are cached: if you modify demo.py and re-import it in the old session, you will get the
old one.
Solution:
In [10]: reload(demo)
Introspection
In [4]: demo?
Type:
module
Base Class: <type 'module'>
String Form:
<module 'demo' from 'demo.py'>
Namespace: Interactive
File:
/home/varoquau/Projects/Python_talks/scipy_2009_tutorial/source/demo.py
Docstring:
A demo module.
‘__main__’ and module loading
Tip: Sometimes we want code to be executed when a module is run directly, but not when it is imported by another
module. if __name__ == ’__main__’ allows us to check whether the module is being run directly.
File demo2.py:
In [5]: who
demo
def print_b():
"Prints b."
print 'b'
In [6]: whos
Variable
Type
Data/Info
-----------------------------demo
module
<module 'demo' from 'demo.py'>
def print_a():
"Prints a."
print 'a'
In [7]: dir(demo)
Out[7]:
['__builtins__',
'__doc__',
1.2. The Python language
# print_b() runs on import
print_b()
29
1.2. The Python language
30
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• or modify the sys.path variable itself within a Python script.
if __name__ == '__main__':
# print_a() is only executed when the module is run directly.
print_a()
Tip:
import sys
new_path = '/home/emma/user_defined_modules'
if new_path not in sys.path:
sys.path.append(new_path)
Importing it:
In [11]: import demo2
b
This method is not very robust, however, because it makes the code less portable (user-dependent path) and
because you have to add the directory to your sys.path each time you want to import from a module in this
directory.
In [12]: import demo2
Running it:
In [13]: %run demo2
b
a
See also:
Scripts or modules? How to organize your code
Packages
See http://docs.python.org/tutorial/modules.html for more information about modules.
Note: Rule of thumb
• Sets of instructions that are called several times should be written inside functions for better code reusability.
• Functions (or other bits of code) that are called from several scripts should be written inside a module,
so that only the module is imported in the different scripts (do not copy-and-paste your functions in the
different scripts!).
How modules are found and imported
When the import mymodule statement is executed, the module mymodule is searched in a given list of
directories. This list includes a list of installation-dependent default path (e.g., /usr/lib/python) as well as
the list of directories specified by the environment variable PYTHONPATH.
The list of directories searched by Python is given by the sys.path variable
In [1]: import sys
In [2]: sys.path
Out[2]:
['',
'/home/varoquau/.local/bin',
'/usr/lib/python2.7',
'/home/varoquau/.local/lib/python2.7/site-packages',
'/usr/lib/python2.7/dist-packages',
'/usr/local/lib/python2.7/dist-packages',
...]
A directory that contains many modules is called a package. A package is a module with submodules (which can
have submodules themselves, etc.). A special file called __init__.py (which may be empty) tells Python that
the directory is a Python package, from which modules can be imported.
$ ls
cluster/
io/
README.txt@
__config__.py@ LATEST.txt@ setup.py@
__config__.pyc lib/
setup.pyc
constants/
linalg/
setupscons.py@
fftpack/
linsolve/
setupscons.pyc
__init__.py@
maxentropy/ signal/
__init__.pyc
misc/
sparse/
INSTALL.txt@
ndimage/
spatial/
integrate/
odr/
special/
interpolate/
optimize/
stats/
$ cd ndimage
$ ls
doccer.py@
fourier.pyc
interpolation.py@
doccer.pyc
info.py@
interpolation.pyc
setupscons.py@
filters.py@ info.pyc
measurements.py@
setupscons.pyc
filters.pyc __init__.py@ measurements.pyc
fourier.py@ __init__.pyc morphology.py@
stsci/
__svn_version__.py@
__svn_version__.pyc
THANKS.txt@
TOCHANGE.txt@
version.py@
version.pyc
weave/
morphology.pyc
_nd_image.so
setup.pyc
_ni_support.py@
_ni_support.pyc
setup.py@
tests/
From Ipython:
In [1]: import scipy
In [2]: scipy.__file__
Out[2]: '/usr/lib/python2.6/dist-packages/scipy/__init__.pyc'
Modules must be located in the search path, therefore you can:
• write your own modules within directories already defined in the search path (e.g.
$HOME/.local/lib/python2.7/dist-packages). You may use symbolic links (on Linux) to
keep the code somewhere else.
• modify the environment variable PYTHONPATH to include the directories containing the user-defined modules.
Tip: On Linux/Unix, add the following line to a file read by the shell at startup (e.g. /etc/profile, .profile)
In [3]: import scipy.version
In [4]: scipy.version.version
Out[4]: '0.7.0'
In [5]: import scipy.ndimage.morphology
In [6]: from scipy.ndimage import morphology
export PYTHONPATH=$PYTHONPATH:/home/emma/user_defined_modules
In [17]: morphology.binary_dilation?
Type:
function
On Windows, http://support.microsoft.com/kb/310519 explains how to handle environment variables.
1.2. The Python language
31
1.2. The Python language
32
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Base Class:
<type 'function'>
String Form:
<function binary_dilation at 0x9bedd84>
Namespace:
Interactive
File:
/usr/lib/python2.6/dist-packages/scipy/ndimage/morphology.py
Definition:
morphology.binary_dilation(input, structure=None,
iterations=1, mask=None, output=None, border_value=0, origin=0,
brute_force=False)
Docstring:
Multi-dimensional binary dilation with the given structure.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Quick read
If you want to do a first quick pass through the Scipy lectures to learn the ecosystem, you can directly skip
to the next chapter: NumPy: creating and manipulating numerical data (page 42).
The remainder of this chapter is not necessary to follow the rest of the intro part. But be sure to come back
and finish this chapter later.
1.2.6 Input and Output
An output array can optionally be provided. The origin parameter
controls the placement of the filter. If no structuring element is
provided an element is generated with a squared connectivity equal
to one. The dilation operation is repeated iterations times. If
iterations is less than 1, the dilation is repeated until the
result does not change anymore. If a mask is given, only those
elements with a true value at the corresponding mask element are
modified at each iteration.
To be exhaustive, here are some information about input and output in Python. Since we will use the Numpy
methods to read and write files, you may skip this chapter at first reading.
We write or read strings to/from files (other types must be converted to strings). To write in a file:
>>> f = open('workfile', 'w') # opens the workfile file
>>> type(f)
<type 'file'>
>>> f.write('This is a test \nand another test')
>>> f.close()
Good practices
• Use meaningful object names
To read from a file
• Indentation: no choice!
In [1]: f = open('workfile', 'r')
Tip: Indenting is compulsory in Python! Every command block following a colon bears an additional
indentation level with respect to the previous line with a colon. One must therefore indent after def f():
or while:. At the end of such logical blocks, one decreases the indentation depth (and re-increases it if a
new block is entered, etc.)
Strict respect of indentation is the price to pay for getting rid of { or ; characters that delineate logical
blocks in other languages. Improper indentation leads to errors such as
-----------------------------------------------------------IndentationError: unexpected indent (test.py, line 2)
In [2]: s = f.read()
In [3]: print(s)
This is a test
and another test
In [4]: f.close()
See also:
All this indentation business can be a bit confusing in the beginning. However, with the clear indentation,
and in the absence of extra characters, the resulting code is very nice to read compared to other languages.
For more details: http://docs.python.org/tutorial/inputoutput.html
Iterating over a file
• Indentation depth: Inside your text editor, you may choose to indent with any positive number of spaces
(1, 2, 3, 4, ...). However, it is considered good practice to indent with 4 spaces. You may configure your
editor to map the Tab key to a 4-space indentation. In Python(x,y), the editor is already configured this
way.
• Style guidelines
Long lines: you should not write very long lines that span over more than (e.g.) 80 characters. Long lines
can be broken with the \ character
>>> long_line = "Here is a very very long line \
... that we break in two parts."
In [6]: f = open('workfile', 'r')
In [7]: for line in f:
...:
print line
...:
This is a test
and another test
In [8]: f.close()
Spaces
File modes
Write well-spaced code: put whitespaces after commas, around arithmetic operators, etc.:
>>> a = 1 # yes
>>> a=1 # too cramped
• Read-only: r
• Write-only: w
A certain number of rules for writing “beautiful” code (and more importantly using the same conventions
as anybody else!) are given in the Style Guide for Python Code.
– Note: Create a new file or overwrite existing file.
• Append a file: a
• Read and Write: r+
1.2. The Python language
33
1.2. The Python language
34
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Binary mode: b
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In [44]: fp = open('junk.txt', 'w')
– Note: Use for binary files, especially on Windows.
In [45]: fp.close()
1.2.7 Standard Library
In [46]: 'junk.txt' in os.listdir(os.curdir)
Out[46]: True
Note: Reference document for this section:
In [47]: os.remove('junk.txt')
• The Python Standard Library documentation: http://docs.python.org/library/index.html
In [48]: 'junk.txt' in os.listdir(os.curdir)
Out[48]: False
• Python Essential Reference, David Beazley, Addison-Wesley Professional
os.path: path manipulations
os module: operating system functionality
os.path provides common operations on pathnames.
“A portable way of using operating system dependent functionality.”
In [70]: fp = open('junk.txt', 'w')
Directory and file manipulation
In [71]: fp.close()
Current directory:
In [72]: a = os.path.abspath('junk.txt')
In [17]: os.getcwd()
Out[17]: '/Users/cburns/src/scipy2009/scipy_2009_tutorial/source'
In [73]: a
Out[73]: '/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/junk.txt'
List a directory:
In [74]: os.path.split(a)
Out[74]: ('/Users/cburns/src/scipy2009/scipy_2009_tutorial/source',
'junk.txt')
In [31]: os.listdir(os.curdir)
Out[31]:
['.index.rst.swo',
'.python_language.rst.swp',
'.view_array.py.swp',
'_static',
'_templates',
'basic_types.rst',
'conf.py',
'control_flow.rst',
'debugging.rst',
...
In [78]: os.path.dirname(a)
Out[78]: '/Users/cburns/src/scipy2009/scipy_2009_tutorial/source'
In [79]: os.path.basename(a)
Out[79]: 'junk.txt'
In [80]: os.path.splitext(os.path.basename(a))
Out[80]: ('junk', '.txt')
In [84]: os.path.exists('junk.txt')
Out[84]: True
Make a directory:
In [86]: os.path.isfile('junk.txt')
Out[86]: True
In [32]: os.mkdir('junkdir')
In [33]: 'junkdir' in os.listdir(os.curdir)
Out[33]: True
In [87]: os.path.isdir('junk.txt')
Out[87]: False
Rename the directory:
In [36]: os.rename('junkdir', 'foodir')
In [88]: os.path.expanduser('~/local')
Out[88]: '/Users/cburns/local'
In [37]: 'junkdir' in os.listdir(os.curdir)
Out[37]: False
In [92]: os.path.join(os.path.expanduser('~'), 'local', 'bin')
Out[92]: '/Users/cburns/local/bin'
In [38]: 'foodir' in os.listdir(os.curdir)
Out[38]: True
Running an external command
In [41]: os.rmdir('foodir')
In [8]: os.system('ls')
basic_types.rst
demo.py
control_flow.rst exceptions.rst
demo2.py
first_steps.rst
In [42]: 'foodir' in os.listdir(os.curdir)
Out[42]: False
functions.rst
io.rst
oop.rst
python_language.rst
python-logo.png
reusing_code.rst
standard_library.rst
Delete a file:
1.2. The Python language
35
1.2. The Python language
36
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5'
Note: Alternative to os.system
A noteworthy alternative to os.system is the sh module. Which provides much more convenient ways to obtain
the output, error stream and exit code of the external command.
In [20]: import sh
In [20]: com = sh.ls()
In [21]: print com
basic_types.rst
exceptions.rst
control_flow.rst first_steps.rst
demo2.py
functions.rst
demo.py
io.rst
oop.rst
python_language.rst
python-logo.png
reusing_code.rst
standard_library.rst
In [16]: os.getenv('PYTHONPATH')
Out[16]: '.:/Users/cburns/src/utils:/Users/cburns/src/nitools:
/Users/cburns/local/lib/python2.5/site-packages/:
/usr/local/lib/python2.5/site-packages/:
/Library/Frameworks/Python.framework/Versions/2.5/lib/python2.5'
shutil: high-level file operations
The shutil provides useful file operations:
• shutil.rmtree: Recursively delete a directory tree.
In [22]: print com.exit_code
0
In [23]: type(com)
Out[23]: sh.RunningCommand
• shutil.move: Recursively move a file or directory to another location.
• shutil.copy: Copy files or directories.
glob: Pattern matching on files
Walking a directory
The glob module provides convenient file pattern matching.
Find all files ending in .txt:
os.path.walk generates a list of filenames in a directory tree.
In [18]: import glob
In [10]: for dirpath, dirnames, filenames in os.walk(os.curdir):
....:
for fp in filenames:
....:
print os.path.abspath(fp)
....:
....:
/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/.index.rst.swo
/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/.view_array.py.swp
/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/basic_types.rst
/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/conf.py
/Users/cburns/src/scipy2009/scipy_2009_tutorial/source/control_flow.rst
...
In [19]: glob.glob('*.txt')
Out[19]: ['holy_grail.txt', 'junk.txt', 'newfile.txt']
sys module: system-specific information
System-specific information related to the Python interpreter.
• Which version of python are you running and where is it installed:
In [117]: sys.platform
Out[117]: 'darwin'
Environment variables:
In [118]: sys.version
Out[118]: '2.5.2 (r252:60911, Feb 22 2008, 07:57:53) \n
[GCC 4.0.1 (Apple Computer, Inc. build 5363)]'
In [9]: import os
In [11]: os.environ.keys()
Out[11]:
['_',
'FSLDIR',
'TERM_PROGRAM_VERSION',
'FSLREMOTECALL',
'USER',
'HOME',
'PATH',
'PS1',
'SHELL',
'EDITOR',
'WORKON_HOME',
'PYTHONPATH',
...
In [119]: sys.prefix
Out[119]: '/Library/Frameworks/Python.framework/Versions/2.5'
• List of command line arguments passed to a Python script:
In [100]: sys.argv
Out[100]: ['/Users/cburns/local/bin/ipython']
sys.path is a list of strings that specifies the search path for modules. Initialized from PYTHONPATH:
In [121]: sys.path
Out[121]:
['',
'/Users/cburns/local/bin',
'/Users/cburns/local/lib/python2.5/site-packages/grin-1.1-py2.5.egg',
'/Users/cburns/local/lib/python2.5/site-packages/argparse-0.8.0-py2.5.egg',
'/Users/cburns/local/lib/python2.5/site-packages/urwid-0.9.7.1-py2.5.egg',
'/Users/cburns/local/lib/python2.5/site-packages/yolk-0.4.1-py2.5.egg',
'/Users/cburns/local/lib/python2.5/site-packages/virtualenv-1.2-py2.5.egg',
...
In [12]: os.environ['PYTHONPATH']
Out[12]: '.:/Users/cburns/src/utils:/Users/cburns/src/nitools:
/Users/cburns/local/lib/python2.5/site-packages/:
/usr/local/lib/python2.5/site-packages/:
1.2. The Python language
37
1.2. The Python language
38
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
pickle: easy persistence
Catching exceptions
Useful to store arbitrary objects to a file. Not safe or fast!
try/except
In [1]: import pickle
In [10]: while True:
....:
try:
....:
x = int(raw_input('Please enter a number: '))
....:
break
....:
except ValueError:
....:
print('That was no valid number. Try again...')
....:
Please enter a number: a
That was no valid number. Try again...
Please enter a number: 1
In [2]: l = [1, None, 'Stan']
In [3]: pickle.dump(l, file('test.pkl', 'w'))
In [4]: pickle.load(file('test.pkl'))
Out[4]: [1, None, 'Stan']
Exercise
Write a program to search your PYTHONPATH for the module site.py.
In [9]: x
Out[9]: 1
path_site
try/finally
1.2.8 Exception handling in Python
Exceptions
In [10]: try:
....:
x = int(raw_input('Please enter a number: '))
....: finally:
....:
print('Thank you for your input')
....:
....:
Please enter a number: a
Thank you for your input
--------------------------------------------------------------------------ValueError: invalid literal for int() with base 10: 'a'
Exceptions are raised by errors in Python:
Important for resource management (e.g. closing a file)
In [1]: 1/0
--------------------------------------------------------------------------ZeroDivisionError: integer division or modulo by zero
Easier to ask for forgiveness than for permission
It is likely that you have raised Exceptions if you have typed all the previous commands of the tutorial. For
example, you may have raised an exception if you entered a command with a typo.
Exceptions are raised by different kinds of errors arising when executing Python code. In your own code, you
may also catch errors, or define custom error types. You may want to look at the descriptions of the the built-in
Exceptions when looking for the right exception type.
In [11]: def print_sorted(collection):
....:
try:
....:
collection.sort()
....:
except AttributeError:
....:
pass
....:
print(collection)
....:
....:
In [2]: 1 + 'e'
--------------------------------------------------------------------------TypeError: unsupported operand type(s) for +: 'int' and 'str'
In [3]: d = {1:1, 2:2}
In [4]: d[3]
--------------------------------------------------------------------------KeyError: 3
In [12]: print_sorted([1, 3, 2])
[1, 2, 3]
In [5]: l = [1, 2, 3]
In [13]: print_sorted(set((1, 3, 2)))
set([1, 2, 3])
In [6]: l[4]
--------------------------------------------------------------------------IndexError: list index out of range
In [14]: print_sorted('132')
132
In [7]: l.foobar
--------------------------------------------------------------------------AttributeError: 'list' object has no attribute 'foobar'
Raising exceptions
As you can see, there are different types of exceptions for different errors.
• Capturing and reraising an exception:
1.2. The Python language
39
1.2. The Python language
40
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In [15]: def filter_name(name):
....:
try:
....:
name = name.encode('ascii')
....:
except UnicodeError, e:
....:
if name == 'Gaël':
....:
print('OK, Gaël')
....:
else:
....:
raise e
....:
return name
....:
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> anna.set_age(21)
>>> anna.set_major('physics')
In the previous example, the Student class has __init__, set_age and set_major methods. Its attributes are name, age and major. We can call these methods and attributes with the following notation:
classinstance.method or classinstance.attribute. The __init__ constructor is a special
method we call with: MyClass(init parameters if any).
Now, suppose we want to create a new class MasterStudent with the same methods and attributes as the previous
one, but with an additional internship attribute. We won’t copy the previous class, but inherit from it:
In [16]: filter_name('Gaël')
OK, Gaël
Out[16]: 'Ga\xc3\xabl'
In [17]: filter_name('Stéfan')
--------------------------------------------------------------------------UnicodeDecodeError: 'ascii' codec can't decode byte 0xc3 in position 2: ordinal not in range(128)
• Exceptions to pass messages between parts of the code:
>>> class MasterStudent(Student):
...
internship = 'mandatory, from March to June'
...
>>> james = MasterStudent('james')
>>> james.internship
'mandatory, from March to June'
>>> james.set_age(23)
>>> james.age
23
The MasterStudent class inherited from the Student attributes and methods.
In [17]: def achilles_arrow(x):
....:
if abs(x - 1) < 1e-3:
....:
raise StopIteration
....:
x = 1 - (1-x)/2.
....:
return x
....:
Thanks to classes and object-oriented programming, we can organize code with different classes corresponding to
different objects we encounter (an Experiment class, an Image class, a Flow class, etc.), with their own methods
and attributes. Then we can use inheritance to consider variations around a base class and re-use code. Ex : from
a Flow base class, we can create derived StokesFlow, TurbulentFlow, PotentialFlow, etc.
In [18]: x = 0
1.3 NumPy: creating and manipulating numerical data
In [19]: while True:
....:
try:
....:
x = achilles_arrow(x)
....:
except StopIteration:
....:
break
....:
....:
Authors: Emmanuelle Gouillart, Didrik Pinte, Gaël Varoquaux, and Pauli Virtanen
This chapter gives an overview of Numpy, the core tool for performant numerical computing with Python.
In [20]: x
Out[20]: 0.9990234375
1.3.1 The Numpy array object
Use exceptions to notify certain conditions are met (e.g. StopIteration) or not (e.g. custom error raising)
Section contents
1.2.9 Object-oriented programming (OOP)
Python supports object-oriented programming (OOP). The goals of OOP are:
• to organize the code, and
• to re-use code in similar contexts.
Here is a small example: we create a Student class, which is an object gathering several custom functions (methods) and variables (attributes), we will be able to use:
>>> class Student(object):
...
def __init__(self, name):
...
self.name = name
...
def set_age(self, age):
...
self.age = age
...
def set_major(self, major):
...
self.major = major
...
>>> anna = Student('anna')
1.2. The Python language
•
•
•
•
•
•
•
What are Numpy and Numpy arrays? (page 42)
Creating arrays (page 44)
Basic data types (page 46)
Basic visualization (page 47)
Indexing and slicing (page 49)
Copies and views (page 52)
Fancy indexing (page 53)
What are Numpy and Numpy arrays?
Numpy arrays
Python objects
• high-level number objects: integers, floating point
• containers: lists (costless insertion and append), dictionaries (fast lookup)
41
1.3. NumPy: creating and manipulating numerical data
42
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Numpy provides
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In [6]: np.con* ?
np.concatenate
np.conj
np.conjugate
np.convolve
• extension package to Python for multi-dimensional arrays
• closer to hardware (efficiency)
• designed for scientific computation (convenience)
• Also known as array oriented computing
Import conventions
The recommended convention to import numpy is:
>>> import numpy as np
>>> import numpy as np
>>> a = np.array([0, 1, 2, 3])
>>> a
array([0, 1, 2, 3])
Creating arrays
Manual construction of arrays
Tip: For example, An array containing:
• 1-D:
• values of an experiment/simulation at discrete time steps
>>> a = np.array([0, 1, 2, 3])
>>> a
array([0, 1, 2, 3])
>>> a.ndim
1
>>> a.shape
(4,)
>>> len(a)
4
• signal recorded by a measurement device, e.g. sound wave
• pixels of an image, grey-level or colour
• 3-D data measured at different X-Y-Z positions, e.g. MRI scan
• ...
Why it is useful: Memory-efficient container that provides fast numerical operations.
In [1]: L = range(1000)
• 2-D, 3-D, ...:
In [2]: %timeit [i**2 for i in L]
1000 loops, best of 3: 403 us per loop
>>> b = np.array([[0, 1, 2], [3, 4, 5]])
# 2 x 3 array
>>> b
array([[0, 1, 2],
[3, 4, 5]])
>>> b.ndim
2
>>> b.shape
(2, 3)
>>> len(b)
# returns the size of the first dimension
2
In [3]: a = np.arange(1000)
In [4]: %timeit a**2
100000 loops, best of 3: 12.7 us per loop
Numpy Reference documentation
>>> c = np.array([[[1], [2]], [[3], [4]]])
>>> c
array([[[1],
[2]],
• On the web: http://docs.scipy.org/
• Interactive help:
In [5]: np.array?
String Form:<built-in function array>
Docstring:
array(object, dtype=None, copy=True, order=None, subok=False, ndmin=0, ...
[[3],
[4]]])
>>> c.shape
(2, 2, 1)
• Looking for something:
>>> np.lookfor('create array')
Search results for 'create array'
--------------------------------numpy.array
Create an array.
numpy.memmap
Create a memory-map to an array stored in a *binary* file on disk.
1.3. NumPy: creating and manipulating numerical data
Exercise: Simple arrays
• Create a simple two dimensional array. First, redo the examples from above. And then create your
own: how about odd numbers counting backwards on the first row, and even numbers on the second?
• Use the functions len(), numpy.shape() on these arrays. How do they relate to each other? And
to the ndim attribute of the arrays?
43
1.3. NumPy: creating and manipulating numerical data
44
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Functions for creating arrays
Exercise: Creating arrays using functions
•
•
•
•
Tip: In practice, we rarely enter items one by one...
• Evenly spaced:
>>> a = np.arange(10) # 0 .. n-1 (!)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> b = np.arange(1, 9, 2) # start, end (exclusive), step
>>> b
array([1, 3, 5, 7])
np.linspace(0, 1, 6)
You may have noticed that, in some instances, array elements are displayed with a trailing dot (e.g. 2. vs 2). This
is due to a difference in the data-type used:
>>> a = np.array([1, 2, 3])
>>> a.dtype
dtype('int64')
# start, end, num-points
0. , 0.2, 0.4, 0.6, 0.8, 1. ])
np.linspace(0, 1, 5, endpoint=False)
0. ,
0.2,
0.4,
0.6,
Experiment with arange, linspace, ones, zeros, eye and diag.
Create different kinds of arrays with random numbers.
Try setting the seed before creating an array with random values.
Look at the function np.empty. What does it do? When might this be useful?
Basic data types
• or by number of points:
>>> c =
>>> c
array([
>>> d =
>>> d
array([
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> b = np.array([1., 2., 3.])
>>> b.dtype
dtype('float64')
0.8])
Tip: Different data-types allow us to store data more compactly in memory, but most of the time we simply work
with floating point numbers. Note that, in the example above, NumPy auto-detects the data-type from the input.
• Common arrays:
>>> a = np.ones((3, 3)) # reminder: (3, 3) is a tuple
>>> a
array([[ 1., 1., 1.],
[ 1., 1., 1.],
[ 1., 1., 1.]])
>>> b = np.zeros((2, 2))
>>> b
array([[ 0., 0.],
[ 0., 0.]])
>>> c = np.eye(3)
>>> c
array([[ 1., 0., 0.],
[ 0., 1., 0.],
[ 0., 0., 1.]])
>>> d = np.diag(np.array([1, 2, 3, 4]))
>>> d
array([[1, 0, 0, 0],
[0, 2, 0, 0],
[0, 0, 3, 0],
[0, 0, 0, 4]])
You can explicitly specify which data-type you want:
>>> c = np.array([1, 2, 3], dtype=float)
>>> c.dtype
dtype('float64')
The default data type is floating point:
>>> a = np.ones((3, 3))
>>> a.dtype
dtype('float64')
There are also other types:
Complex
>>> d = np.array([1+2j, 3+4j, 5+6*1j])
>>> d.dtype
dtype('complex128')
• np.random: random numbers (Mersenne Twister PRNG):
Bool
>>> a = np.random.rand(4)
# uniform in [0, 1]
>>> a
array([ 0.95799151, 0.14222247, 0.08777354, 0.51887998])
>>> b = np.random.randn(4)
# Gaussian
>>> b
array([ 0.37544699, -0.11425369, -0.47616538,
>>> np.random.seed(1234)
>>> e = np.array([True, False, False, True])
>>> e.dtype
dtype('bool')
Strings
1.79664113])
>>> f = np.array(['Bonjour', 'Hello', 'Hallo',])
>>> f.dtype
# <--- strings containing max. 7 letters
dtype('S7')
# Setting the random seed
Much more
• int32
• int64
• uint32
1.3. NumPy: creating and manipulating numerical data
45
1.3. NumPy: creating and manipulating numerical data
46
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• uint64
9
Basic visualization
8
Now that we have our first data arrays, we are going to visualize them.
Start by launching IPython:
7
$ ipython
6
Or the notebook:
$ ipython notebook
5
Once IPython has started, enable interactive plots:
4
>>> %matplotlib
Or, from the notebook, enable plots in the notebook:
3
>>> %matplotlib inline
2
The inline is important for the notebook, so that plots are displayed in the notebook and not in a new window.
1
Matplotlib is a 2D plotting package. We can import its functions as below:
>>> import matplotlib.pyplot as plt
# the tidy way
And then use (note that you have to use show explicitly if you have not enabled interactive plots with
%matplotlib):
>>> plt.plot(x, y)
>>> plt.show()
# line plot
# <-- shows the plot (not needed with interactive plots)
0.5
1.0
1.5
2.0
2.5
3.0
• 2D arrays (such as images):
>>> image = np.random.rand(30, 30)
>>> plt.imshow(image, cmap=plt.cm.hot)
>>> plt.colorbar()
<matplotlib.colorbar.Colorbar instance at ...>
Or, if you have enabled interactive plots with %matplotlib:
>>> plot(x, y)
0
0.0
# line plot
• 1D plotting:
>>> x = np.linspace(0, 3, 20)
>>> y = np.linspace(0, 9, 20)
>>> plt.plot(x, y)
# line plot
[<matplotlib.lines.Line2D object at ...>]
>>> plt.plot(x, y, 'o') # dot plot
[<matplotlib.lines.Line2D object at ...>]
1.3. NumPy: creating and manipulating numerical data
47
1.3. NumPy: creating and manipulating numerical data
48
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> a = np.diag(np.arange(3))
>>> a
array([[0, 0, 0],
[0, 1, 0],
[0, 0, 2]])
>>> a[1, 1]
1
>>> a[2, 1] = 10 # third line, second column
>>> a
array([[ 0, 0, 0],
[ 0, 1, 0],
[ 0, 10, 2]])
>>> a[1]
array([0, 1, 0])
0
0.9
0.8
5
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
0.7
10
0.6
0.5
15
Note:
0.4
20
• In 2D, the first dimension corresponds to rows, the second to columns.
0.3
• for multidimensional a, a[0] is interpreted by taking all elements in the unspecified dimensions.
0.2
25
Slicing: Arrays, like other Python sequences can also be sliced:
>>> a = np.arange(10)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> a[2:9:3] # [start:end:step]
array([2, 5, 8])
0.1
0
5
10
15
20
25
0.0
Note that the last index is not included! :
See also:
>>> a[:4]
array([0, 1, 2, 3])
More in the: matplotlib chapter (page 81)
All three slice components are not required: by default, start is 0, end is the last and step is 1:
Exercise: Simple visualizations
>>> a[1:3]
array([1, 2])
>>> a[::2]
array([0, 2, 4, 6, 8])
>>> a[3:]
array([3, 4, 5, 6, 7, 8, 9])
• Plot some simple arrays: a cosine as a function of time and a 2D matrix.
• Try using the gray colormap on the 2D matrix.
Indexing and slicing
A small illustrated summary of Numpy indexing and slicing...
The items of an array can be accessed and assigned to the same way as other Python sequences (e.g. lists):
>>> a = np.arange(10)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> a[0], a[2], a[-1]
(0, 2, 9)
Warning: Indices begin at 0, like other Python sequences (and C/C++). In contrast, in Fortran or Matlab,
indices begin at 1.
The usual python idiom for reversing a sequence is supported:
>>> a[::-1]
array([9, 8, 7, 6, 5, 4, 3, 2, 1, 0])
For multidimensional arrays, indexes are tuples of integers:
1.3. NumPy: creating and manipulating numerical data
49
1.3. NumPy: creating and manipulating numerical data
50
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise: Array creation
Create the following arrays (with correct data types):
[[1,
[1,
[1,
[1,
1,
1,
1,
6,
[[0.,
[2.,
[0.,
[0.,
[0.,
[0.,
1,
1,
1,
1,
0.,
0.,
3.,
0.,
0.,
0.,
1],
1],
2],
1]]
0.,
0.,
0.,
4.,
0.,
0.,
0.,
0.,
0.,
0.,
5.,
0.,
0.],
0.],
0.],
0.],
0.],
6.]]
Par on course: 3 statements for each
Hint: Individual array elements can be accessed similarly to a list, e.g. a[1] or a[1, 2].
Hint: Examine the docstring for diag.
Exercise: Tiling for array creation
Skim through the documentation for np.tile, and use this function to construct the array:
You can also combine assignment and slicing:
[[4,
[2,
[4,
[2,
>>> a = np.arange(10)
>>> a[5:] = 10
>>> a
array([ 0, 1, 2, 3, 4, 10, 10, 10, 10, 10])
>>> b = np.arange(5)
>>> a[5:] = b[::-1]
>>> a
array([0, 1, 2, 3, 4, 4, 3, 2, 1, 0])
3,
1,
3,
1,
4,
2,
4,
2,
3,
1,
3,
1,
4,
2,
4,
2,
3],
1],
3],
1]]
Copies and views
A slicing operation creates a view on the original array, which is just a way of accessing array data. Thus the
original array is not copied in memory. You can use np.may_share_memory() to check if two arrays share
the same memory block. Note however, that this uses heuristics and may give you false positives.
Exercise: Indexing and slicing
When modifying the view, the original array is modified as well:
• Try the different flavours of slicing, using start, end and step: starting from a linspace, try to
obtain odd numbers counting backwards, and even numbers counting forwards.
• Reproduce the slices in the diagram above. You may use the following expression to create the array:
>>> a = np.arange(10)
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> b = a[::2]
>>> b
array([0, 2, 4, 6, 8])
>>> np.may_share_memory(a, b)
True
>>> b[0] = 12
>>> b
array([12, 2, 4, 6, 8])
>>> a
# (!)
array([12, 1, 2, 3, 4, 5, 6, 7,
>>> np.arange(6) + np.arange(0, 51, 10)[:, np.newaxis]
array([[ 0, 1, 2, 3, 4, 5],
[10, 11, 12, 13, 14, 15],
[20, 21, 22, 23, 24, 25],
[30, 31, 32, 33, 34, 35],
[40, 41, 42, 43, 44, 45],
[50, 51, 52, 53, 54, 55]])
8,
9])
>>> a = np.arange(10)
>>> c = a[::2].copy() # force a copy
>>> c[0] = 12
>>> a
array([0, 1, 2, 3, 4, 5, 6, 7, 8, 9])
>>> np.may_share_memory(a, c)
False
This behavior can be surprising at first sight... but it allows to save both memory and time.
1.3. NumPy: creating and manipulating numerical data
51
1.3. NumPy: creating and manipulating numerical data
52
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> extract_from_a = a[mask] # or, a[a%3==0]
>>> extract_from_a
# extract a sub-array with the mask
array([ 3, 0, 9, 6, 0, 12])
Worked example: Prime number sieve
Indexing with a mask can be very useful to assign a new value to a sub-array:
>>> a[a % 3 == 0] = -1
>>> a
array([10, -1, 8, -1, 19, 10, 11, -1, 10, -1, -1, 20, -1,
7, 14])
Indexing with an array of integers
>>> a = np.arange(0, 100, 10)
>>> a
array([ 0, 10, 20, 30, 40, 50, 60, 70, 80, 90])
Indexing can be done with an array of integers, where the same index is repeated several time:
>>> a[[2, 3, 2, 4, 2]] # note: [2, 3, 2, 4, 2] is a Python list
array([20, 30, 20, 40, 20])
Compute prime numbers in 0–99, with a sieve
• Construct a shape (100,) boolean array is_prime, filled with True in the beginning:
New values can be assigned with this kind of indexing:
>>> a[[9, 7]] = -100
>>> a
array([
0,
10,
20,
>>> is_prime = np.ones((100,), dtype=bool)
• Cross out 0 and 1 which are not primes:
30,
40,
50,
60, -100,
80, -100])
>>> is_prime[:2] = 0
Tip: When a new array is created by indexing with an array of integers, the new array has the same shape than
the array of integers:
• For each integer j starting from 2, cross out its higher multiples:
>>> N_max = int(np.sqrt(len(is_prime)))
>>> for j in range(2, N_max):
...
is_prime[2*j::j] = False
>>> a = np.arange(10)
>>> idx = np.array([[3, 4], [9, 7]])
>>> idx.shape
(2, 2)
>>> a[idx]
array([[3, 4],
[9, 7]])
• Skim through help(np.nonzero), and print the prime numbers
• Follow-up:
– Move the above code into a script file named prime_sieve.py
– Run it to check it works
– Use the optimization suggested in the sieve of Eratosthenes:
1. Skip j which are already known to not be primes
2. The first number to cross out is j 2
The image below illustrates various fancy indexing applications
Fancy indexing
Tip: Numpy arrays can be indexed with slices, but also with boolean or integer arrays (masks). This method is
called fancy indexing. It creates copies not views.
Using boolean masks
>>> np.random.seed(3)
>>> a = np.random.random_integers(0, 20, 15)
>>> a
array([10, 3, 8, 0, 19, 10, 11, 9, 10, 6, 0, 20, 12, 7, 14])
>>> (a % 3 == 0)
array([False, True, False, True, False, False, False, True, False,
True, True, False, True, False, False], dtype=bool)
>>> mask = (a % 3 == 0)
1.3. NumPy: creating and manipulating numerical data
53
1.3. NumPy: creating and manipulating numerical data
54
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Warning: Array multiplication is not matrix multiplication:
Exercise: Fancy indexing
>>> c = np.ones((3, 3))
>>> c * c
array([[ 1., 1., 1.],
[ 1., 1., 1.],
[ 1., 1., 1.]])
• Again, reproduce the fancy indexing shown in the diagram above.
• Use fancy indexing on the left and array creation on the right to assign values into an array, for instance
by setting parts of the array in the diagram above to zero.
1.3.2 Numerical operations on arrays
Note: Matrix multiplication:
>>> c.dot(c)
array([[ 3.,
[ 3.,
[ 3.,
Section contents
•
•
•
•
•
•
# NOT matrix multiplication!
Elementwise operations (page 55)
Basic reductions (page 57)
Broadcasting (page 62)
Array shape manipulation (page 65)
Sorting data (page 67)
Summary (page 68)
3.,
3.,
3.,
3.],
3.],
3.]])
Exercise: Elementwise operations
• Try simple arithmetic elementwise operations: add even elements with odd elements
• Time them against their pure python counterparts using %timeit.
• Generate:
– [2**0, 2**1, 2**2, 2**3, 2**4]
– a_j = 2^(3*j) - j
Elementwise operations
Basic operations
Other operations
With scalars:
>>> a = np.array([1, 2, 3, 4])
>>> a + 1
array([2, 3, 4, 5])
>>> 2**a
array([ 2, 4, 8, 16])
Comparisons:
>>> a = np.array([1, 2, 3, 4])
>>> b = np.array([4, 2, 2, 4])
>>> a == b
array([False, True, False, True], dtype=bool)
>>> a > b
array([False, False, True, False], dtype=bool)
All arithmetic operates elementwise:
>>> b = np.ones(4) + 1
>>> a - b
array([-1., 0., 1., 2.])
>>> a * b
array([ 2., 4., 6., 8.])
Tip: Array-wise comparisons:
>>> a = np.array([1, 2, 3, 4])
>>> b = np.array([4, 2, 2, 4])
>>> c = np.array([1, 2, 3, 4])
>>> np.array_equal(a, b)
False
>>> np.array_equal(a, c)
True
>>> j = np.arange(5)
>>> 2**(j + 1) - j
array([ 2, 3, 6, 13, 28])
These operations are of course much faster than if you did them in pure python:
>>> a = np.arange(10000)
>>> %timeit a + 1
10000 loops, best of 3: 24.3 us per loop
>>> l = range(10000)
>>> %timeit [i+1 for i in l]
1000 loops, best of 3: 861 us per loop
Logical operations:
>>> a = np.array([1, 1, 0, 0], dtype=bool)
>>> b = np.array([1, 0, 1, 0], dtype=bool)
>>> np.logical_or(a, b)
array([ True, True, True, False], dtype=bool)
>>> np.logical_and(a, b)
array([ True, False, False, False], dtype=bool)
Transcendental functions:
>>> a = np.arange(5)
>>> np.sin(a)
1.3. NumPy: creating and manipulating numerical data
55
1.3. NumPy: creating and manipulating numerical data
56
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
array([ 0.
, 0.84147098, 0.90929743, 0.14112001, -0.7568025 ])
>>> np.log(a)
array([
-inf, 0.
, 0.69314718, 1.09861229, 1.38629436])
>>> np.exp(a)
array([ 1.
,
2.71828183,
7.3890561 , 20.08553692, 54.59815003])
Shape mismatches
>>> a = np.arange(4)
>>> a + np.array([1, 2])
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: operands could not be broadcast together with shapes (4) (2)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: operands could not be broadcast together with shapes (4) (2)
Broadcasting? We’ll return to that later (page 62).
Sum by rows and by columns:
Transposition:
>>> a = np.triu(np.ones((3, 3)), 1)
>>> a
array([[ 0., 1., 1.],
[ 0., 0., 1.],
[ 0., 0., 0.]])
>>> a.T
array([[ 0., 0., 0.],
[ 1., 0., 0.],
[ 1., 1., 0.]])
>>> x = np.array([[1, 1], [2, 2]])
>>> x
array([[1, 1],
[2, 2]])
>>> x.sum(axis=0)
# columns (first dimension)
array([3, 3])
>>> x[:, 0].sum(), x[:, 1].sum()
(3, 3)
>>> x.sum(axis=1)
# rows (second dimension)
array([2, 4])
>>> x[0, :].sum(), x[1, :].sum()
(2, 4)
# see help(np.triu)
Warning: The transposition is a view
As a results, the following code is wrong and will not make a matrix symmetric:
Tip: Same idea in higher dimensions:
>>> a += a.T
Note: Linear algebra
The sub-module numpy.linalg implements basic linear algebra, such as solving linear systems, singular value
decomposition, etc. However, it is not guaranteed to be compiled using efficient routines, and thus we recommend
the use of scipy.linalg, as detailed in section Linear algebra operations: scipy.linalg (page 105)
>>> x = np.random.rand(2, 2, 2)
>>> x.sum(axis=2)[0, 1]
1.14764...
>>> x[0, 1, :].sum()
1.14764...
Other reductions
Exercise other operations
— works the same way (and take axis=)
• Look at the help for np.allclose. When might this be useful?
• Look at the help for np.triu and np.tril.
Extrema:
>>> x = np.array([1, 3, 2])
>>> x.min()
1
>>> x.max()
3
Basic reductions
Computing sums
>>> x.argmin()
0
>>> x.argmax()
1
>>> x = np.array([1, 2, 3, 4])
>>> np.sum(x)
10
>>> x.sum()
10
1.3. NumPy: creating and manipulating numerical data
# index of minimum
# index of maximum
Logical operations:
>>> np.all([True, True, False])
False
57
1.3. NumPy: creating and manipulating numerical data
58
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Worked Example: data statistics
>>> np.any([True, True, False])
True
Data in populations.txt describes the populations of hares and lynxes (and carrots) in northern Canada
during 20 years.
You can view the data in an editor, or alternatively in IPython (both shell and notebook):
Note: Can be used for array comparisons:
>>> a = np.zeros((100, 100))
>>> np.any(a != 0)
False
>>> np.all(a == a)
True
>>> a =
>>> b =
>>> c =
>>> ((a
True
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In [1]: !cat data/populations.txt
First, load the data into a Numpy array:
>>> data = np.loadtxt('data/populations.txt')
>>> year, hares, lynxes, carrots = data.T # trick: columns to variables
np.array([1, 2, 3, 2])
np.array([2, 2, 3, 2])
np.array([6, 4, 4, 5])
<= b) & (b <= c)).all()
Then plot it:
>>>
>>>
>>>
>>>
from matplotlib import pyplot as plt
plt.axes([0.2, 0.1, 0.5, 0.8])
plt.plot(year, hares, year, lynxes, year, carrots)
plt.legend(('Hare', 'Lynx', 'Carrot'), loc=(1.05, 0.5))
Statistics:
>>> x = np.array([1, 2, 3, 1])
>>> y = np.array([[1, 2, 3], [5, 6, 1]])
>>> x.mean()
1.75
>>> np.median(x)
1.5
>>> np.median(y, axis=-1) # last axis
array([ 2., 5.])
80000
>>> x.std()
0.82915619758884995
50000
70000
60000
# full population standard dev.
Hare
Lynx
Carrot
40000
... and many more (best to learn as you go).
30000
Exercise: Reductions
• Given there is a sum, what other function might you expect to see?
• What is the difference between sum and cumsum?
20000
10000
0
1900
1905
1910
1915
1920
The mean populations over time:
>>> populations = data[:, 1:]
>>> populations.mean(axis=0)
array([ 34080.95238095, 20166.66666667,
42400.
])
The sample standard deviations:
>>> populations.std(axis=0)
array([ 20897.90645809, 16254.59153691,
3322.50622558])
Which species has the highest population each year?:
>>> np.argmax(populations, axis=1)
array([2, 2, 0, 0, 1, 1, 2, 2, 2, 2, 2, 2, 0, 0, 0, 1, 2, 2, 2, 2, 2])
1.3. NumPy: creating and manipulating numerical data
59
1.3. NumPy: creating and manipulating numerical data
60
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Broadcasting
Worked Example: diffusion using a random walk algorithm
• Basic operations on numpy arrays (addition, etc.) are elementwise
• This works on arrays of the same size.
Nevertheless, It’s also possible to do operations on arrays of different
sizes if Numpy can transform these arrays so that they all have
the same size: this conversion is called broadcasting.
Tip: Let us consider a simple 1D random walk process: at each time step a walker jumps right or left with
equal probability.
We are interested in finding the typical distance from the origin of a random walker after t left or right
jumps? We are going to simulate many “walkers” to find this law, and we are going to do so using array
computing tricks: we are going to create a 2D array with the “stories” (each walker has a story) in one
direction, and the time in the other:
The image below gives an example of broadcasting:
>>> n_stories = 1000 # number of walkers
>>> t_max = 200
# time during which we follow the walker
We randomly choose all the steps 1 or -1 of the walk:
>>> t = np.arange(t_max)
>>> steps = 2 * np.random.random_integers(0, 1, (n_stories, t_max)) - 1
>>> np.unique(steps) # Verification: all steps are 1 or -1
array([-1, 1])
We build the walks by summing steps along the time:
>>> positions = np.cumsum(steps, axis=1) # axis = 1: dimension of time
>>> sq_distance = positions**2
We get the mean in the axis of the stories:
Let’s verify:
>>> mean_sq_distance = np.mean(sq_distance, axis=0)
Plot the results:
q
(δx)
2
®
>>> plt.figure(figsize=(4, 3))
<matplotlib.figure.Figure object at ...>
>>> plt.plot(t, np.sqrt(mean_sq_distance), 'g.', t, np.sqrt(t), 'y-')
[<matplotlib.lines.Line2D object at ...>, <matplotlib.lines.Line2D object at ...>]
>>> plt.xlabel(r"$t$")
<matplotlib.text.Text object at ...>
>>> plt.ylabel(r"$\sqrt{\langle (\delta x)^2 \rangle}$")
<matplotlib.text.Text object at ...>
1.3.
16
14
12
10
8
6
NumPy: creating and manipulating numerical data
4
2
>>> a = np.tile(np.arange(0, 40, 10), (3, 1)).T
>>> a
array([[ 0, 0, 0],
[10, 10, 10],
[20, 20, 20],
[30, 30, 30]])
>>> b = np.array([0, 1, 2])
>>> a + b
array([[ 0, 1, 2],
[10, 11, 12],
[20, 21, 22],
[30, 31, 32]])
We have already used broadcasting without knowing it!:
>>> a = np.ones((4, 5))
>>> a[0] = 2 # we assign an array of dimension 0 to an array of dimension 1
>>> a
array([[ 2., 2., 2., 2., 2.],
[ 1., 1., 1., 1., 1.],
61
1.3. NumPy: creating and manipulating numerical data
62
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
[ 1.,
[ 1.,
1.,
1.,
1.,
1.,
1.,
1.,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
distance from the origin of points on a 10x10 grid, we can do
1.],
1.]])
>>> x, y = np.arange(5), np.arange(5)[:, np.newaxis]
>>> distance = np.sqrt(x ** 2 + y ** 2)
>>> distance
array([[ 0.
, 1.
, 2.
, 3.
,
[ 1.
, 1.41421356, 2.23606798, 3.16227766,
[ 2.
, 2.23606798, 2.82842712, 3.60555128,
[ 3.
, 3.16227766, 3.60555128, 4.24264069,
[ 4.
, 4.12310563, 4.47213595, 5.
,
An useful trick:
>>> a = np.arange(0, 40, 10)
>>> a.shape
(4,)
>>> a = a[:, np.newaxis] # adds a new axis -> 2D array
>>> a.shape
(4, 1)
>>> a
array([[ 0],
[10],
[20],
[30]])
>>> a + b
array([[ 0, 1, 2],
[10, 11, 12],
[20, 21, 22],
[30, 31, 32]])
4.
],
4.12310563],
4.47213595],
5.
],
5.65685425]])
Or in color:
>>> plt.pcolor(distance)
>>> plt.colorbar()
5
5.4
4.8
Tip: Broadcasting seems a bit magical, but it is actually quite natural to use it when we want to solve a problem
whose output data is an array with more dimensions than input data.
4
4.2
3.6
Worked Example: Broadcasting
3
3.0
Let’s construct an array of distances (in miles) between cities of Route 66: Chicago, Springfield, Saint-Louis,
Tulsa, Oklahoma City, Amarillo, Santa Fe, Albuquerque, Flagstaff and Los Angeles.
>>> mileposts = np.array([0, 198, 303, 736, 871, 1175, 1475, 1544,
...
1913, 2448])
>>> distance_array = np.abs(mileposts - mileposts[:, np.newaxis])
>>> distance_array
array([[
0, 198, 303, 736, 871, 1175, 1475, 1544, 1913, 2448],
[ 198,
0, 105, 538, 673, 977, 1277, 1346, 1715, 2250],
[ 303, 105,
0, 433, 568, 872, 1172, 1241, 1610, 2145],
[ 736, 538, 433,
0, 135, 439, 739, 808, 1177, 1712],
[ 871, 673, 568, 135,
0, 304, 604, 673, 1042, 1577],
[1175, 977, 872, 439, 304,
0, 300, 369, 738, 1273],
[1475, 1277, 1172, 739, 604, 300,
0,
69, 438, 973],
[1544, 1346, 1241, 808, 673, 369,
69,
0, 369, 904],
[1913, 1715, 1610, 1177, 1042, 738, 438, 369,
0, 535],
[2448, 2250, 2145, 1712, 1577, 1273, 973, 904, 535,
0]])
2.4
2
1.8
1
1.2
0.6
0
0
1
2
3
4
5
0.0
Remark : the numpy.ogrid function allows to directly create vectors x and y of the previous example, with
two “significant dimensions”:
>>> x, y = np.ogrid[0:5, 0:5]
>>> x, y
(array([[0],
[1],
[2],
[3],
[4]]), array([[0, 1, 2, 3, 4]]))
>>> x.shape, y.shape
((5, 1), (1, 5))
>>> distance = np.sqrt(x ** 2 + y ** 2)
A lot of grid-based or network-based problems can also use broadcasting. For instance, if we want to compute the
Tip: So, np.ogrid is very useful as soon as we have to handle computations on a grid. On the other hand,
np.mgrid directly provides matrices full of indices for cases where we can’t (or don’t want to) benefit from
broadcasting:
1.3. NumPy: creating and manipulating numerical data
1.3. NumPy: creating and manipulating numerical data
63
64
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> x, y =
>>> x
array([[0,
[1,
[2,
[3,
>>> y
array([[0,
[0,
[0,
[0,
>>> a = np.zeros((3, 2))
>>> b = a.T.reshape(3*2)
>>> b[0] = 9
>>> a
array([[ 0., 0.],
[ 0., 0.],
[ 0., 0.]])
np.mgrid[0:4, 0:4]
0,
1,
2,
3,
0,
1,
2,
3,
0],
1],
2],
3]])
1,
1,
1,
1,
2,
2,
2,
2,
3],
3],
3],
3]])
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
To understand this you need to learn more about the memory layout of a numpy array.
Adding a dimension
Array shape manipulation
Indexing with the np.newaxis object allows us to add an axis to an array (you have seen this already above in
the broadcasting section):
Flattening
>>> z = np.array([1, 2, 3])
>>> z
array([1, 2, 3])
>>> a = np.array([[1, 2, 3], [4, 5, 6]])
>>> a.ravel()
array([1, 2, 3, 4, 5, 6])
>>> a.T
array([[1, 4],
[2, 5],
[3, 6]])
>>> a.T.ravel()
array([1, 4, 2, 5, 3, 6])
>>> z[:, np.newaxis]
array([[1],
[2],
[3]])
>>> z[np.newaxis, :]
array([[1, 2, 3]])
Higher dimensions: last dimensions ravel out “first”.
Dimension shuffling
Reshaping
>>> a.shape
(2, 3)
>>> b = a.ravel()
>>> b = b.reshape((2, 3))
>>> b
array([[1, 2, 3],
[4, 5, 6]])
>>>
>>>
(4,
>>>
5
>>>
>>>
(3,
>>>
5
Or,
Also creates a view:
The inverse operation to flattening:
>>> a.reshape((2, -1))
array([[1, 2, 3],
[4, 5, 6]])
a = np.arange(4*3*2).reshape(4, 3, 2)
a.shape
3, 2)
a[0, 2, 1]
b = a.transpose(1, 2, 0)
b.shape
2, 4)
b[2, 1, 0]
>>> b[2, 1, 0] = -1
>>> a[0, 2, 1]
-1
# unspecified (-1) value is inferred
Warning: ndarray.reshape may return a view (cf help(np.reshape))), or copy
Resizing
Tip:
Size of an array can be changed with ndarray.resize:
>>> b[0, 0] = 99
>>> a
array([[99, 2, 3],
[ 4, 5, 6]])
>>> a = np.arange(4)
>>> a.resize((8,))
>>> a
array([0, 1, 2, 3, 0, 0, 0, 0])
Beware: reshape may also return a copy!:
However, it must not be referred to somewhere else:
1.3. NumPy: creating and manipulating numerical data
65
1.3. NumPy: creating and manipulating numerical data
66
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise: Sorting
>>> b = a
>>> a.resize((4,))
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: cannot resize an array that has been referenced or is
referencing another array in this way. Use the resize function
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ValueError: cannot resize an array that has been referenced or is
•
•
•
•
•
•
Try both in-place and out-of-place sorting.
Try creating arrays with different dtypes and sorting them.
Use all or array_equal to check the results.
Look at np.random.shuffle for a way to create sortable input quicker.
Combine ravel, sort and reshape.
Look at the axis keyword for sort and rewrite the previous exercise.
Summary
Exercise: Shape manipulations
• Look at the docstring for reshape, especially the notes section which has some more information
about copies and views.
• Use flatten as an alternative to ravel. What is the difference? (Hint: check which one returns a
view and which a copy)
• Experiment with transpose for dimension shuffling.
What do you need to know to get started?
• Know how to create arrays : array, arange, ones, zeros.
• Know the shape of the array with array.shape, then use slicing to obtain different views of the array:
array[::2], etc. Adjust the shape of the array using reshape or flatten it with ravel.
• Obtain a subset of the elements of an array and/or modify their values with masks
>>> a[a < 0] = 0
Sorting data
• Know miscellaneous operations on arrays, such as finding the mean or max (array.max(),
array.mean()). No need to retain everything, but have the reflex to search in the documentation (online
docs, help(), lookfor())!!
Sorting along an axis:
>>> a = np.array([[4, 3, 5], [1, 2, 1]])
>>> b = np.sort(a, axis=1)
>>> b
array([[3, 4, 5],
[1, 1, 2]])
• For advanced use: master the indexing with arrays of integers, as well as broadcasting. Know more Numpy
functions to handle various array operations.
Quick read
Note: Sorts each row separately!
If you want to do a first quick pass through the Scipy lectures to learn the ecosystem, you can directly skip
to the next chapter: Matplotlib: plotting (page 81).
The remainder of this chapter is not necessary to follow the rest of the intro part. But be sure to come back
and finish this chapter, as well as to do some more exercices (page 77).
In-place sort:
>>> a.sort(axis=1)
>>> a
array([[3, 4, 5],
[1, 1, 2]])
1.3.3 More elaborate arrays
Sorting with fancy indexing:
>>> a = np.array([4, 3, 1, 2])
>>> j = np.argsort(a)
>>> j
array([2, 3, 1, 0])
>>> a[j]
array([1, 2, 3, 4])
Section contents
• More data types (page 68)
• Structured data types (page 70)
• maskedarray: dealing with (propagation of) missing data (page 71)
Finding minima and maxima:
>>>
>>>
>>>
>>>
(0,
More data types
a = np.array([4, 3, 1, 2])
j_max = np.argmax(a)
j_min = np.argmin(a)
j_max, j_min
2)
Casting
“Bigger” type wins in mixed-type operations:
>>> np.array([1, 2, 3]) + 1.5
array([ 2.5, 3.5, 4.5])
Assignment never changes the type!
1.3. NumPy: creating and manipulating numerical data
67
1.3. NumPy: creating and manipulating numerical data
68
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
float16
float32
float64
float96
float128
>>> a = np.array([1, 2, 3])
>>> a.dtype
dtype('int64')
>>> a[0] = 1.9
# <-- float is truncated to integer
>>> a
array([1, 2, 3])
16 bits
32 bits
64 bits (same as float)
96 bits, platform-dependent (same as np.longdouble)
128 bits, platform-dependent (same as np.longdouble)
>>> np.finfo(np.float32).eps
1.1920929e-07
>>> np.finfo(np.float64).eps
2.2204460492503131e-16
Forced casts:
>>> a = np.array([1.7, 1.2, 1.6])
>>> b = a.astype(int) # <-- truncates to integer
>>> b
array([1, 1, 1])
>>> np.float32(1e-8) + np.float32(1) == 1
True
>>> np.float64(1e-8) + np.float64(1) == 1
False
Rounding:
>>> a = np.array([1.2, 1.5, 1.6, 2.5, 3.5, 4.5])
>>> b = np.around(a)
>>> b
# still floating-point
array([ 1., 2., 2., 2., 4., 4.])
>>> c = np.around(a).astype(int)
>>> c
array([1, 2, 2, 2, 4, 4])
Complex floating-point numbers:
complex64
complex128
complex192
complex256
two 32-bit floats
two 64-bit floats
two 96-bit floats, platform-dependent
two 128-bit floats, platform-dependent
Smaller data types
If you don’t know you need special data types, then you probably don’t.
Comparison on using float32 instead of float64:
• Half the size in memory and on disk
• Half the memory bandwidth required (may be a bit faster in some operations)
Different data type sizes
Integers (signed):
int8
int16
int32
int64
8 bits
16 bits
32 bits (same as int on 32-bit platform)
64 bits (same as int on 64-bit platform)
In [1]: a = np.zeros((1e6,), dtype=np.float64)
In [2]: b = np.zeros((1e6,), dtype=np.float32)
In [3]: %timeit a*a
1000 loops, best of 3: 1.78 ms per loop
>>> np.array([1], dtype=int).dtype
dtype('int64')
>>> np.iinfo(np.int32).max, 2**31 - 1
(2147483647, 2147483647)
In [4]: %timeit b*b
1000 loops, best of 3: 1.07 ms per loop
Unsigned integers:
uint8
uint16
uint32
uint64
• But: bigger rounding errors — sometimes in surprising places (i.e., don’t use them unless you really
need them)
8 bits
16 bits
32 bits
64 bits
Structured data types
>>> np.iinfo(np.uint32).max, 2**32 - 1
(4294967295, 4294967295)
sensor_code
position
value
Long integers
(4-character string)
(float)
(float)
>>> samples = np.zeros((6,), dtype=[('sensor_code', 'S4'),
...
('position', float), ('value', float)])
>>> samples.ndim
1
>>> samples.shape
(6,)
>>> samples.dtype.names
('sensor_code', 'position', 'value')
Python 2 has a specific type for ‘long’ integers, that cannot overflow, represented with an ‘L’ at the end. In
Python 3, all integers are long, and thus cannot overflow.
>>> np.iinfo(np.int64).max, 2**63 - 1
(9223372036854775807, 9223372036854775807L)
Floating-point numbers:
>>> samples[:] = [('ALFA',
1, 0.37), ('BETA', 1, 0.11), ('TAU', 1,
0.13),
...
('ALFA', 1.5, 0.37), ('ALFA', 3, 0.11), ('TAU', 1.2, 0.13)]
>>> samples
array([('ALFA', 1.0, 0.37), ('BETA', 1.0, 0.11), ('TAU', 1.0, 0.13),
1.3. NumPy: creating and manipulating numerical data
69
1.3. NumPy: creating and manipulating numerical data
70
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
('ALFA', 1.5, 0.37), ('ALFA', 3.0, 0.11), ('TAU', 1.2, 0.13)],
dtype=[('sensor_code', 'S4'), ('position', '<f8'), ('value', '<f8')])
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Good practices
• Explicit variable names (no need of a comment to explain what is in the variable)
• Style: spaces after commas, around =, etc.
A certain number of rules for writing “beautiful” code (and, more importantly, using the same conventions as everybody else!) are given in the Style Guide for Python Code and the Docstring Conventions
page (to manage help strings).
• Except some rare cases, variable names and comments in English.
Field access works by indexing with field names:
>>> samples['sensor_code']
array(['ALFA', 'BETA', 'TAU', 'ALFA', 'ALFA', 'TAU'],
dtype='|S4')
>>> samples['value']
array([ 0.37, 0.11, 0.13, 0.37, 0.11, 0.13])
>>> samples[0]
('ALFA', 1.0, 0.37)
1.3.4 Advanced operations
>>> samples[0]['sensor_code'] = 'TAU'
>>> samples[0]
('TAU', 1.0, 0.37)
Section contents
Multiple fields at once:
• Polynomials (page 72)
• Loading data files (page 74)
>>> samples[['position', 'value']]
array([(1.0, 0.37), (1.0, 0.11), (1.0, 0.13), (1.5, 0.37), (3.0, 0.11),
(1.2, 0.13)],
dtype=[('position', '<f8'), ('value', '<f8')])
Polynomials
Fancy indexing works, as usual:
Numpy also contains polynomials in different bases:
>>> samples[samples['sensor_code'] == 'ALFA']
array([('ALFA', 1.5, 0.37), ('ALFA', 3.0, 0.11)],
dtype=[('sensor_code', 'S4'), ('position', '<f8'), ('value', '<f8')])
For example, 3x2 + 2x − 1:
>>> p = np.poly1d([3, 2, -1])
>>> p(0)
-1
>>> p.roots
array([-1.
, 0.33333333])
>>> p.order
2
Note: There are a bunch of other syntaxes for constructing structured arrays, see here and here.
maskedarray: dealing with (propagation of) missing data
• For floats one could use NaN’s, but masks work for all types:
>>> x = np.linspace(0, 1, 20)
>>> y = np.cos(x) + 0.3*np.random.rand(20)
>>> p = np.poly1d(np.polyfit(x, y, 3))
>>> x = np.ma.array([1, 2, 3, 4], mask=[0, 1, 0, 1])
>>> x
masked_array(data = [1 -- 3 --],
mask = [False True False True],
fill_value = 999999)
>>> t = np.linspace(0, 1, 200)
>>> plt.plot(x, y, 'o', t, p(t), '-')
[<matplotlib.lines.Line2D object at ...>, <matplotlib.lines.Line2D object at ...>]
>>> y = np.ma.array([1, 2, 3, 4], mask=[0, 1, 1, 1])
>>> x + y
masked_array(data = [2 -- -- --],
mask = [False True True True],
fill_value = 999999)
• Masking versions of common functions:
>>> np.ma.sqrt([1, -1, 2, -2])
masked_array(data = [1.0 -- 1.41421356237... --],
mask = [False True False True],
fill_value = 1e+20)
Note: There are other useful array siblings (page 181)
While it is off topic in a chapter on numpy, let’s take a moment to recall good coding practice, which really do pay
off in the long run:
1.3. NumPy: creating and manipulating numerical data
71
1.3. NumPy: creating and manipulating numerical data
72
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.3
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.3
1.2
1.2
1.1
1.1
1.0
1.0
0.9
0.9
0.8
0.8
0.7
0.7
0.6
0.0
0.6
0.2
0.4
0.6
0.8
0.5
1.0
1.0
0.5
0.0
See http://docs.scipy.org/doc/numpy/reference/routines.polynomials.poly1d.html for more.
The Chebyshev polynomials have some advantages in interpolation.
More polynomials (with more bases)
Loading data files
Numpy also has a more sophisticated polynomial interface, which supports e.g. the Chebyshev basis.
Text files
3x2 + 2x − 1:
Example: populations.txt:
>>> p = np.polynomial.Polynomial([-1, 2, 3]) # coefs in different order!
>>> p(0)
-1.0
>>> p.roots()
array([-1.
, 0.33333333])
>>> p.degree() # In general polynomials do not always expose 'order'
2
# year
1900
1901
1902
1903
hare
30e3
47.2e3
70.2e3
77.4e3
lynx
4e3
6.1e3
9.8e3
35.2e3
1.0
carrot
48300
48200
41500
38200
>>> x = np.linspace(-1, 1, 2000)
>>> y = np.cos(x) + 0.3*np.random.rand(2000)
>>> p = np.polynomial.Chebyshev.fit(x, y, 90)
>>> data = np.loadtxt('data/populations.txt')
>>> data
array([[ 1900., 30000.,
4000., 48300.],
[ 1901., 47200.,
6100., 48200.],
[ 1902., 70200.,
9800., 41500.],
...
>>> t = np.linspace(-1, 1, 200)
>>> plt.plot(x, y, 'r.')
[<matplotlib.lines.Line2D object at ...>]
>>> plt.plot(t, p(t), 'k-', lw=3)
[<matplotlib.lines.Line2D object at ...>]
>>> np.savetxt('pop2.txt', data)
>>> data2 = np.loadtxt('pop2.txt')
Example using polynomials in Chebyshev basis, for polynomials in range [-1, 1]:
0.5
Note: If you have a complicated text file, what you can try are:
• np.genfromtxt
• Using Python’s I/O functions and e.g. regexps for parsing (Python is quite well suited for this)
1.3. NumPy: creating and manipulating numerical data
73
1.3. NumPy: creating and manipulating numerical data
74
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Reminder: Navigating the filesystem with IPython
In [1]: pwd
# show current directory
'/home/user/stuff/2011-numpy-tutorial'
In [2]: cd ex
'/home/user/stuff/2011-numpy-tutorial/ex'
In [3]: ls
populations.txt species.txt
0
5
10
Images
15
Using Matplotlib:
20
>>> img = plt.imread('data/elephant.png')
>>> img.shape, img.dtype
((200, 300, 3), dtype('float32'))
>>> plt.imshow(img)
<matplotlib.image.AxesImage object at ...>
>>> plt.savefig('plot.png')
25
30
>>> plt.imsave('red_elephant', img[:,:,0], cmap=plt.cm.gray)
0
10
20
30
40
This saved only one channel (of RGB):
>>> plt.imshow(plt.imread('red_elephant.png'))
<matplotlib.image.AxesImage object at ...>
Other libraries:
Numpy’s own format
>>> from scipy.misc import imsave
>>> imsave('tiny_elephant.png', img[::6,::6])
>>> plt.imshow(plt.imread('tiny_elephant.png'), interpolation='nearest')
<matplotlib.image.AxesImage object at ...>
Numpy has its own binary format, not portable but with efficient I/O:
>>> data = np.ones((3, 3))
>>> np.save('pop.npy', data)
>>> data3 = np.load('pop.npy')
Well-known (& more obscure) file formats
• HDF5: h5py, PyTables
• NetCDF: scipy.io.netcdf_file, netcdf4-python, ...
• Matlab: scipy.io.loadmat, scipy.io.savemat
• MatrixMarket: scipy.io.mmread, scipy.io.mmwrite
• IDL: scipy.io.readsav
... if somebody uses it, there’s probably also a Python library for it.
Exercise: Text data files
Write a Python script that loads data from populations.txt:: and drop the last column and the first 5
rows. Save the smaller dataset to pop2.txt.
1.3. NumPy: creating and manipulating numerical data
75
1.3. NumPy: creating and manipulating numerical data
76
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Numpy internals
>>> import pylab as plt
>>> lena = misc.lena()
>>> plt.imshow(lena)
<matplotlib.image.AxesImage object at 0x...>
If you are interested in the Numpy internals, there is a good discussion in Advanced Numpy (page 155).
• Lena is then displayed in false colors. A colormap must be specified for her to be displayed in grey.
1.3.5 Some exercises
>>> plt.imshow(lena, cmap=plt.cm.gray)
<matplotlib.image.AxesImage object at 0x...>
Array manipulations
• Create an array of the image with a narrower centering [for example,] remove 30 pixels from all the
borders of the image. To check the result, display this new array with imshow.
1. Form the 2-D array (without typing it in explicitly):
[[1, 6,
[2, 7,
[3, 8,
[4, 9,
[5, 10,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
11],
12],
13],
14],
15]]
>>> crop_lena = lena[30:-30,30:-30]
• We will now frame Lena’s face with a black locket. For this, we need to create a mask corresponding
to the pixels we want to be black. The mask is defined by this condition (y-256)**2 +
(x-256)**2
and generate a new array containing its 2nd and 4th rows.
>>> y, x = np.ogrid[0:512,0:512] # x and y indices of pixels
>>> y.shape, x.shape
((512, 1), (1, 512))
>>> centerx, centery = (256, 256) # center of the image
>>> mask = ((y - centery)**2 + (x - centerx)**2) > 230**2 # circle
2. Divide each column of the array:
>>> import numpy as np
>>> a = np.arange(25).reshape(5, 5)
elementwise with the array b = np.array([1., 5, 10, 15, 20]). (Hint: np.newaxis).
3. Harder one: Generate a 10 x 3 array of random numbers (in range [0,1]). For each row, pick the number
closest to 0.5.
• Use abs and argsort to find the column j closest for each row.
• Use fancy indexing to extract the numbers. (Hint: a[i,j] – the array i must contain the row numbers
corresponding to stuff in j.)
then we assign the value 0 to the pixels of the image corresponding to the mask. The syntax is
extremely simple and intuitive:
>>> lena[mask] = 0
>>> plt.imshow(lena)
<matplotlib.image.AxesImage object at 0x...>
• Follow-up: copy all instructions of this exercise in a script called lena_locket.py then execute
this script in IPython with %run lena_locket.py.
Change the circle to an ellipsoid.
Picture manipulation: Framing Lena
Let’s do some manipulations on numpy arrays by starting with the famous image of Lena
(http://www.cs.cmu.edu/~chuck/lennapg/). scipy provides a 2D array of this image with the scipy.lena
function:
>>> from scipy import misc
>>> lena = misc.lena()
Data statistics
The data in populations.txt describes the populations of hares and lynxes (and carrots) in northern Canada
during 20 years:
>>> data = np.loadtxt('data/populations.txt')
>>> year, hares, lynxes, carrots = data.T # trick: columns to variables
Note: In older versions of scipy, you will find lena under scipy.lena()
Here are a few images we will be able to obtain with our manipulations: use different colormaps, crop the image,
change some parts of the image.
>>> import matplotlib.pyplot as plt
>>> plt.axes([0.2, 0.1, 0.5, 0.8])
<matplotlib.axes...Axes object at ...>
>>> plt.plot(year, hares, year, lynxes, year, carrots)
[<matplotlib.lines.Line2D object at ...>, ...]
>>> plt.legend(('Hare', 'Lynx', 'Carrot'), loc=(1.05, 0.5))
<matplotlib.legend.Legend object at ...>
• Let’s use the imshow function of pylab to display the image.
1.3. NumPy: creating and manipulating numerical data
77
1.3. NumPy: creating and manipulating numerical data
78
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
def f(a, b, c):
return some_result
80000
Solution: Python source file
70000
Mandelbrot set
60000
Hare
Lynx
Carrot
50000
40000
1.5
1.0
30000
0.5
20000
10000
0
1900
0.0
1905
1910
1915
1920
0.5
Computes and print, based on the data in populations.txt...
1.0
1. The mean and std of the populations of each species for the years in the period.
2. Which year each species had the largest population.
3. Which species has the largest population for each year.
np.array([’H’, ’L’, ’C’]))
(Hint: argsort & fancy indexing of
1.5
2.0
1.5
1.0
0.5
0.0
0.5
1.0
4. Which years any of the populations is above 50000. (Hint: comparisons and np.any)
5. The top 2 years for each species when they had the lowest populations. (Hint: argsort, fancy indexing)
6. Compare (plot) the change in hare population (see help(np.gradient)) and the number of lynxes.
Check correlation (see help(np.corrcoef)).
Write a script that computes the Mandelbrot fractal. The Mandelbrot iteration:
N_max = 50
some_threshold = 50
... all without for-loops.
c = x + 1j*y
Solution: Python source file
for j in xrange(N_max):
z = z**2 + c
Crude integral approximations
Point (x, y) belongs to the Mandelbrot set if |c| < some_threshold.
Write a function f(a, b, c) that returns ab − c. Form a 24x12x6 array containing its values in parameter
ranges [0,1] x [0,1] x [0,1].
Do this computation by:
1. Construct a grid of c = x + 1j*y values in range [-2, 1] x [-1.5, 1.5]
2. Do the iteration
Approximate the 3-d integral
︁
1
0
︁
1
0
︁
1
3. Form the 2-d boolean mask indicating which points are in the set
b
0
(a − c)da db dc
over this volume with the mean. The exact result is: ln 2 −
1
2
4. Save the result to an image with:
≈ 0.1931 . . . — what is your relative error?
(Hints: use elementwise operations and broadcasting. You can make np.ogrid give a number of points in given
range with np.ogrid[0:1:20j].)
Reminder Python functions:
1.3. NumPy: creating and manipulating numerical data
79
>>> import matplotlib.pyplot as plt
>>> plt.imshow(mask.T, extent=[-2, 1, -1.5, 1.5])
<matplotlib.image.AxesImage object at ...>
>>> plt.gray()
>>> plt.savefig('mandelbrot.png')
1.3. NumPy: creating and manipulating numerical data
80
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Solution: Python source file
Chapters contents
Markov chain
Markov chain transition matrix P, and probability distribution on the states p:
1. 0 <= P[i,j] <= 1: probability to go from state i to state j
2. Transition rule: pnew = P T pold
3. all(sum(P, axis=1) == 1), p.sum() == 1: normalization
Write a script that works with 5 states, and:
• Constructs a random matrix, and normalizes each row so that it is a transition matrix.
• Starts from a random (normalized) probability distribution p and takes 50 steps => p_50
• Computes the stationary distribution: the eigenvector of P.T with eigenvalue 1 (numerically: closest to 1)
=> p_stationary
Remember to normalize the eigenvector — I didn’t...
• Checks if p_50 and p_stationary are equal to tolerance 1e-5
Toolbox: np.random.rand, .dot(), np.linalg.eig, reductions, abs(), argmin, comparisons, all,
np.linalg.norm, etc.
Solution: Python source file
1.4 Matplotlib: plotting
Thanks
1.4.1 Introduction
Many thanks to Bill Wing and Christoph Deil for review and corrections.
Tip: Matplotlib is probably the single most used Python package for 2D-graphics. It provides both a very quick
way to visualize data from Python and publication-quality figures in many formats. We are going to explore
matplotlib in interactive mode covering most common cases.
Authors: Nicolas Rougier, Mike Müller, Gaël Varoquaux
1.4. Matplotlib: plotting
• Introduction (page 82)
– IPython and the pylab mode (page 83)
– pylab (page 83)
• Simple plot (page 83)
– Plotting with default settings (page 84)
– Instantiating defaults (page 84)
– Changing colors and line widths (page 85)
– Setting limits (page 86)
– Setting ticks (page 86)
– Setting tick labels (page 87)
– Moving spines (page 87)
– Adding a legend (page 88)
– Annotate some points (page 88)
– Devil is in the details (page 89)
• Figures, Subplots, Axes and Ticks (page 89)
– Figures (page 90)
– Subplots (page 90)
– Axes (page 90)
– Ticks (page 91)
• Other Types of Plots: examples and exercises (page 91)
– Regular Plots (page 93)
– Scatter Plots (page 93)
– Bar Plots (page 94)
– Contour Plots (page 94)
– Imshow (page 95)
– Pie Charts (page 95)
– Quiver Plots (page 96)
– Grids (page 96)
– Multi Plots (page 96)
– Polar Axis (page 97)
– 3D Plots (page 97)
– Text (page 98)
• Beyond this tutorial (page 98)
– Tutorials (page 98)
– Matplotlib documentation (page 99)
– Code documentation (page 99)
– Galleries (page 100)
– Mailing lists (page 100)
• Quick references (page 100)
– Line properties (page 101)
– Line styles (page 102)
– Markers (page 102)
– Colormaps (page 102)
81
1.4. Matplotlib: plotting
82
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
IPython and the pylab mode
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Plotting with default settings
Tip: IPython is an enhanced interactive Python shell that has lots of interesting features including named inputs and outputs, access to shell commands, improved debugging and many more. It is central to the scientificcomputing workflow in Python for its use in combination with Matplotlib:
We start IPython with the command line argument -pylab (--pylab since IPython version 0.12), for interactive
matplotlib sessions with Matlab/Mathematica-like functionality.
pylab
Tip: pylab provides a procedural interface to the matplotlib object-oriented plotting library. It is modeled
closely after Matlab™. Therefore, the majority of plotting commands in pylab have Matlab™ analogs with similar
arguments. Important commands are explained with interactive examples.
Hint: Documentation
• plot tutorial
• plot() command
1.4.2 Simple plot
Tip: In this section, we want to draw the cosine and sine functions on the same plot. Starting from the default
settings, we’ll enrich the figure step by step to make it nicer.
Tip: Matplotlib comes with a set of default settings that allow customizing all kinds of properties. You can
control the defaults of almost every property in matplotlib: figure size and dpi, line width, color and style, axes,
axis and grid properties, text and font properties and so on.
First step is to get the data for the sine and cosine functions:
import pylab as pl
import numpy as np
import numpy as np
X = np.linspace(-np.pi, np.pi, 256, endpoint=True)
C, S = np.cos(X), np.sin(X)
X = np.linspace(-np.pi, np.pi, 256, endpoint=True)
C, S = np.cos(X), np.sin(X)
X is now a numpy array with 256 values ranging from -π to +π (included). C is the cosine (256 values) and S is
the sine (256 values).
pl.plot(X, C)
pl.plot(X, S)
pl.show()
To run the example, you can type them in an IPython interactive session:
$ ipython --pylab
Instantiating defaults
This brings us to the IPython prompt:
IPython
?
%magic
help
object?
0.13 -- An enhanced Interactive Python.
-> Introduction to IPython's features.
-> Information about IPython's 'magic' % functions.
-> Python's own help system.
-> Details about 'object'. ?object also works, ?? prints more.
Welcome to pylab, a matplotlib-based Python environment.
For more information, type 'help(pylab)'.
Tip: You can also download each of the examples and run it using regular python, but you will loose interactive
data manipulation:
$ python exercice_1.py
Hint: Documentation
• Customizing matplotlib
You can get source for each step by clicking on the corresponding figure.
In the script below, we’ve instantiated (and commented) all the figure settings that influence the appearance of the
plot.
Tip: The settings have been explicitly set to their default values, but now you can interactively play with the
values to explore their affect (see Line properties (page 101) and Line styles (page 102) below).
1.4. Matplotlib: plotting
83
1.4. Matplotlib: plotting
84
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
import pylab as pl
import numpy as np
pl.plot(X, S, color="red",
...
# Create a figure of size 8x6 inches, 80 dots per inch
pl.figure(figsize=(8, 6), dpi=80)
Setting limits
linewidth=2.5, linestyle="-")
# Create a new subplot from a grid of 1x1
pl.subplot(1, 1, 1)
X = np.linspace(-np.pi, np.pi, 256, endpoint=True)
C, S = np.cos(X), np.sin(X)
# Plot cosine with a blue continuous line of width 1 (pixels)
pl.plot(X, C, color="blue", linewidth=1.0, linestyle="-")
# Plot sine with a green continuous line of width 1 (pixels)
pl.plot(X, S, color="green", linewidth=1.0, linestyle="-")
Hint: Documentation
# Set x limits
pl.xlim(-4.0, 4.0)
• xlim() command
• ylim() command
# Set x ticks
pl.xticks(np.linspace(-4, 4, 9, endpoint=True))
Tip: Current limits of the figure are a bit too tight and we want to make some space in order to clearly see all
data points.
# Set y limits
pl.ylim(-1.0, 1.0)
...
pl.xlim(X.min() * 1.1, X.max() * 1.1)
pl.ylim(C.min() * 1.1, C.max() * 1.1)
...
# Set y ticks
pl.yticks(np.linspace(-1, 1, 5, endpoint=True))
# Save figure using 72 dots per inch
# savefig("exercice_2.png", dpi=72)
Setting ticks
# Show result on screen
pl.show()
Changing colors and line widths
Hint: Documentation
• xticks() command
• yticks() command
• Tick container
Hint: Documentation
• Tick locating and formatting
• Controlling line properties
• Line API
Tip: Current ticks are not ideal because they do not show the interesting values (+/-π,+/-π/2) for sine and cosine.
We’ll change them such that they show only these values.
Tip: First step, we want to have the cosine in blue and the sine in red and a slighty thicker line for both of them.
We’ll also slightly alter the figure size to make it more horizontal.
...
pl.figure(figsize=(10, 6), dpi=80)
pl.plot(X, C, color="blue", linewidth=2.5, linestyle="-")
1.4. Matplotlib: plotting
85
...
pl.xticks([-np.pi, -np.pi/2, 0, np.pi/2, np.pi])
pl.yticks([-1, 0, +1])
...
1.4. Matplotlib: plotting
86
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
...
ax = pl.gca() # gca stands for 'get current axis'
ax.spines['right'].set_color('none')
ax.spines['top'].set_color('none')
ax.xaxis.set_ticks_position('bottom')
ax.spines['bottom'].set_position(('data',0))
ax.yaxis.set_ticks_position('left')
ax.spines['left'].set_position(('data',0))
...
Setting tick labels
Adding a legend
Hint: Documentation
• Working with text
• xticks() command
• yticks() command
• set_xticklabels()
• set_yticklabels()
Tip: Ticks are now properly placed but their label is not very explicit. We could guess that 3.142 is π but it would
be better to make it explicit. When we set tick values, we can also provide a corresponding label in the second
argument list. Note that we’ll use latex to allow for nice rendering of the label.
Hint: Documentation
• Legend guide
• legend() command
...
pl.xticks([-np.pi, -np.pi/2, 0, np.pi/2, np.pi],
[r'$-\pi$', r'$-\pi/2$', r'$0$', r'$+\pi/2$', r'$+\pi$'])
• Legend API
Tip: Let’s add a legend in the upper left corner. This only requires adding the keyword argument label (that will
be used in the legend box) to the plot commands.
pl.yticks([-1, 0, +1],
[r'$-1$', r'$0$', r'$+1$'])
...
...
pl.plot(X, C, color="blue", linewidth=2.5, linestyle="-", label="cosine")
pl.plot(X, S, color="red", linewidth=2.5, linestyle="-", label="sine")
Moving spines
pl.legend(loc='upper left')
...
Annotate some points
Hint: Documentation
• Spines
• Axis container
• Transformations tutorial
Hint: Documentation
Tip: Spines are the lines connecting the axis tick marks and noting the boundaries of the data area. They can be
placed at arbitrary positions and until now, they were on the border of the axis. We’ll change that since we want
to have them in the middle. Since there are four of them (top/bottom/left/right), we’ll discard the top and right by
setting their color to none and we’ll move the bottom and left ones to coordinate 0 in data space coordinates.
• Annotating axis
• annotate() command
Tip: Let’s annotate some interesting points using the annotate command. We chose the 2π/3 value and we want
1.4. Matplotlib: plotting
87
1.4. Matplotlib: plotting
88
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
to annotate both the sine and the cosine. We’ll first draw a marker on the curve as well as a straight dotted line.
Then, we’ll use the annotate command to display some text with an arrow.
current axes and gca in turn calls gcf() to get the current figure. If there is none it calls figure() to make
one, strictly speaking, to make a subplot(111). Let’s look at the details.
...
Figures
t = 2 * np.pi / 3
pl.plot([t, t], [0, np.cos(t)], color='blue', linewidth=2.5, linestyle="--")
pl.scatter([t, ], [np.cos(t), ], 50, color='blue')
Tip: A figure is the windows in the GUI that has “Figure #” as title. Figures are numbered starting from 1 as
opposed to the normal Python way starting from 0. This is clearly MATLAB-style. There are several parameters
that determine what the figure looks like:
pl.annotate(r'$sin(\frac{2\pi}{3})=\frac{\sqrt{3}}{2}$',
xy=(t, np.sin(t)), xycoords='data',
xytext=(+10, +30), textcoords='offset points', fontsize=16,
arrowprops=dict(arrowstyle="->", connectionstyle="arc3,rad=.2"))
Argument
num
figsize
dpi
facecolor
edgecolor
frameon
pl.plot([t, t],[0, np.sin(t)], color='red', linewidth=2.5, linestyle="--")
pl.scatter([t, ],[np.sin(t), ], 50, color='red')
pl.annotate(r'$cos(\frac{2\pi}{3})=-\frac{1}{2}$',
xy=(t, np.cos(t)), xycoords='data',
xytext=(-90, -50), textcoords='offset points', fontsize=16,
arrowprops=dict(arrowstyle="->", connectionstyle="arc3,rad=.2"))
...
Default
1
figure.figsize
figure.dpi
figure.facecolor
figure.edgecolor
True
Description
number of figure
figure size in in inches (width, height)
resolution in dots per inch
color of the drawing background
color of edge around the drawing background
draw figure frame or not
Tip: The defaults can be specified in the resource file and will be used most of the time. Only the number of the
figure is frequently changed.
As with other objects, you can set figure properties also setp or with the set_something methods.
Devil is in the details
When you work with the GUI you can close a figure by clicking on the x in the upper right corner. But you
can close a figure programmatically by calling close. Depending on the argument it closes (1) the current figure
(no argument), (2) a specific figure (figure number or figure instance as argument), or (3) all figures ("all" as
argument).
pl.close(1)
# Closes figure 1
Subplots
Tip: With subplot you can arrange plots in a regular grid. You need to specify the number of rows and columns
and the number of the plot. Note that the gridspec command is a more powerful alternative.
Hint: Documentation
• Artists
• BBox
Tip: The tick labels are now hardly visible because of the blue and red lines. We can make them bigger and we
can also adjust their properties such that they’ll be rendered on a semi-transparent white background. This will
allow us to see both the data and the labels.
...
for label in ax.get_xticklabels() + ax.get_yticklabels():
label.set_fontsize(16)
label.set_bbox(dict(facecolor='white', edgecolor='None', alpha=0.65))
...
Axes
Axes are very similar to subplots but allow placement of plots at any location in the figure.
So if we want to put a smaller plot inside a bigger one we do so with axes.
1.4.3 Figures, Subplots, Axes and Ticks
A “figure” in matplotlib means the whole window in the user interface. Within this figure there can be “subplots”.
Tip: So far we have used implicit figure and axes creation. This is handy for fast plots. We can have more control
over the display using figure, subplot, and axes explicitly. While subplot positions the plots in a regular grid, axes
allows free placement within the figure. Both can be useful depending on your intention. We’ve already worked
with figures and subplots without explicitly calling them. When we call plot, matplotlib calls gca() to get the
1.4. Matplotlib: plotting
89
1.4. Matplotlib: plotting
90
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
(page 93)
(page 94)
(page 94)
(page 95)
(page 96)
(page 95)
(page 96)
(page 96)
(page 97)
(page 98)
(page 97)
Ticks
Well formatted ticks are an important part of publishing-ready figures. Matplotlib provides a totally configurable
system for ticks. There are tick locators to specify where ticks should appear and tick formatters to give ticks the
appearance you want. Major and minor ticks can be located and formatted independently from each other. Per
default minor ticks are not shown, i.e. there is only an empty list for them because it is as NullLocator (see
below).
Tick Locators
Tick locators control the positions of the ticks. They are set as follows:
ax = pl.gca()
ax.xaxis.set_major_locator(eval(locator))
There are several locators for different kind of requirements:
All of these locators derive from the base class matplotlib.ticker.Locator. You can make your own
locator deriving from it. Handling dates as ticks can be especially tricky. Therefore, matplotlib provides special
locators in matplotlib.dates.
1.4.4 Other Types of Plots: examples and exercises
(page
1.4. Matplotlib: plotting
93)
91
1.4. Matplotlib: plotting
92
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Regular Plots
Bar Plots
Hint: You need to use the fill_between command.
Hint: You need to take care of text alignment.
Starting from the code below, try to reproduce the graphic on the right taking care of filled areas:
Starting from the code below, try to reproduce the graphic on the right by adding labels for red bars.
n = 256
X = np.linspace(-np.pi, np.pi, n, endpoint=True)
Y = np.sin(2 * X)
n = 12
X = np.arange(n)
Y1 = (1 - X / float(n)) * np.random.uniform(0.5, 1.0, n)
Y2 = (1 - X / float(n)) * np.random.uniform(0.5, 1.0, n)
pl.plot(X, Y + 1, color='blue', alpha=1.00)
pl.plot(X, Y - 1, color='blue', alpha=1.00)
pl.bar(X, +Y1, facecolor='#9999ff', edgecolor='white')
pl.bar(X, -Y2, facecolor='#ff9999', edgecolor='white')
Click on the figure for solution.
for x, y in zip(X, Y1):
pl.text(x + 0.4, y + 0.05, '%.2f' % y, ha='center', va='bottom')
Scatter Plots
pl.ylim(-1.25, +1.25)
Click on figure for solution.
Contour Plots
Hint: Color is given by angle of (X,Y).
Starting from the code below, try to reproduce the graphic on the right taking care of marker size, color and
transparency.
n = 1024
X = np.random.normal(0,1,n)
Y = np.random.normal(0,1,n)
Hint: You need to use the clabel command.
pl.scatter(X,Y)
Starting from the code below, try to reproduce the graphic on the right taking care of the colormap (see Colormaps
(page 102) below).
def f(x, y):
return (1 - x / 2 + x ** 5 + y ** 3) * np.exp(-x ** 2 -y ** 2)
Click on figure for solution.
n = 256
x = np.linspace(-3, 3, n)
y = np.linspace(-3, 3, n)
X, Y = np.meshgrid(x, y)
1.4. Matplotlib: plotting
93
1.4. Matplotlib: plotting
94
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Quiver Plots
pl.contourf(X, Y, f(X, Y), 8, alpha=.75, cmap='jet')
C = pl.contour(X, Y, f(X, Y), 8, colors='black', linewidth=.5)
Click on figure for solution.
Imshow
Hint: You need to draw arrows twice.
Starting from the code above, try to reproduce the graphic on the right taking care of colors and orientations.
n = 8
X, Y = np.mgrid[0:n, 0:n]
pl.quiver(X, Y)
Hint: You need to take care of the origin of the image in the imshow command and use a colorbar
Starting from the code below, try to reproduce the graphic on the right taking care of colormap, image interpolation
and origin.
Click on figure for solution.
Grids
def f(x, y):
return (1 - x / 2 + x ** 5 + y ** 3) * np.exp(-x ** 2 - y ** 2)
n = 10
x = np.linspace(-3, 3, 4 * n)
y = np.linspace(-3, 3, 3 * n)
X, Y = np.meshgrid(x, y)
pl.imshow(f(X, Y))
Click on the figure for the solution.
Pie Charts
Starting from the code below, try to reproduce the graphic on the right
taking care of line styles.
axes = pl.gca()
axes.set_xlim(0, 4)
axes.set_ylim(0, 3)
axes.set_xticklabels([])
axes.set_yticklabels([])
Click on figure for solution.
Multi Plots
Hint: You need to modify Z.
Starting from the code below, try to reproduce the graphic on the right taking care of colors and slices size.
Z = np.random.uniform(0, 1, 20)
pl.pie(Z)
Click on the figure for the solution.
1.4. Matplotlib: plotting
95
1.4. Matplotlib: plotting
96
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
from mpl_toolkits.mplot3d import Axes3D
Hint: You can use several subplots with different partition.
fig = pl.figure()
ax = Axes3D(fig)
X = np.arange(-4, 4, 0.25)
Y = np.arange(-4, 4, 0.25)
X, Y = np.meshgrid(X, Y)
R = np.sqrt(X**2 + Y**2)
Z = np.sin(R)
Starting from the code below, try to reproduce the graphic on the right.
pl.subplot(2, 2, 1)
pl.subplot(2, 2, 3)
pl.subplot(2, 2, 4)
Click on figure for solution.
ax.plot_surface(X, Y, Z, rstride=1, cstride=1, cmap='hot')
Polar Axis
Click on figure for solution.
See also:
3D plotting with Mayavi (page 357)
Text
Hint: You only need to modify the axes line
Starting from the code below, try to reproduce the graphic on the right.
pl.axes([0, 0, 1, 1])
N = 20
theta = np.arange(0., 2 * np.pi, 2 * np.pi / N)
radii = 10 * np.random.rand(N)
width = np.pi / 4 * np.random.rand(N)
bars = pl.bar(theta, radii, width=width, bottom=0.0)
Hint: Have a look at the matplotlib logo.
Try to do the same from scratch !
Click on figure for solution.
for r, bar in zip(radii, bars):
bar.set_facecolor(cm.jet(r / 10.))
bar.set_alpha(0.5)
Quick read
Click on figure for solution.
If you want to do a first quick pass through the Scipy lectures to learn the ecosystem, you can directly skip
to the next chapter: Scipy : high-level scientific computing (page 103).
The remainder of this chapter is not necessary to follow the rest of the intro part. But be sure to come back
and finish this chapter later.
3D Plots
1.4.5 Beyond this tutorial
Matplotlib benefits from extensive documentation as well as a large community of users and developers. Here are
some links of interest:
Tutorials
•
•
•
•
Hint: You need to use contourf
Starting from the code below, try to reproduce the graphic on the right.
1.4. Matplotlib: plotting
97
Pyplot tutorial
Introduction
Controlling line properties
Working with multiple figures and axes
1.4. Matplotlib: plotting
98
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Working with text
Image tutorial
Startup commands
Importing image data into Numpy arrays
Plotting numpy arrays as images
Text tutorial
Text introduction
Basic text commands
Text properties and layout
Writing mathematical expressions
Text rendering With LaTeX
Annotating text
Artist tutorial
Introduction
Customizing your objects
Object containers
Figure container
Axes container
Axis containers
Tick containers
Path tutorial
Introduction
Bézier example
Compound paths
Transforms tutorial
Introduction
Data coordinates
Axes coordinates
Blended transformations
Using offset transforms to create a shadow effect
The transformation pipeline
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
argument, allowing for multiple *x*, *y* pairs with an
optional format string. For example, each of the following is
legal::
plot(x, y)
plot(x, y, 'bo')
plot(y)
plot(y, 'r+')
#
#
#
#
plot x
plot x
plot y
ditto,
and y using default line style and color
and y using blue circle markers
using x as index array 0..N-1
but with red plusses
If *x* and/or *y* is 2-dimensional, then the corresponding columns
will be plotted.
...
Galleries
The matplotlib gallery is also incredibly useful when you search how to render a given graphic. Each example
comes with its source.
A smaller gallery is also available here.
Mailing lists
Finally, there is a user mailing list where you can ask for help and a developers mailing list that is more technical.
1.4.6 Quick references
Here is a set of tables that show main properties and styles.
Matplotlib documentation
• User guide
• FAQ
– Installation
– Usage
– How-To
– Troubleshooting
– Environment Variables
• Screenshots
Code documentation
The code is well documented and you can quickly access a specific command from within a python session:
>>> import pylab as pl
>>> help(pl.plot)
Help on function plot in module matplotlib.pyplot:
plot(*args, **kwargs)
Plot lines and/or markers to the
:class:`~matplotlib.axes.Axes`. *args* is a variable length
1.4. Matplotlib: plotting
99
1.4. Matplotlib: plotting
100
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Line properties
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Line styles
Property
Description
alpha (or a)
alpha transparency on 0-1 scale
antialiased
True or False - use antialised
rendering
color (or c)
matplotlib color arg
linestyle (or ls)
see Line properties (page 101)
linewidth (or lw)
float, the line width in points
solid_capstyle
Cap style for solid lines
solid_joinstyle
Join style for solid lines
dash_capstyle
Cap style for dashes
dash_joinstyle
Join style for dashes
marker
see Markers (page 102)
markeredgewidth
(mew)
line width around the marker
symbol
markeredgecolor
(mec)
edge color if a marker is used
markerfacecolor
(mfc)
face color if a marker is used
markersize (ms)
size of the marker in points
Appearance
Markers
Colormaps
All colormaps can be reversed by appending _r. For instance, gray_r is the reverse of gray.
If you want to know more about colormaps, checks Documenting the matplotlib colormaps.
1.4. Matplotlib: plotting
101
1.4. Matplotlib: plotting
102
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
scipy.cluster
scipy.constants
scipy.fftpack
scipy.integrate
scipy.interpolate
scipy.io
scipy.linalg
scipy.ndimage
scipy.odr
scipy.optimize
scipy.signal
scipy.sparse
scipy.spatial
scipy.special
scipy.stats
Vector quantization / Kmeans
Physical and mathematical constants
Fourier transform
Integration routines
Interpolation
Data input and output
Linear algebra routines
n-dimensional image package
Orthogonal distance regression
Optimization
Signal processing
Sparse matrices
Spatial data structures and algorithms
Any special mathematical functions
Statistics
Tip: They all depend on numpy, but are mostly independent of each other. The standard way of importing
Numpy and these Scipy modules is:
1.5 Scipy : high-level scientific computing
>>> import numpy as np
>>> from scipy import stats
# same for other sub-modules
Authors: Adrien Chauve, Andre Espaze, Emmanuelle Gouillart, Gaël Varoquaux, Ralf Gommers
The main scipy namespace mostly contains functions that are really numpy functions (try scipy.cos is
np.cos). Those are exposed for historical reasons only; there’s usually no reason to use import scipy in
your code.
Scipy
The scipy package contains various toolboxes dedicated to common issues in scientific computing. Its
different submodules correspond to different applications, such as interpolation, integration, optimization,
image processing, statistics, special functions, etc.
scipy can be compared to other standard scientific-computing libraries, such as the GSL (GNU Scientific
Library for C and C++), or Matlab’s toolboxes. scipy is the core package for scientific routines in Python;
it is meant to operate efficiently on numpy arrays, so that numpy and scipy work hand in hand.
Before implementing a routine, it is worth checking if the desired data processing is not already implemented in Scipy. As non-professional programmers, scientists often tend to re-invent the wheel, which
leads to buggy, non-optimal, difficult-to-share and unmaintainable code. By contrast, Scipy‘s routines are
optimized and tested, and should therefore be used when possible.
1.5.1 File input/output: scipy.io
• Loading and saving matlab files:
>>> from scipy import io as spio
>>> a = np.ones((3, 3))
>>> spio.savemat('file.mat', {'a': a}) # savemat expects a dictionary
>>> data = spio.loadmat('file.mat', struct_as_record=True)
>>> data['a']
array([[ 1., 1., 1.],
[ 1., 1., 1.],
[ 1., 1., 1.]])
Chapters contents
•
•
•
•
•
•
•
•
•
•
•
File input/output: scipy.io (page 104)
Special functions: scipy.special (page 104)
Linear algebra operations: scipy.linalg (page 105)
Fast Fourier transforms: scipy.fftpack (page 106)
Optimization and fit: scipy.optimize (page 110)
Statistics and random numbers: scipy.stats (page 114)
Interpolation: scipy.interpolate (page 116)
Numerical integration: scipy.integrate (page 117)
Signal processing: scipy.signal (page 119)
Image processing: scipy.ndimage (page 121)
Summary exercises on scientific computing (page 125)
• Reading images:
>>> from scipy import misc
>>> misc.imread('fname.png')
array(...)
>>> # Matplotlib also has a similar function
>>> import matplotlib.pyplot as plt
>>> plt.imread('fname.png')
array(...)
See also:
• Load text files: numpy.loadtxt()/numpy.savetxt()
Warning: This tutorial is far from an introduction to numerical computing. As enumerating the different
submodules and functions in scipy would be very boring, we concentrate instead on a few examples to give a
general idea of how to use scipy for scientific computing.
• Clever loading of text/csv files: numpy.genfromtxt()/numpy.recfromcsv()
• Fast and efficient, but numpy-specific, binary format: numpy.save()/numpy.load()
1.5.2 Special functions: scipy.special
scipy is composed of task-specific sub-modules:
Special functions are transcendental functions. The docstring of the scipy.special module is well-written,
so we won’t list all functions here. Frequently used ones are:
1.5. Scipy : high-level scientific computing
103
1.5. Scipy : high-level scientific computing
104
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Bessel function, such as scipy.special.jn() (nth integer order Bessel function)
>>> spec
array([ 14.88982544,
• Elliptic function (scipy.special.ellipj() for the Jacobian elliptic function, ...)
0.45294236,
0.29654967])
The original matrix can be re-composed by matrix multiplication of the outputs of svd with np.dot:
• Gamma function: scipy.special.gamma(), also note scipy.special.gammaln() which will
give the log of Gamma to a higher numerical precision.
>>> sarr = np.diag(spec)
>>> svd_mat = uarr.dot(sarr).dot(vharr)
>>> np.allclose(svd_mat, arr)
True
• Erf, the area under a Gaussian curve: scipy.special.erf()
1.5.3 Linear algebra operations: scipy.linalg
SVD is commonly used in statistics and signal processing. Many other standard decompositions (QR, LU,
Cholesky, Schur), as well as solvers for linear systems, are available in scipy.linalg.
The scipy.linalg module provides standard linear algebra operations, relying on an underlying efficient
implementation (BLAS, LAPACK).
1.5.4 Fast Fourier transforms: scipy.fftpack
• The scipy.linalg.det() function computes the determinant of a square matrix:
>>> from scipy import linalg
>>> arr = np.array([[1, 2],
...
[3, 4]])
>>> linalg.det(arr)
-2.0
>>> arr = np.array([[3, 2],
...
[6, 4]])
>>> linalg.det(arr)
0.0
>>> linalg.det(np.ones((3, 4)))
Traceback (most recent call last):
...
ValueError: expected square matrix
Traceback (most recent call last):
...
ValueError: expected square matrix
The scipy.fftpack module allows to compute fast Fourier transforms. As an illustration, a (noisy) input
signal may look like:
>>>
>>>
>>>
>>>
...
time_step = 0.02
period = 5.
time_vec = np.arange(0, 20, time_step)
sig = np.sin(2 * np.pi / period * time_vec) + \
0.5 * np.random.randn(time_vec.size)
The observer doesn’t know the signal frequency, only the sampling time step of the signal sig.
The signal is supposed to come from a real function so the Fourier transform will be symmetric.
The scipy.fftpack.fftfreq() function will generate the sampling frequencies and
scipy.fftpack.fft() will compute the fast Fourier transform:
>>> from scipy import fftpack
>>> sample_freq = fftpack.fftfreq(sig.size, d=time_step)
>>> sig_fft = fftpack.fft(sig)
• The scipy.linalg.inv() function computes the inverse of a square matrix:
Because the resulting power is symmetric, only the positive part of the spectrum needs to be used for finding the
frequency:
>>> arr = np.array([[1, 2],
...
[3, 4]])
>>> iarr = linalg.inv(arr)
>>> iarr
array([[-2. , 1. ],
[ 1.5, -0.5]])
>>> np.allclose(np.dot(arr, iarr), np.eye(2))
True
>>> pidxs = np.where(sample_freq > 0)
>>> freqs = sample_freq[pidxs]
>>> power = np.abs(sig_fft)[pidxs]
600
Finally computing the inverse of a singular matrix (its determinant is zero) will raise LinAlgError:
Peak frequency
500
>>> arr = np.array([[3, 2],
...
[6, 4]])
>>> linalg.inv(arr)
Traceback (most recent call last):
...
...LinAlgError: singular matrix
Traceback (most recent call last):
...
...LinAlgError: singular matrix
plower
400
300
200
• More advanced operations are available, for example singular-value decomposition (SVD):
0.050.100.150.200.250.300.350.400.45
100
>>> arr = np.arange(9).reshape((3, 3)) + np.diag([1, 0, 1])
>>> uarr, spec, vharr = linalg.svd(arr)
0
0
The resulting array spectrum is:
5
10
15
20
25
Frequency [Hz]
The signal frequency can be found by:
1.5. Scipy : high-level scientific computing
105
1.5. Scipy : high-level scientific computing
106
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> freq = freqs[power.argmax()]
>>> np.allclose(freq, 1./period)
True
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Worked example: Crude periodicity finding
# check that correct freq is found
80
Now the high-frequency noise will be removed from the Fourier transformed signal:
>>> sig_fft[np.abs(sample_freq) > freq] = 0
hare
lynx
carrot
70
Population number ( 103 )
The resulting filtered signal can be computed by the scipy.fftpack.ifft() function:
>>> main_sig = fftpack.ifft(sig_fft)
60
·
The result can be viewed with:
>>> import pylab as plt
>>> plt.figure()
<matplotlib.figure.Figure object at 0x...>
>>> plt.plot(time_vec, sig)
[<matplotlib.lines.Line2D object at 0x...>]
>>> plt.plot(time_vec, main_sig, linewidth=3)
[<matplotlib.lines.Line2D object at 0x...>]
>>> plt.xlabel('Time [s]')
<matplotlib.text.Text object at 0x...>
>>> plt.ylabel('Amplitude')
<matplotlib.text.Text object at 0x...>
50
40
30
20
10
3
0
1900
2
1905
1910
Year
1915
1920
Amplitude
1
300
0
1
250
10
Time [s]
15
20
200
3
5
Power ( ·10
3
0
)
2
numpy.fft
Numpy also has an implementation of FFT (numpy.fft). However, in general the scipy one should be
preferred, as it uses more efficient underlying implementations.
150
100
50
0
0
5
10
15
20
Period
1.5. Scipy : high-level scientific computing
107
1.5. Scipy : high-level scientific computing
108
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Worked example: Gaussian image blur
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise: Denoise moon landing image
Convolution:
f1 (t) =
︁
dt′ K(t − t′ )f0 (t′ )
f˜1 (ω) = K̃(ω)f˜0 (ω)
0
50
1. Examine the provided image moonlanding.png, which is heavily contaminated with periodic noise. In
this exercise, we aim to clean up the noise using the Fast Fourier Transform.
2. Load the image using pylab.imread().
3. Find and use the 2-D FFT function in scipy.fftpack, and plot the spectrum (Fourier transform
of) the image. Do you have any trouble visualising the spectrum? If so, why?
4. The spectrum consists of high and low frequency components. The noise is contained in the highfrequency part of the spectrum, so set some of those components to zero (use array slicing).
5. Apply the inverse Fourier transform to see the resulting image.
100
150
0
50
100
150
200
250
1.5.5 Optimization and fit: scipy.optimize
Optimization is the problem of finding a numerical solution to a minimization or equality.
The scipy.optimize module provides useful algorithms for function minimization (scalar or multidimensional), curve fitting and root finding.
>>> from scipy import optimize
Finding the minimum of a scalar function
Let’s define the following function:
>>> def f(x):
...
return x**2 + 10*np.sin(x)
and plot it:
>>> x = np.arange(-10, 10, 0.1)
>>> plt.plot(x, f(x))
>>> plt.show()
1.5. Scipy : high-level scientific computing
109
1.5. Scipy : high-level scientific computing
110
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Another available (but much less efficient) global optimizer is scipy.optimize.brute() (brute force optimization on a grid). More efficient algorithms for different classes of global optimization problems exist, but this
is out of the scope of scipy. Some useful packages for global optimization are OpenOpt, IPOPT, PyGMO and
PyEvolve.
120
100
Note: scipy used to contain the routine anneal, it has been deprecated since SciPy 0.14.0 and removed in
SciPy 0.16.0.
80
To find the local minimum, let’s
scipy.optimize.fminbound():
constraint
the
variable
to
the
interval
(0, 10)
using
>>> xmin_local = optimize.fminbound(f, 0, 10)
>>> xmin_local
3.8374671...
60
40
Note: Finding minima of function is discussed in more details in the advanced chapter: Mathematical optimization: finding minima of functions (page 239).
20
Finding the roots of a scalar function
To find a root, i.e. a point where f(x) = 0, of the function f above we can use for example
scipy.optimize.fsolve():
0
20
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
10
5
0
5
>>> root = optimize.fsolve(f, 1)
>>> root
array([ 0.])
10
# our initial guess is 1
Note that only one root is found. Inspecting the plot of f reveals that there is a second root around -2.5. We find
the exact value of it by adjusting our initial guess:
This function has a global minimum around -1.3 and a local minimum around 3.8.
The general and efficient way to find a minimum for this function is to conduct a gradient descent starting from a
given initial point. The BFGS algorithm is a good way of doing this:
>>> optimize.fmin_bfgs(f, 0)
Optimization terminated successfully.
Current function value: -7.945823
Iterations: 5
Function evaluations: 24
Gradient evaluations: 8
array([-1.30644003])
>>> root2 = optimize.fsolve(f, -2.5)
>>> root2
array([-2.47948183])
Curve fitting
Suppose we have data sampled from f with some noise:
.. Comment to make doctest pass
>>> np.random.seed(42)
A possible issue with this approach is that, if the function has local minima the algorithm may find these local
minima instead of the global minimum depending on the initial point:
>>> xdata = np.linspace(-10, 10, num=20)
>>> ydata = f(xdata) + np.random.randn(xdata.size)
Now if we know the functional form of the function from which the samples were drawn (x^2 + sin(x) in
this case) but not the amplitudes of the terms, we can find those by least squares curve fitting. First we have to
define the function to fit:
>>> optimize.fmin_bfgs(f, 3, disp=0)
array([ 3.83746663])
If we don’t know the neighborhood of the global minimum to choose the initial point, we need to resort to costlier
global optimization. To find the global minimum, we use scipy.optimize.basinhopping() (which
combines a local optimizer with stochastic sampling of starting points for the local optimizer):
>>> def f2(x, a, b):
...
return a*x**2 + b*np.sin(x)
New in version 0.12.0: basinhopping was added in version 0.12.0 of Scipy
Then we can use scipy.optimize.curve_fit() to find a and b:
>>> optimize.basinhopping(f, 0)
nfev: 1725
minimization_failures: 0
fun: -7.9458233756152845
x: array([-1.30644001])
message: ['requested number of basinhopping iterations completed successfully']
njev: 575
nit: 100
>>> guess = [2, 2]
>>> params, params_covariance = optimize.curve_fit(f2, xdata, ydata, guess)
>>> params
array([ 0.99667386, 10.17808313])
1.5. Scipy : high-level scientific computing
111
Now we have found the minima and roots of f and used curve fitting on it, we put all those resuls together in a
single plot:
1.5. Scipy : high-level scientific computing
112
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise: 2-D minimization
120
f(x)
Curve fit result
Minima
Roots
100
60
40
20
0
20
6
5
4
3
2
1
0
1
2
1.0
0.5
0.0y
0.5
f(x, y)
f(x)
80
Six-hump Camelback function
10
5
0
x
5
2.01.51.0
0.50.0
x 0.51.01.5
2.0 1.0
10
Note:
In Scipy >= 0.11 unified interfaces to all minimization and root finding algorithms
scipy.optimize.minimize(), scipy.optimize.minimize_scalar() and
are available:
scipy.optimize.root(). They allow comparing various algorithms easily through the method keyword.
You can find algorithms with the same functionalities for multi-dimensional problems in scipy.optimize.
Exercise: Curve fitting of temperature data
The temperature extremes in Alaska for each month, starting in January, are given by (in degrees
Celcius):
max: 17, 19, 21, 28, 33, 38, 37, 37, 31, 23, 19, 18
min: -62, -59, -56, -46, -32, -18, -9, -13, -25, -46, -52, -58
The six-hump camelback function
f (x, y) = (4 − 2.1x2 +
x4 2
)x + xy + (4y 2 − 4)y 2
3
has multiple global and local minima. Find the global minima of this function.
Hints:
• Variables can be restricted to -2 < x < 2 and -1 < y < 1.
• Use numpy.meshgrid() and pylab.imshow() to find visually the regions.
• Use scipy.optimize.fmin_bfgs() or another multi-dimensional minimizer.
How many global minima are there, and what is the function value at those points? What
happens for an initial guess of (x, y) = (0, 0)?
See the summary exercise on Non linear least squares curve fitting: application to point extraction in topographical lidar data (page 129) for another, more advanced example.
1. Plot these temperature extremes.
2. Define a function that can describe min and max temperatures. Hint: this function has to
have a period of 1 year. Hint: include a time offset.
3. Fit this function to the data with scipy.optimize.curve_fit().
4. Plot the result. Is the fit reasonable? If not, why?
5. Is the time offset for min and max temperatures the same within the fit accuracy?
1.5.6 Statistics and random numbers: scipy.stats
The module scipy.stats contains statistical tools and probabilistic descriptions of random processes. Random
number generators for various random process can be found in numpy.random.
Histogram and probability density function
Given observations of a random process, their histogram is an estimator of the random process’s PDF (probability
density function):
>>> a = np.random.normal(size=1000)
>>> bins = np.arange(-4, 5)
>>> bins
1.5. Scipy : high-level scientific computing
113
1.5. Scipy : high-level scientific computing
114
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> stats.scoreatpercentile(a, 50)
0.0404176959...
array([-4, -3, -2, -1, 0, 1, 2, 3, 4])
>>> histogram = np.histogram(a, bins=bins, normed=True)[0]
>>> bins = 0.5*(bins[1:] + bins[:-1])
>>> bins
array([-3.5, -2.5, -1.5, -0.5, 0.5, 1.5, 2.5, 3.5])
>>> from scipy import stats
>>> b = stats.norm.pdf(bins) # norm is a distribution
Similarly, we can calculate the percentile 90:
>>> stats.scoreatpercentile(a, 90)
1.3185699120...
The percentile is an estimator of the CDF: cumulative distribution function.
>>> plt.plot(bins, histogram)
[<matplotlib.lines.Line2D object at ...>]
>>> plt.plot(bins, b)
[<matplotlib.lines.Line2D object at ...>]
Statistical tests
A statistical test is a decision indicator. For instance, if we have two sets of observations, that we assume are generated from Gaussian processes, we can use a T-test to decide whether the two sets of observations are significantly
different:
0.40
0.35
>>> a = np.random.normal(0, 1, size=100)
>>> b = np.random.normal(1, 1, size=10)
>>> stats.ttest_ind(a, b)
(array(-3.177574054...), 0.0019370639...)
0.30
0.25
Tip: The resulting output is composed of:
0.20
• The T statistic value: it is a number the sign of which is proportional to the difference between the two
random processes and the magnitude is related to the significance of this difference.
0.15
• the p value: the probability of both processes being identical. If it is close to 1, the two process are almost
certainly identical. The closer it is to zero, the more likely it is that the processes have different means.
0.10
0.05
See also:
0.00
6
4
2
0
2
4
The chapter on statistics (page 271) introduces much more elaborate tools for statistical testing and statistical data
loading and visualization outside of scipy.
6
If we know that the random process belongs to a given family of random processes, such as normal processes,
we can do a maximum-likelihood fit of the observations to estimate the parameters of the underlying distribution.
Here we fit a normal process to the observed data:
1.5.7 Interpolation: scipy.interpolate
The scipy.interpolate is useful for fitting a function from experimental data and thus evaluating points
where no measure exists. The module is based on the FITPACK Fortran subroutines from the netlib project.
>>> loc, std = stats.norm.fit(a)
>>> loc
0.0314345570...
>>> std
0.9778613090...
By imagining experimental data close to a sine function:
>>> measured_time = np.linspace(0, 1, 10)
>>> noise = (np.random.random(10)*2 - 1) * 1e-1
>>> measures = np.sin(2 * np.pi * measured_time) + noise
Exercise: Probability distributions
The scipy.interpolate.interp1d class can build a linear interpolation function:
Generate 1000 random variates from a gamma distribution with a shape parameter of 1, then plot a histogram
from those samples. Can you plot the pdf on top (it should match)?
Extra: the distributions have a number of useful methods. Explore them by reading the docstring or by using
IPython tab completion. Can you find the shape parameter of 1 back by using the fit method on your
random variates?
>>> from scipy.interpolate import interp1d
>>> linear_interp = interp1d(measured_time, measures)
Then the scipy.interpolate.linear_interp instance needs to be evaluated at the time of interest:
>>> computed_time = np.linspace(0, 1, 50)
>>> linear_results = linear_interp(computed_time)
Percentiles
A cubic interpolation can also be selected by providing the kind optional keyword argument:
The median is the value with half of the observations below, and half above:
>>> cubic_interp = interp1d(measured_time, measures, kind='cubic')
>>> cubic_results = cubic_interp(computed_time)
>>> np.median(a)
0.04041769593...
The results are now gathered on the following Matplotlib figure:
It is also called the percentile 50, because 50% of the observation are below it:
1.5. Scipy : high-level scientific computing
115
1.5. Scipy : high-level scientific computing
116
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
...
...
1.0
measures
linear interp
cubic interp
0.5
return -2 * ypos
An extra argument counter_arr has been added to illustrate that the function may be called several times for
a single time step, until solver convergence. The counter array is defined as:
>>> counter = np.zeros((1,), dtype=np.uint16)
The trajectory will now be computed:
>>> from scipy.integrate import odeint
>>> time_vec = np.linspace(0, 4, 40)
>>> yvec, info = odeint(calc_derivative, 1, time_vec,
...
args=(counter,), full_output=True)
0.0
Thus the derivative function has been called more than 40 times (which was the number of time steps):
0.5
>>> counter
array([129], dtype=uint16)
and the cumulative number of iterations for each of the 10 first time steps can be obtained by:
1.0
>>> info['nfe'][:10]
array([31, 35, 43, 49, 53, 57, 59, 63, 65, 69], dtype=int32)
0.2
0.4
0.6
0.8
Note that the solver requires more iterations for the first time step. The solution yvec for the trajectory can now
be plotted:
1.0
1.0
scipy.interpolate.interp2d is similar to scipy.interpolate.interp1d, but for 2-D arrays.
Note that for the interp family, the computed time must stay within the measured time range. See the summary exercise on Maximum wind speed prediction at the Sprogø station (page 125) for a more advance spline
interpolation example.
1.5.8 Numerical integration: scipy.integrate
The most generic integration routine is scipy.integrate.quad():
>>> from scipy.integrate import quad
>>> res, err = quad(np.sin, 0, np.pi/2)
>>> np.allclose(res, 1)
True
>>> np.allclose(err, 1 - res)
True
0.6
0.4
0.2
0.0
0.0 0.5 1.0 1.5 2.0 2.5 3.0 3.5 4.0
Time [s]
Others integration schemes are available with fixed_quad, quadrature, romberg.
scipy.integrate also features routines for integrating Ordinary Differential Equations (ODE). In particular,
scipy.integrate.odeint() is a general-purpose integrator using LSODA (Livermore Solver for Ordinary
Differential equations with Automatic method switching for stiff and non-stiff problems), see the ODEPACK
Fortran library for more details.
Another example with scipy.integrate.odeint() will be a damped spring-mass oscillator (2nd order
oscillator). The position of a mass attached to a spring obeys the 2nd order ODE y’’ + 2 eps wo y’ +
wo^2 y = 0 with wo^2 = k/m with k the spring constant, m the mass and eps=c/(2 m wo) with c the
damping coefficient. For this example, we choose the parameters as:
>>> mass = 0.5 # kg
>>> kspring = 4 # N/m
>>> cviscous = 0.4 # N s/m
odeint solves first-order ODE systems of the form:
dy/dt = rhs(y1, y2, .., t0,...)
As an introduction, let us solve the ODE dy/dt = -2y between t = 0..4, with the initial condition y(t=0)
= 1. First the function computing the derivative of the position needs to be defined:
>>> def calc_derivative(ypos, time, counter_arr):
...
counter_arr += 1
1.5. Scipy : high-level scientific computing
0.8
y position [m]
1.5
0.0
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
117
so the system will be underdamped, because:
>>> eps = cviscous / (2 * mass * np.sqrt(kspring/mass))
>>> eps < 1
True
1.5. Scipy : high-level scientific computing
118
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
For the scipy.integrate.odeint() solver the 2nd order equation needs to be transformed in a system of
two first-order equations for the vector Y=(y, y’). It will be convenient to define nu = 2 eps * wo = c
/ m and om = wo^2 = k/m:
8
>>> nu_coef = cviscous / mass
>>> om_coef = kspring / mass
6
Thus the function will calculate the velocity and acceleration by:
4
>>> def calc_deri(yvec, time, nuc, omc):
...
return (yvec[1], -nuc * yvec[1] - omc * yvec[0])
...
>>> time_vec = np.linspace(0, 10, 100)
>>> yarr = odeint(calc_deri, (1, 0), time_vec, args=(nu_coef, om_coef))
2
0
The final position and velocity are shown on the following Matplotlib figure:
2
4
0
1.5
y
1.0
1
2
3
4
5
y'
• scipy.signal.resample(): resample a signal to n points using FFT.
0.5
>>> t = np.linspace(0, 5, 100)
>>> x = np.sin(t)
0.0
>>> plt.plot(t, x, linewidth=3)
[<matplotlib.lines.Line2D object at ...>]
>>> plt.plot(t[::2], signal.resample(x, 50), 'ko')
[<matplotlib.lines.Line2D object at ...>]
0.5
1.0
1.5
2.0
2.5
0
1.5
2
4
6
8
10
1.0
There is no Partial Differential Equations (PDE) solver in Scipy. Some Python packages for solving PDE’s are
available, such as fipy or SfePy.
0.5
0.0
1.5.9 Signal processing: scipy.signal
0.5
>>> from scipy import signal
• scipy.signal.detrend(): remove linear trend from signal:
1.0
>>> t = np.linspace(0, 5, 100)
>>> x = t + np.random.normal(size=100)
1.5
0
>>> plt.plot(t, x, linewidth=3)
[<matplotlib.lines.Line2D object at ...>]
>>> plt.plot(t, signal.detrend(x), linewidth=3)
[<matplotlib.lines.Line2D object at ...>]
1
2
3
4
5
Notice how on the side of the window the resampling is less accurate and has a rippling effect.
has
many
window
functions:
scipy.signal.hamming(),
• scipy.signal
scipy.signal.bartlett(), scipy.signal.blackman()...
has
filtering
(median
filter
scipy.signal.medfilt(),
• scipy.signal
scipy.signal.wiener()), but we will discuss this in the image section.
1.5. Scipy : high-level scientific computing
119
1.5. Scipy : high-level scientific computing
Wiener
120
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
1.5.10 Image processing: scipy.ndimage
The submodule dedicated to image processing in scipy is scipy.ndimage.
>>> from scipy import ndimage
Image processing routines may be sorted according to the category of processing they perform.
Geometrical transformations on images
Mathematical morphology
Changing orientation, resolution, ..
>>> from scipy import misc
>>> lena = misc.lena()
>>> shifted_lena = ndimage.shift(lena, (50, 50))
>>> shifted_lena2 = ndimage.shift(lena, (50, 50), mode='nearest')
>>> rotated_lena = ndimage.rotate(lena, 30)
>>> cropped_lena = lena[50:-50, 50:-50]
>>> zoomed_lena = ndimage.zoom(lena, 2)
>>> zoomed_lena.shape
(1024, 1024)
Mathematical morphology is a mathematical theory that stems from set theory. It characterizes and transforms
geometrical structures. Binary (black and white) images, in particular, can be transformed using this theory:
the sets to be transformed are the sets of neighboring non-zero-valued pixels. The theory was also extended to
gray-valued images.
>>> plt.subplot(151)
<matplotlib.axes._subplots.AxesSubplot object at 0x...>
Elementary mathematical-morphology operations use a structuring element in order to modify other geometrical
structures.
>>> plt.imshow(shifted_lena, cmap=plt.cm.gray)
<matplotlib.image.AxesImage object at 0x...>
Let us first generate a structuring element
>>> el = ndimage.generate_binary_structure(2, 1)
>>> el
array([[False, True, False],
[...True, True, True],
[False, True, False]], dtype=bool)
>>> el.astype(np.int)
array([[0, 1, 0],
[1, 1, 1],
[0, 1, 0]])
>>> plt.axis('off')
(-0.5, 511.5, 511.5, -0.5)
>>> # etc.
Image filtering
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
from scipy import misc
lena = misc.lena()
import numpy as np
noisy_lena = np.copy(lena).astype(np.float)
noisy_lena += lena.std()*0.5*np.random.standard_normal(lena.shape)
blurred_lena = ndimage.gaussian_filter(noisy_lena, sigma=3)
median_lena = ndimage.median_filter(blurred_lena, size=5)
from scipy import signal
wiener_lena = signal.wiener(blurred_lena, (5,5))
• Erosion
>>> a = np.zeros((7,7), dtype=np.int)
>>> a[1:6, 2:5] = 1
>>> a
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> ndimage.binary_erosion(a).astype(a.dtype)
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
Many other filters in scipy.ndimage.filters and scipy.signal can be applied to images.
Exercise
Compare histograms for the different filtered images.
1.5. Scipy : high-level scientific computing
121
1.5. Scipy : high-level scientific computing
122
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>>
>>>
>>>
>>>
>>>
>>>
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> #Erosion removes objects smaller than the structure
>>> ndimage.binary_erosion(a, structure=np.ones((5,5))).astype(a.dtype)
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
a = np.zeros((50, 50))
a[10:-10, 10:-10] = 1
a += 0.25*np.random.standard_normal(a.shape)
mask = a>=0.5
opened_mask = ndimage.binary_opening(mask)
closed_mask = ndimage.binary_closing(opened_mask)
• Dilation
>>> a = np.zeros((5, 5))
>>> a[2, 2] = 1
>>> a
array([[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.]])
>>> ndimage.binary_dilation(a).astype(a.dtype)
array([[ 0., 0., 0., 0., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 1., 1., 1., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 0., 0., 0., 0.]])
Exercise
Check that the area of the reconstructed square is smaller than the area of the initial square. (The
opposite would occur if the closing step was performed before the opening).
For gray-valued images, eroding (resp. dilating) amounts to replacing a pixel by the minimal (resp. maximal)
value among pixels covered by the structuring element centered on the pixel of interest.
>>> a = np.zeros((7,7), dtype=np.int)
>>> a[1:6, 1:6] = 3
>>> a[4,4] = 2; a[2,3] = 1
>>> a
array([[0, 0, 0, 0, 0, 0, 0],
[0, 3, 3, 3, 3, 3, 0],
[0, 3, 3, 1, 3, 3, 0],
[0, 3, 3, 3, 3, 3, 0],
[0, 3, 3, 3, 2, 3, 0],
[0, 3, 3, 3, 3, 3, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> ndimage.grey_erosion(a, size=(3,3))
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 3, 2, 2, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
• Opening
>>> a = np.zeros((5,5), dtype=np.int)
>>> a[1:4, 1:4] = 1; a[4, 4] = 1
>>> a
array([[0, 0, 0, 0, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 0, 0, 0, 1]])
>>> # Opening removes small objects
>>> ndimage.binary_opening(a, structure=np.ones((3,3))).astype(np.int)
array([[0, 0, 0, 0, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 0, 0, 0, 0]])
>>> # Opening can also smooth corners
>>> ndimage.binary_opening(a).astype(np.int)
array([[0, 0, 0, 0, 0],
[0, 0, 1, 0, 0],
[0, 1, 1, 1, 0],
[0, 0, 1, 0, 0],
[0, 0, 0, 0, 0]])
Measurements on images
Let us first generate a nice synthetic binary image.
>>> x, y = np.indices((100, 100))
>>> sig = np.sin(2*np.pi*x/50.)*np.sin(2*np.pi*y/50.)*(1+x*y/50.**2)**2
>>> mask = sig > 1
• Closing: ndimage.binary_closing
Now we look for various information about the objects in the image:
Exercise
Check that opening amounts to eroding, then dilating.
An opening operation removes small structures, while a closing operation fills small holes. Such operations can
therefore be used to “clean” an image.
1.5. Scipy : high-level scientific computing
123
>>> labels, nb = ndimage.label(mask)
>>> nb
8
>>> areas = ndimage.sum(mask, labels, range(1, labels.max()+1))
>>> areas
array([ 190.,
45., 424., 278., 459., 190., 549., 424.])
1.5. Scipy : high-level scientific computing
124
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Computing the cumulative probabilities
>>> maxima = ndimage.maximum(sig, labels, range(1, labels.max()+1))
>>> maxima
array([ 1.80238238,
1.13527605,
5.51954079,
2.49611818,
6.71673619,
1.80238238, 16.76547217,
5.51954079])
>>> ndimage.find_objects(labels==4)
[(slice(30L, 48L, None), slice(30L, 48L, None))]
>>> sl = ndimage.find_objects(labels==4)
>>> import pylab as pl
>>> pl.imshow(sig[sl[0]])
<matplotlib.image.AxesImage object at ...>
The annual wind speeds maxima have already been computed and saved in the numpy format in the file
examples/max-speeds.npy, thus they will be loaded by using numpy:
>>> import numpy as np
>>> max_speeds = np.load('intro/summary-exercises/examples/max-speeds.npy')
>>> years_nb = max_speeds.shape[0]
Following the cumulative probability definition p_i from the previous section, the corresponding values will be:
>>> cprob = (np.arange(years_nb, dtype=np.float32) + 1)/(years_nb + 1)
and they are assumed to fit the given wind speeds:
>>> sorted_max_speeds = np.sort(max_speeds)
Prediction with UnivariateSpline
See the summary exercise on Image processing application: counting bubbles and unmolten grains (page 133) for
a more advanced example.
1.5.11 Summary exercises on scientific computing
The summary exercises use mainly Numpy, Scipy and Matplotlib. They provide some real-life examples of
scientific computing with Python. Now that the basics of working with Numpy and Scipy have been introduced,
the interested user is invited to try these exercises.
In this section the quantile function will be estimated by using the UnivariateSpline class which can
represent a spline from points. The default behavior is to build a spline of degree 3 and points can have
different weights according to their reliability. Variants are InterpolatedUnivariateSpline and
LSQUnivariateSpline on which errors checking is going to change. In case a 2D spline is wanted, the
BivariateSpline class family is provided. All those classes for 1D and 2D splines use the FITPACK Fortran subroutines, that’s why a lower library access is available through the splrep and splev functions for
respectively representing and evaluating a spline. Moreover interpolation functions without the use of FITPACK
parameters are also provided for simpler use (see interp1d, interp2d, barycentric_interpolate
and so on).
For the Sprogø maxima wind speeds, the UnivariateSpline will be used because a spline of degree 3 seems
to correctly fit the data:
>>> from scipy.interpolate import UnivariateSpline
>>> quantile_func = UnivariateSpline(cprob, sorted_max_speeds)
Maximum wind speed prediction at the Sprogø station
The quantile function is now going to be evaluated from the full range of probabilities:
The exercise goal is to predict the maximum wind speed occurring every 50 years even if no measure exists for
such a period. The available data are only measured over 21 years at the Sprogø meteorological station located
in Denmark. First, the statistical steps will be given and then illustrated with functions from the scipy.interpolate
module. At the end the interested readers are invited to compute results from raw data and in a slightly different
approach.
>>> nprob = np.linspace(0, 1, 1e2)
>>> fitted_max_speeds = quantile_func(nprob)
In the current model, the maximum wind speed occurring every 50 years is defined as the upper 2% quantile. As
a result, the cumulative probability value will be:
>>> fifty_prob = 1. - 0.02
Statistical approach
So the storm wind speed occurring every 50 years can be guessed by:
The annual maxima are supposed to fit a normal probability density function. However such function is not going
to be estimated because it gives a probability from a wind speed maxima. Finding the maximum wind speed
occurring every 50 years requires the opposite approach, the result needs to be found from a defined probability.
That is the quantile function role and the exercise goal will be to find it. In the current model, it is supposed that
the maximum wind speed occurring every 50 years is defined as the upper 2% quantile.
By definition, the quantile function is the inverse of the cumulative distribution function. The latter describes the
probability distribution of an annual maxima. In the exercise, the cumulative probability p_i for a given year
i is defined as p_i = i/(N+1) with N = 21, the number of measured years. Thus it will be possible to
calculate the cumulative probability of every measured wind speed maxima. From those experimental points, the
scipy.interpolate module will be very useful for fitting the quantile function. Finally the 50 years maxima is going
to be evaluated from the cumulative probability of the 2% quantile.
1.5. Scipy : high-level scientific computing
125
>>> fifty_wind = quantile_func(fifty_prob)
>>> fifty_wind
array(32.97989825...)
The results are now gathered on a Matplotlib figure:
Exercise with the Gumbell distribution
The interested readers are now invited to make an exercise by using the wind speeds measured over 21 years.
The measurement period is around 90 minutes (the original period was around 10 minutes but the file size
has been reduced for making the exercise setup easier). The data are stored in numpy format inside the file
examples/sprog-windspeeds.npy. Do not look at the source code for the plots until you have completed
the exercise.
1.5. Scipy : high-level scientific computing
126
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Figure 1.1: Solution: Python source file
1.5. Scipy : high-level scientific computing
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Figure 1.2: Solution: Python source file
127
1.5. Scipy : high-level scientific computing
128
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• The first step will be to find the annual maxima by using numpy and plot them as a matplotlib bar figure.
• The second step will be to use the Gumbell distribution on cumulative probabilities p_i defined as -log(
-log(p_i) ) for fitting a linear quantile function (remember that you can define the degree of the
UnivariateSpline). Plotting the annual maxima versus the Gumbell distribution should give you
the following figure.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
In this tutorial, the goal is to analyze the waveform recorded by the lidar system 2 . Such a signal contains peaks
whose center and amplitude permit to compute the position and some characteristics of the hit target. When the
footprint of the laser beam is around 1m on the Earth surface, the beam can hit multiple targets during the two-way
propagation (for example the ground and the top of a tree or building). The sum of the contributions of each target
hit by the laser beam then produces a complex signal with multiple peaks, each one containing information about
one target.
One state of the art method to extract information from these data is to decompose them in a sum of Gaussian
functions where each function represents the contribution of a target hit by the laser beam.
Therefore, we use the scipy.optimize module to fit a waveform to one or a sum of Gaussian functions.
Loading and visualization
Load the first waveform using:
>>> import numpy as np
>>> waveform_1 = np.load('data/waveform_1.npy')
and visualize it:
>>> import matplotlib.pyplot as plt
>>> t = np.arange(len(waveform_1))
>>> plt.plot(t, waveform_1)
[<matplotlib.lines.Line2D object at ...>]
>>> plt.show()
Figure 1.3: Solution: Python source file
• The last step will be to find 34.23 m/s for the maximum wind speed occurring every 50 years.
Non linear least squares curve fitting: application to point extraction in topographical lidar data
The goal of this exercise is to fit a model to some data. The data used in this tutorial are lidar data and are described
in details in the following introductory paragraph. If you’re impatient and want to practice now, please skip it and
go directly to Loading and visualization (page 130).
Introduction
Lidars systems are optical rangefinders that analyze property of scattered light to measure distances. Most of them
emit a short light impulsion towards a target and record the reflected signal. This signal is then processed to extract
the distance between the lidar system and the target.
Topographical lidar systems are such systems embedded in airborne platforms. They measure distances between
the platform and the Earth, so as to deliver information on the Earth’s topography (see 1 for more details).
1
As you can notice, this waveform is a 80-bin-length signal with a single peak.
Mallet, C. and Bretar, F. Full-Waveform Topographic Lidar: State-of-the-Art. ISPRS Journal of Photogrammetry and Remote Sensing
64(1), pp.1-16, January 2009 http://dx.doi.org/10.1016/j.isprsjprs.2008.09.007
2 The data used for this tutorial are part of the demonstration data available for the FullAnalyze software and were kindly provided by the
GIS DRAIX.
1.5. Scipy : high-level scientific computing
1.5. Scipy : high-level scientific computing
129
130
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Fitting a waveform with a simple Gaussian model
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Going further
The signal is very simple and can be modeled as a single Gaussian function and an offset corresponding to the
background noise. To fit the signal with the function, we must:
• define the model
• Try with a more complex waveform (for instance data/waveform_2.npy) that contains three significant peaks. You must adapt the model which is now a sum of Gaussian functions instead of only one
Gaussian peak.
• propose an initial solution
• call scipy.optimize.leastsq
Model A Gaussian function defined by
︃ ︂
B + A exp −
t−µ
σ
︂2 ︃
can be defined in python by:
>>> def model(t, coeffs):
...
return coeffs[0] + coeffs[1] * np.exp( - ((t-coeffs[2])/coeffs[3])**2 )
where
• coeffs[0] is B (noise)
• coeffs[1] is A (amplitude)
• coeffs[2] is µ (center)
• coeffs[3] is σ (width)
Initial solution An approximative initial solution that we can find from looking at the graph is for instance:
>>> x0 = np.array([3, 30, 15, 1], dtype=float)
Fit scipy.optimize.leastsq minimizes the sum of squares of the function given as an argument. Basically, the function to minimize is the residuals (the difference between the data and the model):
• In some cases, writing an explicit function to compute the Jacobian is faster than letting leastsq estimate it numerically. Create a function to compute the Jacobian of the residuals and use it as an input for
leastsq.
>>> def residuals(coeffs, y, t):
...
return y - model(t, coeffs)
• When we want to detect very small peaks in the signal, or when the initial guess is too far from a good
solution, the result given by the algorithm is often not satisfying. Adding constraints to the parameters of
the model enables to overcome such limitations. An example of a priori knowledge we can add is the sign
of our variables (which are all positive).
So let’s get our solution by calling scipy.optimize.leastsq() with the following arguments:
• the function to minimize
• an initial solution
With the following initial solution:
• the additional arguments to pass to the function
>>> x0 = np.array([3, 50, 20, 1], dtype=float)
>>> from scipy.optimize import leastsq
>>> x, flag = leastsq(residuals, x0, args=(waveform_1, t))
>>> print(x)
[ 2.70363341 27.82020742 15.47924562
3.05636228]
compare the result of scipy.optimize.leastsq() and what
scipy.optimize.fmin_slsqp() when adding boundary constraints.
you
can
get
with
And visualize the solution:
>>> plt.plot(t, waveform_1, t, model(t, x))
[<matplotlib.lines.Line2D object at ...>, <matplotlib.lines.Line2D object at ...>]
>>> plt.legend(['waveform', 'model'])
<matplotlib.legend.Legend object at ...>
>>> plt.show()
Remark: from scipy v0.8 and above, you should rather use scipy.optimize.curve_fit() which takes
the model and the data as arguments, so you don’t need to define the residuals any more.
1.5. Scipy : high-level scientific computing
131
1.5. Scipy : high-level scientific computing
132
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Image processing application: counting bubbles and unmolten grains
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Example of solution for the image processing exercise: unmolten grains in glass
1. Open the image file MV_HFV_012.jpg and display it. Browse through the keyword arguments in the
docstring of imshow to display the image with the “right” orientation (origin in the bottom left corner, and
not the upper left corner as for standard arrays).
>>> dat = pl.imread('data/MV_HFV_012.jpg')
Statement of the problem
1. Open the image file MV_HFV_012.jpg and display it. Browse through the keyword arguments in the docstring
of imshow to display the image with the “right” orientation (origin in the bottom left corner, and not the upper
left corner as for standard arrays).
This Scanning Element Microscopy image shows a glass sample (light gray matrix) with some bubbles (on black)
and unmolten sand grains (dark gray). We wish to determine the fraction of the sample covered by these three
phases, and to estimate the typical size of sand grains and bubbles, their sizes, etc.
2. Crop the image to remove the lower panel with measure information.
2. Crop the image to remove the lower panel with measure information.
>>> dat = dat[:-60]
3. Slightly filter the image with a median filter in order to refine its histogram. Check how the histogram
changes.
>>> filtdat = ndimage.median_filter(dat, size=(7,7))
>>> hi_dat = np.histogram(dat, bins=np.arange(256))
>>> hi_filtdat = np.histogram(filtdat, bins=np.arange(256))
3. Slightly filter the image with a median filter in order to refine its histogram. Check how the histogram changes.
4. Using the histogram of the filtered image, determine thresholds that allow to define masks for sand pixels, glass
pixels and bubble pixels. Other option (homework): write a function that determines automatically the thresholds
from the minima of the histogram.
5. Display an image in which the three phases are colored with three different colors.
6. Use mathematical morphology to clean the different phases.
7. Attribute labels to all bubbles and sand grains, and remove from the sand mask grains that are smaller than 10
pixels. To do so, use ndimage.sum or np.bincount to compute the grain sizes.
8. Compute the mean size of bubbles.
Proposed solution
>>> import numpy as np
>>> import pylab as pl
>>> from scipy import ndimage
1.5. Scipy : high-level scientific computing
133
1.5. Scipy : high-level scientific computing
134
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
4. Using the histogram of the filtered image, determine thresholds that allow to define masks for sand pixels,
glass pixels and bubble pixels. Other option (homework): write a function that determines automatically
the thresholds from the minima of the histogram.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
6. Use mathematical morphology to clean the different phases.
>>> sand_op = ndimage.binary_opening(sand, iterations=2)
7. Attribute labels to all bubbles and sand grains, and remove from the sand mask grains that are smaller than
10 pixels. To do so, use ndimage.sum or np.bincount to compute the grain sizes.
>>> void = filtdat <= 50
>>> sand = np.logical_and(filtdat > 50, filtdat <= 114)
>>> glass = filtdat > 114
5. Display an image in which the three phases are colored with three different colors.
>>> phases = void.astype(np.int) + 2*glass.astype(np.int) + 3*sand.astype(np.int)
>>>
>>>
>>>
>>>
sand_labels, sand_nb = ndimage.label(sand_op)
sand_areas = np.array(ndimage.sum(sand_op, sand_labels, np.arange(sand_labels.max()+1)))
mask = sand_areas > 100
remove_small_sand = mask[sand_labels.ravel()].reshape(sand_labels.shape)
8. Compute the mean size of bubbles.
>>>
>>>
>>>
>>>
>>>
1.5. Scipy : high-level scientific computing
135
bubbles_labels, bubbles_nb = ndimage.label(void)
bubbles_areas = np.bincount(bubbles_labels.ravel())[1:]
mean_bubble_size = bubbles_areas.mean()
median_bubble_size = np.median(bubbles_areas)
mean_bubble_size, median_bubble_size
1.5. Scipy : high-level scientific computing
136
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
(1699.875, 65.0)
1.6 Getting help and finding documentation
Author: Emmanuelle Gouillart
Rather than knowing all functions in Numpy and Scipy, it is important to find rapidly information throughout the
documentation and the available help. Here are some ways to get information:
• In Ipython, help function opens the docstring of the function. Only type the beginning of the function’s name and use tab completion to display the matching functions.
In [204]: help np.v
np.vander
np.vdot
np.var
np.vectorize
np.version
np.void
np.void0
np.vsplit
np.vstack
countered, such as fitting data points, solving ODE, etc.
• Matplotlib’s website http://matplotlib.sourceforge.net/ features a very nice gallery with a large number of
plots, each of them shows both the source code and the resulting plot. This is very useful for learning by
example. More standard documentation is also available.
Finally, two more “technical” possibilities are useful as well:
• In Ipython, the magical function %psearch search for objects matching patterns. This is useful if, for
example, one does not know the exact name of a function.
In [204]: help np.vander
In Ipython it is not possible to open a separated window for help and documentation; however one can always open
In [3]: import numpy as np
In [4]: %psearch np.diag*
np.diag
np.diagflat
np.diagonal
• numpy.lookfor looks for keywords inside the docstrings of specified modules.
a second Ipython shell just to display help and docstrings...
• Numpy’s and Scipy’s documentations can be browsed online on http://docs.scipy.org/doc.
The search button is quite useful inside the reference documentation of the two packages
(http://docs.scipy.org/doc/numpy/reference/ and http://docs.scipy.org/doc/scipy/reference/).
Tutorials on various topics as well as the complete API with all docstrings are found on this website.
• Numpy’s and Scipy’s documentation is enriched and updated on a regular basis by users on a wiki
http://docs.scipy.org/numpy/. As a result, some docstrings are clearer or more detailed on the wiki, and
you may want to read directly the documentation on the wiki instead of the official documentation website.
Note that anyone can create an account on the wiki and write better documentation; this is an easy way to
contribute to an open-source project and improve the tools you are using!
• Scipy’s cookbook http://www.scipy.org/Cookbook gives recipes on many common problems frequently en-
In [45]: numpy.lookfor('convolution')
Search results for 'convolution'
-------------------------------numpy.convolve
Returns the discrete, linear convolution of two one-dimensional
sequences.
numpy.bartlett
Return the Bartlett window.
numpy.correlate
Discrete, linear correlation of two 1-dimensional sequences.
In [46]: numpy.lookfor('remove', module='os')
Search results for 'remove'
--------------------------os.remove
remove(path)
os.removedirs
removedirs(path)
os.rmdir
rmdir(path)
os.unlink
unlink(path)
os.walk
Directory tree generator.
• If everything listed above fails (and Google doesn’t have the answer)... don’t despair! Write to the mailinglist suited to your problem: you should have a quick answer if you describe your problem well. Experts on
scientific python often give very enlightening explanations on the mailing-list.
– Numpy discussion (
[email protected]): all about numpy arrays, manipulating them, indexation questions, etc.
– SciPy Users List (
[email protected]): scientific computing with Python, high-level data processing, in particular with the scipy package.
–
[email protected] for plotting with matplotlib.
1.6. Getting help and finding documentation
137
1.6. Getting help and finding documentation
138
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
CHAPTER 2
2.1.1 Iterators, generator expressions and generators
Iterators
Simplicity
Advanced topics
Duplication of effort is wasteful, and replacing the various home-grown approaches with a standard feature
usually ends up making things more readable, and interoperable as well.
Guido van Rossum — Adding Optional Static Typing to Python
An iterator is an object adhering to the iterator protocol — basically this means that it has a next method,
which, when called, returns the next item in the sequence, and when there’s nothing to return, raises the
StopIteration exception.
This part of the Scipy lecture notes is dedicated to advanced usage. It strives to educate the proficient Python coder
to be an expert and tackles various specific topics.
An iterator object allows to loop just once. It holds the state (position) of a single iteration, or from the other side,
each loop over a sequence requires a single iterator object. This means that we can iterate over the same sequence
more than once concurrently. Separating the iteration logic from the sequence allows us to have more than one
way of iteration.
Calling the __iter__ method on a container to create an iterator object is the most straightforward way to get
hold of an iterator. The iter function does that for us, saving a few keystrokes.
2.1 Advanced Python Constructs
Author Zbigniew J˛edrzejewski-Szmek
This section covers some features of the Python language which can be considered advanced — in the sense that
not every language has them, and also in the sense that they are more useful in more complicated programs or
libraries, but not in the sense of being particularly specialized, or particularly complicated.
It is important to underline that this chapter is purely about the language itself — about features supported through
special syntax complemented by functionality of the Python stdlib, which could not be implemented through
clever external modules.
The process of developing the Python programming language, its syntax, is very transparent; proposed changes
are evaluated from various angles and discussed via Python Enhancement Proposals — PEPs. As a result, features
described in this chapter were added after it was shown that they indeed solve real problems and that their use is
as simple as possible.
Chapters contents
• Iterators, generator expressions and generators (page 140)
– Iterators (page 140)
– Generator expressions (page 141)
– Generators (page 141)
– Bidirectional communication (page 142)
– Chaining generators (page 144)
• Decorators (page 144)
– Replacing or tweaking the original object (page 145)
– Decorators implemented as classes and as functions (page 145)
– Copying the docstring and other attributes of the original function (page 147)
– Examples in the standard library (page 148)
– Deprecation of functions (page 150)
– A while-loop removing decorator (page 151)
– A plugin registration system (page 151)
• Context managers (page 152)
– Catching exceptions (page 153)
– Using generators to define context managers (page 154)
>>> nums = [1, 2, 3]
# note that ... varies: these are different objects
>>> iter(nums)
<...iterator object at ...>
>>> nums.__iter__()
<...iterator object at ...>
>>> nums.__reversed__()
<...reverseiterator object at ...>
>>> it = iter(nums)
>>> next(it)
1
>>> next(it)
2
>>> next(it)
3
>>> next(it)
Traceback (most recent
File "<stdin>", line
StopIteration
Traceback (most recent
File "<stdin>", line
StopIteration
call last):
1, in <module>
call last):
1, in <module>
When used in a loop, StopIteration is swallowed and causes the loop to finish. But with explicit invocation,
we can see that once the iterator is exhausted, accessing it raises an exception.
Using the for..in loop also uses the __iter__ method. This allows us to transparently start the iteration over a
sequence. But if we already have the iterator, we want to be able to use it in an for loop in the same way. In order
to achieve this, iterators in addition to next are also required to have a method called __iter__ which returns
the iterator (self).
Support for iteration is pervasive in Python: all sequences and unordered containers in the standard library allow
this. The concept is also stretched to other things: e.g. file objects support iteration over lines.
>>> f = open('/etc/fstab')
>>> f is f.__iter__()
True
The file is an iterator itself and it’s __iter__ method doesn’t create a separate object: only a single thread of
sequential access is allowed.
139
2.1. Advanced Python Constructs
140
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Generator expressions
Let’s go over the life of the single invocation of the generator function.
A second way in which iterator objects are created is through generator expressions, the basis for list comprehensions. To increase clarity, a generator expression must always be enclosed in parentheses or an expression. If
round parentheses are used, then a generator iterator is created. If rectangular parentheses are used, the process is
short-circuited and we get a list.
>>> (i for
<generator
>>> [i for
[1, 2, 3]
>>> list(i
[1, 2, 3]
i in nums)
object <genexpr> at 0x...>
i in nums]
for i in nums)
The list comprehension syntax also extends to dictionary and set comprehensions. A set is created when
the generator expression is enclosed in curly braces. A dict is created when the generator expression contains
“pairs” of the form key:value:
>>> {i for i in range(3)}
set([0, 1, 2])
>>> {i:i**2 for i in range(3)}
{0: 0, 1: 1, 2: 4}
One gotcha should be mentioned: in old Pythons the index variable (i) would leak, and in versions >= 3 this is
fixed.
Generators
>>> def f():
...
print("-...
yield 3
...
print("-...
yield 4
...
print("->>> gen = f()
>>> next(gen)
-- start -3
>>> next(gen)
-- middle -4
>>> next(gen)
-- finished -Traceback (most
...
StopIteration
Traceback (most
...
StopIteration
start --")
middle --")
finished --")
recent call last):
recent call last):
Contrary to a normal function, where executing f() would immediately cause the first print to be executed,
gen is assigned without executing any statements in the function body. Only when gen.next() is invoked
by next, the statements up to the first yield are executed. The second next prints -- middle -- and
execution halts on the second yield. The third next prints -- finished -- and falls of the end of the
function. Since no yield was reached, an exception is raised.
What happens with the function after a yield, when the control passes to the caller? The state of each generator
is stored in the generator object. From the point of view of the generator function, is looks almost as if it was
running in a separate thread, but this is just an illusion: execution is strictly single-threaded, but the interpreter
keeps and restores the state in between the requests for the next value.
Generators
A generator is a function that produces a sequence of results instead of a single value.
David Beazley — A Curious Course on Coroutines and Concurrency
A third way to create iterator objects is to call a generator function. A generator is a function containing the
keyword yield. It must be noted that the mere presence of this keyword completely changes the nature of the
function: this yield statement doesn’t have to be invoked, or even reachable, but causes the function to be
marked as a generator. When a normal function is called, the instructions contained in the body start to be
executed. When a generator is called, the execution stops before the first instruction in the body. An invocation
of a generator function creates a generator object, adhering to the iterator protocol. As with normal function
invocations, concurrent and recursive invocations are allowed.
When next is called, the function is executed until the first yield. Each encountered yield statement gives a
value becomes the return value of next. After executing the yield statement, the execution of this function is
suspended.
>>> def f():
...
yield 1
...
yield 2
>>> f()
<generator object f at 0x...>
>>> gen = f()
>>> next(gen)
1
>>> next(gen)
2
>>> next(gen)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration
2.1. Advanced Python Constructs
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Why are generators useful? As noted in the parts about iterators, a generator function is just a different way to
create an iterator object. Everything that can be done with yield statements, could also be done with next
methods. Nevertheless, using a function and having the interpreter perform its magic to create an iterator has
advantages. A function can be much shorter than the definition of a class with the required next and __iter__
methods. What is more important, it is easier for the author of the generator to understand the state which is
kept in local variables, as opposed to instance attributes, which have to be used to pass data between consecutive
invocations of next on an iterator object.
A broader question is why are iterators useful? When an iterator is used to power a loop, the loop becomes very
simple. The code to initialise the state, to decide if the loop is finished, and to find the next value is extracted into
a separate place. This highlights the body of the loop — the interesting part. In addition, it is possible to reuse the
iterator code in other places.
Bidirectional communication
Each yield statement causes a value to be passed to the caller. This is the reason for the introduction of generators
by PEP 255 (implemented in Python 2.2). But communication in the reverse direction is also useful. One obvious
way would be some external state, either a global variable or a shared mutable object. Direct communication is
possible thanks to PEP 342 (implemented in 2.5). It is achieved by turning the previously boring yield statement
into an expression. When the generator resumes execution after a yield statement, the caller can call a method
on the generator object to either pass a value into the generator, which then is returned by the yield statement,
or a different method to inject an exception into the generator.
The first of the new methods is send(value), which is similar to next(), but passes value into the generator
to be used for the value of the yield expression. In fact, g.next() and g.send(None) are equivalent.
141
2.1. Advanced Python Constructs
142
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The second of the new methods is throw(type, value=None, traceback=None) which is equivalent
to:
raise type, value, traceback
at the point of the yield statement.
Unlike raise (which immediately raises an exception from the current execution point), throw() first resumes
the generator, and only then raises the exception. The word throw was picked because it is suggestive of putting
the exception in another location, and is associated with exceptions in other languages.
What happens when an exception is raised inside the generator? It can be either raised explicitly or when executing
some statements or it can be injected at the point of a yield statement by means of the throw() method.
In either case, such an exception propagates in the standard manner: it can be intercepted by an except or
finally clause, or otherwise it causes the execution of the generator function to be aborted and propagates in
the caller.
For completeness’ sake, it’s worth mentioning that generator iterators also have a close() method, which can
be used to force a generator that would otherwise be able to provide more values to finish immediately. It allows
the generator __del__ method to destroy objects holding the state of generator.
Let’s define a generator which just prints what is passed in through send and throw.
>>> import itertools
>>> def g():
...
print('--start--')
...
for i in itertools.count():
...
print('--yielding %i--' % i)
...
try:
...
ans = yield i
...
except GeneratorExit:
...
print('--closing--')
...
raise
...
except Exception as e:
...
print('--yield raised %r--' % e)
...
else:
...
print('--yield returned %s--' % ans)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
next or __next__?
In Python 2.x, the iterator method to retrieve the next value is called next. It is invoked implicitly through
the global function next, which means that it should be called __next__. Just like the global function iter calls __iter__. This inconsistency is corrected in Python 3.x, where it.next becomes
it.__next__. For other generator methods — send and throw — the situation is more complicated,
because they are not called implicitly by the interpreter. Nevertheless, there’s a proposed syntax extension
to allow continue to take an argument which will be passed to send of the loop’s iterator. If this extension is accepted, it’s likely that gen.send will become gen.__send__. The last of generator methods,
close, is pretty obviously named incorrectly, because it is already invoked implicitly.
Chaining generators
Note: This is a preview of PEP 380 (not yet implemented, but accepted for Python 3.3).
Let’s say we are writing a generator and we want to yield a number of values generated by a second generator,
a subgenerator. If yielding of values is the only concern, this can be performed without much difficulty using a
loop such as
subgen = some_other_generator()
for v in subgen:
yield v
However, if the subgenerator is to interact properly with the caller in the case of calls to send(), throw()
and close(), things become considerably more difficult. The yield statement has to be guarded by a
try..except..finally structure similar to the one defined in the previous section to “debug” the generator function.
Such code is provided in PEP 380, here it suffices to say that new syntax to properly yield from a subgenerator is
being introduced in Python 3.3:
yield from some_other_generator()
This behaves like the explicit loop above, repeatedly yielding values from some_other_generator until it is
exhausted, but also forwards send, throw and close to the subgenerator.
>>> it = g()
>>> next(it)
--start---yielding 0-0
>>> it.send(11)
--yield returned 11---yielding 1-1
>>> it.throw(IndexError)
--yield raised IndexError()---yielding 2-2
>>> it.close()
--closing--
2.1.2 Decorators
Summary
This amazing feature appeared in the language almost apologetically and with concern that it might not be
that useful.
Bruce Eckel — An Introduction to Python Decorators
Since a function or a class are objects, they can be passed around. Since they are mutable objects, they can be
modified. The act of altering a function or class object after it has been constructed but before is is bound to its
name is called decorating.
There are two things hiding behind the name “decorator” — one is the function which does the work of decorating,
i.e. performs the real work, and the other one is the expression adhering to the decorator syntax, i.e. an at-symbol
and the name of the decorating function.
Function can be decorated by using the decorator syntax for functions:
@decorator
def function():
pass
# ❷
# ❶
• A function is defined in the standard way. ❶
2.1. Advanced Python Constructs
143
2.1. Advanced Python Constructs
144
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• An expression starting with @ placed before the function definition is the decorator ❷. The part after @ must
be a simple expression, usually this is just the name of a function or class. This part is evaluated first, and
after the function defined below is ready, the decorator is called with the newly defined function object as
the single argument. The value returned by the decorator is attached to the original name of the function.
Decorators can be applied to functions and to classes. For classes the semantics are identical — the original class
definition is used as an argument to call the decorator and whatever is returned is assigned under the original name.
Before the decorator syntax was implemented (PEP 318), it was possible to achieve the same effect by assigning
the function or class object to a temporary variable and then invoking the decorator explicitly and then assigning
the return value to the name of the function. This sounds like more typing, and it is, and also the name of the
decorated function doubling as a temporary variable must be used at least three times, which is prone to errors.
Nevertheless, the example above is equivalent to:
def function():
pass
function = decorator(function)
# ❶
# ❷
Decorators can be stacked — the order of application is bottom-to-top, or inside-out. The semantics are such
that the originally defined function is used as an argument for the first decorator, whatever is returned by the first
decorator is used as an argument for the second decorator, ..., and whatever is returned by the last decorator is
attached under the name of the original function.
The decorator syntax was chosen for its readability. Since the decorator is specified before the header of the
function, it is obvious that its is not a part of the function body and its clear that it can only operate on the whole
function. Because the expression is prefixed with @ is stands out and is hard to miss (“in your face”, according to
the PEP :) ). When more than one decorator is applied, each one is placed on a separate line in an easy to read
way.
Replacing or tweaking the original object
Decorators can either return the same function or class object or they can return a completely different object.
In the first case, the decorator can exploit the fact that function and class objects are mutable and add attributes,
e.g. add a docstring to a class. A decorator might do something useful even without modifying the object, for
example register the decorated class in a global registry. In the second case, virtually anything is possible: when
something different is substituted for the original function or class, the new object can be completely different.
Nevertheless, such behaviour is not the purpose of decorators: they are intended to tweak the decorated object, not
do something unpredictable. Therefore, when a function is “decorated” by replacing it with a different function,
the new function usually calls the original function, after doing some preparatory work. Likewise, when a class is
“decorated” by replacing if with a new class, the new class is usually derived from the original class. When the
purpose of the decorator is to do something “every time”, like to log every call to a decorated function, only the
second type of decorators can be used. On the other hand, if the first type is sufficient, it is better to use it, because
it is simpler.
Decorators implemented as classes and as functions
The only requirement on decorators is that they can be called with a single argument. This means that decorators
can be implemented as normal functions, or as classes with a __call__ method, or in theory, even as lambda
functions.
Let’s compare the function and class approaches. The decorator expression (the part after @) can be either just a
name, or a call. The bare-name approach is nice (less to type, looks cleaner, etc.), but is only possible when no
arguments are needed to customise the decorator. Decorators written as functions can be used in those two cases:
>>> def simple_decorator(function):
...
print("doing decoration")
...
return function
>>> @simple_decorator
... def function():
...
print("inside function")
2.1. Advanced Python Constructs
145
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
doing decoration
>>> function()
inside function
>>> def decorator_with_arguments(arg):
...
print("defining the decorator")
...
def _decorator(function):
...
# in this inner function, arg is available too
...
print("doing decoration, %r" % arg)
...
return function
...
return _decorator
>>> @decorator_with_arguments("abc")
... def function():
...
print("inside function")
defining the decorator
doing decoration, 'abc'
>>> function()
inside function
The two trivial decorators above fall into the category of decorators which return the original function. If they
were to return a new function, an extra level of nestedness would be required. In the worst case, three levels of
nested functions.
>>> def replacing_decorator_with_args(arg):
...
print("defining the decorator")
...
def _decorator(function):
...
# in this inner function, arg is available too
...
print("doing decoration, %r" % arg)
...
def _wrapper(*args, **kwargs):
...
print("inside wrapper, %r %r" % (args, kwargs))
...
return function(*args, **kwargs)
...
return _wrapper
...
return _decorator
>>> @replacing_decorator_with_args("abc")
... def function(*args, **kwargs):
...
print("inside function, %r %r" % (args, kwargs))
...
return 14
defining the decorator
doing decoration, 'abc'
>>> function(11, 12)
inside wrapper, (11, 12) {}
inside function, (11, 12) {}
14
The _wrapper function is defined to accept all positional and keyword arguments. In general we cannot know
what arguments the decorated function is supposed to accept, so the wrapper function just passes everything to the
wrapped function. One unfortunate consequence is that the apparent argument list is misleading.
Compared to decorators defined as functions, complex decorators defined as classes are simpler. When an object
is created, the __init__ method is only allowed to return None, and the type of the created object cannot be
changed. This means that when a decorator is defined as a class, it doesn’t make much sense to use the argumentless form: the final decorated object would just be an instance of the decorating class, returned by the constructor
call, which is not very useful. Therefore it’s enough to discuss class-based decorators where arguments are given
in the decorator expression and the decorator __init__ method is used for decorator construction.
>>> class decorator_class(object):
...
def __init__(self, arg):
...
# this method is called in the decorator expression
...
print("in decorator init, %s" % arg)
...
self.arg = arg
...
def __call__(self, function):
...
# this method is called to do the job
...
print("in decorator call, %s" % self.arg)
2.1. Advanced Python Constructs
146
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
functools.update_wrapper(wrapper, wrapped)
...
return function
>>> deco_instance = decorator_class('foo')
in decorator init, foo
>>> @deco_instance
... def function(*args, **kwargs):
...
print("in function, %s %s" % (args, kwargs))
in decorator call, foo
>>> function()
in function, () {}
“Update a wrapper function to look like the wrapped function.”
Contrary to normal rules (PEP 8) decorators written as classes behave more like functions and therefore their
name often starts with a lowercase letter.
In reality, it doesn’t make much sense to create a new class just to have a decorator which returns the original
function. Objects are supposed to hold state, and such decorators are more useful when the decorator returns a
new object.
>>> class replacing_decorator_class(object):
...
def __init__(self, arg):
...
# this method is called in the decorator expression
...
print("in decorator init, %s" % arg)
...
self.arg = arg
...
def __call__(self, function):
...
# this method is called to do the job
...
print("in decorator call, %s" % self.arg)
...
self.function = function
...
return self._wrapper
...
def _wrapper(self, *args, **kwargs):
...
print("in the wrapper, %s %s" % (args, kwargs))
...
return self.function(*args, **kwargs)
>>> deco_instance = replacing_decorator_class('foo')
in decorator init, foo
>>> @deco_instance
... def function(*args, **kwargs):
...
print("in function, %s %s" % (args, kwargs))
in decorator call, foo
>>> function(11, 12)
in the wrapper, (11, 12) {}
in function, (11, 12) {}
>>> import functools
>>> def better_replacing_decorator_with_args(arg):
...
print("defining the decorator")
...
def _decorator(function):
...
print("doing decoration, %r" % arg)
...
def _wrapper(*args, **kwargs):
...
print("inside wrapper, %r %r" % (args, kwargs))
...
return function(*args, **kwargs)
...
return functools.update_wrapper(_wrapper, function)
...
return _decorator
>>> @better_replacing_decorator_with_args("abc")
... def function():
...
"extensive documentation"
...
print("inside function")
...
return 14
defining the decorator
doing decoration, 'abc'
>>> function
<function function at 0x...>
>>> print(function.__doc__)
extensive documentation
One important thing is missing from the list of attributes which can be copied to the replacement function: the argument list. The default values for arguments can be modified through the __defaults__,
__kwdefaults__ attributes, but unfortunately the argument list itself cannot be set as an attribute. This means
that help(function) will display a useless argument list which will be confusing for the user of the function.
An effective but ugly way around this problem is to create the wrapper dynamically, using eval. This can be
automated by using the external decorator module. It provides support for the decorator decorator, which
takes a wrapper and turns it into a decorator which preserves the function signature.
To sum things up, decorators should always use functools.update_wrapper or some other means of
copying function attributes.
Examples in the standard library
A decorator like this can do pretty much anything, since it can modify the original function object and mangle the
arguments, call the original function or not, and afterwards mangle the return value.
Copying the docstring and other attributes of the original function
When a new function is returned by the decorator to replace the original function, an unfortunate consequence
is that the original function name, the original docstring, the original argument list are lost. Those attributes of
the original function can partially be “transplanted” to the new function by setting __doc__ (the docstring),
__module__ and __name__ (the full name of the function), and __annotations__ (extra information
about arguments and the return value of the function available in Python 3). This can be done automatically by
using functools.update_wrapper.
First, it should be mentioned that there’s a number of useful decorators available in the standard library. There are
three decorators which really form a part of the language:
• classmethod causes a method to become a “class method”, which means that it can be invoked without
creating an instance of the class. When a normal method is invoked, the interpreter inserts the instance
object as the first positional parameter, self. When a class method is invoked, the class itself is given as
the first parameter, often called cls.
Class methods are still accessible through the class’ namespace, so they don’t pollute the module’s namespace. Class methods can be used to provide alternative constructors:
class Array(object):
def __init__(self, data):
self.data = data
@classmethod
def fromfile(cls, file):
data = numpy.load(file)
return cls(data)
This is cleaner then using a multitude of flags to __init__.
• staticmethod is applied to methods to make them “static”, i.e. basically a normal function, but accessible through the class namespace. This can be useful when the function is only needed inside this class (its
2.1. Advanced Python Constructs
147
2.1. Advanced Python Constructs
148
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
name would then be prefixed with _), or when we want the user to think of the method as connected to the
class, despite an implementation which doesn’t require this.
• property is the pythonic answer to the problem of getters and setters. A method decorated with
property becomes a getter which is automatically called on attribute access.
>>> class A(object):
...
@property
...
def a(self):
...
"an important attribute"
...
return "a value"
>>> A.a
<property object at 0x...>
>>> A().a
'a value'
In this example, A.a is an read-only attribute. It is also documented: help(A) includes the docstring for
attribute a taken from the getter method. Defining a as a property allows it to be a calculated on the fly, and
has the side effect of making it read-only, because no setter is defined.
To have a setter and a getter, two methods are required, obviously. Since Python 2.6 the following syntax is
preferred:
class Rectangle(object):
def __init__(self, edge):
self.edge = edge
<property object at 0x...>
>>> D.a.fget
<function ...>
>>> D.a.fset
<function ...>
>>> D.a.fdel
<function ...>
>>> d = D()
# ... varies, this is not the same `a` function
>>> d.a
getting 1
1
>>> d.a = 2
setting 2
>>> del d.a
deleting
>>> d.a
getting 1
1
Properties are a bit of a stretch for the decorator syntax. One of the premises of the decorator syntax — that
the name is not duplicated — is violated, but nothing better has been invented so far. It is just good style to
use the same name for the getter, setter, and deleter methods.
Some newer examples include:
• functools.lru_cache memoizes an arbitrary function maintaining a limited cache of arguments:answer pairs (Python 3.2)
@property
def area(self):
"""Computed area.
• functools.total_ordering is a class decorator which fills in missing ordering methods (__lt__,
__gt__, __le__, ...) based on a single available one (Python 2.7).
Setting this updates the edge length to the proper value.
"""
return self.edge**2
Deprecation of functions
Let’s say we want to print a deprecation warning on stderr on the first invocation of a function we don’t like
anymore. If we don’t want to modify the function, we can use a decorator:
@area.setter
def area(self, area):
self.edge = area ** 0.5
The way that this works, is that the property decorator replaces the getter method with a property object.
This object in turn has three methods, getter, setter, and deleter, which can be used as decorators.
Their job is to set the getter, setter and deleter of the property object (stored as attributes fget, fset, and
fdel). The getter can be set like in the example above, when creating the object. When defining the setter,
we already have the property object under area, and we add the setter to it by using the setter method.
All this happens when we are creating the class.
Afterwards, when an instance of the class has been created, the property object is special. When the interpreter executes attribute access, assignment, or deletion, the job is delegated to the methods of the property
object.
To make everything crystal clear, let’s define a “debug” example:
>>> class D(object):
...
@property
...
def a(self):
...
print("getting 1")
...
return 1
...
@a.setter
...
def a(self, value):
...
print("setting %r" % value)
...
@a.deleter
...
def a(self):
...
print("deleting")
>>> D.a
2.1. Advanced Python Constructs
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
class deprecated(object):
"""Print a deprecation warning once on first use of the function.
>>> @deprecated()
# doctest: +SKIP
... def f():
...
pass
>>> f()
# doctest: +SKIP
f is deprecated
"""
def __call__(self, func):
self.func = func
self.count = 0
return self._wrapper
def _wrapper(self, *args, **kwargs):
self.count += 1
if self.count == 1:
print self.func.__name__, 'is deprecated'
return self.func(*args, **kwargs)
It can also be implemented as a function:
def deprecated(func):
"""Print a deprecation warning once on first use of the function.
>>> @deprecated
... def f():
...
pass
149
2.1. Advanced Python Constructs
# doctest: +SKIP
150
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> f()
# doctest: +SKIP
f is deprecated
"""
count = [0]
def wrapper(*args, **kwargs):
count[0] += 1
if count[0] == 1:
print func.__name__, 'is deprecated'
return func(*args, **kwargs)
return wrapper
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
@WordProcessor.plugin
class CleanMdashesExtension(object):
def cleanup(self, text):
return text.replace('—', u'\N{em dash}')
Here we use a decorator to decentralise the registration of plugins. We call our decorator with a noun, instead of
a verb, because we use it to declare that our class is a plugin for WordProcessor. Method plugin simply
appends the class to the list of plugins.
A word about the plugin itself: it replaces HTML entity for em-dash with a real Unicode em-dash character. It
exploits the unicode literal notation to insert a character by using its name in the unicode database (“EM DASH”).
If the Unicode character was inserted directly, it would be impossible to distinguish it from an en-dash in the
source of a program.
A while-loop removing decorator
Let’s say we have function which returns a lists of things, and this list created by running a loop. If we don’t know
how many objects will be needed, the standard way to do this is something like:
def find_answers():
answers = []
while True:
ans = look_for_next_answer()
if ans is None:
break
answers.append(ans)
return answers
See also:
More examples and reading
• PEP 318 (function and method decorator syntax)
• PEP 3129 (class decorator syntax)
• http://wiki.python.org/moin/PythonDecoratorLibrary
• http://docs.python.org/dev/library/functools.html
• http://pypi.python.org/pypi/decorator
This is fine, as long as the body of the loop is fairly compact. Once it becomes more complicated, as often happens
in real code, this becomes pretty unreadable. We could simplify this by using yield statements, but then the user
would have to explicitly call list(find_answers()).
We can define a decorator which constructs the list for us:
• Bruce Eckel
– Decorators I: Introduction to Python Decorators
– Python Decorators II: Decorator Arguments
– Python Decorators III: A Decorator-Based Build System
def vectorized(generator_func):
def wrapper(*args, **kwargs):
return list(generator_func(*args, **kwargs))
return functools.update_wrapper(wrapper, generator_func)
2.1.3 Context managers
Our function then becomes:
A context manager is an object with __enter__ and __exit__ methods which can be used in the with statement:
@vectorized
def find_answers():
while True:
ans = look_for_next_answer()
if ans is None:
break
yield ans
with manager as var:
do_something(var)
is in the simplest case equivalent to
var = manager.__enter__()
try:
do_something(var)
finally:
manager.__exit__()
A plugin registration system
This is a class decorator which doesn’t modify the class, but just puts it in a global registry. It falls into the category
of decorators returning the original object:
1. The __enter__ method is called first. It can return a value which will be assigned to var. The as-part
is optional: if it isn’t present, the value returned by __enter__ is simply ignored.
class WordProcessor(object):
PLUGINS = []
def process(self, text):
for plugin in self.PLUGINS:
text = plugin().cleanup(text)
return text
2. The block of code underneath with is executed. Just like with try clauses, it can either execute successfully to the end, or it can break, continue‘ or return, or it can throw an exception. Either way, after the
block is finished, the __exit__ method is called. If an exception was thrown, the information about the
exception is passed to __exit__, which is described below in the next subsection. In the normal case,
exceptions can be ignored, just like in a finally clause, and will be rethrown after __exit__ is finished.
@classmethod
def plugin(cls, plugin):
cls.PLUGINS.append(plugin)
2.1. Advanced Python Constructs
In other words, the context manager protocol defined in PEP 343 permits the extraction of the boring part of a
try..except..finally structure into a separate class leaving only the interesting do_something block.
Let’s say we want to make sure that a file is closed immediately after we are done writing to it:
151
2.1. Advanced Python Constructs
152
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> class closing(object):
...
def __init__(self, obj):
...
self.obj = obj
...
def __enter__(self):
...
return self.obj
...
def __exit__(self, *args):
...
self.obj.close()
>>> with closing(open('/tmp/file', 'w')) as f:
...
f.write('the contents\n')
Here we have made sure that the f.close() is called when the with block is exited. Since closing files is such
a common operation, the support for this is already present in the file class. It has an __exit__ method which
calls close and can be used as a context manager itself:
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
class assert_raises(object):
# based on pytest and unittest.TestCase
def __init__(self, type):
self.type = type
def __enter__(self):
pass
def __exit__(self, type, value, traceback):
if type is None:
raise AssertionError('exception expected')
if issubclass(type, self.type):
return True # swallow the expected exception
raise AssertionError('wrong exception type')
with assert_raises(KeyError):
{}['foo']
>>> with open('/tmp/file', 'a') as f:
...
f.write('more contents\n')
The common use for try..finally is releasing resources. Various different cases are implemented similarly:
in the __enter__ phase the resource is acquired, in the __exit__ phase it is released, and the exception, if
thrown, is propagated. As with files, there’s often a natural operation to perform after the object has been used and
it is most convenient to have the support built in. With each release, Python provides support in more places:
• all file-like objects:
– file ➥ automatically closed
– fileinput, tempfile (py >= 3.2)
Using generators to define context managers
When discussing generators (page 141), it was said that we prefer generators to iterators implemented as classes
because they are shorter, sweeter, and the state is stored as local, not instance, variables. On the other hand, as
described in Bidirectional communication (page 142), the flow of data between the generator and its caller can
be bidirectional. This includes exceptions, which can be thrown into the generator. We would like to implement
context managers as special generator functions. In fact, the generator protocol was designed to support this use
case.
@contextlib.contextmanager
def some_generator(<arguments>):
<setup>
try:
yield <value>
finally:
<cleanup>
– bz2.BZ2File, gzip.GzipFile, tarfile.TarFile, zipfile.ZipFile
– ftplib, nntplib ➥ close connection (py >= 3.2 or 3.3)
• locks
– multiprocessing.RLock ➥ lock and unlock
– multiprocessing.Semaphore
• contextlib.closing ➥ the same as the example above, call close
The contextlib.contextmanager helper takes a generator and turns it into a context manager. The generator has to obey some rules which are enforced by the wrapper function — most importantly it must yield
exactly once. The part before the yield is executed from __enter__, the block of code protected by the context manager is executed when the generator is suspended in yield, and the rest is executed in __exit__. If
an exception is thrown, the interpreter hands it to the wrapper through __exit__ arguments, and the wrapper
function then throws it at the point of the yield statement. Through the use of generators, the context manager
is shorter and simpler.
• parallel programming
Let’s rewrite the closing example as a generator:
– memoryview ➥ automatically release (py >= 3.2 and 2.7)
• decimal.localcontext ➥ modify precision of computations temporarily
• _winreg.PyHKEY ➥ open and close hive key
• warnings.catch_warnings ➥ kill warnings temporarily
– concurrent.futures.ThreadPoolExecutor ➥ invoke in parallel then kill thread pool (py
>= 3.2)
– concurrent.futures.ProcessPoolExecutor ➥ invoke in parallel then kill process pool
(py >= 3.2)
@contextlib.contextmanager
def closing(obj):
try:
yield obj
finally:
obj.close()
– nogil ➥ solve the GIL problem temporarily (cython only :( )
Let’s rewrite the assert_raises example as a generator:
Catching exceptions
The ability to catch exceptions opens interesting possibilities. A classic example comes from unit-tests — we
want to make sure that some code throws the right kind of exception:
@contextlib.contextmanager
def assert_raises(type):
try:
yield
except type:
return
except Exception as value:
raise AssertionError('wrong exception type')
else:
raise AssertionError('exception expected')
2.1. Advanced Python Constructs
2.1. Advanced Python Constructs
When an exception is thrown in the with-block, it is passed as arguments to __exit__. Three arguments are
used, the same as returned by sys.exc_info(): type, value, traceback. When no exception is thrown, None
is used for all three arguments. The context manager can “swallow” the exception by returning a true value from
__exit__. Exceptions can be easily ignored, because if __exit__ doesn’t use return and just falls of the
end, None is returned, a false value, and therefore the exception is rethrown after __exit__ is finished.
153
154
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Chapter contents
Here we use a decorator to turn generator functions into context managers!
2.2 Advanced Numpy
Author: Pauli Virtanen
Numpy is at the base of Python’s scientific stack of tools. Its purpose to implement efficient operations on many
items in a block of memory. Understanding how it works in detail helps in making efficient use of its flexibility,
taking useful shortcuts.
This section covers:
• Anatomy of Numpy arrays, and its consequences. Tips and tricks.
• Universal functions: what, why, and what to do if you want a new one.
• Integration with other tools: Numpy offers several ways to wrap any data in an ndarray, without unnecessary
copies.
• Recently added features, and what’s in them: PEP 3118 buffers, generalized ufuncs, ...
Prerequisites
• Numpy
• Cython
• Pillow (Python imaging library, used in a couple of examples)
• Life of ndarray (page 156)
– It’s... (page 156)
– Block of memory (page 157)
– Data types (page 158)
– Indexing scheme: strides (page 163)
– Findings in dissection (page 169)
• Universal functions (page 169)
– What they are? (page 169)
– Exercise: building an ufunc from scratch (page 170)
– Solution: building an ufunc from scratch (page 174)
– Generalized ufuncs (page 177)
• Interoperability features (page 178)
– Sharing multidimensional, typed data (page 178)
– The old buffer protocol (page 178)
– The old buffer protocol (page 179)
– Array interface protocol (page 180)
• Array siblings: chararray, maskedarray, matrix (page 181)
– chararray: vectorized string operations (page 181)
– masked_array missing data (page 181)
– recarray: purely convenience (page 184)
– matrix: convenience? (page 184)
• Summary (page 184)
• Contributing to Numpy/Scipy (page 184)
– Why (page 184)
– Reporting bugs (page 184)
– Contributing to documentation (page 185)
– Contributing features (page 186)
– How to help, in general (page 186)
Tip: In this section, numpy will be imported as follows:
>>> import numpy as np
2.2.1 Life of ndarray
It’s...
ndarray =
block of memory + indexing scheme + data type descriptor
• raw data
• how to locate an element
• how to interpret an element
2.2. Advanced Numpy
155
2.2. Advanced Numpy
156
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> x[0] = 9
>>> y
array([9, 2, 3])
Memory does not need to be owned by an ndarray:
>>> x = b'1234'
# The 'b' is for "bytes", necessary in Python 3
x is a string (in Python 3 a bytes), we can represent its data as an array of ints:
>>> y = np.frombuffer(x, dtype=np.int8)
>>> y.data
<... at ...>
>>> y.base is x
True
typedef struct PyArrayObject {
PyObject_HEAD
>>> y.flags
C_CONTIGUOUS : True
F_CONTIGUOUS : True
OWNDATA : False
WRITEABLE : False
ALIGNED : True
UPDATEIFCOPY : False
/* Block of memory */
char *data;
/* Data type descriptor */
PyArray_Descr *descr;
The owndata and writeable flags indicate status of the memory block.
/* Indexing scheme */
int nd;
npy_intp *dimensions;
npy_intp *strides;
Data types
The descriptor
/* Other stuff */
PyObject *base;
int flags;
PyObject *weakreflist;
} PyArrayObject;
dtype describes a single item in the array:
type
itemsize
byteorder
fields
shape
Block of memory
>>> x = np.array([1, 2, 3], dtype=np.int32)
>>> x.data
<... at ...>
>>> str(x.data)
'\x01\x00\x00\x00\x02\x00\x00\x00\x03\x00\x00\x00'
scalar type of the data, one of:
int8, int16, float64, et al. (fixed size)
str, unicode, void (flexible size)
size of the data block
byte order: big-endian > / little-endian < / not applicable |
sub-dtypes, if it’s a structured data type
shape of the array, if it’s a sub-array
>>> np.dtype(int).type
<type 'numpy.int64'>
>>> np.dtype(int).itemsize
8
>>> np.dtype(int).byteorder
'='
Memory address of the data:
>>> x.__array_interface__['data'][0]
64803824
The whole __array_interface__:
Example: reading .wav files
>>> x.__array_interface__
{'data': (35828928, False),
'descr': [('', '<i4')],
'shape': (4,),
'strides': None,
'typestr': '<i4',
'version': 3}
The .wav file header:
Reminder: two ndarrays may share the same memory:
>>> x = np.array([1, 2, 3, 4])
>>> y = x[:-1]
2.2. Advanced Numpy
157
2.2. Advanced Numpy
158
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
chunk_id
chunk_size
format
fmt_id
fmt_size
audio_fmt
num_channels
sample_rate
byte_rate
block_align
bits_per_sample
data_id
data_size
"RIFF"
4-byte unsigned little-endian integer
"WAVE"
"fmt "
4-byte unsigned little-endian integer
2-byte unsigned little-endian integer
2-byte unsigned little-endian integer
4-byte unsigned little-endian integer
4-byte unsigned little-endian integer
2-byte unsigned little-endian integer
2-byte unsigned little-endian integer
"data"
4-byte unsigned little-endian integer
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise
Mini-exercise, make a “sparse” dtype by using offsets, and only some of the fields:
>>> wav_header_dtype = np.dtype(dict(
...
names=['format', 'sample_rate', 'data_id'],
...
offsets=[offset_1, offset_2, offset_3], # counted from start of structure in bytes
...
formats=list of dtypes for each of the fields,
... ))
and use that to read the sample rate, and data_id (as sub-array).
>>> f = open('data/test.wav', 'r')
>>> wav_header = np.fromfile(f, dtype=wav_header_dtype, count=1)
>>> f.close()
>>> print(wav_header)
[ ('RIFF', 17402L, 'WAVE', 'fmt ', 16L, 1, 1, 16000L, 32000L, 2, 16, [['d', 'a'], ['t', 'a']], 173
>>> wav_header['sample_rate']
array([16000], dtype=uint32)
• 44-byte block of raw data (in the beginning of the file)
• ... followed by data_size bytes of actual sound data.
The .wav file header as a Numpy structured data type:
>>> wav_header_dtype = np.dtype([
...
("chunk_id", (bytes, 4)), # flexible-sized scalar type, item size 4
...
("chunk_size", "<u4"),
# little-endian unsigned 32-bit integer
...
("format", "S4"),
# 4-byte string
...
("fmt_id", "S4"),
...
("fmt_size", "<u4"),
...
("audio_fmt", "<u2"),
#
...
("num_channels", "<u2"), # .. more of the same ...
...
("sample_rate", "<u4"),
#
...
("byte_rate", "<u4"),
...
("block_align", "<u2"),
...
("bits_per_sample", "<u2"),
...
("data_id", ("S1", (2, 2))), # sub-array, just for fun!
...
("data_size", "u4"),
...
#
...
# the sound data itself cannot be represented here:
...
# it does not have a fixed size
...
])
Let’s try accessing the sub-array:
See also:
casting
>>> wav_header['data_id']
array([[['d', 'a'],
['t', 'a']]],
dtype='|S1')
>>> wav_header.shape
(1,)
>>> wav_header['data_id'].shape
(1, 2, 2)
When accessing sub-arrays, the dimensions get added to the end!
Note: There are existing modules such as wavfile, audiolab, etc. for loading sound data...
Casting and re-interpretation/views
wavreader.py
• on assignment
>>> wav_header_dtype['format']
dtype('S4')
>>> wav_header_dtype.fields
dict_proxy({'block_align': (dtype('uint16'), 32), 'format': (dtype('S4'), 8), 'data_id': (dtype(('S1',
>>> wav_header_dtype.fields['format']
(dtype('S4'), 8)
• on array construction
• on arithmetic
• etc.
• and manually: .astype(dtype)
data re-interpretation
• The first element is the sub-dtype in the structured data, corresponding to the name format
• manually: .view(dtype)
• The second one is its offset (in bytes) from the beginning of the item
Casting
• Casting in arithmetic, in nutshell:
– only type (not value!) of operands matters
– largest “safe” type able to represent both is picked
– scalars can “lose” to arrays in some situations
• Casting in general copies data:
2.2. Advanced Numpy
159
2.2. Advanced Numpy
160
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> x = np.array([1, 2, 3, 4], dtype=np.float)
>>> x
array([ 1., 2., 3., 4.])
>>> y = x.astype(np.int8)
>>> y
array([1, 2, 3, 4], dtype=int8)
>>> y + 1
array([2, 3, 4, 5], dtype=int8)
>>> y + 256
array([257, 258, 259, 260], dtype=int16)
>>> y + 256.0
array([ 257., 258., 259., 260.])
>>> y + np.array([256], dtype=np.int32)
array([257, 258, 259, 260], dtype=int32)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Note:
• .view() makes views, does not copy (or alter) the memory block
• only changes the dtype (and adjusts array shape):
>>> x[1] = 5
>>> y
array([328193], dtype=int32)
>>> y.base is x
True
Mini-exercise: data re-interpretation
• Casting on setitem: dtype of the array is not changed on item assignment:
See also:
>>> y[:] = y + 1.5
>>> y
array([2, 3, 4, 5], dtype=int8)
view-colors.py
You have RGBA data in an array:
>>>
>>>
>>>
>>>
>>>
Note: Exact rules: see documentation: http://docs.scipy.org/doc/numpy/reference/ufuncs.html#casting-rules
Re-interpretation / viewing
• Data block in memory (4 bytes)
0x01
||
0x02
||
x = np.zeros((10, 10, 4), dtype=np.int8)
x[:, :, 0] = 1
x[:, :, 1] = 2
x[:, :, 2] = 3
x[:, :, 3] = 4
where the last three dimensions are the R, B, and G, and alpha channels.
0x03
||
0x04
How to make a (10, 10) structured array with field names ‘r’, ‘g’, ‘b’, ‘a’ without copying data?
– 4 of uint8, OR,
>>> y = ...
– 4 of int8, OR,
>>>
>>>
>>>
>>>
– 2 of int16, OR,
– 1 of int32, OR,
assert
assert
assert
assert
(y['r']
(y['g']
(y['b']
(y['a']
==
==
==
==
1).all()
2).all()
3).all()
4).all()
– 1 of float32, OR,
Solution
– ...
>>> y = x.view([('r', 'i1'),
...
('g', 'i1'),
...
('b', 'i1'),
...
('a', 'i1')]
...
)[:, :, 0]
How to switch from one to another?
1. Switch the dtype:
>>> x = np.array([1, 2, 3, 4], dtype=np.uint8)
>>> x.dtype = "<i2"
>>> x
array([ 513, 1027], dtype=int16)
>>> 0x0201, 0x0403
(513, 1027)
0x01
0x02
||
0x03
0x04
Note: little-endian: least significant byte is on the left in memory
2. Create a new view:
>>> y = x.view("<i4")
>>> y
array([67305985], dtype=int32)
>>> 0x04030201
67305985
0x01
0x02
0x03
2.2. Advanced Numpy
0x04
161
2.2. Advanced Numpy
162
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> y = np.array(x, order='F')
>>> y.strides
(2, 4)
>>> str(y.data)
'\x01\x00\x04\x00\x02\x00\x05\x00\x03\x00\x06\x00'
Warning: Another array taking exactly 4 bytes of memory:
>>> y = np.array([[1, 3], [2, 4]], dtype=np.uint8).transpose()
>>> x = y.copy()
>>> x
array([[1, 2],
[3, 4]], dtype=uint8)
>>> y
array([[1, 2],
[3, 4]], dtype=uint8)
>>> x.view(np.int16)
array([[ 513],
[1027]], dtype=int16)
>>> 0x0201, 0x0403
(513, 1027)
>>> y.view(np.int16)
array([[ 769, 1026]], dtype=int16)
• Need to jump 2 bytes to find the next row
• Need to jump 4 bytes to find the next column
• Similarly to higher dimensions:
– C: last dimensions vary fastest (= smaller strides)
– F: first dimensions vary fastest
shape = (d1 , d2 , ..., dn )
strides = (s1 , s2 , ..., sn )
sC
j = dj+1 dj+2 ...dn × itemsize
• What happened?
• ... we need to look into what x[0,1] actually means
sF
j = d1 d2 ...dj−1 × itemsize
>>> 0x0301, 0x0402
(769, 1026)
Note: Now we can understand the behavior of .view():
>>> y = np.array([[1, 3], [2, 4]], dtype=np.uint8).transpose()
>>> x = y.copy()
Indexing scheme: strides
Transposition does not affect the memory layout of the data, only strides
>>>
(2,
>>>
(1,
Main point
The question:
>>> x = np.array([[1, 2, 3],
...
[4, 5, 6],
...
[7, 8, 9]], dtype=np.int8)
>>> str(x.data)
'\x01\x02\x03\x04\x05\x06\x07\x08\t'
x.strides
1)
y.strides
2)
>>> str(x.data)
'\x01\x02\x03\x04'
>>> str(y.data)
'\x01\x03\x02\x04'
• the results are different when interpreted as 2 of int16
At which byte in ``x.data`` does the item ``x[1, 2]`` begin?
• .copy() creates new arrays in the C order (by default)
The answer (in Numpy)
• strides: the number of bytes to jump to find the next element
Slicing with integers
• 1 stride per dimension:
>>> x.strides
• Everything can be represented by changing only shape, strides, and possibly adjusting the data
pointer!
(3, 1) >>> byte_offset = 3*1 + 1*2 # to find x[1, 2] >>> x.flat[byte_offset] 6 >>> x[1, 2] 6
• Never makes copies of the data
• simple, flexible
>>> x = np.array([1, 2, 3, 4, 5, 6], dtype=np.int32)
>>> y = x[::-1]
>>> y
array([6, 5, 4, 3, 2, 1], dtype=int32)
>>> y.strides
(-4,)
C and Fortran order
>>> x = np.array([[1, 2, 3],
...
[4, 5, 6]], dtype=np.int16, order='C')
>>> x.strides
(6, 2)
>>> str(x.data)
'\x01\x00\x02\x00\x03\x00\x04\x00\x05\x00\x06\x00'
>>> y = x[2:]
>>> y.__array_interface__['data'][0] - x.__array_interface__['data'][0]
8
• Need to jump 6 bytes to find the next row
>>> x = np.zeros((10, 10, 10), dtype=np.float)
>>> x.strides
• Need to jump 2 bytes to find the next column
2.2. Advanced Numpy
163
2.2. Advanced Numpy
164
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
using only as_strided.:
(800, 80, 8)
>>> x[::2,::3,::4].strides
(1600, 240, 32)
Hint: byte_offset = stride[0]*index[0] + stride[1]*index[1] + ...
Spoiler
• Similarly, transposes never make copies (it just swaps strides):
Stride can also be 0:
>>> x = np.zeros((10, 10, 10), dtype=np.float)
>>> x.strides
(800, 80, 8)
>>> x.T.strides
(8, 80, 800)
>>> x = np.array([1, 2, 3, 4], dtype=np.int8)
>>> y = as_strided(x, strides=(0, 1), shape=(3, 4))
>>> y
array([[1, 2, 3, 4],
[1, 2, 3, 4],
[1, 2, 3, 4]], dtype=int8)
>>> y.base.base is x
True
But: not all reshaping operations can be represented by playing with strides:
>>>
>>>
>>>
(1,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
a = np.arange(6, dtype=np.int8).reshape(3, 2)
b = a.T
b.strides
2)
Broadcasting
So far, so good. However:
• Doing something useful with it: outer product of [1, 2, 3, 4] and [5, 6, 7]
>>> str(a.data)
'\x00\x01\x02\x03\x04\x05'
>>> b
array([[0, 2, 4],
[1, 3, 5]], dtype=int8)
>>> c = b.reshape(3*2)
>>> c
array([0, 2, 4, 1, 3, 5], dtype=int8)
>>> x = np.array([1, 2, 3, 4], dtype=np.int16)
>>> x2 = as_strided(x, strides=(0, 1*2), shape=(3, 4))
>>> x2
array([[1, 2, 3, 4],
[1, 2, 3, 4],
[1, 2, 3, 4]], dtype=int16)
Here, there is no way to represent the array c given one stride and the block of memory for a. Therefore, the
reshape operation needs to make a copy here.
Example: fake dimensions with strides
>>> y = np.array([5, 6, 7], dtype=np.int16)
>>> y2 = as_strided(y, strides=(1*2, 0), shape=(3, 4))
>>> y2
array([[5, 5, 5, 5],
[6, 6, 6, 6],
[7, 7, 7, 7]], dtype=int16)
>>> x2 *
array([[
[
[
Stride manipulation
>>> from numpy.lib.stride_tricks import as_strided
>>> help(as_strided)
as_strided(x, shape=None, strides=None)
Make an ndarray from the given array with the given shape and strides
y2
5, 10, 15, 20],
6, 12, 18, 24],
7, 14, 21, 28]], dtype=int16)
... seems somehow familiar ...
Warning: as_strided does not check that you stay inside the memory block bounds...
>>> x = np.array([1, 2, 3, 4], dtype=np.int16)
>>> y = np.array([5, 6, 7], dtype=np.int16)
>>> x[np.newaxis,:] * y[:,np.newaxis]
array([[ 5, 10, 15, 20],
[ 6, 12, 18, 24],
[ 7, 14, 21, 28]], dtype=int16)
>>> x = np.array([1, 2, 3, 4], dtype=np.int16)
>>> as_strided(x, strides=(2*2, ), shape=(2, ))
array([1, 3], dtype=int16)
>>> x[::2]
array([1, 3], dtype=int16)
• Internally, array broadcasting is indeed implemented using 0-strides.
See also:
stride-fakedims.py
More tricks: diagonals
Exercise
See also:
array([1, 2, 3, 4], dtype=np.int8)
stride-diagonals.py
-> array([[1, 2, 3, 4],
[1, 2, 3, 4],
[1, 2, 3, 4]], dtype=np.int8)
2.2. Advanced Numpy
Challenge
• Pick diagonal entries of the matrix: (assume C memory order):
165
2.2. Advanced Numpy
166
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> x = np.array([[1, 2, 3],
...
[4, 5, 6],
...
[7, 8, 9]], dtype=np.int32)
CPU cache effects
>>> x_diag = as_strided(x, shape=(3,), strides=(???,))
In [1]: x = np.zeros((20000,))
Memory layout can affect performance:
• Pick the first super-diagonal entries [2, 6].
In [2]: y = np.zeros((20000*67,))[::67]
• And the sub-diagonals?
In [3]: x.shape, y.shape
((20000,), (20000,))
(Hint to the last two: slicing first moves the point where striding starts from.)
In [4]: %timeit x.sum()
100000 loops, best of 3: 0.180 ms per loop
Solution
Pick diagonals:
In [5]: %timeit y.sum()
100000 loops, best of 3: 2.34 ms per loop
>>> x_diag = as_strided(x, shape=(3, ), strides=((3+1)*x.itemsize, ))
>>> x_diag
array([1, 5, 9], dtype=int32)
In [6]: x.strides, y.strides
((8,), (536,))
Slice first, to adjust the data pointer:
>>> as_strided(x[0, 1:], shape=(2, ), strides=((3+1)*x.itemsize, ))
array([2, 6], dtype=int32)
Smaller strides are faster?
>>> as_strided(x[1:, 0], shape=(2, ), strides=((3+1)*x.itemsize, ))
array([4, 8], dtype=int32)
Note: Using np.diag
>>> y = np.diag(x, k=1)
>>> y
array([2, 6], dtype=int32)
However,
>>> y.flags.owndata
False
• CPU pulls data from main memory to its cache in blocks
• If many array items consecutively operated on fit in a single block (small stride):
Note This behavior has changed: before numpy 1.9, np.diag would make a copy.
– ⇒ fewer transfers needed
– ⇒ faster
See also:
stride-diagonals.py
See also:
Challenge
numexpr is designed to mitigate cache effects in array computing.
Compute the tensor trace:
Example: inplace operations (caveat emptor)
>>> x = np.arange(5*5*5*5).reshape(5, 5, 5, 5)
>>> s = 0
>>> for i in range(5):
...
for j in range(5):
...
s += x[j, i, j, i]
• Sometimes,
>>> a -= b
is not the same as
by striding, and using sum() on the result.
>>> a -= b.copy()
>>> y = as_strided(x, shape=(5, 5), strides=(TODO, TODO))
>>> s2 = ...
>>> assert s == s2
>>> x = np.array([[1, 2], [3, 4]])
>>> x -= x.transpose()
>>> x
array([[ 0, -1],
[ 4, 0]])
Solution
>>> y = as_strided(x, shape=(5, 5), strides=((5*5*5 + 5)*x.itemsize,
...
(5*5 + 1)*x.itemsize))
>>> s2 = y.sum()
2.2. Advanced Numpy
167
2.2. Advanced Numpy
168
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> y = np.array([[1, 2], [3, 4]])
>>> y -= y.T.copy()
>>> y
array([[ 0, -1],
[ 1, 0]])
* This function must compute the ufunc for many values at once,
* in the way shown below.
*/
char *input_1 = (char*)args[0];
char *input_2 = (char*)args[1];
char *output = (char*)args[2];
int i;
• x and x.transpose() share data
• x -= x.transpose() modifies the data element-by-element...
for (i = 0; i < dimensions[0]; ++i) {
*output = elementwise_function(*input_1, *input_2);
input_1 += steps[0];
input_2 += steps[1];
output += steps[2];
}
• because x and x.transpose() have different striding, modified data re-appears on the RHS
Findings in dissection
}
2. The Numpy part, built by
char types[3]
types[0] = NPY_BYTE
types[1] = NPY_BYTE
types[2] = NPY_BYTE
• memory block: may be shared, .base, .data
• data type descriptor: structured data, sub-arrays, byte order, casting, viewing, .astype(), .view()
• strided indexing: strides, C/F-order, slicing w/ integers, as_strided, broadcasting, stride tricks, diag,
CPU cache coherence
/* type of first input arg */
/* type of second input arg */
/* type of third input arg */
PyObject *python_ufunc = PyUFunc_FromFuncAndData(
ufunc_loop,
NULL,
types,
1, /* ntypes */
2, /* num_inputs */
1, /* num_outputs */
identity_element,
name,
docstring,
unused)
• A ufunc can also support multiple different input-output type combinations.
2.2.2 Universal functions
Making it easier
What they are?
3. ufunc_loop is of very generic form, and Numpy provides pre-made ones
• Ufunc performs and elementwise operation on all elements of an array.
PyUfunc_f_f float elementwise_func(float input_1)
PyUfunc_ff_ffloat elementwise_func(float input_1, float input_2)
PyUfunc_d_d double elementwise_func(double input_1)
PyUfunc_dd_ddouble elementwise_func(double input_1, double input_2)
PyUfunc_D_D elementwise_func(npy_cdouble *input, npy_cdouble* output)
PyUfunc_DD_Delementwise_func(npy_cdouble *in1, npy_cdouble *in2,
npy_cdouble* out)
Examples:
np.add, np.subtract, scipy.special.*, ...
• Automatically support: broadcasting, casting, ...
• The author of an ufunc only has to supply the elementwise operation, Numpy takes care of the rest.
• The elementwise operation needs to be implemented in C (or, e.g., Cython)
• Only elementwise_func needs to be supplied
• ... except when your elementwise function is not in one of the above forms
Parts of an Ufunc
Exercise: building an ufunc from scratch
1. Provided by user
The Mandelbrot fractal is defined by the iteration
void ufunc_loop(void **args, int *dimensions, int *steps, void *data)
{
/*
* int8 output = elementwise_function(int8 input_1, int8 input_2)
*
2.2. Advanced Numpy
z ← z2 + c
where c = x + iy is a complex number. This iteration is repeated – if z stays finite no matter how long the iteration
runs, c belongs to the Mandelbrot set.
169
2.2. Advanced Numpy
170
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Make ufunc called mandel(z0, c) that computes:
#
#
#
z = z0
for k in range(iterations):
z = z*z + c
Say, use 100 as the maximum number of iterations, and 1000
as the cutoff for z.real**2 + z.imag**2.
TODO: mandelbrot iteration should go here
say, 100 iterations or until z.real**2 + z.imag**2 > 1000. Use it to determine which c are in the
Mandelbrot set.
# Return the answer for this point
z_out[0] = z
• Our function is a simple one, so make use of the PyUFunc_* helpers.
• Write it in Cython
#
#
#
#
#
See also:
mandel.pyx, mandelplot.py
#
# Fix the parts marked by TODO
#
The litany below is particularly long, but you don't really need to
read this part; it just pulls in stuff from the Numpy C headers.
----------------------------------------------------------
cdef extern from "numpy/arrayobject.h":
void import_array()
ctypedef int npy_intp
cdef enum NPY_TYPES:
NPY_DOUBLE
NPY_CDOUBLE
NPY_LONG
#
# Compile this file by (Cython >= 0.12 required because of the complex vars)
#
#
cython mandel.pyx
#
python setup.py build_ext -i
#
# and try it out with, in this directory,
#
#
>>> import mandel
#
>>> mandel.mandel(0, 1 + 2j)
#
#
cdef extern from "numpy/ufuncobject.h":
void import_ufunc()
ctypedef void (*PyUFuncGenericFunction)(char**, npy_intp*, npy_intp*, void*)
object PyUFunc_FromFuncAndData(PyUFuncGenericFunction* func, void** data,
char* types, int ntypes, int nin, int nout,
int identity, char* name, char* doc, int c)
# List of pre-defined loop functions
# The elementwise function
# ------------------------
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
cdef void mandel_single_point(double complex *z_in,
double complex *c_in,
double complex *z_out) nogil:
#
# The Mandelbrot iteration
#
#
#
#
#
#
#
#
#
#
#
#
#
Boilerplate Cython definitions
Some points of note:
- It's *NOT* allowed to call any Python functions here.
The Ufunc loop runs with the Python Global Interpreter Lock released.
Hence, the ``nogil``.
PyUFunc_f_f_As_d_d(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_d_d(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_f_f(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_g_g(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_F_F_As_D_D(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_F_F(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_D_D(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_G_G(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_ff_f_As_dd_d(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_ff_f(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_dd_d(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_gg_g(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_FF_F_As_DD_D(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_DD_D(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_FF_F(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
PyUFunc_GG_G(char** args, npy_intp* dimensions, npy_intp* steps, void* func)
- And so all local variables must be declared with ``cdef``
# Required module initialization
# ------------------------------
- Note also that this function receives *pointers* to the data
import_array()
import_ufunc()
cdef double complex z = z_in[0]
cdef double complex c = c_in[0]
cdef int k # the integer we use in the for loop
# The actual ufunc declaration
# ----------------------------
#
# TODO: write the Mandelbrot iteration for one point here,
#
as you would write it in Python.
#
2.2. Advanced Numpy
cdef PyUFuncGenericFunction loop_func[1]
cdef char input_output_types[3]
171
2.2. Advanced Numpy
172
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
NPY_LONGDOUBLE, NPY_CFLOAT, NPY_CDOUBLE, NPY_CLONGDOUBLE, NPY_DATETIME,
NPY_TIMEDELTA, NPY_OBJECT, NPY_STRING, NPY_UNICODE, NPY_VOID
cdef void *elementwise_funcs[1]
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
#
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Reminder: some pre-made Ufunc loops:
================
``PyUfunc_f_f``
``PyUfunc_ff_f``
``PyUfunc_d_d``
``PyUfunc_dd_d``
``PyUfunc_D_D``
``PyUfunc_DD_D``
================
=======================================================
``float elementwise_func(float input_1)``
``float elementwise_func(float input_1, float input_2)``
``double elementwise_func(double input_1)``
``double elementwise_func(double input_1, double input_2)``
``elementwise_func(complex_double *input, complex_double* complex_double)``
``elementwise_func(complex_double *in1, complex_double *in2, complex_double* out)``
=======================================================
The full list is above.
Solution: building an ufunc from scratch
# The elementwise function
# -----------------------cdef void mandel_single_point(double complex *z_in,
double complex *c_in,
double complex *z_out) nogil:
#
# The Mandelbrot iteration
#
#
#
#
#
#
#
#
#
#
#
#
#
#
Type codes:
NPY_BOOL, NPY_BYTE, NPY_UBYTE, NPY_SHORT, NPY_USHORT, NPY_INT, NPY_UINT,
NPY_LONG, NPY_ULONG, NPY_LONGLONG, NPY_ULONGLONG, NPY_FLOAT, NPY_DOUBLE,
NPY_LONGDOUBLE, NPY_CFLOAT, NPY_CDOUBLE, NPY_CLONGDOUBLE, NPY_DATETIME,
NPY_TIMEDELTA, NPY_OBJECT, NPY_STRING, NPY_UNICODE, NPY_VOID
loop_func[0] = ... TODO: suitable PyUFunc_* ...
input_output_types[0] = ... TODO ...
... TODO: fill in rest of input_output_types ...
# This thing is passed as the ``data`` parameter for the generic
# PyUFunc_* loop, to let it know which function it should call.
elementwise_funcs[0] = <void*>mandel_single_point
- It's *NOT* allowed to call any Python functions here.
The Ufunc loop runs with the Python Global Interpreter Lock released.
Hence, the ``nogil``.
- And so all local variables must be declared with ``cdef``
- Note also that this function receives *pointers* to the data;
the "traditional" solution to passing complex variables around
cdef double complex z = z_in[0]
cdef double complex c = c_in[0]
cdef int k # the integer we use in the for loop
# Construct the ufunc:
# Straightforward iteration
mandel = PyUFunc_FromFuncAndData(
loop_func,
elementwise_funcs,
input_output_types,
1, # number of supported input types
TODO, # number of input args
TODO, # number of output args
0, # `identity` element, never mind this
"mandel", # function name
"mandel(z, c) -> computes z*z + c", # docstring
0 # unused
)
for k in range(100):
z = z*z + c
if z.real**2 + z.imag**2 > 1000:
break
# Return the answer for this point
z_out[0] = z
#
#
#
#
#
Reminder: some pre-made Ufunc loops:
PyUfunc_f_f float elementwise_func(float input_1)
PyUfunc_ff_ffloat elementwise_func(float input_1, float input_2)
PyUfunc_d_d double elementwise_func(double input_1)
PyUfunc_dd_ddouble elementwise_func(double input_1, double input_2)
PyUfunc_D_D elementwise_func(complex_double *input, complex_double*
output)
PyUfunc_DD_Delementwise_func(complex_double *in1, complex_double *in2,
complex_double* out)
Boilerplate Cython definitions
You don't really need to read this part, it just pulls in
stuff from the Numpy C headers.
----------------------------------------------------------
cdef extern from "numpy/arrayobject.h":
void import_array()
ctypedef int npy_intp
cdef enum NPY_TYPES:
NPY_CDOUBLE
cdef extern from "numpy/ufuncobject.h":
void import_ufunc()
ctypedef void (*PyUFuncGenericFunction)(char**, npy_intp*, npy_intp*, void*)
object PyUFunc_FromFuncAndData(PyUFuncGenericFunction* func, void** data,
char* types, int ntypes, int nin, int nout,
Type codes:
NPY_BOOL, NPY_BYTE, NPY_UBYTE, NPY_SHORT, NPY_USHORT, NPY_INT, NPY_UINT,
NPY_LONG, NPY_ULONG, NPY_LONGLONG, NPY_ULONGLONG, NPY_FLOAT, NPY_DOUBLE,
2.2. Advanced Numpy
Some points of note:
173
2.2. Advanced Numpy
174
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
int identity, char* name, char* doc, int c)
void PyUFunc_DD_D(char**, npy_intp*, npy_intp*, void*)
# Required module initialization
# -----------------------------import_array()
import_ufunc()
# The actual ufunc declaration
# ---------------------------cdef PyUFuncGenericFunction loop_func[1]
cdef char input_output_types[3]
cdef void *elementwise_funcs[1]
Note: Most of the boilerplate could be automated by these Cython modules:
http://wiki.cython.org/MarkLodato/CreatingUfuncs
loop_func[0] = PyUFunc_DD_D
input_output_types[0] = NPY_CDOUBLE
input_output_types[1] = NPY_CDOUBLE
input_output_types[2] = NPY_CDOUBLE
Several accepted input types
E.g. supporting both single- and double-precision versions
elementwise_funcs[0] = <void*>mandel_single_point
cdef void mandel_single_point(double complex *z_in,
double complex *c_in,
double complex *z_out) nogil:
...
mandel = PyUFunc_FromFuncAndData(
loop_func,
elementwise_funcs,
input_output_types,
1, # number of supported input types
2, # number of input args
1, # number of output args
0, # `identity` element, never mind this
"mandel", # function name
"mandel(z, c) -> computes iterated z*z + c", # docstring
0 # unused
)
cdef void mandel_single_point_singleprec(float complex *z_in,
float complex *c_in,
float complex *z_out) nogil:
...
cdef PyUFuncGenericFunction loop_funcs[2]
cdef char input_output_types[3*2]
cdef void *elementwise_funcs[1*2]
loop_funcs[0] = PyUFunc_DD_D
input_output_types[0] = NPY_CDOUBLE
input_output_types[1] = NPY_CDOUBLE
input_output_types[2] = NPY_CDOUBLE
elementwise_funcs[0] = <void*>mandel_single_point
"""
Plot Mandelbrot
================
Plot the Mandelbrot ensemble.
loop_funcs[1] = PyUFunc_FF_F
input_output_types[3] = NPY_CFLOAT
input_output_types[4] = NPY_CFLOAT
input_output_types[5] = NPY_CFLOAT
elementwise_funcs[1] = <void*>mandel_single_point_singleprec
"""
import numpy as np
import mandel
x = np.linspace(-1.7, 0.6, 1000)
y = np.linspace(-1.4, 1.4, 1000)
c = x[None,:] + 1j*y[:,None]
z = mandel.mandel(c, c)
mandel = PyUFunc_FromFuncAndData(
loop_func,
elementwise_funcs,
input_output_types,
2, # number of supported input types
<---------------2, # number of input args
1, # number of output args
0, # `identity` element, never mind this
"mandel", # function name
"mandel(z, c) -> computes iterated z*z + c", # docstring
0 # unused
import matplotlib.pyplot as plt
plt.imshow(abs(z)**2 < 1000, extent=[-1.7, 0.6, -1.4, 1.4])
plt.gray()
plt.show()
2.2. Advanced Numpy
175
2.2. Advanced Numpy
176
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
void gufunc_loop(void **args, int *dimensions, int *steps, void *data)
{
char *input_1 = (char*)args[0]; /* these are as previously */
char *input_2 = (char*)args[1];
char *output = (char*)args[2];
)
Generalized ufuncs
ufunc
int
int
int
int
int
int
output = elementwise_function(input)
Both output and input can be a single array element only.
generalized ufunc
input_1_stride_m = steps[3]; /* strides for the core dimensions */
input_1_stride_n = steps[4]; /* are added after the non-core */
input_2_strides_n = steps[5]; /* steps */
input_2_strides_p = steps[6];
output_strides_n = steps[7];
output_strides_p = steps[8];
output and input can be arrays with a fixed number of dimensions
int m = dimension[1]; /* core dimensions are added after */
int n = dimension[2]; /* the main dimension; order as in */
int p = dimension[3]; /* signature */
For example, matrix trace (sum of diag elements):
input shape = (n, n)
output shape = ()
i.e.
scalar
int i;
(n, n) -> ()
for (i = 0; i < dimensions[0]; ++i) {
matmul_for_strided_matrices(input_1, input_2, output,
strides for each array...);
Matrix product:
input_1 shape = (m, n)
input_2 shape = (n, p)
output shape = (m, p)
input_1 += steps[0];
input_2 += steps[1];
output += steps[2];
}
(m, n), (n, p) -> (m, p)
}
• This is called the “signature” of the generalized ufunc
• The dimensions on which the g-ufunc acts, are “core dimensions”
2.2.3 Interoperability features
Status in Numpy
Sharing multidimensional, typed data
Suppose you
• g-ufuncs are in Numpy already ...
• new ones can be created with PyUFunc_FromFuncAndDataAndSignature
1. Write a library than handles (multidimensional) binary data,
• ... but we don’t ship with public g-ufuncs, except for testing, ATM
2. Want to make it easy to manipulate the data with Numpy, or whatever other library,
3. ... but would not like to have Numpy as a dependency.
>>> import numpy.core.umath_tests as ut
>>> ut.matrix_multiply.signature
'(m,n),(n,p)->(m,p)'
Currently, 3 solutions:
1. the “old” buffer interface
>>> x = np.ones((10, 2, 4))
>>> y = np.ones((10, 4, 5))
>>> ut.matrix_multiply(x, y).shape
(10, 2, 5)
2. the array interface
3. the “new” buffer interface (PEP 3118)
• the last two dimensions became core dimensions, and are modified as per the signature
The old buffer protocol
• otherwise, the g-ufunc operates “elementwise”
• Only 1-D buffers
• matrix multiplication this way could be useful for operating on many small matrices at once
• No data type information
• C-level interface; PyBufferProcs tp_as_buffer in the type object
Generalized ufunc loop
• But it’s integrated into Python (e.g. strings support it)
Matrix multiplication (m,n),(n,p) -> (m,p)
Mini-exercise using Pillow (Python Imaging Library):
See also:
pilbuffer.py
2.2. Advanced Numpy
177
2.2. Advanced Numpy
178
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>>
>>>
>>>
>>>
>>>
>>>
>>>
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
from PIL import Image
data = np.zeros((200, 200, 4), dtype=np.int8)
data[:, :] = [255, 0, 0, 255] # Red
# In PIL, RGBA images consist of 32-bit integers whose bytes are [RR,GG,BB,AA]
data = data.view(np.int32).squeeze()
img = Image.frombuffer("RGBA", (200, 200), data, "raw", "RGBA", 0, 1)
img.save('test.png')
Q:
Check what happens if data is now modified, and img saved again.
The old buffer protocol
"""
From buffer
============
Show how to exchange data between numpy and a library that only knows
the buffer interface.
"""
import numpy as np
import Image
# Let's make a sample image, RGBA format
x = np.zeros((200, 200, 4), dtype=np.int8)
x[:,:,0] = 254 # red
x[:,:,3] = 255 # opaque
data = x.view(np.int32) # Check that you understand why this is OK!
img = Image.frombuffer("RGBA", (200, 200), data)
img.save('test.png')
#
# Modify the original data, and save again.
#
# It turns out that PIL, which knows next to nothing about Numpy,
# happily shares the same data.
#
Array interface protocol
• Multidimensional buffers
• Data type information present
• Numpy-specific approach; slowly deprecated (but not going away)
x[:,:,1] = 254
img.save('test2.png')
• Not integrated in Python otherwise
See also:
Documentation: http://docs.scipy.org/doc/numpy/reference/arrays.interface.html
>>> x = np.array([[1, 2], [3, 4]])
>>> x.__array_interface__
{'data': (171694552, False),
#
'descr': [('', '<i4')],
#
'typestr': '<i4',
#
'strides': None,
#
'shape': (2, 2),
'version': 3,
}
memory address of data, is readonly?
data type descriptor
same, in another form
strides; or None if in C-order
::
2.2. Advanced Numpy
179
2.2. Advanced Numpy
180
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The mask
>>> from PIL import Image
>>> img = Image.open('data/test.png')
>>> img.__array_interface__
{'data': ...,
'shape': (200, 200, 4),
'typestr': '|u1'}
>>> x = np.asarray(img)
>>> x.shape
(200, 200, 4)
You can modify the mask by assigning:
>>> mx[1] = np.ma.masked
>>> mx
masked_array(data = [1 -- 3 -- 5],
mask = [False True False
fill_value = 999999)
True False],
The mask is cleared on assignment:
Note: A more C-friendly variant of the array interface is also defined.
>>> mx[1] = 9
>>> mx
masked_array(data = [1 9 3 -- 5],
mask = [False False False
fill_value = 999999)
2.2.4 Array siblings: chararray, maskedarray, matrix
True False],
chararray: vectorized string operations
The mask is also available directly:
>>> x = np.array(['a', ' bbb', ' ccc']).view(np.chararray)
>>> x.lstrip(' ')
chararray(['a', 'bbb', 'ccc'],
dtype='...')
>>> x.upper()
chararray(['A', ' BBB', ' CCC'],
dtype='...')
>>> mx.mask
array([False, False, False,
True, False], dtype=bool)
The masked entries can be filled with a given value to get an usual array back:
>>> x2 = mx.filled(-1)
>>> x2
array([ 1, 9, 3, -1,
Note: .view() has a second meaning: it can make an ndarray an instance of a specialized ndarray subclass
5])
The mask can also be cleared:
>>> mx.mask = np.ma.nomask
>>> mx
masked_array(data = [1 9 3 -99 5],
mask = [False False False False False],
fill_value = 999999)
masked_array missing data
Masked arrays are arrays that may have missing or invalid entries.
For example, suppose we have an array where the fourth entry is invalid:
>>> x = np.array([1, 2, 3, -99, 5])
Domain-aware functions
One way to describe this is to create a masked array:
The masked array package also contains domain-aware functions:
>>> mx = np.ma.masked_array(x, mask=[0, 0, 0, 1, 0])
>>> mx
masked_array(data = [1 2 3 -- 5],
mask = [False False False True False],
fill_value = 999999)
>>> np.ma.log(np.array([1, 2, -1, -2, 3, -5]))
masked_array(data = [0.0 0.6931471805599453 -- -- 1.0986122886681098 --],
mask = [False False True True False True],
fill_value = 1e+20)
Masked mean ignores masked data:
Note: Streamlined and more seamless support for dealing with missing data in arrays is making its way into
Numpy 1.7. Stay tuned!
>>> mx.mean()
2.75
>>> np.mean(mx)
2.75
Warning: Not all Numpy functions respect masks, for instance np.dot, so check the return types.
The masked_array returns a view to the original array:
>>> mx[1] = 9
>>> x
array([ 1,
9,
3, -99,
2.2. Advanced Numpy
5])
181
2.2. Advanced Numpy
182
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
recarray: purely convenience
Example: Masked statistics
Canadian rangers were distracted when counting hares and lynxes in 1903-1910 and 1917-1918, and got
the numbers are wrong. (Carrot farmers stayed alert, though.) Compute the mean populations over time,
ignoring the invalid numbers.
>>> arr = np.array([('a', 1), ('b', 2)], dtype=[('x', 'S1'), ('y', int)])
>>> arr2 = arr.view(np.recarray)
>>> arr2.x
chararray(['a', 'b'],
dtype='|S1')
>>> arr2.y
array([1, 2])
>>> data = np.loadtxt('data/populations.txt')
>>> populations = np.ma.masked_array(data[:,1:])
>>> year = data[:, 0]
>>>
...
>>>
>>>
>>>
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
bad_years = (((year >= 1903) & (year <= 1910))
| ((year >= 1917) & (year <= 1918)))
# '&' means 'and' and '|' means 'or'
populations[bad_years, 0] = np.ma.masked
populations[bad_years, 1] = np.ma.masked
matrix: convenience?
• always 2-D
• * is the matrix product, not the elementwise one
>>> populations.mean(axis=0)
masked_array(data = [40472.72727272727 18627.272727272728 42400.0],
mask = [False False False],
fill_value = 1e+20)
>>> np.matrix([[1, 0], [0, 1]]) * np.matrix([[1, 2], [3, 4]])
matrix([[1, 2],
[3, 4]])
>>> populations.std(axis=0)
masked_array(data = [21087.656489006717 15625.799814240254 3322.5062255844787],
mask = [False False False],
fill_value = 1e+20)
2.2.5 Summary
• Anatomy of the ndarray: data, dtype, strides.
Note that Matplotlib knows about masked arrays:
• Universal functions: elementwise operations, how to make new ones
>>> plt.plot(year, populations, 'o-')
[<matplotlib.lines.Line2D object at ...>, ...]
• Ndarray subclasses
• Various buffer interfaces for integration with other tools
80000
• Recent additions: PEP 3118, generalized ufuncs
70000
2.2.6 Contributing to Numpy/Scipy
Get this tutorial: http://www.euroscipy.org/talk/882
60000
Why
50000
• “There’s a bug?”
40000
• “I don’t understand what this is supposed to do?”
• “I have this fancy code. Would you like to have it?”
30000
• “I’d like to help! What can I do?”
20000
Reporting bugs
10000
• Bug tracker (prefer this)
– http://projects.scipy.org/numpy
0
1900
1905
1910
1915
– http://projects.scipy.org/scipy
1920
– Click the “Register” link to get an account
• Mailing lists ( scipy.org/Mailing_Lists )
– If you’re unsure
– No replies in a week or so? Just file a bug ticket.
2.2. Advanced Numpy
183
2.2. Advanced Numpy
184
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
* “change your subscription options”, at the bottom of
Good bug report
http://mail.scipy.org/mailman/listinfo/scipy-dev
Title: numpy.random.permutations fails for non-integer arguments
– Send a mail @ scipy-dev mailing list; ask for activation:
I'm trying to generate random permutations, using numpy.random.permutations
To:
[email protected]
When calling numpy.random.permutation with non-integer arguments
it fails with a cryptic error message::
Hi,
I'd like to edit Numpy/Scipy docstrings. My account is XXXXX
>>> np.random.permutation(12)
array([ 6, 11, 4, 10, 2, 8, 1, 7, 9, 3, 0, 5])
>>> np.random.permutation(12.)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "mtrand.pyx", line 3311, in mtrand.RandomState.permutation
File "mtrand.pyx", line 3254, in mtrand.RandomState.shuffle
TypeError: len() of unsized object
Cheers,
N. N.
• Check the style guide:
– http://docs.scipy.org/numpy/
– Don’t be intimidated; to fix a small thing, just fix it
This also happens with long arguments, and so
np.random.permutation(X.shape[0]) where X is an array fails on 64
bit windows (where shape is a tuple of longs).
• Edit
2. Edit sources and send patches (as for bugs)
3. Complain on the mailing list
It would be great if it could cast to integer or at least raise a
proper error for non-integer types.
Contributing features
I'm using Numpy 1.4.1, built from the official tarball, on Windows
64 with Visual studio 2008, on Python.org 64-bit Python.
0. Ask on mailing list, if unsure where it should go
0. What are you trying to do?
1. Write a patch, add an enhancement ticket on the bug tracket
1. Small code snippet reproducing the bug (if possible)
2. OR, create a Git branch implementing the feature + add enhancement ticket.
• What actually happens
• Especially for big/invasive additions
• What you’d expect
• http://projects.scipy.org/numpy/wiki/GitMirror
2. Platform (Windows / Linux / OSX, 32/64 bits, x86/PPC, ...)
• http://www.spheredev.org/wiki/Git_for_the_lazy
3. Version of Numpy/Scipy
# Clone numpy repository
git clone --origin svn http://projects.scipy.org/git/numpy.git numpy
cd numpy
>>> print(np.__version__)
1...
Check that the following is what you expect
# Create a feature branch
git checkout -b name-of-my-feature-branch
>>> print(np.__file__)
/...
svn/trunk
<edit stuff>
In case you have old/broken Numpy installations lying around.
git commit -a
If unsure, try to remove existing Numpy installations, and reinstall...
• Create account on http://github.com (or anywhere)
• Create a new repository @ Github
Contributing to documentation
• Push your work to github
1. Documentation editor
git remote add github git@github:YOURUSERNAME/YOURREPOSITORYNAME.git
git push github name-of-my-feature-branch
• http://docs.scipy.org/numpy
• Registration
– Register an account
How to help, in general
– Subscribe to scipy-dev mailing list (subscribers-only)
• Bug fixes always welcome!
– Problem with mailing lists: you get mail
– What irks you most
* But: you can turn mail delivery off
2.2. Advanced Numpy
185
2.2. Advanced Numpy
186
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
– Browse the tracker
Brian Kernighan
• Documentation work
“Everyone knows that debugging is twice as hard as writing a program in the first place. So if you’re as
clever as you can be when you write it, how will you ever debug it?”
– API docs: improvements to docstrings
* Know some Scipy module well?
– User guide
• We all write buggy code. Accept it. Deal with it.
* Needs to be done eventually.
• Write your code with testing and debugging in mind.
* Want to think? Come up with a Table of Contents
• Keep It Simple, Stupid (KISS).
http://scipy.org/Developer_Zone/UG_Toc
– What is the simplest thing that could possibly work?
• Ask on communication channels:
• Don’t Repeat Yourself (DRY).
– numpy-discussion list
– Every piece of knowledge must have a single, unambiguous, authoritative representation within a
system.
– scipy-dev list
– Constants, algorithms, etc...
• Try to limit interdependencies of your code. (Loose Coupling)
2.3 Debugging code
• Give your variables, functions and modules meaningful names (not mathematics names)
Author: Gaël Varoquaux
pyflakes: fast static analysis
This section explores tools to understand better your code base: debugging, to find and fix bugs.
It is not specific to the scientific Python community, but the strategies that we will employ are tailored to its needs.
They are several static analysis tools in Python; to name a few:
• pylint
Prerequisites
•
•
•
•
•
• pychecker
Numpy
IPython
nosetests (http://readthedocs.org/docs/nose/en/latest/)
pyflakes (http://pypi.python.org/pypi/pyflakes)
gdb for the C-debugging part.
• pyflakes
• pep8
• flake8
Here we focus on pyflakes, which is the simplest tool.
• Fast, simple
Chapters contents
• Detects syntax errors, missing imports, typos on names.
• Avoiding bugs (page 187)
– Coding best practices to avoid getting in trouble (page 187)
– pyflakes: fast static analysis (page 188)
* Running pyflakes on the current edited file (page 188)
* A type-as-go spell-checker like integration (page 189)
• Debugging workflow (page 190)
• Using the Python debugger (page 190)
– Invoking the debugger (page 191)
* Postmortem (page 191)
* Step-by-step execution (page 192)
* Other ways of starting a debugger (page 194)
– Debugger commands and interaction (page 195)
* Getting help when in the debugger (page 195)
• Debugging segmentation faults using gdb (page 195)
Another good recommendation is the flake8 tool which is a combination of pyflakes and pep8. Thus, in addition
to the types of errors that pyflakes catches, flake8 detects violations of the recommendation in PEP8 style guide.
Integrating pyflakes (or flake8) in your editor or IDE is highly recommended, it does yield productivity gains.
Running pyflakes on the current edited file
You can bind a key to run pyflakes in the current buffer.
• In kate Menu: ‘settings -> configure kate
– In plugins enable ‘external tools’
– In external Tools’, add pyflakes:
kdialog --title "pyflakes %filename" --msgbox "$(pyflakes %filename)"
• In TextMate
2.3.1 Avoiding bugs
Menu: TextMate -> Preferences -> Advanced -> Shell variables, add a shell variable:
TM_PYCHECKER=/Library/Frameworks/Python.framework/Versions/Current/bin/pyflakes
Coding best practices to avoid getting in trouble
Then Ctrl-Shift-V is binded to a pyflakes report
2.3. Debugging code
187
2.3. Debugging code
188
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• In vim In your vimrc (binds F5 to pyflakes):
autocmd
autocmd
autocmd
autocmd
FileType
FileType
FileType
FileType
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• In
emacs
Use
the
flymake
mode
with
pyflakes,
documented
http://www.plope.com/Members/chrism/flymake-mode : add the following to your .emacs file:
python let &mp = 'echo "*** running % ***" ; pyflakes %'
tex,mp,rst,python imap <Esc>[15~ <C-O>:make!^M
tex,mp,rst,python map <Esc>[15~ :make!^M
tex,mp,rst,python set autowrite
on
(when (load "flymake" t)
(defun flymake-pyflakes-init ()
(let* ((temp-file (flymake-init-create-temp-buffer-copy
'flymake-create-temp-inplace))
(local-file (file-relative-name
temp-file
(file-name-directory buffer-file-name))))
(list "pyflakes" (list local-file))))
• In emacs In your emacs (binds F5 to pyflakes):
(defun pyflakes-thisfile () (interactive)
(compile (format "pyflakes %s" (buffer-file-name)))
)
(add-to-list 'flymake-allowed-file-name-masks
'("\\.py\\'" flymake-pyflakes-init)))
(define-minor-mode pyflakes-mode
"Toggle pyflakes mode.
With no argument, this command toggles the mode.
Non-null prefix argument turns on the mode.
Null prefix argument turns off the mode."
;; The initial value.
nil
;; The indicator for the mode line.
" Pyflakes"
;; The minor mode bindings.
'( ([f5] . pyflakes-thisfile) )
)
(add-hook 'find-file-hook 'flymake-find-file-hook)
2.3.2 Debugging workflow
If you do have a non trivial bug, this is when debugging strategies kick in. There is no silver bullet. Yet, strategies
help:
For debugging a given problem, the favorable situation is when the problem is isolated in a
small number of lines of code, outside framework or application code, with short modify-runfail cycles
(add-hook 'python-mode-hook (lambda () (pyflakes-mode t)))
1. Make it fail reliably. Find a test case that makes the code fail every time.
A type-as-go spell-checker like integration
2. Divide and Conquer. Once you have a failing test case, isolate the failing code.
• Which module.
• In vim
• Which function.
– Use the pyflakes.vim plugin:
• Which line of code.
1. download the zip file from http://www.vim.org/scripts/script.php?script_id=2441
=> isolate a small reproducible failure: a test case
2. extract the files in ~/.vim/ftplugin/python
3. Change one thing at a time and re-run the failing test case.
3. make sure your vimrc has filetype plugin indent on
4. Use the debugger to understand what is going wrong.
5. Take notes and be patient. It may take a while.
Note: Once you have gone through this process: isolated a tight piece of code reproducing the bug and fix the
bug using this piece of code, add the corresponding code to your test suite.
– Alternatively: use the syntastic plugin. This can be configured to use flake8 too and also handles
on-the-fly checking for many other languages.
2.3.3 Using the Python debugger
The python debugger, pdb: http://docs.python.org/library/pdb.html, allows you to inspect your code interactively.
Specifically it allows you to:
• View the source code.
• Walk up and down the call stack.
• Inspect values of variables.
• Modify values of variables.
• Set breakpoints.
2.3. Debugging code
189
2.3. Debugging code
190
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
r
ipdb> quit
print
Yes, print statements do work as a debugging tool. However to inspect runtime, it is often more efficient
to use the debugger.
In [3]:
Post-mortem debugging without IPython
Invoking the debugger
In some situations you cannot use IPython, for instance to debug a script that wants to be called from the
command line. In this case, you can call the script with python -m pdb script.py:
Ways to launch the debugger:
1. Postmortem, launch debugger after module errors.
2. Launch the module with the debugger.
3. Call the debugger inside the module
Postmortem
Situation: You’re working in IPython and you get a traceback.
Here we debug the file index_error.py. When running it, an IndexError is raised. Type %debug and
drop into the debugger.
In [1]: %run index_error.py
--------------------------------------------------------------------------IndexError
Traceback (most recent call last)
/home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/index_error.py in <module>()
6
7 if __name__ == '__main__':
----> 8
index_error()
9
/home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/index_error.py in index_error()
3 def index_error():
4
lst = list('foobar')
----> 5
print lst[len(lst)]
6
7 if __name__ == '__main__':
Step-by-step execution
Situation: You believe a bug exists in a module but are not sure where.
For instance we are trying to debug wiener_filtering.py. Indeed the code runs, but the filtering does not
work well.
IndexError: list index out of range
In [2]: %debug
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/index_error.py(5)index_error()
4
lst = list('foobar')
----> 5
print lst[len(lst)]
6
ipdb> list
1 """Small snippet to raise an IndexError."""
2
3 def index_error():
4
lst = list('foobar')
----> 5
print lst[len(lst)]
6
7 if __name__ == '__main__':
8
index_error()
9
• Run the script in IPython with the debugger using %run -d wiener_filtering.p :
In [1]: %run -d wiener_filtering.py
*** Blank or comment
*** Blank or comment
*** Blank or comment
Breakpoint 1 at /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_f
NOTE: Enter 'c' at the ipdb> prompt to start your script.
> <string>(1)<module>()
• Set a break point at line 34 using b 34:
ipdb> n
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_filtering.py(4)
3
1---> 4 import numpy as np
5 import scipy as sp
ipdb> len(lst)
6
ipdb> print lst[len(lst)-1]
2.3. Debugging code
$ python -m pdb index_error.py
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/index_error.py(1)<module>(
-> """Small snippet to raise an IndexError."""
(Pdb) continue
Traceback (most recent call last):
File "/usr/lib/python2.6/pdb.py", line 1296, in main
pdb._runscript(mainpyfile)
File "/usr/lib/python2.6/pdb.py", line 1215, in _runscript
self.run(statement)
File "/usr/lib/python2.6/bdb.py", line 372, in run
exec cmd in globals, locals
File "<string>", line 1, in <module>
File "index_error.py", line 8, in <module>
index_error()
File "index_error.py", line 5, in index_error
print lst[len(lst)]
IndexError: list index out of range
Uncaught exception. Entering post mortem debugging
Running 'cont' or 'step' will restart the program
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/index_error.py(5)index_err
-> print lst[len(lst)]
(Pdb)
ipdb> b 34
Breakpoint 2 at /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_f
191
2.3. Debugging code
192
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Continue execution to next breakpoint with c(ont(inue)):
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Raising exception on numerical errors
ipdb> c
When we run the wiener_filtering.py file, the following warnings are raised:
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_filtering.py(34)iterated_wiener()
In [2]: %run wiener_filtering.py
33
"""
wiener_filtering.py:40: RuntimeWarning: divide by zero encountered in divide
2--> 34
noisy_img = noisy_img
noise_level = (1 - noise/l_var )
35
denoised_img = local_mean(noisy_img, size=size)
• Step into code with n(ext) and s(tep): next jumps to the next statement in the current execution
context, while step will go across execution contexts, i.e. enable exploring inside function calls:
We can turn these warnings in exception, which enables us to do post-mortem debugging on them, and find
our problem more quickly:
In [3]: np.seterr(all='raise')
ipdb> s
Out[3]: {'divide': 'print', 'invalid': 'print', 'over': 'print', 'under': 'ignore'}
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_filtering.py(35)iterated_wiener()
In [4]: %run wiener_filtering.py
2
34
noisy_img = noisy_img
-----------------------------------------------------------------------------> 35
denoised_img = local_mean(noisy_img, size=size)
FloatingPointError
Traceback (most recent call last)
36
l_var = local_var(noisy_img, size=size)
/home/esc/anaconda/lib/python2.7/site-packages/IPython/utils/py3compat.pyc in execfile(fname,
*wh
176
else:
ipdb> n
177
filename = fname
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_filtering.py(36)iterated_wiener()
--> 178
__builtin__.execfile(filename, *where)
35
denoised_img = local_mean(noisy_img, size=size)
---> 36
l_var = local_var(noisy_img, size=size)
/home/esc/physique-cuso-python-2013/scipy-lecture-notes/advanced/debugging/wiener_filtering.py in
37
for i in range(3):
55 pl.matshow(noisy_lena[cut], cmap=pl.cm.gray)
56
---> 57 denoised_lena = iterated_wiener(noisy_lena)
58 pl.matshow(denoised_lena[cut], cmap=pl.cm.gray)
ipdb> n
59
> /home/varoquau/dev/scipy-lecture-notes/advanced/debugging_optimizing/wiener_filtering.py(37)iterated_wiener()
36
l_var = local_var(noisy_img, size=size)
/home/esc/physique-cuso-python-2013/scipy-lecture-notes/advanced/debugging/wiener_filtering.py in
---> 37
for i in range(3):
38
res = noisy_img - denoised_img
38
res = noisy_img - denoised_img
39
noise = (res**2).sum()/res.size
ipdb> print l_var
---> 40
noise_level = (1 - noise/l_var )
[[5868 5379 5316 ..., 5071 4799 5149]
41
noise_level[noise_level<0] = 0
[5013 363 437 ..., 346 262 4355]
42
denoised_img += noise_level*res
[5379 410 344 ..., 392 604 3377]
• Step a few lines and explore the local variables:
...,
[ 435 362 308 ..., 275 198 1632]
[ 548 392 290 ..., 248 263 1653]
[ 466 789 736 ..., 1835 1725 1940]]
ipdb> print l_var.min()
0
FloatingPointError: divide by zero encountered in divide
Other ways of starting a debugger
Oh dear, nothing but integers, and 0 variation. Here is our bug, we are doing integer arithmetic.
• Raising an exception as a poor man break point
If you find it tedious to note the line number to set a break point, you can simply raise an exception at the
point that you want to inspect and use IPython’s %debug. Note that in this case you cannot step or continue
the execution.
• Debugging test failures using nosetests
You can run nosetests --pdb to drop in post-mortem debugging on exceptions, and nosetests
--pdb-failure to inspect test failures using the debugger.
In addition, you can use the IPython interface for the debugger in nose by installing the nose plugin ipdbplugin. You can than pass --ipdb and --ipdb-failure options to nosetests.
• Calling the debugger explicitly
Insert the following line where you want to drop in the debugger:
import pdb; pdb.set_trace()
Warning: When running nosetests, the output is captured, and thus it seems that the debugger does not
work. Simply run the nosetests with the -s flag.
2.3. Debugging code
193
2.3. Debugging code
194
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
To debug with gdb the Python script segfault.py, we can run the script in gdb as follows
Graphical debuggers and alternatives
$ gdb python
...
(gdb) run segfault.py
Starting program: /usr/bin/python segfault.py
[Thread debugging using libthread_db enabled]
• For stepping through code and inspecting variables, you might find it more convenient to use a graphical debugger such as winpdb.
• Alternatively, pudb is a good semi-graphical debugger with a text user interface in the console.
• Also, the pydbgr project is probably worth looking at.
Program received signal SIGSEGV, Segmentation fault.
_strided_byte_copy (dst=0x8537478 "\360\343G", outstrides=4, src=
0x86c0690 <Address 0x86c0690 out of bounds>, instrides=32, N=3,
elsize=4)
at numpy/core/src/multiarray/ctors.c:365
365
_FAST_MOVE(Int32);
(gdb)
Debugger commands and interaction
l(list)
u(p)
d(own)
n(ext)
s(tep)
bt
a
!command
Lists the code at the current position
Walk up the call stack
Walk down the call stack
Execute the next line (does not go down in new functions)
Execute the next statement (goes down in new functions)
Print the call stack
Print the local variables
Execute the given Python command (by opposition to pdb commands
We get a segfault, and gdb captures it for post-mortem debugging in the C level stack (not the Python call stack).
We can debug the C call stack using gdb’s commands:
Warning: Debugger commands are not Python code
You cannot name the variables the way you want. For instance, if in you cannot override the variables in the
current frame with the same name: use different names than your local variable when typing code in the
debugger.
As you can see, right now, we are in the C code of numpy. We would like to know what is the Python code that
triggers this segfault, so we go up the stack until we hit the Python execution loop:
(gdb) up
#8 0x080ddd23 in call_function (f=
Frame 0x85371ec, for file /home/varoquau/usr/lib/python2.6/site-packages/numpy/core/arrayprint
at ../Python/ceval.c:3750
3750
../Python/ceval.c: No such file or directory.
in ../Python/ceval.c
Getting help when in the debugger
Type h or help to access the interactive help:
ipdb> help
Documented commands (type help <topic>):
========================================
EOF
bt
cont
enable jump
a
c
continue exit
l
alias cl
d
h
list
args
clear
debug
help
n
b
commands
disable
ignore next
break condition down
j
p
(gdb) up
#1 0x004af4f5 in _copy_from_same_shape (dest=<value optimized out>,
src=<value optimized out>, myfunc=0x496780 <_strided_byte_copy>,
swap=0)
at numpy/core/src/multiarray/ctors.c:748
748
myfunc(dit->dataptr, dest->strides[maxaxis],
pdef
pdoc
pinfo
pp
q
quit
r
restart
return
run
s
step
tbreak
u
unalias
unt
until
up
(gdb) up
#9 PyEval_EvalFrameEx (f=
Frame 0x85371ec, for file /home/varoquau/usr/lib/python2.6/site-packages/numpy/core/arrayprint
at ../Python/ceval.c:2412
2412
in ../Python/ceval.c
(gdb)
w
whatis
where
Once we are in the Python execution loop, we can use our special Python helper function. For instance we can
find the corresponding Python code:
Miscellaneous help topics:
==========================
exec pdb
(gdb) pyframe
/home/varoquau/usr/lib/python2.6/site-packages/numpy/core/arrayprint.py (158): _leading_trailing
(gdb)
Undocumented commands:
======================
retval rv
This is numpy code, we need to go up until we find code that we have written:
2.3.4 Debugging segmentation faults using gdb
If you have a segmentation fault, you cannot debug it with pdb, as it crashes the Python interpreter before it can
drop in the debugger. Similarly, if you have a bug in C code embedded in Python, pdb is useless. For this we turn
to the gnu debugger, gdb, available on Linux.
(gdb) up
...
(gdb) up
#34 0x080dc97a in PyEval_EvalFrameEx (f=
Frame 0x82f064c, for file segfault.py, line 11, in print_big_array (small_array=<numpy.ndarray
1630
../Python/ceval.c: No such file or directory.
in ../Python/ceval.c
(gdb) pyframe
segfault.py (12): print_big_array
Before we start with gdb, let us add a few Python-specific tools to it. For this we add a few macros to our
~/.gbdinit. The optimal choice of macro depends on your Python version and your gdb version. I have added
a simplified version in gdbinit, but feel free to read DebuggingWithGdb.
The corresponding code is:
2.3. Debugging code
2.3. Debugging code
195
196
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3. Optimize the code by profiling simple use-cases to find the bottlenecks and speeding up these bottleneck,
finding a better algorithm or implementation. Keep in mind that a trade off should be found between
profiling on a realistic example and the simplicity and speed of execution of the code. For efficient work, it
is best to work with profiling runs lasting around 10s.
def make_big_array(small_array):
big_array = stride_tricks.as_strided(small_array,
shape=(2e6, 2e6), strides=(32, 32))
return big_array
def print_big_array(small_array):
big_array = make_big_array(small_array)
2.4.2 Profiling Python code
Thus the segfault happens when printing big_array[-10:]. The reason is simply that big_array has been
allocated with its end outside the program memory.
No optimization without measuring!
• Measure: profiling, timing
• You’ll have surprises: the fastest code is not always what you think
Note: For a list of Python-specific commands defined in the gdbinit, read the source of this file.
Wrap up exercise
Timeit
The following script is well documented and hopefully legible. It seeks to answer a problem of actual interest
for numerical computing, but it does not work... Can you debug it?
Python source code: to_debug.py
In IPython, use timeit (http://docs.python.org/library/timeit.html) to time elementary operations:
In [1]: import numpy as np
In [2]: a = np.arange(1000)
2.4 Optimizing code
In [3]: %timeit a ** 2
100000 loops, best of 3: 5.73 us per loop
In [4]: %timeit a ** 2.1
1000 loops, best of 3: 154 us per loop
Donald Knuth
“Premature optimization is the root of all evil”
In [5]: %timeit a * a
100000 loops, best of 3: 5.56 us per loop
Author: Gaël Varoquaux
Use this to guide your choice between strategies.
This chapter deals with strategies to make Python code go faster.
Note: For long running calls, using %time instead of %timeit; it is less precise but faster
Prerequisites
• line_profiler
Profiler
Useful when you have a large program to profile, for example the following file:
Chapters contents
# For this example to run, you also need the 'ica.py' file
• Optimization workflow (page 197)
• Profiling Python code (page 198)
– Timeit (page 198)
– Profiler (page 198)
– Line-profiler (page 200)
• Making code go faster (page 200)
– Algorithmic optimization (page 200)
* Example of the SVD (page 200)
• Writing faster numerical code (page 201)
– Additional Links (page 203)
import numpy as np
from scipy import linalg
from ica import fastica
def test():
data = np.random.random((5000, 100))
u, s, v = linalg.svd(data)
pca = np.dot(u[:, :10].T, data)
results = fastica(pca.T, whiten=False)
if __name__ == '__main__':
test()
2.4.1 Optimization workflow
1. Make it work: write the code in a simple legible ways.
2. Make it work reliably: write automated test cases, make really sure that your algorithm is right and that if
you break it, the tests will capture the breakage.
2.4. Optimizing code
197
Note: This is a combination of two unsupervised learning techniques, principal component analysis (PCA)
and independent component analysis (ICA). PCA is a technique for dimensionality reduction, i.e. an algorithm
to explain the observed variance in your data using less dimensions. ICA is a source seperation technique, for
2.4. Optimizing code
198
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
example to unmix multiple signals that have been recorded through multiple sensors. Doing a PCA first and then
an ICA can be useful if you have more sensors than signals. For more information see: the FastICA example from
scikits-learn.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Line-profiler
The profiler tells us which function takes most of the time, but not where it is called.
For this, we use the line_profiler: in the source file, we decorate a few functions that we want to inspect with
@profile (no need to import it)
To run it, you also need to download the ica module. In IPython we can time the script:
In [1]: %run -t demo.py
@profile
def test():
data = np.random.random((5000, 100))
u, s, v = linalg.svd(data)
pca = np.dot(u[:, :10], data)
results = fastica(pca.T, whiten=False)
IPython CPU timings (estimated):
User :
14.3929 s.
System:
0.256016 s.
and profile it:
Then we run the script using the kernprof.py program, with switches -l, --line-by-line and -v,
--view to use the line-by-line profiler and view the results in addition to saving them:
In [2]: %run -p demo.py
916 function calls in 14.551 CPU seconds
$ kernprof.py -l -v demo.py
Ordered by: internal time
ncalls tottime
1
14.457
1
0.054
1
0.017
54
0.011
2
0.005
6
0.001
6
0.001
14
0.001
19
0.001
1
0.001
1
0.001
107
0.000
7
0.000
7
0.000
172
0.000
1
0.000
29
0.000
35
0.000
35
0.000
21
0.000
41
0.000
28
0.000
1
0.000
...
percall
14.457
0.054
0.017
0.000
0.002
0.000
0.000
0.000
0.000
0.001
0.001
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000
0.000
cumtime
14.479
0.054
0.021
0.011
0.005
0.001
0.001
0.001
0.001
0.008
14.551
0.001
0.004
0.002
0.000
14.551
0.000
0.000
0.001
0.001
0.000
0.000
0.008
percall
14.479
0.054
0.021
0.000
0.002
0.000
0.000
0.000
0.000
0.008
14.551
0.000
0.001
0.000
0.000
14.551
0.000
0.000
0.000
0.000
0.000
0.000
0.008
filename:lineno (function)
decomp.py:849 (svd)
{method 'random_sample' of 'mtrand.RandomState' objects}
function_base.py:645 (asarray_chkfinite)
{numpy.core._dotblas.dot}
{method 'any' of 'numpy.ndarray' objects}
ica.py:195 (gprime)
ica.py:192 (g)
{numpy.linalg.lapack_lite.dsyevd}
twodim_base.py:204 (diag)
ica.py:69 (_ica_par)
{execfile}
defmatrix.py:239 (__array_finalize__)
ica.py:58 (_sym_decorrelation)
linalg.py:841 (eigh)
{isinstance}
demo.py:1 (<module>)
numeric.py:180 (asarray)
defmatrix.py:193 (__new__)
defmatrix.py:43 (asmatrix)
defmatrix.py:287 (__mul__)
{numpy.core.multiarray.zeros}
{method 'transpose' of 'numpy.ndarray' objects}
ica.py:97 (fastica)
Wrote profile results to demo.py.lprof
Timer unit: 1e-06 s
File: demo.py
Function: test at line 5
Total time: 14.2793 s
Line #
Hits
Time Per Hit
% Time Line Contents
=========== ============ ===== ========= ======= ==== ========
5
@profile
6
def test():
7
1
19015 19015.0
0.1
data = np.random.random((5000, 100))
8
1
14242163 14242163.0
99.7
u, s, v = linalg.svd(data)
9
1
10282 10282.0
0.1
pca = np.dot(u[:10, :], data)
10
1
7799
7799.0
0.1
results = fastica(pca.T, whiten=False)
The SVD is taking all the time. We need to optimise this line.
2.4.3 Making code go faster
Once we have identified the bottlenecks, we need to make the corresponding code go faster.
Algorithmic optimization
The first thing to look for is algorithmic optimization: are there ways to compute less, or better?
Clearly the svd (in decomp.py) is what takes most of our time, a.k.a. the bottleneck. We have to find a way to
make this step go faster, or to avoid this step (algorithmic optimization). Spending time on the rest of the code is
useless.
Profiling outside of IPython, running ‘‘cProfile‘‘
Example of the SVD
Similar profiling can be done outside of IPython, simply calling the built-in Python profilers cProfile
and profile.
$
In both examples above, the SVD - Singular Value Decomposition - is what takes most of the time. Indeed, the
computational cost of this algorithm is roughly n3 in the size of the input matrix.
python -m cProfile -o demo.prof demo.py
However, in both of these example, we are not using all the output of the SVD, but only the first few rows of its
first return argument. If we use the svd implementation of scipy, we can ask for an incomplete version of the
SVD. Note that implementations of linear algebra in scipy are richer then those in numpy and should be preferred.
Using the -o switch will output the profiler results to the file demo.prof to view with an external tool.
This can be useful if you wish to process the profiler output with a visualization tool.
2.4. Optimizing code
For a high-level view of the problem, a good understanding of the maths behind the algorithm helps. However, it
is not uncommon to find simple changes, like moving computation or memory allocation outside a for loop,
that bring in big gains.
199
2.4. Optimizing code
200
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Use broadcasting (page 62) to do operations on arrays as small as possible before combining them.
In [3]: %timeit np.linalg.svd(data)
1 loops, best of 3: 14.5 s per loop
• In place operations
In [4]: from scipy import linalg
In [1]: a = np.zeros(1e7)
In [5]: %timeit linalg.svd(data)
1 loops, best of 3: 14.2 s per loop
In [2]: %timeit global a ; a = 0*a
10 loops, best of 3: 111 ms per loop
In [6]: %timeit linalg.svd(data, full_matrices=False)
1 loops, best of 3: 295 ms per loop
In [3]: %timeit global a ; a *= 0
10 loops, best of 3: 48.4 ms per loop
In [7]: %timeit np.linalg.svd(data, full_matrices=False)
1 loops, best of 3: 293 ms per loop
note: we need global a in the timeit so that it work, as it is assigning to a, and thus considers it as a
local variable.
• Be easy on the memory: use views, and not copies
We can then use this insight to optimize the previous code:
Copying big arrays is as costly as making simple numerical operations on them:
def test():
data = np.random.random((5000, 100))
u, s, v = linalg.svd(data, full_matrices=False)
pca = np.dot(u[:, :10].T, data)
results = fastica(pca.T, whiten=False)
In [1]: a = np.zeros(1e7)
In [2]: %timeit a.copy()
10 loops, best of 3: 124 ms per loop
In [1]: import demo
In [2]: %timeit demo.
demo.fastica
demo.np
demo.linalg
demo.prof
In [3]: %timeit a + 1
10 loops, best of 3: 112 ms per loop
demo.prof.pdf
demo.prof.png
demo.py
demo.py.lprof
demo.pyc
demo.test
• Beware of cache effects
Memory access is cheaper when it is grouped: accessing a big array in a continuous way is much faster than
random access. This implies amongst other things that smaller strides are faster (see CPU cache effects
(page 168)):
In [2]: %timeit demo.test()
ica.py:65: RuntimeWarning: invalid value encountered in sqrt
W = (u * np.diag(1.0/np.sqrt(s)) * u.T) * W # W = (W * W.T) ^{-1/2} * W
1 loops, best of 3: 17.5 s per loop
In [1]: c = np.zeros((1e4, 1e4), order='C')
In [2]: %timeit c.sum(axis=0)
1 loops, best of 3: 3.89 s per loop
In [3]: import demo_opt
In [4]: %timeit demo_opt.test()
1 loops, best of 3: 208 ms per loop
In [3]: %timeit c.sum(axis=1)
1 loops, best of 3: 188 ms per loop
Real incomplete SVDs, e.g. computing only the first 10 eigenvectors, can be computed with arpack, available in
scipy.sparse.linalg.eigsh.
In [4]: c.strides
Out[4]: (80000, 8)
Computational linear algebra
This is the reason why Fortran ordering or C ordering may make a big difference on operations:
For certain algorithms, many of the bottlenecks will be linear algebra computations. In this case, using the
right function to solve the right problem is key. For instance, an eigenvalue problem with a symmetric matrix
is easier to solve than with a general matrix. Also, most often, you can avoid inverting a matrix and use a
less costly (and more numerically stable) operation.
Know your computational linear algebra. When in doubt, explore scipy.linalg, and use %timeit to
try out different alternatives on your data.
In [5]: a = np.random.rand(20, 2**18)
In [6]: b = np.random.rand(20, 2**18)
In [7]: %timeit np.dot(b, a.T)
1 loops, best of 3: 194 ms per loop
In [8]: c = np.ascontiguousarray(a.T)
In [9]: %timeit np.dot(b, c)
10 loops, best of 3: 84.2 ms per loop
2.4.4 Writing faster numerical code
A complete discussion on advanced use of numpy is found in chapter Advanced Numpy (page 155), or in the
article The NumPy array: a structure for efficient numerical computation by van der Walt et al. Here we discuss
only some commonly encountered tricks to make code faster.
Note that copying the data to work around this effect may not be worth it:
In [10]: %timeit c = np.ascontiguousarray(a.T)
10 loops, best of 3: 106 ms per loop
• Vectorizing for loops
Using numexpr can be useful to automatically optimize code for such effects.
Find tricks to avoid for loops using numpy arrays. For this, masks and indices arrays can be useful.
• Use compiled code
• Broadcasting
2.4. Optimizing code
201
2.4. Optimizing code
202
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The last resort, once you are sure that all the high-level optimizations have been explored, is to transfer the
hot spots, i.e. the few lines or functions in which most of the time is spent, to compiled code. For compiled
code, the preferred option is to use Cython: it is easy to transform exiting Python code in compiled code,
and with a good use of the numpy support yields efficient code on numpy arrays, for instance by unrolling
loops.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Sparse Matrices vs. Sparse Matrix Storage Schemes
• sparse matrix is a matrix, which is almost empty
• storing all the zeros is wasteful -> store only nonzero items
• think compression
Warning: For all the above: profile and time your choices. Don’t base your optimization on theoretical
considerations.
• pros: huge memory savings
• cons: depends on actual storage scheme, (*) usually does not hold
Additional Links
Typical Applications
• If you need to profile memory usage, you could try the memory_profiler
• solution of partial differential equations (PDEs)
• If you need to profile down into C extensions, you could try using gperftools from Python with yep.
– the finite element method
• If you would like to track performace of your code across time, i.e. as you make new commits to your
repository, you could try: vbench
– mechanical engineering, electrotechnics, physics, ...
• graph theory
• If you need some interactive visualization why not try RunSnakeRun
– nonzero at (i, j) means that node i is connected to node j
• ...
2.5 Sparse Matrices in SciPy
Prerequisites
Author: Robert Cimrman
recent versions of
• numpy
• scipy
• matplotlib (optional)
2.5.1 Introduction
• ipython (the enhancements come handy)
(dense) matrix is:
• mathematical object
Sparsity Structure Visualization
• data structure for storing a 2D array of values
• spy() from matplotlib
important features:
• example plots:
• memory allocated once for all items
– usually a contiguous chunk, think NumPy ndarray
• fast access to individual items (*)
Why Sparse Matrices?
• the memory, that grows like n**2
• small example (double precision matrix):
>>> import numpy as np
>>> import matplotlib.pyplot as plt
>>> x = np.linspace(0, 1e6, 10)
>>> plt.plot(x, 8.0 * (x**2) / 1e6, lw=5)
[<matplotlib.lines.Line2D object at ...>]
>>> plt.xlabel('size n')
<matplotlib.text.Text object at ...>
>>> plt.ylabel('memory [MB]')
<matplotlib.text.Text object at ...>
2.5. Sparse Matrices in SciPy
203
2.5. Sparse Matrices in SciPy
204
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Common Methods
• all scipy.sparse classes are subclasses of spmatrix
– default implementation of arithmetic operations
* always converts to CSR
* subclasses override for efficiency
– shape, data type set/get
– nonzero indices
– format conversion, interaction with NumPy (toarray(), todense())
– ...
• attributes:
– mtx.A - same as mtx.toarray()
– mtx.T - transpose (same as mtx.transpose())
– mtx.H - Hermitian (conjugate) transpose
– mtx.real - real part of complex matrix
– mtx.imag - imaginary part of complex matrix
– mtx.size - the number of nonzeros (same as self.getnnz())
– mtx.shape - the number of rows and columns (tuple)
• data usually stored in NumPy arrays
Sparse Matrix Classes
2.5.2 Storage Schemes
Diagonal Format (DIA)
• seven sparse matrix types in scipy.sparse:
1. csc_matrix: Compressed Sparse Column format
• very simple scheme
2. csr_matrix: Compressed Sparse Row format
• diagonals in dense NumPy array of shape (n_diag, length)
3. bsr_matrix: Block Sparse Row format
– fixed length -> waste space a bit when far from main diagonal
4. lil_matrix: List of Lists format
– subclass of _data_matrix (sparse matrix classes with data attribute)
• offset for each diagonal
5. dok_matrix: Dictionary of Keys format
6. coo_matrix: COOrdinate format (aka IJV, triplet format)
– 0 is the main diagonal
7. dia_matrix: DIAgonal format
– negative offset = below
– positive offset = above
• each suitable for some tasks
• many employ sparsetools C++ module by Nathan Bell
• fast matrix * vector (sparsetools)
• assume the following is imported:
• fast and easy item-wise operations
– manipulate data array directly (fast NumPy machinery)
>>> import numpy as np
>>> import scipy.sparse as sps
>>> import matplotlib.pyplot as plt
• constructor accepts:
– dense matrix (array)
• warning for NumPy users:
– sparse matrix
– the multiplication with ‘*’ is the matrix multiplication (dot product)
– shape tuple (create empty matrix)
– not part of NumPy!
– (data, offsets) tuple
* passing a sparse matrix object to NumPy functions expecting ndarray/matrix does not work
2.5. Sparse Matrices in SciPy
205
• no slicing, no individual item access
2.5. Sparse Matrices in SciPy
206
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• use:
-2:
-3:
– rather specialized
. 6 3 .
. . 7 4
---------8
– solving PDEs by finite differences
• matrix-vector multiplication
– with an iterative solver
>>> vec = np.ones((4, ))
>>> vec
array([ 1., 1., 1., 1.])
>>> mtx * vec
array([ 12., 19.,
9., 11.])
>>> mtx.toarray() * vec
array([[ 1.,
0., 11.,
0.],
[ 5.,
2.,
0., 12.],
[ 0.,
6.,
3.,
0.],
[ 0.,
0.,
7.,
4.]])
Examples
• create some DIA matrices:
>>> data = np.array([[1, 2, 3, 4]]).repeat(3, axis=0)
>>> data
array([[1, 2, 3, 4],
[1, 2, 3, 4],
[1, 2, 3, 4]])
>>> offsets = np.array([0, -1, 2])
>>> mtx = sparse.dia_matrix((data, offsets), shape=(4, 4))
>>> mtx
<4x4 sparse matrix of type '<... 'numpy.int64'>'
with 9 stored elements (3 diagonals) in DIAgonal format>
>>> mtx.todense()
matrix([[1, 0, 3, 0],
[1, 2, 0, 4],
[0, 2, 3, 0],
[0, 0, 3, 4]])
List of Lists Format (LIL)
• row-based linked list
– each row is a Python list (sorted) of column indices of non-zero elements
– rows stored in a NumPy array (dtype=np.object)
– non-zero values data stored analogously
>>> data = np.arange(12).reshape((3, 4)) + 1
>>> data
array([[ 1, 2, 3, 4],
[ 5, 6, 7, 8],
[ 9, 10, 11, 12]])
>>> mtx = sparse.dia_matrix((data, offsets), shape=(4, 4))
>>> mtx.data
array([[ 1, 2, 3, 4],
[ 5, 6, 7, 8],
[ 9, 10, 11, 12]]...)
>>> mtx.offsets
array([ 0, -1, 2], dtype=int32)
>>> print(mtx)
(0, 0)
1
(1, 1)
2
(2, 2)
3
(3, 3)
4
(1, 0)
5
(2, 1)
6
(3, 2)
7
(0, 2)
11
(1, 3)
12
>>> mtx.todense()
matrix([[ 1, 0, 11, 0],
[ 5, 2, 0, 12],
[ 0, 6, 3, 0],
[ 0, 0, 7, 4]])
• efficient for constructing sparse matrices incrementally
• constructor accepts:
– dense matrix (array)
– sparse matrix
– shape tuple (create empty matrix)
• flexible slicing, changing sparsity structure is efficient
• slow arithmetics, slow column slicing due to being row-based
• use:
– when sparsity pattern is not known apriori or changes
– example: reading a sparse matrix from a text file
Examples
• create an empty LIL matrix:
>>> mtx = sparse.lil_matrix((4, 5))
• prepare random data:
>>> from
>>> data
>>> data
array([[
[
• explanation with a scheme:
numpy.random import rand
= np.round(rand(2, 3))
1.,
1.,
1.,
0.,
1.],
1.]])
offset: row
• assign the data using fancy indexing:
2:
1:
0:
-1:
9
--10-----1 . 11 .
5 2 . 12
2.5. Sparse Matrices in SciPy
>>> mtx[:2, [1, 2, 3]] = data
>>> mtx
<4x5 sparse matrix of type '<... 'numpy.float64'>'
with 5 stored elements in LInked List format>
207
2.5. Sparse Matrices in SciPy
208
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> print(mtx)
(0, 1) 1.0
(0, 2) 1.0
(0, 3) 1.0
(1, 1) 1.0
(1, 3) 1.0
>>> mtx.todense()
matrix([[ 0., 1.,
[ 0., 1.,
[ 0., 0.,
[ 0., 0.,
>>> mtx.toarray()
array([[ 0., 1.,
[ 0., 1.,
[ 0., 0.,
[ 0., 0.,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• can be efficiently converted to a coo_matrix once constructed
• slow arithmetics (for loops with dict.iteritems())
• use:
– when sparsity pattern is not known apriori or changes
1.,
0.,
0.,
0.,
1.,
0.,
0.,
0.,
1.,
1.,
0.,
0.,
1.,
1.,
0.,
0.,
0.],
0.],
0.],
0.]])
Examples
• create a DOK matrix element by element:
>>> mtx = sparse.dok_matrix((5, 5), dtype=np.float64)
>>> mtx
<5x5 sparse matrix of type '<... 'numpy.float64'>'
with 0 stored elements in Dictionary Of Keys format>
>>> for ir in range(5):
...
for ic in range(5):
...
mtx[ir, ic] = 1.0 * (ir != ic)
>>> mtx
<5x5 sparse matrix of type '<... 'numpy.float64'>'
with 20 stored elements in Dictionary Of Keys format>
>>> mtx.todense()
matrix([[ 0., 1., 1., 1., 1.],
[ 1., 0., 1., 1., 1.],
[ 1., 1., 0., 1., 1.],
[ 1., 1., 1., 0., 1.],
[ 1., 1., 1., 1., 0.]])
0.],
0.],
0.],
0.]])
• more slicing and indexing:
>>> mtx = sparse.lil_matrix([[0, 1, 2, 0], [3, 0, 1, 0], [1, 0, 0, 1]])
>>> mtx.todense()
matrix([[0, 1, 2, 0],
[3, 0, 1, 0],
[1, 0, 0, 1]]...)
>>> print(mtx)
(0, 1)
1
(0, 2)
2
(1, 0)
3
(1, 2)
1
(2, 0)
1
(2, 3)
1
>>> mtx[:2, :]
<2x4 sparse matrix of type '<... 'numpy.int64'>'
with 4 stored elements in LInked List format>
>>> mtx[:2, :].todense()
matrix([[0, 1, 2, 0],
[3, 0, 1, 0]]...)
>>> mtx[1:2, [0,2]].todense()
matrix([[3, 1]]...)
>>> mtx.todense()
matrix([[0, 1, 2, 0],
[3, 0, 1, 0],
[1, 0, 0, 1]]...)
• slicing and indexing:
>>> mtx[1, 1]
0.0
>>> mtx[1, 1:3]
<1x2 sparse matrix of type '<... 'numpy.float64'>'
with 1 stored elements in Dictionary Of Keys format>
>>> mtx[1, 1:3].todense()
matrix([[ 0., 1.]])
>>> mtx[[2,1], 1:3].todense()
matrix([[ 1., 0.],
[ 0., 1.]])
Coordinate Format (COO)
• also known as the ‘ijv’ or ‘triplet’ format
Dictionary of Keys Format (DOK)
– three NumPy arrays: row, col, data
• subclass of Python dict
– data[i] is value at (row[i], col[i]) position
– keys are (row, column) index tuples (no duplicate entries allowed)
– permits duplicate entries
– values are corresponding non-zero values
– subclass of _data_matrix (sparse matrix classes with data attribute)
• efficient for constructing sparse matrices incrementally
• fast format for constructing sparse matrices
• constructor accepts:
• constructor accepts:
– dense matrix (array)
– dense matrix (array)
– sparse matrix
– sparse matrix
– shape tuple (create empty matrix)
– shape tuple (create empty matrix)
• efficient O(1) access to individual elements
– (data, ij) tuple
• flexible slicing, changing sparsity structure is efficient
2.5. Sparse Matrices in SciPy
• very fast conversion to and from CSR/CSC formats
209
2.5. Sparse Matrices in SciPy
210
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• fast matrix * vector (sparsetools)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Compressed Sparse Row Format (CSR)
• fast and easy item-wise operations
• row oriented
– manipulate data array directly (fast NumPy machinery)
– three NumPy arrays: indices, indptr, data
• no slicing, no arithmetics (directly)
* indices is array of column indices
• use:
* data is array of corresponding nonzero values
– facilitates fast conversion among sparse formats
* indptr points to row starts in indices and data
– when converting to other format (usually CSR or CSC), duplicate entries are summed together
* length is n_row + 1, last item = number of values = length of both indices and data
* facilitates efficient construction of finite element matrices
* nonzero values of the i-th row are data[indptr[i]:indptr[i+1]] with column
indices indices[indptr[i]:indptr[i+1]]
Examples
* item (i, j) can be accessed as data[indptr[i]+k], where k is position of j in
indices[indptr[i]:indptr[i+1]]
• create empty COO matrix:
>>> mtx = sparse.coo_matrix((3, 4), dtype=np.int8)
>>> mtx.todense()
matrix([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)
– subclass of _cs_matrix (common CSR/CSC functionality)
* subclass of _data_matrix (sparse matrix classes with data attribute)
• fast matrix vector products and other arithmetics (sparsetools)
• constructor accepts:
• create using (data, ij) tuple:
– dense matrix (array)
>>> row = np.array([0, 3, 1, 0])
>>> col = np.array([0, 3, 1, 2])
>>> data = np.array([4, 5, 7, 9])
>>> mtx = sparse.coo_matrix((data, (row, col)), shape=(4, 4))
>>> mtx
<4x4 sparse matrix of type '<... 'numpy.int64'>'
with 4 stored elements in COOrdinate format>
>>> mtx.todense()
matrix([[4, 0, 9, 0],
[0, 7, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 5]])
– sparse matrix
– shape tuple (create empty matrix)
– (data, ij) tuple
– (data, indices, indptr) tuple
• efficient row slicing, row-oriented operations
• slow column slicing, expensive changes to the sparsity structure
• use:
– actual computations (most linear solvers support this format)
• duplicates entries are summed together:
>>> row = np.array([0, 0, 1, 3, 1, 0, 0])
>>> col = np.array([0, 2, 1, 3, 1, 0, 0])
>>> data = np.array([1, 1, 1, 1, 1, 1, 1])
>>> mtx = sparse.coo_matrix((data, (row, col)), shape=(4, 4))
>>> mtx.todense()
matrix([[3, 0, 1, 0],
[0, 2, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 1]])
Examples
• create empty CSR matrix:
>>> mtx = sparse.csr_matrix((3, 4), dtype=np.int8)
>>> mtx.todense()
matrix([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)
• create using (data, ij) tuple:
• no slicing...:
>>> row = np.array([0, 0, 1, 2, 2, 2])
>>> col = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> mtx = sparse.csr_matrix((data, (row, col)), shape=(3, 3))
>>> mtx
<3x3 sparse matrix of type '<... 'numpy.int64'>'
with 6 stored elements in Compressed Sparse Row format>
>>> mtx.todense()
matrix([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]]...)
>>> mtx.data
>>> mtx[2, 3]
Traceback (most recent call last):
...
TypeError: 'coo_matrix' object ...
Traceback (most recent call last):
...
TypeError: 'coo_matrix' object ...
2.5. Sparse Matrices in SciPy
211
2.5. Sparse Matrices in SciPy
212
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> mtx = sparse.csc_matrix((3, 4), dtype=np.int8)
>>> mtx.todense()
matrix([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)
array([1, 2, 3, 4, 5, 6]...)
>>> mtx.indices
array([0, 2, 2, 0, 1, 2], dtype=int32)
>>> mtx.indptr
array([0, 2, 3, 6], dtype=int32)
• create using (data, indices, indptr) tuple:
• create using (data, ij) tuple:
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> indices = np.array([0, 2, 2, 0, 1, 2])
>>> indptr = np.array([0, 2, 3, 6])
>>> mtx = sparse.csr_matrix((data, indices, indptr), shape=(3, 3))
>>> mtx.todense()
matrix([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]])
>>> row = np.array([0, 0, 1, 2, 2, 2])
>>> col = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> mtx = sparse.csc_matrix((data, (row, col)), shape=(3, 3))
>>> mtx
<3x3 sparse matrix of type '<... 'numpy.int64'>'
with 6 stored elements in Compressed Sparse Column format>
>>> mtx.todense()
matrix([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]]...)
>>> mtx.data
array([1, 4, 5, 2, 3, 6]...)
>>> mtx.indices
array([0, 2, 2, 0, 1, 2], dtype=int32)
>>> mtx.indptr
array([0, 2, 3, 6], dtype=int32)
Compressed Sparse Column Format (CSC)
• column oriented
– three NumPy arrays: indices, indptr, data
* indices is array of row indices
* data is array of corresponding nonzero values
• create using (data, indices, indptr) tuple:
* indptr points to column starts in indices and data
* length is n_col + 1, last item = number of values = length of both indices and data
* nonzero values of the i-th column are data[indptr[i]:indptr[i+1]] with row
indices indices[indptr[i]:indptr[i+1]]
* item (i, j) can be accessed as data[indptr[j]+k], where k is position of i in
indices[indptr[j]:indptr[j+1]]
>>> data = np.array([1, 4, 5, 2, 3, 6])
>>> indices = np.array([0, 2, 2, 0, 1, 2])
>>> indptr = np.array([0, 2, 3, 6])
>>> mtx = sparse.csc_matrix((data, indices, indptr), shape=(3, 3))
>>> mtx.todense()
matrix([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]])
– subclass of _cs_matrix (common CSR/CSC functionality)
* subclass of _data_matrix (sparse matrix classes with data attribute)
Block Compressed Row Format (BSR)
• fast matrix vector products and other arithmetics (sparsetools)
• basically a CSR with dense sub-matrices of fixed shape instead of scalar items
• constructor accepts:
– block size (R, C) must evenly divide the shape of the matrix (M, N)
– dense matrix (array)
– three NumPy arrays: indices, indptr, data
– sparse matrix
– shape tuple (create empty matrix)
* indices is array of column indices for each block
– (data, ij) tuple
* data is array of corresponding nonzero values of shape (nnz, R, C)
* ...
– (data, indices, indptr) tuple
– subclass of _cs_matrix (common CSR/CSC functionality)
• efficient column slicing, column-oriented operations
* subclass of _data_matrix (sparse matrix classes with data attribute)
• slow row slicing, expensive changes to the sparsity structure
• fast matrix vector products and other arithmetics (sparsetools)
• use:
• constructor accepts:
– actual computations (most linear solvers support this format)
– dense matrix (array)
– sparse matrix
Examples
– shape tuple (create empty matrix)
• create empty CSC matrix:
– (data, ij) tuple
2.5. Sparse Matrices in SciPy
213
2.5. Sparse Matrices in SciPy
214
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
– (data, indices, indptr) tuple
• many arithmetic operations considerably more efficient than CSR for sparse matrices with dense submatrices
>>> mtx.indptr
array([0, 2, 3, 6], dtype=int32)
• create using (data, indices, indptr) tuple with (2, 2) block size:
• use:
>>> indptr = np.array([0, 2, 3, 6])
>>> indices = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6]).repeat(4).reshape(6, 2, 2)
>>> mtx = sparse.bsr_matrix((data, indices, indptr), shape=(6, 6))
>>> mtx.todense()
matrix([[1, 1, 0, 0, 2, 2],
[1, 1, 0, 0, 2, 2],
[0, 0, 0, 0, 3, 3],
[0, 0, 0, 0, 3, 3],
[4, 4, 5, 5, 6, 6],
[4, 4, 5, 5, 6, 6]])
>>> data
array([[[1, 1],
[1, 1]],
– like CSR
– vector-valued finite element discretizations
Examples
• create empty BSR matrix with (1, 1) block size (like CSR...):
>>> mtx = sparse.bsr_matrix((3, 4), dtype=np.int8)
>>> mtx
<3x4 sparse matrix of type '<... 'numpy.int8'>'
with 0 stored elements (blocksize = 1x1) in Block Sparse Row format>
>>> mtx.todense()
matrix([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)
[[2, 2],
[2, 2]],
• create empty BSR matrix with (3, 2) block size:
[[3, 3],
[3, 3]],
>>> mtx = sparse.bsr_matrix((3, 4), blocksize=(3, 2), dtype=np.int8)
>>> mtx
<3x4 sparse matrix of type '<... 'numpy.int8'>'
with 0 stored elements (blocksize = 3x2) in Block Sparse Row format>
>>> mtx.todense()
matrix([[0, 0, 0, 0],
[0, 0, 0, 0],
[0, 0, 0, 0]], dtype=int8)
[[4, 4],
[4, 4]],
[[5, 5],
[5, 5]],
[[6, 6],
[6, 6]]])
– a bug?
• create using (data, ij) tuple with (1, 1) block size (like CSR...):
Summary
>>> row = np.array([0, 0, 1, 2, 2, 2])
>>> col = np.array([0, 2, 2, 0, 1, 2])
>>> data = np.array([1, 2, 3, 4, 5, 6])
>>> mtx = sparse.bsr_matrix((data, (row, col)), shape=(3, 3))
>>> mtx
<3x3 sparse matrix of type '<... 'numpy.int64'>'
with 6 stored elements (blocksize = 1x1) in Block Sparse Row format>
>>> mtx.todense()
matrix([[1, 0, 2],
[0, 0, 3],
[4, 5, 6]]...)
>>> mtx.data
array([[[1]],
Table 2.1: Summary of storage schemes.
format
DIA
matrix *
vector
sparsetools
get
item
.
fancy
get
.
set
item
.
fancy
set
.
LIL
via CSR
yes
yes
yes
yes
DOK
python
yes
yes
yes
COO
sparsetools
.
one axis
only
.
.
.
[[3]],
CSR
CSC
sparsetools
sparsetools
yes
yes
yes
yes
slow
slow
.
.
[[4]],
BSR
sparsetools
.
.
.
.
[[2]],
[[5]],
[[6]]]...)
>>> mtx.indices
array([0, 2, 2, 0, 1, 2], dtype=int32)
2.5. Sparse Matrices in SciPy
solvers
note
iterative
iterative
iterative
iterative
any
any
has data array, specialized
specialized
arithmetics via CSR,
incremental construction
O(1) item access, incremental
construction
has data array, facilitates fast
conversion
has data array, fast row-wise ops
has data array, fast column-wise
ops
has data array, specialized
2.5.3 Linear System Solvers
• sparse matrix/eigenvalue problem solvers live in scipy.sparse.linalg
215
2.5. Sparse Matrices in SciPy
216
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• the submodules:
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> mtx1 = mtx.astype(np.float32)
>>> x = dsolve.spsolve(mtx1, rhs, use_umfpack=False)
>>> print(x)
[ 106.
-21.
5.5
-1.5
1. ]
>>> print("Error: %s" % (mtx1 * x - rhs))
Error: [ 0. 0. 0. 0. 0.]
– dsolve: direct factorization methods for solving linear systems
– isolve: iterative methods for solving linear systems
– eigen: sparse eigenvalue problem solvers
• all solvers are accessible from:
– solve as double precision real:
>>> import scipy.sparse.linalg as spla
>>> spla.__all__
['LinearOperator', 'Tester', 'arpack', 'aslinearoperator', 'bicg',
'bicgstab', 'cg', 'cgs', 'csc_matrix', 'csr_matrix', 'dsolve',
'eigen', 'eigen_symmetric', 'factorized', 'gmres', 'interface',
'isolve', 'iterative', 'lgmres', 'linsolve', 'lobpcg', 'lsqr',
'minres', 'np', 'qmr', 'speigs', 'spilu', 'splu', 'spsolve', 'svd',
'test', 'umfpack', 'use_solver', 'utils', 'warnings']
>>> mtx2 = mtx.astype(np.float64)
>>> x = dsolve.spsolve(mtx2, rhs, use_umfpack=True)
>>> print(x)
[ 106.
-21.
5.5
-1.5
1. ]
>>> print("Error: %s" % (mtx2 * x - rhs))
Error: [ 0. 0. 0. 0. 0.]
– solve as single precision complex:
>>> mtx1 = mtx.astype(np.complex64)
>>> x = dsolve.spsolve(mtx1, rhs, use_umfpack=False)
>>> print(x)
[ 106.0+0.j -21.0+0.j
5.5+0.j
-1.5+0.j
1.0+0.j]
>>> print("Error: %s" % (mtx1 * x - rhs))
Error: [ 0.+0.j 0.+0.j 0.+0.j 0.+0.j 0.+0.j]
Sparse Direct Solvers
• default solver: SuperLU 4.0
– included in SciPy
– real and complex systems
– solve as double precision complex:
– both single and double precision
>>> mtx2 = mtx.astype(np.complex128)
>>> x = dsolve.spsolve(mtx2, rhs, use_umfpack=True)
>>> print(x)
[ 106.0+0.j -21.0+0.j
5.5+0.j
-1.5+0.j
1.0+0.j]
>>> print("Error: %s" % (mtx2 * x - rhs))
Error: [ 0.+0.j 0.+0.j 0.+0.j 0.+0.j 0.+0.j]
• optional: umfpack
– real and complex systems
– double precision only
– recommended for performance
"""
Solve a linear system
=======================
– wrappers now live in scikits.umfpack
– check-out the new scikits.suitesparse by Nathaniel Smith
Construct a 1000x1000 lil_matrix and add some values to it, convert it
to CSR format and solve A x = b for x:and solve a linear system with a
direct solver.
"""
import numpy as np
import scipy.sparse as sps
from matplotlib import pyplot as plt
from scipy.sparse.linalg.dsolve import linsolve
Examples
• import the whole module, and see its docstring:
>>> from scipy.sparse.linalg import dsolve
>>> help(dsolve)
• both superlu and umfpack can be used (if the latter is installed) as follows:
rand = np.random.rand
– prepare a linear system:
>>> import numpy as np
>>> from scipy import sparse
>>> mtx = sparse.spdiags([[1, 2, 3, 4, 5], [6, 5, 8, 9, 10]], [0, 1], 5, 5)
>>> mtx.todense()
matrix([[ 1, 5, 0, 0, 0],
[ 0, 2, 8, 0, 0],
[ 0, 0, 3, 9, 0],
[ 0, 0, 0, 4, 10],
[ 0, 0, 0, 0, 5]])
>>> rhs = np.array([1, 2, 3, 4, 5], dtype=np.float32)
– solve as single precision real:
mtx = sps.lil_matrix((1000, 1000), dtype=np.float64)
mtx[0, :100] = rand(100)
mtx[1, 100:200] = mtx[0, :100]
mtx.setdiag(rand(1000))
plt.clf()
plt.spy(mtx, marker='.', markersize=2)
plt.show()
mtx = mtx.tocsr()
rhs = rand(1000)
x = linsolve.spsolve(mtx, rhs)
print('rezidual: %r' % np.linalg.norm(mtx * x - rhs))
2.5. Sparse Matrices in SciPy
217
2.5. Sparse Matrices in SciPy
218
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• examples/direct_solve.py
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> A.matvec(np.ones(2))
array([ 2., 3.])
>>> A * np.ones(2)
array([ 2., 3.])
Iterative Solvers
• the isolve module contains the following solvers:
A Few Notes on Preconditioning
– bicg (BIConjugate Gradient)
– bicgstab (BIConjugate Gradient STABilized)
• problem specific
– cg (Conjugate Gradient) - symmetric positive definite matrices only
• often hard to develop
– cgs (Conjugate Gradient Squared)
• if not sure, try ILU
– gmres (Generalized Minimal RESidual)
– available in dsolve as spilu()
– minres (MINimum RESidual)
– qmr (Quasi-Minimal Residual)
Eigenvalue Problem Solvers
The eigen module
Common Parameters
• arpack * a collection of Fortran77 subroutines designed to solve large scale eigenvalue problems
• mandatory:
• lobpcg (Locally Optimal Block Preconditioned Conjugate Gradient Method) * works very well in combination with PyAMG * example by Nathan Bell:
A [{sparse matrix, dense matrix, LinearOperator}] The N-by-N matrix of the linear system.
b [{array, matrix}] Right hand side of the linear system. Has shape (N,) or (N,1).
"""
Compute eigenvectors and eigenvalues using a preconditioned eigensolver
========================================================================
• optional:
x0 [{array, matrix}] Starting guess for the solution.
tol [float] Relative tolerance to achieve before terminating.
maxiter [integer] Maximum number of iterations. Iteration will stop after maxiter steps even if the specified
tolerance has not been achieved.
In this example Smoothed Aggregation (SA) is used to precondition
the LOBPCG eigensolver on a two-dimensional Poisson problem with
Dirichlet boundary conditions.
"""
M [{sparse matrix, dense matrix, LinearOperator}] Preconditioner for A. The preconditioner should approximate the inverse of A. Effective preconditioning dramatically improves the rate of convergence,
which implies that fewer iterations are needed to reach a given error tolerance.
import scipy
from scipy.sparse.linalg import lobpcg
callback [function] User-supplied function to call after each iteration. It is called as callback(xk), where
xk is the current solution vector.
from pyamg import smoothed_aggregation_solver
from pyamg.gallery import poisson
N = 100
K = 9
A = poisson((N,N), format='csr')
LinearOperator Class
from scipy.sparse.linalg.interface import LinearOperator
# create the AMG hierarchy
ml = smoothed_aggregation_solver(A)
• common interface for performing matrix vector products
• useful abstraction that enables using dense and sparse matrices within the solvers, as well as matrix-free
solutions
# initial approximation to the K eigenvectors
X = scipy.rand(A.shape[0], K)
# preconditioner based on ml
M = ml.aspreconditioner()
• has shape and matvec() (+ some optional parameters)
• example:
# compute eigenvalues and eigenvectors with LOBPCG
W,V = lobpcg(A, X, M=M, tol=1e-8, largest=False)
>>> import numpy as np
>>> from scipy.sparse.linalg import LinearOperator
>>> def mv(v):
...
return np.array([2*v[0], 3*v[1]])
...
>>> A = LinearOperator((2, 2), matvec=mv)
>>> A
<2x2 LinearOperator with unspecified dtype>
2.5. Sparse Matrices in SciPy
#plot the eigenvectors
import pylab
pylab.figure(figsize=(9,9))
219
2.5. Sparse Matrices in SciPy
220
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
– http://code.google.com/p/pyamg
for i in range(K):
pylab.subplot(3, 3, i+1)
pylab.title('Eigenvector %d' % i)
pylab.pcolor(V[:,i].reshape(N,N))
pylab.axis('equal')
pylab.axis('off')
pylab.show()
• Pysparse
– own sparse matrix classes
– matrix and eigenvalue problem solvers
– http://pysparse.sourceforge.net/
– examples/pyamg_with_lobpcg.py
2.6 Image manipulation and processing using Numpy and Scipy
• example by Nils Wagner:
– examples/lobpcg_sakurai.py
Authors: Emmanuelle Gouillart, Gaël Varoquaux
• output:
This section addresses basic image manipulation and processing using the core scientific modules NumPy and
SciPy. Some of the operations covered by this tutorial may be useful for other kinds of multidimensional array
processing than image processing. In particular, the submodule scipy.ndimage provides functions operating
on n-dimensional NumPy arrays.
$ python examples/lobpcg_sakurai.py
Results by LOBPCG for n=2500
[ 0.06250083
0.06250028
0.06250007]
See also:
Exact eigenvalues
[ 0.06250005
0.0625002
For more advanced image processing and image-specific routines, see the tutorial Scikit-image: image processing
(page 324), dedicated to the skimage module.
0.06250044]
Elapsed time 7.01
Image = 2-D numerical array
(or 3-D: CT, MRI, 2D + time; 4-D, ...)
Here, image == Numpy array np.array
Tools used in this tutorial:
• numpy: basic array manipulation
• scipy: scipy.ndimage submodule dedicated to image processing (n-dimensional images). See
http://docs.scipy.org/doc/scipy/reference/tutorial/ndimage.html
>>> from scipy import ndimage
Common tasks in image processing:
• Input/Output, displaying images
• Basic manipulations: cropping, flipping, rotating, ...
• Image filtering: denoising, sharpening
• Image segmentation: labeling pixels corresponding to different objects
• Classification
• Feature extraction
• Registration
• ...
2.5.4 Other Interesting Packages
• PyAMG
– algebraic multigrid solvers
2.5. Sparse Matrices in SciPy
221
2.6. Image manipulation and processing using Numpy and Scipy
222
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Chapters contents
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> misc.imsave('lena.png', lena) # First we need to create the PNG file
• Opening and writing to image files (page 223)
• Displaying images (page 224)
• Basic manipulations (page 225)
– Statistical information (page 226)
– Geometrical transformations (page 227)
• Image filtering (page 227)
– Blurring/smoothing (page 227)
– Sharpening (page 228)
– Denoising (page 228)
– Mathematical morphology (page 229)
• Feature extraction (page 232)
– Edge detection (page 232)
– Segmentation (page 232)
• Measuring objects properties: ndimage.measurements (page 234)
>>> lena = misc.imread('lena.png')
>>> type(lena)
<... 'numpy.ndarray'>
>>> lena.shape, lena.dtype
((512, 512), dtype('uint8'))
dtype is uint8 for 8-bit images (0-255)
Opening raw files (camera, 3-D images)
>>> lena.tofile('lena.raw') # Create raw file
>>> lena_from_raw = np.fromfile('lena.raw', dtype=np.uint8)
>>> lena_from_raw.shape
(262144,)
>>> lena_from_raw.shape = (512, 512)
Need to know the shape and dtype of the image (how to separate data bytes).
For large data, use np.memmap for memory mapping:
2.6.1 Opening and writing to image files
>>> lena_memmap = np.memmap('lena.raw', dtype=np.uint8, shape=(512, 512))
Writing an array to a file:
(data are read from the file, and not loaded into memory)
Displaying Lena
================
Working on a list of image files
>>>
...
...
>>>
>>>
>>>
Small example to plot lena.
"""
from scipy import misc
l = misc.lena()
misc.imsave('lena.png', l) # uses the Image module (PIL)
import matplotlib.pyplot as plt
plt.imshow(l)
plt.show()
for i in range(10):
im = np.random.random_integers(0, 255, 10000).reshape((100, 100))
misc.imsave('random_%02d.png' % i, im)
from glob import glob
filelist = glob('random*.png')
filelist.sort()
2.6.2 Displaying images
Use matplotlib and imshow to display an image inside a matplotlib figure:
>>> l = misc.lena()
>>> import matplotlib.pyplot as plt
>>> plt.imshow(l, cmap=plt.cm.gray)
<matplotlib.image.AxesImage object at 0x...>
Increase contrast by setting min and max values:
>>> plt.imshow(l, cmap=plt.cm.gray, vmin=30, vmax=200)
<matplotlib.image.AxesImage object at 0x...>
>>> # Remove axes and ticks
>>> plt.axis('off')
(-0.5, 511.5, 511.5, -0.5)
Draw contour lines:
>>> plt.contour(l, [60, 211])
<matplotlib.contour.QuadContourSet ...>
For fine inspection of intensity variations, use interpolation=’nearest’:
>>> plt.imshow(l[200:220, 200:220], cmap=plt.cm.gray)
<matplotlib.image.AxesImage object at 0x...>
>>> plt.imshow(l[200:220, 200:220], cmap=plt.cm.gray, interpolation='nearest')
<matplotlib.image.AxesImage object at 0x...>
Creating a numpy array from an image file:
>>> from scipy import misc
>>> lena = misc.lena()
2.6. Image manipulation and processing using Numpy and Scipy
223
2.6. Image manipulation and processing using Numpy and Scipy
224
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> # Slicing
>>> lena[10:13, 20:23]
array([[158, 156, 157],
[157, 155, 155],
[157, 157, 158]])
>>> lena[100:120] = 255
>>>
>>> lx, ly = lena.shape
>>> X, Y = np.ogrid[0:lx, 0:ly]
>>> mask = (X - lx / 2) ** 2 + (Y - ly / 2) ** 2 > lx * ly / 4
>>> # Masks
>>> lena[mask] = 0
>>> # Fancy indexing
>>> lena[range(400), range(400)] = 255
3-D visualization: Mayavi
See 3D plotting with Mayavi (page 357).
• Image plane widgets
• Isosurfaces
• ...
Statistical information
>>> lena = misc.lena()
>>> lena.mean()
124.04678344726562
>>> lena.max(), lena.min()
(245, 25)
2.6.3 Basic manipulations
Images are arrays: use the whole numpy machinery.
np.histogram
>>> lena = misc.lena()
>>> lena[0, 40]
166
2.6. Image manipulation and processing using Numpy and Scipy
225
2.6. Image manipulation and processing using Numpy and Scipy
226
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise
>>>
>>>
>>>
>>>
• Open as an array the scikit-image logo (http://scikit-image.org/_static/img/logo.png), or an image that you have on your computer.
• Crop a meaningful part of the image, for example the python circle in the logo.
• Display the image array using matplotlib. Change the interpolation method and zoom to see the
difference.
• Transform your image to greyscale
• Increase the contrast of the image by changing its minimum and maximum values. Optional: use
scipy.stats.scoreatpercentile (read the docstring!) to saturate 5% of the darkest pixels
and 5% of the lightest pixels.
• Save the array to two different file formats (png, jpg, tiff)
from scipy import misc
lena = misc.lena()
blurred_lena = ndimage.gaussian_filter(lena, sigma=3)
very_blurred = ndimage.gaussian_filter(lena, sigma=5)
Uniform filter
>>> local_mean = ndimage.uniform_filter(lena, size=11)
Sharpening
Geometrical transformations
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Sharpen a blurred image:
lena = misc.lena()
lx, ly = lena.shape
# Cropping
crop_lena = lena[lx / 4: - lx / 4, ly / 4: - ly / 4]
# up <-> down flip
flip_ud_lena = np.flipud(lena)
# rotation
rotate_lena = ndimage.rotate(lena, 45)
rotate_lena_noreshape = ndimage.rotate(lena, 45, reshape=False)
>>> from scipy import misc
>>> lena = misc.lena()
>>> blurred_l = ndimage.gaussian_filter(lena, 3)
increase the weight of edges by adding an approximation of the Laplacian:
>>> filter_blurred_l = ndimage.gaussian_filter(blurred_l, 1)
>>> alpha = 30
>>> sharpened = blurred_l + alpha * (blurred_l - filter_blurred_l)
2.6.4 Image filtering
Local filters: replace the value of pixels by a function of the values of neighboring pixels.
Neighbourhood: square (choose size), disk, or more complicated structuring element.
Denoising
Noisy lena:
>>>
>>>
>>>
>>>
from scipy import misc
l = misc.lena()
l = l[230:310, 210:350]
noisy = l + 0.4 * l.std() * np.random.random(l.shape)
A Gaussian filter smoothes the noise out... and the edges as well:
Blurring/smoothing
>>> gauss_denoised = ndimage.gaussian_filter(noisy, 2)
Gaussian filter from scipy.ndimage:
2.6. Image manipulation and processing using Numpy and Scipy
227
2.6. Image manipulation and processing using Numpy and Scipy
228
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Most local linear isotropic filters blur the image (ndimage.uniform_filter)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
array([[0, 1, 0],
[1, 1, 1],
[0, 1, 0]])
A median filter preserves better the edges:
>>> med_denoised = ndimage.median_filter(noisy, 3)
Median filter: better result for straight boundaries (low curvature):
>>>
>>>
>>>
>>>
>>>
im = np.zeros((20, 20))
im[5:-5, 5:-5] = 1
im = ndimage.distance_transform_bf(im)
im_noise = im + 0.2 * np.random.randn(*im.shape)
im_med = ndimage.median_filter(im_noise, 3)
Erosion = minimum filter. Replace the value of a pixel by the minimal value covered by the structuring element.:
Other rank filter: ndimage.maximum_filter, ndimage.percentile_filter
Other local non-linear filters: Wiener (scipy.signal.wiener), etc.
Non-local filters
Exercise: denoising
•
•
•
•
Create a binary image (of 0s and 1s) with several objects (circles, ellipses, squares, or random shapes).
Add some noise (e.g., 20% of noise)
Try two different denoising methods for denoising the image: gaussian filtering and median filtering.
Compare the histograms of the two different denoised images. Which one is the closest to the histogram of the original (noise-free) image?
See also:
More denoising filters are available in skimage.denoising, see the Scikit-image: image processing
(page 324) tutorial.
>>> a = np.zeros((7,7), dtype=np.int)
>>> a[1:6, 2:5] = 1
>>> a
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> ndimage.binary_erosion(a).astype(a.dtype)
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> #Erosion removes objects smaller than the structure
>>> ndimage.binary_erosion(a, structure=np.ones((5,5))).astype(a.dtype)
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
Mathematical morphology
See http://en.wikipedia.org/wiki/Mathematical_morphology
Probe an image with a simple shape (a structuring element), and modify this image according to how the shape
locally fits or misses the image.
Structuring element:
>>> el = ndimage.generate_binary_structure(2, 1)
>>> el
array([[False, True, False],
[ True, True, True],
[False, True, False]], dtype=bool)
>>> el.astype(np.int)
2.6. Image manipulation and processing using Numpy and Scipy
Dilation: maximum filter:
229
2.6. Image manipulation and processing using Numpy and Scipy
230
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> a = np.zeros((5, 5))
>>> a[2, 2] = 1
>>> a
array([[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.]])
>>> ndimage.binary_dilation(a).astype(a.dtype)
array([[ 0., 0., 0., 0., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 1., 1., 1., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 0., 0., 0., 0.]])
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>>
>>>
>>>
>>>
>>>
square = np.zeros((32, 32))
square[10:-10, 10:-10] = 1
np.random.seed(2)
x, y = (32*np.random.random((2, 20))).astype(np.int)
square[x, y] = 1
>>> open_square = ndimage.binary_opening(square)
>>> eroded_square = ndimage.binary_erosion(square)
>>> reconstruction = ndimage.binary_propagation(eroded_square, mask=square)
Also works for grey-valued images:
>>>
>>>
>>>
>>>
np.random.seed(2)
im = np.zeros((64, 64))
x, y = (63*np.random.random((2, 8))).astype(np.int)
im[x, y] = np.arange(8)
Closing: dilation + erosion
Many other mathematical morphology operations: hit and miss transform, tophat, etc.
>>> bigger_points = ndimage.grey_dilation(im, size=(5, 5), structure=np.ones((5, 5)))
>>>
>>>
>>>
>>>
...
square = np.zeros((16, 16))
square[4:-4, 4:-4] = 1
dist = ndimage.distance_transform_bf(square)
dilate_dist = ndimage.grey_dilation(dist, size=(3, 3), \
structure=np.ones((3, 3)))
2.6.5 Feature extraction
Edge detection
Synthetic data:
>>>
>>>
>>>
>>>
>>>
im = np.zeros((256, 256))
im[64:-64, 64:-64] = 1
im = ndimage.rotate(im, 15, mode='constant')
im = ndimage.gaussian_filter(im, 8)
Opening: erosion + dilation:
Use a gradient operator (Sobel) to find high intensity variations:
>>> a = np.zeros((5,5), dtype=np.int)
>>> a[1:4, 1:4] = 1; a[4, 4] = 1
>>> a
array([[0, 0, 0, 0, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 0, 0, 0, 1]])
>>> # Opening removes small objects
>>> ndimage.binary_opening(a, structure=np.ones((3,3))).astype(np.int)
array([[0, 0, 0, 0, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 0, 0, 0, 0]])
>>> # Opening can also smooth corners
>>> ndimage.binary_opening(a).astype(np.int)
array([[0, 0, 0, 0, 0],
[0, 0, 1, 0, 0],
[0, 1, 1, 1, 0],
[0, 0, 1, 0, 0],
[0, 0, 0, 0, 0]])
>>> sx = ndimage.sobel(im, axis=0, mode='constant')
>>> sy = ndimage.sobel(im, axis=1, mode='constant')
>>> sob = np.hypot(sx, sy)
Segmentation
• Histogram-based segmentation (no spatial information)
>>>
>>>
>>>
>>>
>>>
>>>
>>>
Application: remove noise:
2.6. Image manipulation and processing using Numpy and Scipy
n = 10
l = 256
im = np.zeros((l, l))
np.random.seed(1)
points = l*np.random.random((2, n**2))
im[(points[0]).astype(np.int), (points[1]).astype(np.int)] = 1
im = ndimage.gaussian_filter(im, sigma=l/(4.*n))
>>> mask = (im > im.mean()).astype(np.float)
>>> mask += 0.1 * im
231
2.6. Image manipulation and processing using Numpy and Scipy
232
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> img = mask + 0.2*np.random.randn(*mask.shape)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> from sklearn.feature_extraction import image
>>> from sklearn.cluster import spectral_clustering
>>> hist, bin_edges = np.histogram(img, bins=60)
>>> bin_centers = 0.5*(bin_edges[:-1] + bin_edges[1:])
>>> l = 100
>>> x, y = np.indices((l, l))
>>> binary_img = img > 0.5
Use mathematical morphology to clean up the result:
>>>
>>>
>>>
>>>
# Remove small white regions
open_img = ndimage.binary_opening(binary_img)
# Remove small black hole
close_img = ndimage.binary_closing(open_img)
>>>
>>>
>>>
>>>
>>>
center1 = (28, 24)
center2 = (40, 50)
center3 = (67, 58)
center4 = (24, 70)
radius1, radius2, radius3, radius4 = 16, 14, 15, 14
>>>
>>>
>>>
>>>
circle1
circle2
circle3
circle4
>>>
>>>
>>>
>>>
# 4 circles
img = circle1 + circle2 + circle3 + circle4
mask = img.astype(bool)
img = img.astype(float)
>>>
>>>
>>>
>>>
img += 1 + 0.2*np.random.randn(*img.shape)
# Convert the image into a graph with the value of the gradient on
# the edges.
graph = image.img_to_graph(img, mask=mask)
=
=
=
=
(x
(x
(x
(x
-
center1[0])**2
center2[0])**2
center3[0])**2
center4[0])**2
+
+
+
+
(y
(y
(y
(y
-
center1[1])**2
center2[1])**2
center3[1])**2
center4[1])**2
<
<
<
<
radius1**2
radius2**2
radius3**2
radius4**2
>>> # Take a decreasing function of the gradient: we take it weakly
>>> # dependant from the gradient the segmentation is close to a voronoi
>>> graph.data = np.exp(-graph.data/graph.data.std())
>>> labels = spectral_clustering(graph, n_clusters=4, eigen_solver='arpack')
>>> label_im = -np.ones(mask.shape)
>>> label_im[mask] = labels
Exercise
Check that reconstruction operations (erosion + propagation) produce a better result than opening/closing:
>>> eroded_img = ndimage.binary_erosion(binary_img)
>>> reconstruct_img = ndimage.binary_propagation(eroded_img, mask=binary_img)
>>> tmp = np.logical_not(reconstruct_img)
>>> eroded_tmp = ndimage.binary_erosion(tmp)
>>> reconstruct_final = np.logical_not(ndimage.binary_propagation(eroded_tmp, mask=tmp))
>>> np.abs(mask - close_img).mean()
0.00727836...
>>> np.abs(mask - reconstruct_final).mean()
0.00059502...
Exercise
Check how a first denoising step (e.g. with a median filter) modifies the histogram, and check that the
resulting histogram-based segmentation is more accurate.
2.6.6 Measuring objects properties: ndimage.measurements
See also:
More advanced segmentation algorithms are found in the scikit-image: see Scikit-image: image processing
(page 324).
See also:
Other Scientific Packages provide algorithms that can be useful for image processing. In this example, we use the
spectral clustering function of the scikit-learn in order to segment glued objects.
2.6. Image manipulation and processing using Numpy and Scipy
233
Synthetic data:
>>>
>>>
>>>
>>>
>>>
n = 10
l = 256
im = np.zeros((l, l))
points = l*np.random.random((2, n**2))
im[(points[0]).astype(np.int), (points[1]).astype(np.int)] = 1
2.6. Image manipulation and processing using Numpy and Scipy
234
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> im = ndimage.gaussian_filter(im, sigma=l/(4.*n))
>>> mask = im > im.mean()
• Analysis of connected components
Label connected components: ndimage.label:
>>> label_im, nb_labels = ndimage.label(mask)
>>> nb_labels # how many regions?
16
>>> plt.imshow(label_im)
<matplotlib.image.AxesImage object at 0x...>
Compute size, mean_value, etc. of each region:
>>> sizes = ndimage.sum(mask, label_im, range(nb_labels + 1))
>>> mean_vals = ndimage.sum(im, label_im, range(1, nb_labels + 1))
Clean up small connect components:
>>> mask_size = sizes < 1000
>>> remove_pixel = mask_size[label_im]
>>> remove_pixel.shape
(256, 256)
>>> label_im[remove_pixel] = 0
>>> plt.imshow(label_im)
<matplotlib.image.AxesImage object at 0x...>
Now reassign labels with np.searchsorted:
>>> labels = np.unique(label_im)
>>> label_im = np.searchsorted(labels, label_im)
Find region of interest enclosing object:
>>> slice_x, slice_y = ndimage.find_objects(label_im==4)[0]
>>> roi = im[slice_x, slice_y]
>>> plt.imshow(roi)
<matplotlib.image.AxesImage object at 0x...>
Other spatial measures: ndimage.center_of_mass, ndimage.maximum_position, etc.
Can be used outside the limited scope of segmentation applications.
Example: block mean:
>>>
>>>
>>>
>>>
>>>
>>>
from scipy import misc
l = misc.lena()
sx, sy = l.shape
X, Y = np.ogrid[0:sx, 0:sy]
regions = (sy//6) * (X//4) + (Y//6) # note that we use broadcasting
block_mean = ndimage.mean(l, labels=regions, index=np.arange(1,
2.6. Image manipulation and processing using Numpy and Scipy
235
2.6. Image manipulation and processing using Numpy and Scipy
236
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Correlation function, Fourier/wavelet spectrum, etc.
...
regions.max() +1))
>>> block_mean.shape = (sx // 4, sy // 6)
One example with mathematical morphology: granulometry (http://en.wikipedia.org/wiki/Granulometry_%28morphology%29)
When regions are regular blocks, it is more efficient to use stride tricks (Example: fake dimensions with strides
(page 165)).
Non-regularly-spaced blocks: radial mean:
>>>
>>>
>>>
>>>
>>>
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>>
...
...
...
...
...
...
>>>
>>>
...
...
...
...
...
...
...
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
def disk_structure(n):
struct = np.zeros((2 * n + 1, 2 * n + 1))
x, y = np.indices((2 * n + 1, 2 * n + 1))
mask = (x - n)**2 + (y - n)**2 <= n**2
struct[mask] = 1
return struct.astype(np.bool)
def granulometry(data, sizes=None):
s = max(data.shape)
if sizes == None:
sizes = range(1, s/2, 2)
granulo = [ndimage.binary_opening(data, \
structure=disk_structure(n)).sum() for n in sizes]
return granulo
np.random.seed(1)
n = 10
l = 256
im = np.zeros((l, l))
points = l*np.random.random((2, n**2))
im[(points[0]).astype(np.int), (points[1]).astype(np.int)] = 1
im = ndimage.gaussian_filter(im, sigma=l/(4.*n))
mask = im > im.mean()
granulo = granulometry(mask, sizes=np.arange(2, 19, 4))
sx, sy = l.shape
X, Y = np.ogrid[0:sx, 0:sy]
r = np.hypot(X - sx/2, Y - sy/2)
rbin = (20* r/r.max()).astype(np.int)
radial_mean = ndimage.mean(l, labels=rbin, index=np.arange(1, rbin.max() +1))
See also:
More on image-processing:
• The chapter on Scikit-image (page 324)
• Other, more powerful and complete modules: OpenCV (Python bindings), CellProfiler, ITK with Python
bindings
• Other measures
2.6. Image manipulation and processing using Numpy and Scipy
237
2.6. Image manipulation and processing using Numpy and Scipy
238
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
2.7 Mathematical optimization: finding minima of functions
Dimensionality of the problem
Authors: Gaël Varoquaux
Mathematical optimization deals with the problem of finding numerically minimums (or maximums or zeros) of
a function. In this context, the function is called cost function, or objective function, or energy.
Here, we are interested in using scipy.optimize for black-box optimization: we do not rely on the mathematical expression of the function that we are optimizing. Note that this expression can often be used for more
efficient, non black-box, optimization.
The scale of an optimization problem is pretty much set by the dimensionality of the problem, i.e. the number
of scalar variables on which the search is performed.
Convex versus non-convex optimization
Prerequisites
• Numpy, Scipy
• IPython
• matplotlib
References
Mathematical optimization is very ... mathematical. If you want performance, it really pays to read the
books:
• Convex Optimization by Boyd and Vandenberghe (pdf available free online).
• Numerical Optimization, by Nocedal and Wright. Detailed reference on gradient descent methods.
• Practical Methods of Optimization by Fletcher: good at hand-waving explainations.
A convex function:
• f is above all its tangents.
• equivalently, for two point A, B, f(C) lies below
the segment [f(A), f(B])], if A < C < B
Chapters contents
• Knowing your problem (page 239)
– Convex versus non-convex optimization (page 240)
– Smooth and non-smooth problems (page 240)
– Noisy versus exact cost functions (page 241)
– Constraints (page 241)
• A review of the different optimizers (page 241)
– Getting started: 1D optimization (page 241)
– Gradient based methods (page 242)
– Newton and quasi-newton methods (page 244)
– Gradient-less methods (page 246)
– Global optimizers (page 248)
• Practical guide to optimization with scipy (page 248)
– Choosing a method (page 248)
– Making your optimizer faster (page 249)
– Computing gradients (page 249)
– Synthetic exercices (page 249)
• Special case: non-linear least-squares (page 250)
– Minimizing the norm of a vector function (page 250)
– Curve fitting (page 251)
• Optimization with constraints (page 251)
– Box bounds (page 251)
– General constraints (page 252)
A non-convex function
Optimizing convex functions is easy. Optimizing non-convex functions can be very hard.
Note: It can be proven that for a convex function a local minimum is also a global minimum. Then, in some
sense, the minimum is unique.
Smooth and non-smooth problems
2.7.1 Knowing your problem
Not all optimization problems are equal. Knowing your problem enables you to choose the right tool.
2.7. Mathematical optimization: finding minima of functions
A smooth function:
The gradient is defined everywhere, and is a continuous function
239
A non-smooth function
2.7. Mathematical optimization: finding minima of functions
240
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Optimizing smooth functions is easier (true in the context of black-box optimization, otherwise Linear Programming is an example of methods which deal very efficiently with piece-wise linear functions).
Noisy versus exact cost functions
Brent’s method on a quadratic function: it converges
in 3 iterations, as the quadratic approximation is then
exact.
Brent’s method on a non-convex function: note that
the fact that the optimizer avoided the local minimum is a
matter of luck.
Noisy gradients
>>> from scipy import optimize
>>> def f(x):
...
return -np.exp(-(x - .7)**2)
>>> x_min = optimize.brent(f) # It actually converges in 9 iterations!
>>> x_min
0.699999999...
>>> x_min - .7
-2.1605...e-10
Many optimization methods rely on gradients of the objective function. If the gradient function is not given,
they are computed numerically, which induces errors. In such situation, even if the objective function is not
noisy,
Note:
Brent’s method can also be used for optimization constrained to an interval using
scipy.optimize.fminbound()
Noisy (blue) and non-noisy (green) functions
Note: In scipy 0.11, scipy.optimize.minimize_scalar() gives a generic interface to 1D scalar minimization
Constraints
Gradient based methods
Some intuitions about gradient descent
Here we focus on intuitions, not code. Code will follow.
Gradient descent basically consists in taking small steps in the direction of the gradient, that is the direction of the
steepest descent.
Table 2.2: Fixed step gradient descent
Optimizations under constraints
Here:
−1 < x1 < 1
−1 < x2 < 1
A well-conditionned quadratic function.
2.7.2 A review of the different optimizers
Getting started: 1D optimization
Use scipy.optimize.brent() to minimize 1D functions. It combines a bracketing strategy with a parabolic
approximation.
An ill-conditionned quadratic function.
The core problem of gradient-methods on ill-conditioned
problems is that the gradient tends not to point in the direction
of the minimum.
We can see that very anisotropic (ill-conditionned) functions are harder to optimize.
2.7. Mathematical optimization: finding minima of functions
241
2.7. Mathematical optimization: finding minima of functions
242
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The conjugate gradient solves this problem by adding a friction term: each step depends on the two last values of
the gradient and sharp turns are reduced.
Take home message: conditioning number and preconditioning
If you know natural scaling for your variables, prescale them so that they behave similarly. This is related to
preconditioning.
Table 2.4: Conjugate gradient descent
Also, it clearly can be advantageous to take bigger steps. This is done in gradient descent code using a line search.
Table 2.3: Adaptive step gradient descent
An ill-conditionned
non-quadratic function.
A well-conditionned quadratic
function.
An ill-conditionned very
non-quadratic function.
Methods based on conjugate gradient are named with ‘cg’ in scipy. The simple conjugate gradient method to
minimize a function is scipy.optimize.fmin_cg():
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> optimize.fmin_cg(f, [2, 2])
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 13
Function evaluations: 120
Gradient evaluations: 30
array([ 0.99998968, 0.99997855])
An ill-conditionned quadratic
function.
These methods need the gradient of the function. They can compute it, but will perform better if you can pass
them the gradient:
An ill-conditionned
non-quadratic function.
>>> def fprime(x):
...
return np.array((-2*.5*(1 - x[0]) - 4*x[0]*(x[1] - x[0]**2), 2*(x[1] - x[0]**2)))
>>> optimize.fmin_cg(f, [2, 2], fprime=fprime)
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 13
Function evaluations: 30
Gradient evaluations: 30
array([ 0.99999199, 0.99998336])
An ill-conditionned very
non-quadratic function.
Note that the function has only been evaluated 30 times, compared to 120 without the gradient.
The more a function looks like a quadratic function (elliptic iso-curves), the easier it is to optimize.
Newton and quasi-newton methods
Conjugate gradient descent
Newton methods: using the Hessian (2nd differential)
The gradient descent algorithms above are toys not to be used on real problems.
As can be seen from the above experiments, one of the problems of the simple gradient descent algorithms, is that
it tends to oscillate across a valley, each time following the direction of the gradient, that makes it cross the valley.
Newton methods use a local quadratic approximation to compute the jump direction. For this purpose, they rely
on the 2 first derivative of the function: the gradient and the Hessian.
2.7. Mathematical optimization: finding minima of functions
2.7. Mathematical optimization: finding minima of functions
243
244
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Quasi-Newton methods: approximating the Hessian on the fly
BFGS: BFGS (Broyden-Fletcher-Goldfarb-Shanno algorithm) refines at each step an approximation of the Hessian.
An ill-conditionned quadratic function:
Note that, as the quadratic approximation is exact, the Newton
method is blazing fast
An ill-conditionned quadratic function:
On a exactly quadratic function, BFGS is not as fast as
Newton’s method, but still very fast.
An ill-conditionned non-quadratic function:
Here we are optimizing a Gaussian, which is always below its
quadratic approximation. As a result, the Newton method
overshoots and leads to oscillations.
An ill-conditionned non-quadratic function:
Here BFGS does better than Newton, as its empirical estimate
of the curvature is better than that given by the Hessian.
An ill-conditionned very non-quadratic function:
In scipy, the Newton method for optimization is implemented in scipy.optimize.fmin_ncg() (cg here
refers to that fact that an inner operation, the inversion of the Hessian, is performed by conjugate gradient).
scipy.optimize.fmin_tnc() can be use for constraint problems, although it is less versatile:
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> def fprime(x):
...
return np.array((-2*.5*(1 - x[0]) - 4*x[0]*(x[1] - x[0]**2), 2*(x[1] - x[0]**2)))
>>> optimize.fmin_ncg(f, [2, 2], fprime=fprime)
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 9
Function evaluations: 11
Gradient evaluations: 51
Hessian evaluations: 0
array([ 1., 1.])
Note that compared to a conjugate gradient (above), Newton’s method has required less function evaluations, but
more gradient evaluations, as it uses it to approximate the Hessian. Let’s compute the Hessian and pass it to the
algorithm:
An ill-conditionned very non-quadratic function:
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> def fprime(x):
...
return np.array((-2*.5*(1 - x[0]) - 4*x[0]*(x[1] - x[0]**2), 2*(x[1] - x[0]**2)))
>>> optimize.fmin_bfgs(f, [2, 2], fprime=fprime)
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 16
Function evaluations: 24
Gradient evaluations: 24
array([ 1.00000017, 1.00000026])
L-BFGS: Limited-memory BFGS Sits between BFGS and conjugate gradient: in very high dimensions (> 250)
the Hessian matrix is too costly to compute and invert. L-BFGS keeps a low-rank version. In addition, the scipy
version, scipy.optimize.fmin_l_bfgs_b(), includes box bounds:
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> def fprime(x):
...
return np.array((-2*.5*(1 - x[0]) - 4*x[0]*(x[1] - x[0]**2), 2*(x[1] - x[0]**2)))
>>> optimize.fmin_l_bfgs_b(f, [2, 2], fprime=fprime)
(array([ 1.00000005, 1.00000009]), 1.4417677473011859e-15, {...})
>>> def hessian(x): # Computed with sympy
...
return np.array(((1 - 4*x[1] + 12*x[0]**2, -4*x[0]), (-4*x[0], 2)))
>>> optimize.fmin_ncg(f, [2, 2], fprime=fprime, fhess=hessian)
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 9
Function evaluations: 11
Gradient evaluations: 19
Hessian evaluations: 9
array([ 1., 1.])
Note: If you do not specify the gradient to the L-BFGS solver, you need to add approx_grad=1
Gradient-less methods
Note: At very high-dimension, the inversion of the Hessian can be costly and unstable (large scale > 250).
A shooting method: the Powell algorithm
Note: Newton optimizers should not to be confused with Newton’s root finding method, based on the same
principles, scipy.optimize.newton().
Almost a gradient approach
2.7. Mathematical optimization: finding minima of functions
2.7. Mathematical optimization: finding minima of functions
245
246
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Global optimizers
If your problem does not admit a unique local minimum (which can be hard to test unless the function is convex),
and you do not have prior information to initialize the optimization close to the solution, you may need a global
optimizer.
An ill-conditionned quadratic function:
Powell’s method isn’t too sensitive to local
ill-conditionning in low dimensions
Brute force: a grid search
scipy.optimize.brute() evaluates the function on a given grid of parameters and returns the parameters
corresponding to the minimum value. The parameters are specified with ranges given to numpy.mgrid. By
default, 20 steps are taken in each direction:
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> optimize.brute(f, ((-1, 2), (-1, 2)))
array([ 1.00001462, 1.00001547])
An ill-conditionned very non-quadratic function:
Simplex method: the Nelder-Mead
The Nelder-Mead algorithms is a generalization of dichotomy approaches to high-dimensional spaces. The algorithm works by refining a simplex, the generalization of intervals and triangles to high-dimensional spaces, to
bracket the minimum.
Strong points: it is robust to noise, as it does not rely on computing gradients. Thus it can work on functions that
are not locally smooth such as experimental data points, as long as they display a large-scale bell-shape behavior.
However it is slower than gradient-based methods on smooth, non-noisy functions.
2.7.3 Practical guide to optimization with scipy
Choosing a method
An ill-conditionned
non-quadratic function:
Without knowledge of the gradient
• In general, prefer BFGS (scipy.optimize.fmin_bfgs()) or L-BFGS
(scipy.optimize.fmin_l_bfgs_b()), even if you have to approximate numerically gradients
An ill-conditionned very
non-quadratic function:
• On well-conditioned problems, Powell (scipy.optimize.fmin_powell()) and
Nelder-Mead (scipy.optimize.fmin()), both gradient-free methods, work well in
high dimension, but they collapse for ill-conditioned problems.
In scipy, scipy.optimize.fmin() implements the Nelder-Mead approach:
>>> def f(x):
# The rosenbrock function
...
return .5*(1 - x[0])**2 + (x[1] - x[0]**2)**2
>>> optimize.fmin(f, [2, 2])
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 46
Function evaluations: 91
array([ 0.99998568, 0.99996682])
With knowledge of the gradient
• BFGS
(scipy.optimize.fmin_bfgs())
(scipy.optimize.fmin_l_bfgs_b()).
or
L-BFGS
• Computational overhead of BFGS is larger than that L-BFGS, itself larger than that of
conjugate gradient. On the other side, BFGS usually needs less function evaluations than
CG. Thus conjugate gradient method is better than BFGS at optimizing computationally
cheap functions.
With the Hessian
• If
you
can
compute
the
Hessian,
(scipy.optimize.fmin_ncg()).
2.7. Mathematical optimization: finding minima of functions
247
prefer
2.7. Mathematical optimization: finding minima of functions
the
Newton
method
248
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
If you have noisy measurements
• Use
Nelder-Mead
(scipy.optimize.fmin())
(scipy.optimize.fmin_powell()).
or
Exercice: A locally flat minimum
Powell
Consider the function exp(-1/(.1*x**2 + y**2). This function admits a minimum in (0, 0). Starting
from an initialization at (1, 1), try to get within 1e-8 of this minimum point.
Making your optimizer faster
• Choose the right method (see above), do compute analytically the gradient and Hessian, if you can.
• Use preconditionning when possible.
• Choose your initialization points wisely. For instance, if you are running many similar optimizations, warmrestart one with the results of another.
• Relax the tolerance if you don’t need precision
Computing gradients
Computing gradients, and even more Hessians, is very tedious but worth the effort. Symbolic computation with
Sympy (page 318) may come in handy.
Warning: A very common source of optimization not converging well is human error in the computation of
the gradient. You can use scipy.optimize.check_grad() to check that your gradient is correct. It
returns the norm of the different between the gradient given, and a gradient computed numerically:
>>> optimize.check_grad(f, fprime, [2, 2])
2.384185791015625e-07
2.7.4 Special case: non-linear least-squares
Minimizing the norm of a vector function
Least square problems, minimizing the norm of a vector function, have a specific structure that can be used in the
Levenberg–Marquardt algorithm implemented in scipy.optimize.leastsq().
See also scipy.optimize.approx_fprime() to find your errors.
Lets try to minimize the norm of the following vectorial function:
>>> def f(x):
...
return np.arctan(x) - np.arctan(np.linspace(0, 1, len(x)))
Synthetic exercices
>>> x0 = np.zeros(10)
>>> optimize.leastsq(f, x0)
(array([ 0.
, 0.11111111, 0.22222222, 0.33333333, 0.44444444,
0.55555556, 0.66666667, 0.77777778, 0.88888889, 1.
]), 2)
This took 67 function evaluations (check it with ‘full_output=1’). What if we compute the norm ourselves and use
a good generic optimizer (BFGS):
>>> def g(x):
...
return np.sum(f(x)**2)
>>> optimize.fmin_bfgs(g, x0)
Optimization terminated successfully.
Current function value: 0.000000
Iterations: 11
Function evaluations: 144
Gradient evaluations: 12
array([ -7.4...-09,
1.1...e-01,
2.2...e-01,
3.3...e-01,
4.4...e-01,
5.5...e-01,
6.6...e-01,
7.7...e-01,
8.8...e-01,
1.0...e+00])
Exercice: A simple (?) quadratic function
Optimize the following function, using K[0] as a starting point:
np.random.seed(0)
K = np.random.normal(size=(100, 100))
def f(x):
return np.sum((np.dot(K, x - 1))**2) + np.sum(x**2)**2
BFGS needs more function calls, and gives a less precise result.
Time your approach. Find the fastest approach. Why is BFGS not working well?
Note: leastsq is interesting compared to BFGS only if the dimensionality of the output vector is large, and
larger than the number of parameters to optimize.
Warning:
If the function is linear, this is a linear-algebra problem, and should be solved with
scipy.linalg.lstsq().
2.7. Mathematical optimization: finding minima of functions
249
2.7. Mathematical optimization: finding minima of functions
250
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Curve fitting
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• scipy.optimize.fmin_l_bfgs_b() a quasi-Newton (page 246) method with bound constraints:
>>> def f(x):
...
return np.sqrt((x[0] - 3)**2 + (x[1] - 2)**2)
>>> optimize.fmin_l_bfgs_b(f, np.array([0, 0]), approx_grad=1, bounds=((-1.5, 1.5), (-1.5, 1.
(array([ 1.5, 1.5]), 1.5811388300841898, {...})
General constraints
Equality and inequality constraints specified as functions: f(x) = 0 and g(x)< 0.
• scipy.optimize.fmin_slsqp() Sequential least square programming: equality and inequality con-
Least square problems occur often when fitting a nonlinear to data. While it is possible to construct our optimization problem ourselves, scipy provides a helper
function for this purpose: scipy.optimize.curve_fit():
.. Comment to make doctest pass
>>> np.random.seed(0)
>>> def f(t, omega, phi):
...
return np.cos(omega * t + phi)
straints:
>>> def f(x):
...
return np.sqrt((x[0] - 3)**2 + (x[1] - 2)**2)
>>> x = np.linspace(0, 3, 50)
>>> y = f(x, 1.5, 1) + .1*np.random.normal(size=50)
>>> def constraint(x):
...
return np.atleast_1d(1.5 - np.sum(np.abs(x)))
>>> optimize.curve_fit(f, x, y)
(array([ 1.51854577, 0.92665541]), array([[ 0.00037994, -0.00056796],
[-0.00056796, 0.00123978]]))
>>> optimize.fmin_slsqp(f, np.array([0, 0]), ieqcons=[constraint, ])
Optimization terminated successfully.
(Exit mode 0)
Current function value: 2.47487373504
Iterations: 5
Function evaluations: 20
Gradient evaluations: 5
array([ 1.25004696, 0.24995304])
Exercise
Do the same with omega = 3. What is the difficulty?
• scipy.optimize.fmin_cobyla() Constraints optimization by linear approximation: inequality
constraints only:
2.7.5 Optimization with constraints
>>> optimize.fmin_cobyla(f, np.array([0, 0]), cons=constraint)
array([ 1.25009622, 0.24990378])
Box bounds
Box bounds correspond to limiting each of the individual parameters of the optimization. Note that some
problems that are not originally written as box bounds can be rewritten as such via change of variables.
Warning: The above problem is known as the Lasso problem in statistics, and there exists very efficient
solvers for it (for instance in scikit-learn). In general do not use generic solvers when specific ones exist.
Lagrange multipliers
If you are ready to do a bit of math, many constrained optimization problems can be converted to nonconstrained optimization problems using a mathematical trick known as Lagrange multipliers.
2.8 Interfacing with C
Author: Valentin Haenel
• scipy.optimize.fminbound() for 1D-optimization
2.7. Mathematical optimization: finding minima of functions
251
2.8. Interfacing with C
252
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
This chapter contains an introduction to the many different routes for making your native code (primarily C/C++)
available from Python, a process commonly referred to wrapping. The goal of this chapter is to give you a
flavour of what technologies exist and what their respective merits and shortcomings are, so that you can select
the appropriate one for your specific needs. In any case, once you do start wrapping, you almost certainly will
want to consult the respective documentation for your selected technique.
• You will need a C compiler for most of the examples.
2.8.2 Python-C-Api
The Python-C-API is the backbone of the standard Python interpreter (a.k.a CPython). Using this API it is possible
to write Python extension module in C and C++. Obviously, these extension modules can, by virtue of language
compatibility, call any function written in C or C++.
Chapters contents
•
•
•
•
•
•
•
•
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Introduction (page 253)
Python-C-Api (page 254)
Ctypes (page 258)
SWIG (page 261)
Cython (page 265)
Summary (page 269)
Further Reading and References (page 269)
Exercises (page 269)
When using the Python-C-API, one usually writes much boilerplate code, first to parse the arguments that were
given to a function, and later to construct the return type.
Advantages
• Requires no additional libraries
• Lots of low-level control
• Entirely usable from C++
Disadvantages
• May require a substantial amount of effort
2.8.1 Introduction
• Much overhead in the code
This chapter covers the following techniques:
• Must be compiled
• Python-C-Api
• High maintenance cost
• Ctypes
• No forward compatibility across Python versions as C-API changes
• SWIG (Simplified Wrapper and Interface Generator)
• Reference count bugs are easy to create and very hard to track down.
• Cython
These four techniques are perhaps the most well known ones, of which Cython is probably the most advanced one
and the one you should consider using first. The others are also important, if you want to understand the wrapping
problem from different angles. Having said that, there are other alternatives out there, but having understood the
basics of the ones above, you will be in a position to evaluate the technique of your choice to see if it fits your
needs.
The following criteria may be useful when evaluating a technology:
• Are additional libraries required?
Note: The Python-C-Api example here serves mainly for didactic reasons. Many of the other techniques actually
depend on this, so it is good to have a high-level understanding of how it works. In 99% of the use-cases you will
be better off, using an alternative technique.
Note: Since refernce counting bugs are easy to create and hard to track down, anyone really needing to use
the Python C-API should read the section about objects, types and reference counts from the official python
documentation. Additionally, there is a tool by the name of cpychecker which can help discover common errors
with reference counting.
• Is the code autogenerated?
• Does it need to be compiled?
Example
• Is there good support for interacting with Numpy arrays?
The following C-extension module, make the cos function from the standard math library available to Python:
• Does it support C++?
Before you set out, you should consider your use case. When interfacing with native code, there are usually two
use-cases that come up:
• Existing code in C/C++ that needs to be leveraged, either because it already exists, or because it is faster.
• Python code too slow, push inner loops to native code
Each technology is demonstrated by wrapping the cos function from math.h. While this is a mostly a trivial
example, it should serve us well to demonstrate the basics of the wrapping solution. Since each technique also
includes some form of Numpy support, this is also demonstrated using an example where the cosine is computed
on some kind of array.
Last but not least, two small warnings:
• All of these techniques may crash (segmentation fault) the Python interpreter, which is (usually) due to bugs
in the C code.
• All the examples have been done on Linux, they should be possible on other operating systems.
2.8. Interfacing with C
253
/*
Example of wrapping cos function from math.h with the Python-C-API. */
#include <Python.h>
#include <math.h>
/* wrapped cosine function */
static PyObject* cos_func(PyObject* self, PyObject* args)
{
double value;
double answer;
/* parse the input, from python float to c double */
if (!PyArg_ParseTuple(args, "d", &value))
return NULL;
/* if the above function returns -1, an appropriate Python exception will
* have been set, and the function simply returns NULL
*/
2.8. Interfacing with C
254
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Type:
module
String Form:<module 'cos_module' from 'cos_module.so'>
File:
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/python_c_api/cos
Docstring: <no docstring>
/* call cos from libm */
answer = cos(value);
/* construct the output from cos, from c double to python float */
return Py_BuildValue("f", answer);
In [3]: dir(cos_module)
Out[3]: ['__doc__', '__file__', '__name__', '__package__', 'cos_func']
}
/* define functions in module */
static PyMethodDef CosMethods[] =
{
{"cos_func", cos_func, METH_VARARGS, "evaluate the cosine"},
{NULL, NULL, 0, NULL}
};
In [4]: cos_module.cos_func(1.0)
Out[4]: 0.5403023058681398
In [5]: cos_module.cos_func(0.0)
Out[5]: 1.0
In [6]: cos_module.cos_func(3.14159265359)
Out[7]: -1.0
/* module initialization */
PyMODINIT_FUNC
Now let’s see how robust this is:
initcos_module(void)
{
(void) Py_InitModule("cos_module", CosMethods);
}
As you can see, there is much boilerplate, both to «massage» the arguments and return types into place and for
the module initialisation. Although some of this is amortised, as the extension grows, the boilerplate required for
each function(s) remains.
The standard python build system distutils supports compiling C-extensions from a setup.py, which is
rather convenient:
In [10]: cos_module.cos_func('foo')
--------------------------------------------------------------------------TypeError
Traceback (most recent call last)
<ipython-input-10-11bee483665d> in <module>()
----> 1 cos_module.cos_func('foo')
TypeError: a float is required
Numpy Support
from distutils.core import setup, Extension
# define the extension module
cos_module = Extension('cos_module', sources=['cos_module.c'])
Analog to the Python-C-API, Numpy, which is itself implemented as a C-extension, comes with the Numpy-CAPI. This API can be used to create and manipulate Numpy arrays from C, when writing a custom C-extension.
See also: :ref:‘advanced_numpy‘_.
# run the setup
setup(ext_modules=[cos_module])
Note: If you do ever need to use the Numpy C-API refer to the documentation about Arrays and Iterators.
The following example shows how to pass Numpy arrays as arguments to functions and how to iterate over Numpy
arrays using the (old) Numpy-C-API. It simply takes an array as argument applies the cosine function from the
math.h and returns a resulting new array.
This can be compiled:
$ cd advanced/interfacing_with_c/python_c_api
$ ls
cos_module.c
/*
Example of wrapping the cos function from math.h using the Numpy-C-API. */
setup.py
#include <Python.h>
#include <numpy/arrayobject.h>
#include <math.h>
$ python setup.py build_ext --inplace
running build_ext
building 'cos_module' extension
/* wrapped cosine function */
creating build
static PyObject* cos_func_np(PyObject* self, PyObject* args)
creating build/temp.linux-x86_64-2.7
{
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -I/home/esc/anaconda/include/python2.7
gcc -pthread -shared build/temp.linux-x86_64-2.7/cos_module.o -L/home/esc/anaconda/lib -lpython2.7
PyArrayObject *in_array;
PyObject
$ ls
*out_array;
NpyIter *in_iter;
build/ cos_module.c cos_module.so setup.py
NpyIter *out_iter;
NpyIter_IterNextFunc *in_iternext;
• build_ext is to build extension modules
NpyIter_IterNextFunc *out_iternext;
• --inplace will output the compiled extension module into the current directory
In [1]: import cos_module
/* parse single numpy array argument */
if (!PyArg_ParseTuple(args, "O!", &PyArray_Type, &in_array))
return NULL;
In [2]: cos_module?
/*
The file cos_module.so contains the compiled extension, which we can now load in the IPython interpreter:
2.8. Interfacing with C
255
construct the output array, like the input array */
2.8. Interfacing with C
256
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
from distutils.core import setup, Extension
import numpy
out_array = PyArray_NewLikeArray(in_array, NPY_ANYORDER, NULL, 0);
if (out_array == NULL)
return NULL;
# define the extension module
cos_module_np = Extension('cos_module_np', sources=['cos_module_np.c'],
include_dirs=[numpy.get_include()])
/* create the iterators */
in_iter = NpyIter_New(in_array, NPY_ITER_READONLY, NPY_KEEPORDER,
NPY_NO_CASTING, NULL);
if (in_iter == NULL)
goto fail;
# run the setup
setup(ext_modules=[cos_module_np])
out_iter = NpyIter_New((PyArrayObject *)out_array, NPY_ITER_READWRITE,
NPY_KEEPORDER, NPY_NO_CASTING, NULL);
if (out_iter == NULL) {
NpyIter_Deallocate(in_iter);
goto fail;
}
To convince ourselves if this does actually works, we run the following test script:
import cos_module_np
import numpy as np
import pylab
x = np.arange(0, 2 * np.pi, 0.1)
y = cos_module_np.cos_func_np(x)
pylab.plot(x, y)
pylab.show()
in_iternext = NpyIter_GetIterNext(in_iter, NULL);
out_iternext = NpyIter_GetIterNext(out_iter, NULL);
if (in_iternext == NULL || out_iternext == NULL) {
NpyIter_Deallocate(in_iter);
NpyIter_Deallocate(out_iter);
goto fail;
}
double ** in_dataptr = (double **) NpyIter_GetDataPtrArray(in_iter);
double ** out_dataptr = (double **) NpyIter_GetDataPtrArray(out_iter);
And this should result in the following figure:
/* iterate over the arrays */
do {
**out_dataptr = cos(**in_dataptr);
} while(in_iternext(in_iter) && out_iternext(out_iter));
2.8.3 Ctypes
/* clean up and return the result */
NpyIter_Deallocate(in_iter);
NpyIter_Deallocate(out_iter);
Py_INCREF(out_array);
return out_array;
Ctypes is a foreign function library for Python. It provides C compatible data types, and allows calling functions
in DLLs or shared libraries. It can be used to wrap these libraries in pure Python.
Advantages
• Part of the Python standard library
/* in case bad things happen */
fail:
Py_XDECREF(out_array);
return NULL;
• Does not need to be compiled
• Wrapping code entirely in Python
}
Disadvantages
• Requires code to be wrapped to be available as a shared library (roughly speaking *.dll in Windows
*.so in Linux and *.dylib in Mac OSX.)
/* define functions in module */
static PyMethodDef CosMethods[] =
{
{"cos_func_np", cos_func_np, METH_VARARGS,
"evaluate the cosine on a numpy array"},
{NULL, NULL, 0, NULL}
};
• No good support for C++
Example
As advertised, the wrapper code is in pure Python.
/* module initialization */
PyMODINIT_FUNC
initcos_module_np(void)
{
(void) Py_InitModule("cos_module_np", CosMethods);
/* IMPORTANT: this must be called */
import_array();
}
""" Example of wrapping cos function from math.h using ctypes. """
import ctypes
from ctypes.util import find_library
To compile this we can use distutils again. However we need to be sure to include the Numpy headers by using
:func:numpy.get_include.
2.8. Interfacing with C
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
257
# find and load the library
libm = ctypes.cdll.LoadLibrary(find_library('m'))
# set the argument type
libm.cos.argtypes = [ctypes.c_double]
2.8. Interfacing with C
258
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Numpy Support
# set the return type
libm.cos.restype = ctypes.c_double
Numpy contains some support for interfacing with ctypes. In particular there is support for exporting certain
attributes of a Numpy array as ctypes data-types and there are functions to convert from C arrays to Numpy arrays
and back.
def cos_func(arg):
''' Wrapper for cos from math.h '''
return libm.cos(arg)
For more information, consult the corresponding section in the Numpy Cookbook and the API documentation for
numpy.ndarray.ctypes and numpy.ctypeslib.
• Finding and loading the library may vary depending on your operating system, check the documentation for
details
For the following example, let’s consider a C function in a library that takes an input and an output array, computes
the cosine of the input array and stores the result in the output array.
• This may be somewhat deceptive, since the math library exists in compiled form on the system already. If
you were to wrap a in-house library, you would have to compile it first, which may or may not require some
additional effort.
The library consists of the following header file (although this is not strictly needed for this example, we list it for
completeness):
void cos_doubles(double * in_array, double * out_array, int size);
We may now use this, as before:
The function implementation resides in the following C source file:
In [1]: import cos_module
In [2]: cos_module?
Type:
module
String Form:<module 'cos_module' from 'cos_module.py'>
File:
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/ctypes/cos_module.py
Docstring: <no docstring>
In [3]: dir(cos_module)
Out[3]:
['__builtins__',
'__doc__',
'__file__',
'__name__',
'__package__',
'cos_func',
'ctypes',
'find_library',
'libm']
#include <math.h>
/* Compute the cosine of each element in in_array, storing the result in
* out_array. */
void cos_doubles(double * in_array, double * out_array, int size){
int i;
for(i=0;i<size;i++){
out_array[i] = cos(in_array[i]);
}
}
And since the library is pure C, we can’t use distutils to compile it, but must use a combination of make and
gcc:
m.PHONY : clean
libcos_doubles.so : cos_doubles.o
gcc -shared -Wl,-soname,libcos_doubles.so -o libcos_doubles.so cos_doubles.o
In [4]: cos_module.cos_func(1.0)
Out[4]: 0.5403023058681398
cos_doubles.o : cos_doubles.c
gcc -c -fPIC cos_doubles.c -o cos_doubles.o
In [5]: cos_module.cos_func(0.0)
Out[5]: 1.0
clean :
In [6]: cos_module.cos_func(3.14159265359)
Out[6]: -1.0
We can then compile this (on Linux) into the shared library libcos_doubles.so:
-rm -vf libcos_doubles.so cos_doubles.o cos_doubles.pyc
As with the previous example, this code is somewhat robust, although the error message is not quite as helpful,
since it does not tell us what the type should be.
In [7]: cos_module.cos_func('foo')
--------------------------------------------------------------------------ArgumentError
Traceback (most recent call last)
<ipython-input-7-11bee483665d> in <module>()
----> 1 cos_module.cos_func('foo')
$ ls
cos_doubles.c cos_doubles.h cos_doubles.py makefile test_cos_doubles.py
$ make
gcc -c -fPIC cos_doubles.c -o cos_doubles.o
gcc -shared -Wl,-soname,libcos_doubles.so -o libcos_doubles.so cos_doubles.o
$ ls
cos_doubles.c cos_doubles.o
libcos_doubles.so* test_cos_doubles.py
cos_doubles.h cos_doubles.py makefile
Now we can proceed to wrap this library via ctypes with direct support for (certain kinds of) Numpy arrays:
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/ctypes/cos_module.py in cos_func(arg)
12 def cos_func(arg):
13
''' Wrapper for cos from math.h '''
---> 14
return libm.cos(arg)
""" Example of wrapping a C library function that accepts a C double array as
input using the numpy.ctypeslib. """
ArgumentError: argument 1: <type 'exceptions.TypeError'>: wrong type
import numpy as np
import numpy.ctypeslib as npct
from ctypes import c_int
# input type for the cos_doubles function
2.8. Interfacing with C
259
2.8. Interfacing with C
260
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Steep learning curve
# must be a double array, with single dimension that is contiguous
array_1d_double = npct.ndpointer(dtype=np.double, ndim=1, flags='CONTIGUOUS')
Example
# load the library, using numpy mechanisms
libcd = npct.load_library("libcos_doubles", ".")
Let’s imagine that our cos function lives in a cos_module which has been written in c and consists of the
source file cos_module.c:
# setup the return types and argument types
libcd.cos_doubles.restype = None
libcd.cos_doubles.argtypes = [array_1d_double, array_1d_double, c_int]
#include <math.h>
double cos_func(double arg){
return cos(arg);
}
def cos_doubles_func(in_array, out_array):
return libcd.cos_doubles(in_array, out_array, len(in_array))
• Note the inherent limitation of contiguous single dimensional Numpy arrays, since the C functions requires
this kind of buffer.
• Also note that the output array must be preallocated, for example with numpy.zeros() and the function
will write into it’s buffer.
• Although the original signature of the cos_doubles function is ARRAY, ARRAY, int the final
cos_doubles_func takes only two Numpy arrays as arguments.
and the header file cos_module.h:
double cos_func(double arg);
And our goal is to expose the cos_func to Python. To achieve this with SWIG, we must write an interface file
which contains the instructions for SWIG.
/*
Example of wrapping cos function from math.h using SWIG. */
%module cos_module
%{
/* the resulting C file should be built as a python extension */
#define SWIG_FILE_WITH_INIT
/* Includes the header in the wrapper code */
#include "cos_module.h"
%}
/* Parse the header file to generate wrappers */
%include "cos_module.h"
And, as before, we convince ourselves that it worked:
import numpy as np
import pylab
import cos_doubles
x = np.arange(0, 2 * np.pi, 0.1)
y = np.empty_like(x)
cos_doubles.cos_doubles_func(x, y)
pylab.plot(x, y)
pylab.show()
As you can see, not too much code is needed here. For this simple example it is enough to simply include the
header file in the interface file, to expose the function to Python. However, SWIG does allow for more fine grained
inclusion/exclusion of functions found in header files, check the documentation for details.
Generating the compiled wrappers is a two stage process:
1. Run the swig executable on the interface file to generate the files cos_module_wrap.c, which is the
source file for the autogenerated Python C-extension and cos_module.py, which is the autogenerated
pure python module.
2. Compile the cos_module_wrap.c into the _cos_module.so. Luckily, distutils knows how to
handle SWIG interface files, so that our setup.py is simply:
2.8.4 SWIG
from distutils.core import setup, Extension
SWIG, the Simplified Wrapper Interface Generator, is a software development tool that connects programs written
in C and C++ with a variety of high-level programming languages, including Python. The important thing with
SWIG is, that it can autogenerate the wrapper code for you. While this is an advantage in terms of development
time, it can also be a burden. The generated file tend to be quite large and may not be too human readable and the
multiple levels of indirection which are a result of the wrapping process, may be a bit tricky to understand.
$ cd advanced/interfacing_with_c/swig
$ ls
cos_module.c
Note: The autogenerated C code uses the Python-C-Api.
cos_module.h
cos_module.i
setup.py
$ python setup.py build_ext --inplace
running build_ext
building '_cos_module' extension
swigging cos_module.i to cos_module_wrap.c
swig -python -o cos_module_wrap.c cos_module.i
creating build
creating build/temp.linux-x86_64-2.7
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -
Advantages
• Can automatically wrap entire libraries given the headers
• Works nicely with C++
Disadvantages
• Autogenerates enormous files
• Hard to debug if something goes wrong
2.8. Interfacing with C
setup(ext_modules=[Extension("_cos_module",
sources=["cos_module.c", "cos_module.i"])])
261
2.8. Interfacing with C
262
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
gcc -pthread -shared build/temp.linux-x86_64-2.7/cos_module.o build/temp.linux-x86_64-2.7/cos_module_wrap.o
#include <math.h>
$ ls
build/
/* Compute the cosine of each element in in_array, storing the result in
* out_array. */
void cos_doubles(double * in_array, double * out_array, int size){
int i;
for(i=0;i<size;i++){
out_array[i] = cos(in_array[i]);
}
}
cos_module.c
cos_module.h
cos_module.i
cos_module.py
_cos_module.so*
cos_module_wrap.c
We can now load and execute the cos_module as we have done in the previous examples:
In [1]: import cos_module
In [2]: cos_module?
Type:
module
String Form:<module 'cos_module' from 'cos_module.py'>
File:
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/swig/cos_module.py
Docstring: <no docstring>
In [3]: dir(cos_module)
Out[3]:
['__builtins__',
'__doc__',
'__file__',
'__name__',
'__package__',
'_cos_module',
'_newclass',
'_object',
'_swig_getattr',
'_swig_property',
'_swig_repr',
'_swig_setattr',
'_swig_setattr_nondynamic',
'cos_func']
/*
*
Example of wrapping a C function that takes a C double array as input using
numpy typemaps for SWIG. */
%module cos_doubles
%{
/* the resulting C file should be built as a python extension */
#define SWIG_FILE_WITH_INIT
/* Includes the header in the wrapper code */
#include "cos_doubles.h"
%}
/* include the numpy typemaps */
%include "numpy.i"
/* need this for correct module initialization */
%init %{
import_array();
%}
/* typemaps for the two arrays, the second will be modified in-place */
%apply (double* IN_ARRAY1, int DIM1) {(double * in_array, int size_in)}
%apply (double* INPLACE_ARRAY1, int DIM1) {(double * out_array, int size_out)}
In [4]: cos_module.cos_func(1.0)
Out[4]: 0.5403023058681398
In [5]: cos_module.cos_func(0.0)
Out[5]: 1.0
In [6]: cos_module.cos_func(3.14159265359)
Out[6]: -1.0
Again we test for robustness, and we see that we get a better error message (although, strictly speaking in Python
there is no double type):
In [7]: cos_module.cos_func('foo')
--------------------------------------------------------------------------TypeError
Traceback (most recent call last)
<ipython-input-7-11bee483665d> in <module>()
----> 1 cos_module.cos_func('foo')
/* Wrapper for cos_doubles that massages the types */
%inline %{
/* takes as input two numpy arrays */
void cos_doubles_func(double * in_array, int size_in, double * out_array, int size_out) {
/* calls the original funcion, providing only the size of the first */
cos_doubles(in_array, out_array, size_in);
}
%}
• To use the Numpy typemaps, we need include the numpy.i file.
• Observe the call to import_array() which we encountered already in the Numpy-C-API example.
• Since the type maps only support the signature ARRAY, SIZE we need to wrap the cos_doubles as
cos_doubles_func which takes two arrays including sizes as input.
TypeError: in method 'cos_func', argument 1 of type 'double'
• As opposed to the simple SWIG example, we don’t include the cos_doubles.h header, There is nothing
there that we wish to expose to Python since we expose the functionality through cos_doubles_func.
And, as before we can use distutils to wrap this:
Numpy Support
Numpy provides support for SWIG with the numpy.i file. This interface file defines various so-called typemaps
which support conversion between Numpy arrays and C-Arrays. In the following example we will take a quick
look at how such typemaps work in practice.
We have the same cos_doubles function as in the ctypes example:
void cos_doubles(double * in_array, double * out_array, int size);
2.8. Interfacing with C
This is wrapped as cos_doubles_func using the following SWIG interface file:
from distutils.core import setup, Extension
import numpy
setup(ext_modules=[Extension("_cos_doubles",
sources=["cos_doubles.c", "cos_doubles.i"],
include_dirs=[numpy.get_include()])])
As previously, we need to use include_dirs to specify the location.
263
2.8. Interfacing with C
264
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Advantages
$ ls
cos_doubles.c cos_doubles.h cos_doubles.i numpy.i setup.py test_cos_doubles.py
• Python like language for writing C-extensions
$ python setup.py build_ext -i
• Autogenerated code
running build_ext
building '_cos_doubles' extension
• Supports incremental optimization
swigging cos_doubles.i to cos_doubles_wrap.c
swig -python -o cos_doubles_wrap.c cos_doubles.i
• Includes a GNU debugger extension
cos_doubles.i:24: Warning(490): Fragment 'NumPy_Backward_Compatibility' not found.
• Support for C++ (Since version 0.13)
cos_doubles.i:24: Warning(490): Fragment 'NumPy_Backward_Compatibility' not found.
cos_doubles.i:24: Warning(490): Fragment 'NumPy_Backward_Compatibility' not found.
Disadvantages
creating build
creating build/temp.linux-x86_64-2.7
• Must be compiled
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -I/home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include
• Requires an additional library ( but only at build time, at this problem can be overcome by shipping the
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC -I/home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include
In file included from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/ndarraytypes.h:1722, generated C files)
from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/ndarrayobject.h:17,
from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/arrayobject.h:15,
Example
from cos_doubles_wrap.c:2706:
/home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/npy_deprecated_api.h:11:2:
gcc -pthread -shared build/temp.linux-x86_64-2.7/cos_doubles.o build/temp.linux-x86_64-2.7/cos_doubles_wrap.o The main Cython code for our cos_module is contained in the file cos_module.pyx:
$ ls
""" Example of wrapping cos function from math.h using Cython. """
build/
cos_doubles.h cos_doubles.py
cos_doubles_wrap.c setup.py
cos_doubles.c
cos_doubles.i
_cos_doubles.so*
numpy.i
test_cos_doubles.py
And, as before, we convince ourselves that it worked:
cdef extern from "math.h":
double cos(double arg)
def cos_func(arg):
return cos(arg)
import numpy as np
import pylab
import cos_doubles
Note the additional keywords such as cdef and extern. Also the cos_func is then pure Python.
x = np.arange(0, 2 * np.pi, 0.1)
y = np.empty_like(x)
Again we can use the standard distutils module, but this time we need some additional pieces from the
Cython.Distutils:
cos_doubles.cos_doubles_func(x, y)
pylab.plot(x, y)
pylab.show()
from distutils.core import setup, Extension
from Cython.Distutils import build_ext
setup(
cmdclass={'build_ext': build_ext},
ext_modules=[Extension("cos_module", ["cos_module.pyx"])]
)
Compiling this:
2.8.5 Cython
Cython is both a Python-like language for writing C-extensions and an advanced compiler for this language. The
Cython language is a superset of Python, which comes with additional constructs that allow you call C functions
and annotate variables and class attributes with c types. In this sense one could also call it a Python with types.
In addition to the basic use case of wrapping native code, Cython supports an additional use-case, namely interactive optimization. Basically, one starts out with a pure-Python script and incrementally adds Cython types to the
bottleneck code to optimize only those code paths that really matter.
In this sense it is quite similar to SWIG, since the code can be autogenerated but in a sense it also quite similar to
ctypes since the wrapping code can (almost) be written in Python.
While others solutions that autogenerate code can be quite difficult to debug (for example SWIG) Cython comes
with an extension to the GNU debugger that helps debug Python, Cython and C code.
And running it:
In [1]: import cos_module
In [2]: cos_module?
Type:
module
Note: The autogenerated C code uses the Python-C-Api.
2.8. Interfacing with C
$ cd advanced/interfacing_with_c/cython
$ ls
cos_module.pyx setup.py
$ python setup.py build_ext --inplace
running build_ext
cythoning cos_module.pyx to cos_module.c
building 'cos_module' extension
creating build
creating build/temp.linux-x86_64-2.7
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC gcc -pthread -shared build/temp.linux-x86_64-2.7/cos_module.o -L/home/esc/anaconda/lib -lpython2.7
$ ls
build/ cos_module.c cos_module.pyx cos_module.so* setup.py
265
2.8. Interfacing with C
266
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
String Form:<module 'cos_module' from 'cos_module.so'>
File:
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/cython/cos_module.so
Docstring: <no docstring>
In [3]: dir(cos_module)
Out[3]:
['__builtins__',
'__doc__',
'__file__',
'__name__',
'__package__',
'__test__',
'cos_func']
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
* out_array. */
void cos_doubles(double * in_array, double * out_array, int size){
int i;
for(i=0;i<size;i++){
out_array[i] = cos(in_array[i]);
}
}
This is wrapped as cos_doubles_func using the following Cython code:
""" Example of wrapping a C function that takes C double arrays as input using
the Numpy declarations from Cython """
# cimport the Cython declarations for numpy
cimport numpy as np
In [4]: cos_module.cos_func(1.0)
Out[4]: 0.5403023058681398
# if you want to use the Numpy-C-API from Cython
# (not strictly necessary for this example, but good practice)
np.import_array()
In [5]: cos_module.cos_func(0.0)
Out[5]: 1.0
# cdefine the signature of our c function
cdef extern from "cos_doubles.h":
void cos_doubles (double * in_array, double * out_array, int size)
In [6]: cos_module.cos_func(3.14159265359)
Out[6]: -1.0
And, testing a little for robustness, we can see that we get good error messages:
# create the wrapper code, with numpy type annotations
def cos_doubles_func(np.ndarray[double, ndim=1, mode="c"] in_array not None,
np.ndarray[double, ndim=1, mode="c"] out_array not None):
cos_doubles(<double*> np.PyArray_DATA(in_array),
<double*> np.PyArray_DATA(out_array),
in_array.shape[0])
In [7]: cos_module.cos_func('foo')
--------------------------------------------------------------------------TypeError
Traceback (most recent call last)
<ipython-input-7-11bee483665d> in <module>()
----> 1 cos_module.cos_func('foo')
/home/esc/git-working/scipy-lecture-notes/advanced/interfacing_with_c/cython/cos_module.so in cos_module.cos_func
And can be compiled using distutils:
TypeError: a float is required
Additionally, it is worth noting that Cython ships with complete declarations for the C math library, which
simplifies the code above to become:
""" Simpler example of wrapping cos function from math.h using Cython. """
from libc.math cimport cos
def cos_func(arg):
return cos(arg)
from distutils.core import setup, Extension
import numpy
from Cython.Distutils import build_ext
setup(
cmdclass={'build_ext': build_ext},
ext_modules=[Extension("cos_doubles",
sources=["_cos_doubles.pyx", "cos_doubles.c"],
include_dirs=[numpy.get_include()])],
)
• As with the previous compiled Numpy examples, we need the include_dirs option.
In this case the cimport statement is used to import the cos function.
Numpy Support
Cython has support for Numpy via the numpy.pyx file which allows you to add the Numpy array type to your
Cython code. I.e. like specifying that variable i is of type int, you can specify that variable a is of type
numpy.ndarray with a given dtype. Also, certain optimizations such as bounds checking are supported.
Look at the corresponding section in the Cython documentation. In case you want to pass Numpy arrays as C
arrays to your Cython wrapped C functions, there is a section about this in the Cython wiki.
In the following example, we will show how to wrap the familiar cos_doubles function using Cython.
void cos_doubles(double * in_array, double * out_array, int size);
#include <math.h>
/*
Compute the cosine of each element in in_array, storing the result in
2.8. Interfacing with C
267
$ ls
cos_doubles.c cos_doubles.h _cos_doubles.pyx setup.py test_cos_doubles.py
$ python setup.py build_ext -i
running build_ext
cythoning _cos_doubles.pyx to _cos_doubles.c
building 'cos_doubles' extension
creating build
creating build/temp.linux-x86_64-2.7
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC In file included from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/ndar
from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/ndar
from /home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/arra
from _cos_doubles.c:253:
/home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/npy_deprecated_api.h:11:2:
/home/esc/anaconda/lib/python2.7/site-packages/numpy/core/include/numpy/__ufunc_api.h:236: warning
gcc -pthread -fno-strict-aliasing -g -O2 -DNDEBUG -g -fwrapv -O3 -Wall -Wstrict-prototypes -fPIC gcc -pthread -shared build/temp.linux-x86_64-2.7/_cos_doubles.o build/temp.linux-x86_64-2.7/cos_do
$ ls
2.8. Interfacing with C
268
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
build/
_cos_doubles.c
cos_doubles.c
cos_doubles.h
_cos_doubles.pyx
cos_doubles.so*
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
(d) Empty array
setup.py
(e) Arrays with non-double types
And, as before, we convince ourselves that it worked:
4. Use the %timeit IPython magic to measure the execution time of the various solutions
import numpy as np
import pylab
import cos_doubles
Python-C-API
x = np.arange(0, 2 * np.pi, 0.1)
y = np.empty_like(x)
1. Modify the Numpy example such that the function takes two input arguments, where the second is the
preallocated output array, making it similar to the other Numpy examples.
cos_doubles.cos_doubles_func(x, y)
pylab.plot(x, y)
pylab.show()
2. Modify the example such that the function only takes a single input array and modifies this in place.
3. Try to fix the example to use the new Numpy iterator protocol. If you manage to obtain a working solution,
please submit a pull-request on github.
4. You may have noticed, that the Numpy-C-API example is the only Numpy example that does not wrap
cos_doubles but instead applies the cos function directly to the elements of the Numpy array. Does
this have any advantages over the other techniques.
5. Can you wrap cos_doubles using only the Numpy-C-API. You may need to ensure that the arrays have
the correct type, are one dimensional and contiguous in memory.
2.8.6 Summary
Ctypes
In this section four different techniques for interfacing with native code have been presented. The table below
roughly summarizes some of the aspects of the techniques.
x
Python-C-API
Ctypes
Swig
Cython
Part of CPython
True
True
False
False
Compiled
True
False
True
True
Autogenerated
False
False
True
True
Numpy Support
True
True
True
True
1. Modify the Numpy example such that cos_doubles_func handles the preallocation for you, thus making it more like the Numpy-C-API example.
SWIG
1. Look at the code that SWIG autogenerates, how much of it do you understand?
Of all three presented techniques, Cython is the most modern and advanced. In particular, the ability to optimize
code incrementally by adding types to your Python code is unique.
2.8.7 Further Reading and References
• Gaël Varoquaux’s blog post about avoiding data copies provides some insight on how to handle memory
management cleverly. If you ever run into issues with large datasets, this is a reference to come back to for
some inspiration.
2.8.8 Exercises
2. Modify the Numpy example such that cos_doubles_func handles the preallocation for you, thus making it more like the Numpy-C-API example.
3. Modify the cos_doubles C function so that it returns an allocated array. Can you wrap this using SWIG
typemaps? If not, why not? Is there a workaround for this specific situation? (Hint: you know the size of
the output array, so it may be possible to construct a Numpy array from the returned double *.)
Cython
1. Look at the code that Cython autogenerates. Take a closer look at some of the comments that Cython inserts.
What do you see?
2. Look at the section Working with Numpy from the Cython documentation to learn how to incrementally
optimize a pure python script that uses Numpy.
Since this is a brand new section, the exercises are considered more as pointers as to what to look at next, so pick
the ones that you find more interesting. If you have good ideas for exercises, please let us know!
3. Modify the Numpy example such that cos_doubles_func handles the preallocation for you, thus making it more like the Numpy-C-API example.
1. Download the source code for each example and compile and run them on your machine.
2. Make trivial changes to each example and convince yourself that this works. ( E.g. change cos for sin.)
3. Most of the examples, especially the ones involving Numpy may still be fragile and respond badly to input
errors. Look for ways to crash the examples, figure what the problem is and devise a potential solution.
Here are some ideas:
(a) Numerical overflow.
(b) Input and output arrays that have different lengths.
(c) Multidimensional array.
2.8. Interfacing with C
269
2.8. Interfacing with C
270
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
CHAPTER 3
Packages and applications
This part of the Scipy lecture notes is dedicated to various scientific packages useful for extended needs.
Contents
• Data representation and interaction (page 272)
– Data as a table (page 272)
– The panda data-frame (page 272)
• Hypothesis testing: comparing two groups (page 276)
– Student’s t-test: the simplest statistical test (page 277)
– Paired tests: repeated measurements on the same indivuals (page 278)
• Linear models, multiple factors, and analysis of variance (page 279)
– “formulas” to specify statistical models in Python (page 279)
– Multiple Regression: including multiple factors (page 282)
– Post-hoc hypothesis testing: analysis of variance (ANOVA) (page 284)
• More visualization: seaborn for statistical exploration (page 284)
– Pairplot: scatter matrices (page 284)
– lmplot: plotting a univariate regression (page 286)
• Testing for interactions (page 287)
• Full examples (page 288)
Tip: In this document, the Python inputs are represented with the sign “>>>”.
3.1 Statistics in Python
Author: Gaël Varoquaux
Disclaimer: Gender questions
Some of the examples of this tutorial are chosen around gender questions. The reason is that on such questions
controlling the truth of a claim actually matters to many people.
Requirements
• Standard scientific Python environment (numpy, scipy, matplotlib)
• Pandas
• Statsmodels
• Seaborn
To install Python and these dependencies, we recommend that you download Anaconda Python or Enthought
Canopy, or preferably use the package manager if you are under Ubuntu or other linux.
3.1.1 Data representation and interaction
Data as a table
See also:
Bayesian statistics in Python
This chapter does not cover tools for Bayesian statistics. Of particular interest for Bayesian modelling is PyMC,
which implements a probabilistic programming language in Python.
The setting that we consider for statistical analysis is that of multiple observations or samples described by
a set of different attributes or features. The data can than be seen as a 2D table, or matrix, with columns
giving the different attributes of the data, and rows the observations. For instance, the data contained in
examples/brain_size.csv:
"";"Gender";"FSIQ";"VIQ";"PIQ";"Weight";"Height";"MRI_Count"
"1";"Female";133;132;124;"118";"64.5";816932
"2";"Male";140;150;124;".";"72.5";1001121
"3";"Male";139;123;150;"143";"73.3";1038437
"4";"Male";133;129;128;"172";"68.8";965353
"5";"Female";137;132;134;"147";"65.0";951545
Tip: Why Python for statistics?
R is a language dedicated to statistics. Python is a general-purpose language with statistics modules. R has more
statistical analysis features than Python, and specialized syntaxes. However, when it comes to building complex
analysis pipelines that mix statistics with e.g. image analysis, text mining, or control of a physical experiment, the
richness of Python is an invaluable asset.
The panda data-frame
Tip: We will store and manipulate this data in a pandas.DataFrame, from the pandas module. It is the
Python equivalent of the spreadsheet table. It is different from a 2D numpy array as it has named columns, can
contain a mixture of different data types by column, and has elaborate selection and pivotal mechanisms.
Creating dataframes: reading data files or converting arrays
271
3.1. Statistics in Python
272
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Manipulating data
Separator
data is a pandas.DataFrame, that resembles R’s dataframe:
It is a CSV file, but the separator is ”;”
Reading from a CSV file: Using the above CSV file that gives observations of brain size and weight and IQ
(Willerman et al. 1991), the data are a mixture of numerical and categorical values:
>>> import pandas
>>> data = pandas.read_csv('examples/brain_size.csv', sep=';', na_values=".")
>>> data
Unnamed: 0 Gender FSIQ VIQ PIQ Weight Height MRI_Count
0
1 Female
133 132 124
118
64.5
816932
1
2
Male
140 150 124
NaN
72.5
1001121
2
3
Male
139 123 150
143
73.3
1038437
3
4
Male
133 129 128
172
68.8
965353
4
5 Female
137 132 134
147
65.0
951545
...
>>> data.shape
(40, 8)
# 40 rows and 8 columns
>>> data.columns # It has columns
Index([u'Unnamed: 0', u'Gender', u'FSIQ', u'VIQ', u'PIQ', u'Weight', u'Height', u'MRI_Count'], dty
>>> print(data['Gender'])
0
Female
1
Male
2
Male
3
Male
4
Female
...
Warning: Missing values
The weight of the second individual is missing in the CSV file. If we don’t specify the missing value (NA =
not available) marker, we will not be able to do statistical analysis.
# Columns can be addressed by name
>>> # Simpler selector
>>> data[data['Gender'] == 'Female']['VIQ'].mean()
109.45
Note:
For a quick view
pandas.DataFrame.describe().
Creating from arrays: A pandas.DataFrame can also be seen as a dictionary of 1D ‘series’, eg arrays or
lists. If we have 3 numpy arrays:
>>>
>>>
>>>
>>>
import numpy as np
t = np.linspace(-6, 6, 20)
sin_t = np.sin(t)
cos_t = np.cos(t)
on
a
large
dataframe,
use
its
describe
method:
groupby: splitting a dataframe on values of categorical variables:
>>> groupby_gender = data.groupby('Gender')
>>> for gender, value in groupby_gender['VIQ']:
...
print((gender, value.mean()))
('Female', 109.45)
('Male', 115.25)
We can expose them as a pandas.DataFrame:
groupby_gender is a powerful object that exposes many operations on the resulting group of dataframes:
>>> pandas.DataFrame({'t': t, 'sin': sin_t, 'cos': cos_t})
cos
sin
t
0
0.960170 0.279415 -6.000000
1
0.609977 0.792419 -5.368421
2
0.024451 0.999701 -4.736842
3 -0.570509 0.821291 -4.105263
4 -0.945363 0.326021 -3.473684
5 -0.955488 -0.295030 -2.842105
6 -0.596979 -0.802257 -2.210526
7 -0.008151 -0.999967 -1.578947
8
0.583822 -0.811882 -0.947368
...
>>> groupby_gender.mean()
Unnamed: 0
FSIQ
Gender
Female
19.65 111.9
Male
21.35 115.0
VIQ
PIQ
Weight
Height
MRI_Count
109.45
115.25
110.45
111.60
137.200000
166.444444
65.765000
71.431579
862654.6
954855.4
Tip: Use tab-completion on groupby_gender to find more. Other common grouping functions are median,
count (useful for checking to see the amount of missing values in different subsets) or sum. Groupby evaluation
is lazy, no work is done until an aggregation function is applied.
Other inputs: pandas can input data from SQL, excel files, or other formats. See the pandas documentation.
3.1. Statistics in Python
273
3.1. Statistics in Python
274
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> plotting.scatter_matrix(data[['PIQ', 'VIQ', 'FSIQ']])
Two populations
The IQ metrics are bimodal, as if there are 2 sub-populations.
Exercise
• What is the mean value for VIQ for the full population?
• How many males/females were included in this study?
Hint use ‘tab completion’ to find out the methods that can be called, instead of ‘mean’ in the above
example.
• What is the average value of MRI counts expressed in log units, for males and females?
Note: groupby_gender.boxplot is used for the plots above (see this example (page 289)).
Plotting data
Exercise
Pandas comes with some plotting tools (pandas.tools.plotting, using matplotlib behind the scene) to
display statistics of the data in dataframes:
Plot the scatter matrix for males only, and for females only. Do you think that the 2 sub-populations correspond to gender?
Scatter matrices:
3.1.2 Hypothesis testing: comparing two groups
>>> from pandas.tools import plotting
>>> plotting.scatter_matrix(data[['Weight', 'Height', 'MRI_Count']])
For simple statistical tests, we will use the scipy.stats sub-module of scipy:
>>> from scipy import stats
See also:
Scipy is a vast library. For a quick summary to the whole library, see the scipy (page 103) chapter.
3.1. Statistics in Python
275
3.1. Statistics in Python
276
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Student’s t-test: the simplest statistical test
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Paired tests: repeated measurements on the same indivuals
1-sample t-test: testing the value of a population mean
PIQ, VIQ, and FSIQ give 3 measures of IQ. Let us test if FISQ
and PIQ are significantly different. We can use a 2 sample test:
>>> stats.ttest_ind(data['FSIQ'], data['PIQ'])
(...0.46563759638..., 0.64277250...)
The problem with this approach is that it forgets that there are links between observations: FSIQ and PIQ are
measured on the same individuals. Thus the variance due to inter-subject variability is confounding, and can be
removed, using a “paired test”, or “repeated measures test”:
scipy.stats.ttest_1samp() tests if the population mean of data is likely to be equal to a given value
(technically if observations are drawn from a Gaussian distributions of given population mean). It returns the T
statistic, and the p-value (see the function’s help):
>>> stats.ttest_rel(data['FSIQ'], data['PIQ'])
(...1.784201940..., 0.082172638183...)
>>> stats.ttest_1samp(data['VIQ'], 0)
(...30.088099970..., 1.32891964...e-28)
Tip: With a p-value of 10^-28 we can claim that the population mean for the IQ (VIQ measure) is not 0.
2-sample t-test: testing for difference across populations
We have seen above that the mean VIQ in the male and female populations were different. To test if this is
significant, we do a 2-sample t-test with scipy.stats.ttest_ind():
>>> female_viq = data[data['Gender'] == 'Female']['VIQ']
>>> male_viq = data[data['Gender'] == 'Male']['VIQ']
>>> stats.ttest_ind(female_viq, male_viq)
(...-0.77261617232..., 0.4445287677858...)
This is equivalent to a 1-sample test on the difference:
>>> stats.ttest_1samp(data['FSIQ'] - data['PIQ'], 0)
(...1.784201940..., 0.082172638...)
T-tests assume Gaussian errors. We can use a Wilcoxon signed-rank test, that relaxes this assumption:
>>> stats.wilcoxon(data['FSIQ'], data['PIQ'])
(274.5, 0.106594927...)
Note:
The corresponding test
scipy.stats.mannwhitneyu().
3.1. Statistics in Python
277
3.1. Statistics in Python
in
the
non
paired
case
is
the
Mann–Whitney
U
test,
278
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercice
• Test the difference between weights in males and females.
• Use non parametric statistics to test the difference between VIQ in males and females.
Conclusion: we find that the data does not support the hypothesis that males and females have different
VIQ.
Then we specify an OLS model and fit it:
>>> from statsmodels.formula.api import ols
>>> model = ols("y ~ x", data).fit()
We can inspect the various statistics derived from the fit:
>>> print(model.summary())
OLS Regression Results
==============================================================================
Dep. Variable:
y
R-squared:
0.804
Model:
OLS
Adj. R-squared:
0.794
Method:
Least Squares
F-statistic:
74.03
Date:
...
Prob (F-statistic):
8.56e-08
Time:
...
Log-Likelihood:
-57.988
No. Observations:
20
AIC:
120.0
Df Residuals:
18
BIC:
122.0
Df Model:
1
==============================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------------Intercept
-5.5335
1.036
-5.342
0.000
-7.710
-3.357
x
2.9369
0.341
8.604
0.000
2.220
3.654
==============================================================================
Omnibus:
0.100
Durbin-Watson:
2.956
Prob(Omnibus):
0.951
Jarque-Bera (JB):
0.322
Skew:
-0.058
Prob(JB):
0.851
Kurtosis:
2.390
Cond. No.
3.03
=========================================================================...
3.1.3 Linear models, multiple factors, and analysis of variance
“formulas” to specify statistical models in Python
A simple linear regression
Terminology:
Given two set of observations, x and y, we want to test the
hypothesis that y is a linear function of x. In other terms:
y = x ∗ coef + intercept + e
where e is observation noise. We will use the statmodels module to:
Statsmodel uses a statistical terminology: the y variable in statsmodel is called ‘endogenous’ while the x
variable is called exogenous. This is discussed in more detail here.
To simplify, y (endogenous) is the value you are trying to predict, while x (exogenous) represents the features
you are using to make the prediction.
1. Fit a linear model. We will use the simplest strategy, ordinary least squares (OLS).
Exercise
2. Test that coef is non zero.
Retrieve the estimated parameters from the model above. Hint: use tab-completion to find the relevent
attribute.
First, we generate simulated data according to the model:
>>>
>>>
>>>
>>>
>>>
>>>
>>>
import numpy as np
x = np.linspace(-5, 5, 20)
np.random.seed(1)
# normal distributed noise
y = -5 + 3*x + 4 * np.random.normal(size=x.shape)
# Create a data frame containing all the relevant variables
data = pandas.DataFrame({'x': x, 'y': y})
Categorical variables: comparing groups or multiple categories
Let us go back the data on brain size:
>>> data = pandas.read_csv('examples/brain_size.csv', sep=';', na_values=".")
We can write a comparison between IQ of male and female using a linear model:
“formulas” for statistics in Python
>>> model = ols("VIQ ~ Gender + 1", data).fit()
>>> print(model.summary())
See the statsmodels documentation
3.1. Statistics in Python
279
3.1. Statistics in Python
280
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Link to t-tests between different FSIQ and PIQ
OLS Regression Results
==============================================================================
Dep. Variable:
VIQ
R-squared:
0.015
Model:
OLS
Adj. R-squared:
-0.010
Method:
Least Squares
F-statistic:
0.5969
Date:
...
Prob (F-statistic):
0.445
Time:
...
Log-Likelihood:
-182.42
No. Observations:
40
AIC:
368.8
Df Residuals:
38
BIC:
372.2
Df Model:
1
=======================================================================...
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------...
Intercept
109.4500
5.308
20.619
0.000
98.704
120.196
Gender[T.Male]
5.8000
7.507
0.773
0.445
-9.397
20.997
=======================================================================...
Omnibus:
26.188
Durbin-Watson:
1.709
Prob(Omnibus):
0.000
Jarque-Bera (JB):
3.703
Skew:
0.010
Prob(JB):
0.157
Kurtosis:
1.510
Cond. No.
2.62
=======================================================================...
To compare different type of IQ, we need to create a “long-form” table, listing IQs, where the type of IQ is
indicated by a categorical variable:
>>>
>>>
>>>
>>>
data_fisq = pandas.DataFrame({'iq': data['FSIQ'], 'type': 'fsiq'})
data_piq = pandas.DataFrame({'iq': data['PIQ'], 'type': 'piq'})
data_long = pandas.concat((data_fisq, data_piq))
print(data_long)
iq type
0
133 fsiq
1
140 fsiq
2
139 fsiq
...
31 137
piq
32 110
piq
33
86
piq
...
>>> model = ols("iq ~ type", data_long).fit()
>>> print(model.summary())
OLS Regression Results
...
=======================================================================...
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------...
Intercept
113.4500
3.683
30.807
0.000
106.119
120.781
type[T.piq]
-2.4250
5.208
-0.466
0.643
-12.793
7.943
...
Tips on specifying model
Forcing categorical: the ‘Gender’ is automatical detected as a categorical variable, and thus each of its
different values are treated as different entities.
An integer column can be forced to be treated as categorical using:
>>> model = ols('VIQ ~ C(Gender)', data).fit()
We can see that we retrieve the same values for t-test and corresponding p-values for the effect of the type
of iq than the previous t-test:
Intercept: We can remove the intercept using - 1 in the formula, or force the use of an intercept using +
1.
>>> stats.ttest_ind(data['FSIQ'], data['PIQ'])
(...0.46563759638..., 0.64277250...)
Tip:
By default, statsmodel treats a categorical variable with K possible values as K-1 ‘dummy’
boolean variables (the last level being absorbed into the intercept term). This is almost always a
good default choice - however, it is possible to specify different encodings for categorical variables
(http://statsmodels.sourceforge.net/devel/contrasts.html).
Multiple Regression: including multiple factors
Consider a linear model explaining a variable z (the dependent variable) with 2 variables x and y:
z = x c 1 + y c2 + i + e
Such a model can be seen in 3D as fitting a plane to a cloud of (x, y, z) points.
3.1. Statistics in Python
281
3.1. Statistics in Python
282
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Post-hoc hypothesis testing: analysis of variance (ANOVA)
Example: the iris data (examples/iris.csv)
Tip: Sepal and petal size tend to be related: bigger flowers are bigger! But is there in addition a systematic effect
of species?
In the above iris example, we wish to test if the petal length is different between versicolor and virginica, after
removing the effect of sepal width. This can be formulated as testing the difference between the coefficient
associated to versicolor and virginica in the linear model estimated above (it is an Analysis of Variance, ANOVA).
For this, we write a vector of ‘contrast’ on the parameters estimated: we want to test "name[T.versicolor]
- name[T.virginica]", with an F-test:
>>> print(model.f_test([0, 1, -1, 0]))
<F test: F=array([[ 3.24533535]]), p=[[ 0.07369059]], df_denom=146, df_num=1>
Is this difference significant?
Exercice
Going back to the brain size + IQ data, test if the VIQ of male and female are different after removing the
effect of brain size, height and weight.
3.1.4 More visualization: seaborn for statistical exploration
Seaborn combines simple statistical fits with plotting on pandas dataframes.
>>> data = pandas.read_csv('examples/iris.csv')
>>> model = ols('sepal_width ~ name + petal_length', data).fit()
>>> print(model.summary())
OLS Regression Results
==============================================================================
Dep. Variable:
sepal_width
R-squared:
0.478
Model:
OLS
Adj. R-squared:
0.468
Method:
Least Squares
F-statistic:
44.63
Date:
...
Prob (F-statistic):
1.58e-20
Time:
...
Log-Likelihood:
-38.185
No. Observations:
150
AIC:
84.37
Df Residuals:
146
BIC:
96.41
Df Model:
3
===========================================================================...
coef
std err
t
P>|t| [95.0% Conf. Int.]
---------------------------------------------------------------------------...
Intercept
2.9813
0.099
29.989
0.000
2.785
3.178
name[T.versicolor]
-1.4821
0.181
-8.190
0.000
-1.840
-1.124
name[T.virginica]
-1.6635
0.256
-6.502
0.000
-2.169
-1.158
petal_length
0.2983
0.061
4.920
0.000
0.178
0.418
==============================================================================
Omnibus:
2.868
Durbin-Watson:
1.753
Prob(Omnibus):
0.238
Jarque-Bera (JB):
2.885
Skew:
-0.082
Prob(JB):
0.236
Kurtosis:
3.659
Cond. No.
54.0
==============================================================================
3.1. Statistics in Python
283
Let us consider a data giving wages and many other personal information on 500 individuals (Berndt, ER. The
Practice of Econometrics. 1991. NY: Addison-Wesley).
Tip: The full code loading and plotting of the wages data is found in corresponding example (page 303).
>>> print data
EDUCATION
0
8
1
9
2
12
3
12
...
SOUTH
0
0
0
0
SEX
1
1
0
0
EXPERIENCE
21
42
1
4
UNION
0
0
0
0
WAGE
0.707570
0.694605
0.824126
0.602060
AGE
35
57
19
22
RACE
2
3
3
3
\
Pairplot: scatter matrices
We can easily have an intuition on the interactions between continuous variables using seaborn.pairplot()
to display a scatter matrix:
>>> import seaborn
>>> seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
...
kind='reg')
3.1. Statistics in Python
284
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Look and feel and matplotlib settings
Seaborn changes the default of matplotlib figures to achieve a more “modern”, “excel-like” look. It does that
upon import. You can reset the default using:
>>> from matplotlib import pyplot as plt
>>> plt.rcdefaults()
Tip: To switch back to seaborn settings, or understand better styling in seaborn, see the relevent section of
the seaborn documentation.
lmplot: plotting a univariate regression
A regression capturing the relation between one variable and another, eg wage and eduction, can be plotted using
seaborn.lmplot():
>>> seaborn.lmplot(y='WAGE', x='EDUCATION', data=data)
Categorical variables can be plotted as the
hue:
>>> seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
...
kind='reg', hue='SEX')
Robust regression
Tip: Given that, in the above plot, there seems to be a couple of data points that are outside of the main
cloud to the right, they might be outliers, not representative of the population, but driving the regression.
To compute a regression that is less sentive to outliers, one must use a robust model. This is done in seaborn
using robust=True in the plotting functions, or in statsmodels by replacing the use of the OLS by a
“Robust Linear Model”, statsmodels.formula.api.rlm().
3.1. Statistics in Python
285
3.1. Statistics in Python
286
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3.1.5 Testing for interactions
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3.1.6 Full examples
Examples
Code examples
Code examples for the statistics in Python tutorial.
Do wages increase more with education for
males than females?
Tip: The plot above is made of two different fits. We need to formulate a single model that tests for a variance of
slope across the to population. This is done via an “interaction”.
>>> result = sm.ols(formula='wage ~ education + gender + education * gender',
...
data=data).fit()
>>> print(result.summary())
...
coef
std err
t
P>|t| [95.0% Conf. Int.]
-----------------------------------------------------------------------------Intercept
0.2998
0.072
4.173
0.000
0.159
0.441
gender[T.male]
0.2750
0.093
2.972
0.003
0.093
0.457
education
0.0415
0.005
7.647
0.000
0.031
0.052
education:gender[T.male]
-0.0134
0.007
-1.919
0.056
-0.027
0.000
==============================================================================
...
Figure 3.1: Boxplots and paired differences (page 288)
Boxplots and paired differences Plot boxplots for FSIQ, PIQ, and the paired difference between the two: while
the spread (error bars) for FSIQ and PIQ are very large, there is a systematic (common) effect due to the subjects.
This effect is cancelled out in the difference and the spread of the difference (“paired” by subject) is much smaller
than the spread of the individual measures.
Can we conclude that education benefits males more than females?
Take home messages
•
•
•
•
Hypothesis testing and p-value give you the significance of an effect / difference
Formulas (with categorical variables) enable you to express rich links in your data
Visualizing your data and simple model fits matters!
Conditionning (adding factors that can explain all or part of the variation) is important modeling
aspect that changes the interpretation.
3.1. Statistics in Python
287
3.1. Statistics in Python
288
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
Figure 3.2: Plotting simple quantities of a pandas dataframe (page 289)
Plotting simple quantities of a pandas dataframe This example loads from a CSV file data with mixed numerical and categorical entries, and plots a few quantities, separately for females and males, thanks to the pandas
integrated plotting tool (that uses matplotlib behind the scene).
See http://pandas.pydata.org/pandas-docs/stable/visualization.html
•
Python source code: plot_paired_boxplots.py
import pandas
import matplotlib.pyplot as plt
data = pandas.read_csv('brain_size.csv', sep=';', na_values='.')
# Box plot of FSIQ and PIQ (different measures od IQ)
plt.figure(figsize=(4, 3))
data.boxplot(column=['FSIQ', 'PIQ'])
# Boxplot of the difference
plt.figure(figsize=(4, 3))
plt.boxplot(data['FSIQ'] - data['PIQ'])
plt.xticks((1, ), ('FSIQ - PIQ', ))
plt.show()
Total running time of the example: 0.29 seconds ( 0 minutes 0.29 seconds)
3.1. Statistics in Python
289
3.1. Statistics in Python
290
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
Python source code: plot_pandas.py
import pandas
data = pandas.read_csv('brain_size.csv', sep=';', na_values='.')
# Box plots of different columns for each gender
groupby_gender = data.groupby('Gender')
groupby_gender.boxplot(column=['FSIQ', 'VIQ', 'PIQ'])
from pandas.tools import plotting
# Scatter matrices for different columns
plotting.scatter_matrix(data[['Weight', 'Height', 'MRI_Count']])
plotting.scatter_matrix(data[['PIQ', 'VIQ', 'FSIQ']])
import matplotlib.pyplot as plt
plt.show()
Total running time of the example: 0.96 seconds ( 0 minutes 0.96 seconds)
Analysis of Iris petal and sepal sizes Ilustrate an analysis on a real dataset:
• Visualizing the data to formulate intuitions
• Fitting of a linear model
• Hypothesis test of the effect of a categorical variable in the presence of a continuous confound
•
3.1. Statistics in Python
291
3.1. Statistics in Python
292
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
OLS Regression Results
==============================================================================
Dep. Variable:
sepal_width
R-squared:
0.478
Model:
OLS
Adj. R-squared:
0.468
Method:
Least Squares
F-statistic:
44.63
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
1.58e-20
Time:
19:08:35
Log-Likelihood:
-38.185
No. Observations:
150
AIC:
84.37
Df Residuals:
146
BIC:
96.41
Df Model:
3
======================================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-------------------------------------------------------------------------------------Intercept
2.9813
0.099
29.989
0.000
2.785
3.178
name[T.versicolor]
-1.4821
0.181
-8.190
0.000
-1.840
-1.124
name[T.virginica]
-1.6635
0.256
-6.502
0.000
-2.169
-1.158
petal_length
0.2983
0.061
4.920
0.000
0.178
0.418
==============================================================================
Omnibus:
2.868
Durbin-Watson:
1.753
Prob(Omnibus):
0.238
Jarque-Bera (JB):
2.885
Skew:
-0.082
Prob(JB):
0.236
Kurtosis:
3.659
Cond. No.
54.0
==============================================================================
Testing the difference between effect of versicolor and virginica
<F test: F=array([[ 3.24533535]]), p=[[ 0.07369059]], df_denom=146, df_num=1>
Python source code: plot_iris_analysis.py
Figure 3.3: Analysis of Iris petal and sepal sizes (page 292)
import matplotlib.pyplot as plt
import pandas
from pandas.tools import plotting
from statsmodels.formula.api import ols
# Load the data
data = pandas.read_csv('iris.csv')
##############################################################################
# Plot a scatter matrix
# Express the names as categories
categories = pandas.Categorical(data['name'])
# The parameter 'c' is passed to plt.scatter and will control the color
plotting.scatter_matrix(data, c=categories.labels, marker='o')
fig = plt.gcf()
fig.suptitle("blue: setosa, green: versicolor, red: virginica", size=13)
##############################################################################
# Statistical analysis
# Let us try to explain the sepal length as a function of the petal
# width and the category of iris
model = ols('sepal_width ~ name + petal_length', data).fit()
print(model.summary())
# Now formulate a "contrast", to test if the offset for versicolor and
# virginica are identical
Script output:
print('Testing the difference between effect of versicolor and virginica')
3.1. Statistics in Python
293
3.1. Statistics in Python
294
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Script output:
print(model.f_test([0, 1, -1, 0]))
plt.show()
OLS Regression Results
==============================================================================
Dep. Variable:
y
R-squared:
0.804
Model:
OLS
Adj. R-squared:
0.794
Method:
Least Squares
F-statistic:
74.03
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
8.56e-08
Time:
19:08:35
Log-Likelihood:
-57.988
No. Observations:
20
AIC:
120.0
Df Residuals:
18
BIC:
122.0
Df Model:
1
==============================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------------Intercept
-5.5335
1.036
-5.342
0.000
-7.710
-3.357
x
2.9369
0.341
8.604
0.000
2.220
3.654
==============================================================================
Omnibus:
0.100
Durbin-Watson:
2.956
Prob(Omnibus):
0.951
Jarque-Bera (JB):
0.322
Skew:
-0.058
Prob(JB):
0.851
Kurtosis:
2.390
Cond. No.
3.03
==============================================================================
Total running time of the example: 0.83 seconds ( 0 minutes 0.83 seconds)
ANOVA results
df
sum_sq
x
1 1588.873443
Residual 18
386.329330
mean_sq
1588.873443
21.462741
F
74.029383
NaN
PR(>F)
8.560649e-08
NaN
Python source code: plot_regression.py
# Original author: Thomas Haslwanter
Figure 3.4: Simple Regression (page 295)
import numpy as np
import matplotlib.pyplot as plt
import pandas
Simple Regression Fit a simple linear regression using ‘statsmodels’, compute corresponding p-values.
# For statistics. Requires statsmodels 5.0 or more
from statsmodels.formula.api import ols
# Analysis of Variance (ANOVA) on linear models
from statsmodels.stats.anova import anova_lm
##############################################################################
# Generate and show the data
x = np.linspace(-5, 5, 20)
# To get reproducable values, provide a seed value
np.random.seed(1)
y = -5 + 3*x + 4 * np.random.normal(size=x.shape)
# Plot the data
plt.figure(figsize=(5, 4))
plt.plot(x, y, 'o')
##############################################################################
# Multilinear regression model, calculating fit, P-values, confidence
# intervals etc.
# Convert the data into a Pandas DataFrame to use the formulas framework
# in statsmodels
data = pandas.DataFrame({'x': x, 'y': y})
# Fit the model
3.1. Statistics in Python
295
3.1. Statistics in Python
296
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
model = ols("y ~ x", data).fit()
# Print the summary
print(model.summary())
# Peform analysis of variance on fitted linear model
anova_results = anova_lm(model)
print('\nANOVA results')
print(anova_results)
##############################################################################
# Plot the fitted model
# Retrieve the parameter estimates
offset, coef = model._results.params
plt.plot(x, x*coef + offset)
plt.xlabel('x')
plt.ylabel('y')
plt.show()
Total running time of the example: 0.17 seconds ( 0 minutes 0.17 seconds)
Script output:
Figure 3.5: Test for an education/gender interaction in wages (page 297)
Test for an education/gender interaction in wages Wages depend mostly on education. Here we investigate
how this dependence is related to gender: not only does gender create an offset in wages, it also seems that wages
increase more with education for males than females.
Does our data support this last hypothesis?
We will test this using statsmodels’ formulas
(http://statsmodels.sourceforge.net/stable/example_formulas.html).
3.1. Statistics in Python
297
OLS Regression Results
==============================================================================
Dep. Variable:
wage
R-squared:
0.193
Model:
OLS
Adj. R-squared:
0.190
Method:
Least Squares
F-statistic:
63.42
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
2.01e-25
Time:
19:08:36
Log-Likelihood:
86.654
No. Observations:
534
AIC:
-167.3
Df Residuals:
531
BIC:
-154.5
Df Model:
2
==================================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
---------------------------------------------------------------------------------Intercept
0.4053
0.046
8.732
0.000
0.314
0.496
gender[T.male]
0.1008
0.018
5.625
0.000
0.066
0.136
education
0.0334
0.003
9.768
0.000
0.027
0.040
==============================================================================
Omnibus:
4.675
Durbin-Watson:
1.792
Prob(Omnibus):
0.097
Jarque-Bera (JB):
4.876
Skew:
-0.147
Prob(JB):
0.0873
Kurtosis:
3.365
Cond. No.
69.7
==============================================================================
OLS Regression Results
==============================================================================
Dep. Variable:
wage
R-squared:
0.198
Model:
OLS
Adj. R-squared:
0.194
Method:
Least Squares
F-statistic:
43.72
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
2.94e-25
3.1. Statistics in Python
298
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Time:
19:08:36
Log-Likelihood:
88.503
No. Observations:
534
AIC:
-169.0
Df Residuals:
530
BIC:
-151.9
Df Model:
3
============================================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-------------------------------------------------------------------------------------------Intercept
0.2998
0.072
4.173
0.000
0.159
0.441
gender[T.male]
0.2750
0.093
2.972
0.003
0.093
0.457
education
0.0415
0.005
7.647
0.000
0.031
0.052
education:gender[T.male]
-0.0134
0.007
-1.919
0.056
-0.027
0.000
==============================================================================
Omnibus:
4.838
Durbin-Watson:
1.825
Prob(Omnibus):
0.089
Jarque-Bera (JB):
5.000
Skew:
-0.156
Prob(JB):
0.0821
Kurtosis:
3.356
Cond. No.
194.
==============================================================================
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
# joined model for male and female, not separate models for male and
# female. The reason is that a single model enables statistical testing
result = sm.ols(formula='wage ~ education + gender', data=data).fit()
print(result.summary())
# The plots above highlight that there is not only a different offset in
# wage but also a different slope
# We need to model this using an interaction
result = sm.ols(formula='wage ~ education + gender + education * gender',
data=data).fit()
print(result.summary())
# Looking at the p-value of the interaction of gender and education, the
# data does not support the hypothesis that education benefits males
# more than female (p-value > 0.05).
Python source code: plot_wage_education_gender.py
import matplotlib.pyplot as plt
plt.show()
##############################################################################
# Load and massage the data
import pandas
Total running time of the example: 0.35 seconds ( 0 minutes 0.35 seconds)
import urllib
import os
if not os.path.exists('wages.txt'):
# Download the file if it is not present
urllib.urlretrieve('http://lib.stat.cmu.edu/datasets/CPS_85_Wages',
'wages.txt')
# EDUCATION: Number of years of education
# SEX: 1=Female, 0=Male
# WAGE: Wage (dollars per hour)
data = pandas.read_csv('wages.txt', skiprows=27, skipfooter=6, sep=None,
header=None, names=['education', 'gender', 'wage'],
usecols=[0, 2, 5],
)
# Convert genders to strings (this is particulary useful so that the
# statsmodels formulas detects that gender is a categorical variable)
import numpy as np
data['gender'] = np.choose(data.gender, ['male', 'female'])
# Log-transform the wages, because they typically are increased with
# multiplicative factors
data['wage'] = np.log10(data['wage'])
##############################################################################
# simple plotting
import seaborn
Figure 3.6: Multiple Regression (page 300)
# Plot 2 linear fits for male and female.
seaborn.lmplot(y='wage', x='education', hue='gender', data=data)
Multiple Regression Calculate using ‘statsmodels’ just the best fit, or all the corresponding statistical parameters.
Also shows how to make 3d plots.
##############################################################################
# statistical analysis
import statsmodels.formula.api as sm
# Note that this model is not the plot displayed above: it is one
3.1. Statistics in Python
299
3.1. Statistics in Python
300
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Residual
438
27576.201607
62.959364
NaN
NaN
Python source code: plot_regression_3d.py
# Original author: Thomas Haslwanter
import numpy as np
import matplotlib.pyplot as plt
import pandas
# For 3d plots. This import is necessary to have 3D plotting below
from mpl_toolkits.mplot3d import Axes3D
# For statistics. Requires statsmodels 5.0 or more
from statsmodels.formula.api import ols
# Analysis of Variance (ANOVA) on linear models
from statsmodels.stats.anova import anova_lm
##############################################################################
# Generate and show the data
x = np.linspace(-5, 5, 21)
# We generate a 2D grid
X, Y = np.meshgrid(x, x)
# To get reproducable values, provide a seed value
np.random.seed(1)
# Z is the elevation of this 2D grid
Z = -5 + 3*X - 0.5*Y + 8 * np.random.normal(size=X.shape)
# Plot the data
fig = plt.figure()
ax = fig.gca(projection='3d')
surf = ax.plot_surface(X, Y, Z, cmap=plt.cm.coolwarm,
rstride=1, cstride=1)
ax.view_init(20, -120)
ax.set_xlabel('X')
ax.set_ylabel('Y')
ax.set_zlabel('Z')
Script output:
OLS Regression Results
==============================================================================
Dep. Variable:
z
R-squared:
0.594
Model:
OLS
Adj. R-squared:
0.592
Method:
Least Squares
F-statistic:
320.4
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
1.89e-86
Time:
19:08:36
Log-Likelihood:
-1537.7
No. Observations:
441
AIC:
3081.
Df Residuals:
438
BIC:
3094.
Df Model:
2
==============================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------------Intercept
-4.5052
0.378
-11.924
0.000
-5.248
-3.763
x
3.1173
0.125
24.979
0.000
2.872
3.363
y
-0.5109
0.125
-4.094
0.000
-0.756
-0.266
==============================================================================
Omnibus:
0.260
Durbin-Watson:
2.057
Prob(Omnibus):
0.878
Jarque-Bera (JB):
0.204
Skew:
-0.052
Prob(JB):
0.903
Kurtosis:
3.015
Cond. No.
3.03
==============================================================================
##############################################################################
# Multilinear regression model, calculating fit, P-values, confidence
# intervals etc.
# Convert the data into a Pandas DataFrame to use the formulas framework
# in statsmodels
#
X
Y
Z
data = pandas.DataFrame({'x': X, 'y': Y, 'z': Z})
# Fit the model
model = ols("z ~ x + y", data).fit()
Retrieving manually the parameter estimates:
[-4.50523303 3.11734237 -0.51091248]
ANOVA results
df
x
1
y
1
sum_sq
39284.301219
1055.220089
3.1. Statistics in Python
mean_sq
39284.301219
1055.220089
F
623.962799
16.760336
First we need to flatten the data: it's 2D layout is not relevent.
= X.flatten()
= Y.flatten()
= Z.flatten()
# Print the summary
print(model.summary())
print("\nRetrieving manually the parameter estimates:")
print(model._results.params)
# should be array([-4.99754526, 3.00250049, -0.50514907])
PR(>F)
2.888238e-86
5.050899e-05
301
3.1. Statistics in Python
302
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
# Peform analysis of variance on fitted linear model
anova_results = anova_lm(model)
print('\nANOVA results')
print(anova_results)
plt.show()
Total running time of the example: 0.15 seconds ( 0 minutes 0.15 seconds)
Figure 3.7: Visualizing factors influencing wages (page 303)
•
Visualizing factors influencing wages This example uses seaborn to quickly plot various factors relating wages,
experience and eduction.
Seaborn (http://stanford.edu/~mwaskom/software/seaborn/) is a library that combines visualization and statistical
fits to show trends in data.
Note that importing seaborn changes the matplotlib style to have an “excel-like” feeling. This changes affect other
matplotlib figures. To restore defaults once this example is run, we would need to call plt.rcdefaults().
3.1. Statistics in Python
303
3.1. Statistics in Python
304
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
3.1. Statistics in Python
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
305
3.1. Statistics in Python
306
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
Script output:
loading seaborn
•
Python source code: plot_wage_data.py
# Standard library imports
import urllib
import os
import matplotlib.pyplot as plt
##############################################################################
# Load the data
import pandas
if not os.path.exists('wages.txt'):
# Download the file if it is not present
urllib.urlretrieve('http://lib.stat.cmu.edu/datasets/CPS_85_Wages',
'wages.txt')
# Give names to the columns
names = [
'EDUCATION: Number of years of education',
'SOUTH: 1=Person lives in South, 0=Person lives elsewhere',
'SEX: 1=Female, 0=Male',
'EXPERIENCE: Number of years of work experience',
'UNION: 1=Union member, 0=Not union member',
'WAGE: Wage (dollars per hour)',
'AGE: years',
3.1. Statistics in Python
307
3.1. Statistics in Python
308
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
'RACE: 1=Other, 2=Hispanic, 3=White',
'OCCUPATION: 1=Management, 2=Sales, 3=Clerical, 4=Service, 5=Professional, 6=Other',
'SECTOR: 0=Other, 1=Manufacturing, 2=Construction',
'MARR: 0=Unmarried, 1=Married',
]
short_names = [n.split(':')[0] for n in names]
data = pandas.read_csv('wages.txt', skiprows=27, skipfooter=6, sep=None,
header=None)
data.columns = short_names
# Log-transform the wages, because they typically are increased with
# multiplicative factors
import numpy as np
data['WAGE'] = np.log10(data['WAGE'])
##############################################################################
# Plot scatter matrices highlighting different aspects
import seaborn
seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
kind='reg')
seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
kind='reg', hue='SEX')
plt.suptitle('Effect of gender: 1=Female, 0=Male')
Figure 3.8: Air fares before and after 9/11 (page 309)
seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
kind='reg', hue='RACE')
plt.suptitle('Effect of race: 1=Other, 2=Hispanic, 3=White')
seaborn.pairplot(data, vars=['WAGE', 'AGE', 'EDUCATION'],
kind='reg', hue='UNION')
plt.suptitle('Effect of union: 1=Union member, 0=Not union member')
##############################################################################
# Plot a simple regression
seaborn.lmplot(y='WAGE', x='EDUCATION', data=data)
plt.show()
Total running time of the example: 6.58 seconds ( 0 minutes 6.58 seconds)
Air fares before and after 9/11 This is a business-intelligence (BI) like application.
What is interesting here is that we may want to study fares as a function of the year, paired accordingly to the
trips, or forgetting the year, only as a function of the trip endpoints.
Using statsmodels’ linear models, we find that both with an OLS (ordinary least square) and a robust fit, the
intercept and the slope are significantly non-zero: the air fares have decreased between 2000 and 2001, and their
dependence on distance travelled has also decreased
3.1. Statistics in Python
309
3.1. Statistics in Python
310
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
•
•
•
•
Script output:
OLS Regression Results
==============================================================================
Dep. Variable:
fare
R-squared:
0.275
Model:
OLS
Adj. R-squared:
0.275
Method:
Least Squares
F-statistic:
1585.
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
0.00
Time:
19:08:53
Log-Likelihood:
-45532.
No. Observations:
8352
AIC:
9.107e+04
Df Residuals:
8349
BIC:
9.109e+04
Df Model:
2
=================================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
--------------------------------------------------------------------------------Intercept
211.2428
2.466
85.669
0.000
206.409
216.076
•
3.1. Statistics in Python
311
3.1. Statistics in Python
312
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
dist
0.0484
0.001
48.149
0.000
0.046
0.050
nb_passengers
-32.8925
1.127
-29.191
0.000
-35.101
-30.684
==============================================================================
Omnibus:
604.051
Durbin-Watson:
1.446
Prob(Omnibus):
0.000
Jarque-Bera (JB):
740.733
Skew:
0.710
Prob(JB):
1.42e-161
Kurtosis:
3.338
Cond. No.
5.23e+03
==============================================================================
Warnings:
[1] The condition number is large, 5.23e+03. This might indicate that there are
strong multicollinearity or other numerical problems.
Robust linear Model Regression Results
==============================================================================
Dep. Variable:
fare
No. Observations:
8352
Model:
RLM
Df Residuals:
8349
Method:
IRLS
Df Model:
2
Norm:
HuberT
Scale Est.:
mad
Cov Type:
H1
Date:
Mon, 21 Sep 2015
Time:
19:08:53
No. Iterations:
12
=================================================================================
coef
std err
z
P>|z|
[95.0% Conf. Int.]
--------------------------------------------------------------------------------Intercept
215.0848
2.448
87.856
0.000
210.287
219.883
dist
0.0460
0.001
46.166
0.000
0.044
0.048
nb_passengers
-35.2686
1.119
-31.526
0.000
-37.461
-33.076
=================================================================================
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
import os
##############################################################################
# Load the data
import pandas
if not os.path.exists('airfares.txt'):
# Download the file if it is not present
urllib.urlretrieve(
'http://www.stat.ufl.edu/~winner/data/airq4.dat',
'airfares.txt')
# As a seperator, ' +' is a regular expression that means 'one of more
# space'
data = pandas.read_csv('airfares.txt', sep=' +', header=0,
names=['city1', 'city2', 'pop1', 'pop2',
'dist', 'fare_2000', 'nb_passengers_2000',
'fare_2001', 'nb_passengers_2001'])
# we log-transform the number of passengers
import numpy as np
data['nb_passengers_2000'] = np.log10(data['nb_passengers_2000'])
data['nb_passengers_2001'] = np.log10(data['nb_passengers_2001'])
##############################################################################
# Make a dataframe whith the year as an attribute, instead of separate columns
# This involves a small danse in which we separate the dataframes in 2,
# one for year 2000, and one for 2001, before concatenating again.
# Make an index of each flight
data_flat = data.reset_index()
If the model instance has been used for another fit with different fit
parameters, then the fit options might not be the correct ones anymore .
OLS Regression Results
==============================================================================
Dep. Variable:
fare_2001
R-squared:
0.159
Model:
OLS
Adj. R-squared:
0.159
Method:
Least Squares
F-statistic:
791.7
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
1.20e-159
Time:
19:08:53
Log-Likelihood:
-22640.
No. Observations:
4176
AIC:
4.528e+04
Df Residuals:
4174
BIC:
4.530e+04
Df Model:
1
==============================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
-----------------------------------------------------------------------------Intercept
148.0279
1.673
88.480
0.000
144.748
151.308
dist
0.0388
0.001
28.136
0.000
0.036
0.041
==============================================================================
Omnibus:
136.558
Durbin-Watson:
1.544
Prob(Omnibus):
0.000
Jarque-Bera (JB):
149.624
Skew:
0.462
Prob(JB):
3.23e-33
Kurtosis:
2.920
Cond. No.
2.40e+03
==============================================================================
data_2000 = data_flat[['city1', 'city2', 'pop1', 'pop2',
'dist', 'fare_2000', 'nb_passengers_2000']]
# Rename the columns
data_2000.columns = ['city1', 'city2', 'pop1', 'pop2', 'dist', 'fare',
'nb_passengers']
# Add a column with the year
data_2000['year'] = 2000
data_2001 = data_flat[['city1', 'city2', 'pop1', 'pop2',
'dist', 'fare_2001', 'nb_passengers_2001']]
# Rename the columns
data_2001.columns = ['city1', 'city2', 'pop1', 'pop2', 'dist', 'fare',
'nb_passengers']
# Add a column with the year
data_2001['year'] = 2001
data_flat = pandas.concat([data_2000, data_2001])
##############################################################################
# Plot scatter matrices highlighting different aspects
Warnings:
[1] The condition number is large, 2.4e+03. This might indicate that there are
strong multicollinearity or other numerical problems.
import seaborn
seaborn.pairplot(data_flat, vars=['fare', 'dist', 'nb_passengers'],
kind='reg', markers='.')
Python source code: plot_airfare.py
# A second plot, to show the effect of the year (ie the 9/11 effect)
seaborn.pairplot(data_flat, vars=['fare', 'dist', 'nb_passengers'],
kind='reg', hue='year', markers='.')
# Standard library imports
import urllib
3.1. Statistics in Python
313
3.1. Statistics in Python
314
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
##############################################################################
# Plot the difference in fare
import matplotlib.pyplot as plt
plt.figure(figsize=(5, 2))
seaborn.boxplot(data.fare_2001 - data.fare_2000)
plt.title('Fare: 2001 - 2000')
plt.subplots_adjust()
plt.figure(figsize=(5, 2))
seaborn.boxplot(data.nb_passengers_2001 - data.nb_passengers_2000)
plt.title('NB passengers: 2001 - 2000')
plt.subplots_adjust()
##############################################################################
# Statistical testing: dependence of fare on distance and number of
# passengers
import statsmodels.formula.api as sm
result = sm.ols(formula='fare ~ 1 + dist + nb_passengers', data=data_flat).fit()
print(result.summary())
# Using a robust fit
result = sm.rlm(formula='fare ~ 1 + dist + nb_passengers', data=data_flat).fit()
print(result.summary())
Figure 3.9: Relating Gender and IQ (page 315)
##############################################################################
# Statistical testing: regression of fare on distance: 2001/2000 difference
result = sm.ols(formula='fare_2001 - fare_2000 ~ 1 + dist', data=data).fit()
print(result.summary())
# Plot the corresponding regression
data['fare_difference'] = data['fare_2001'] - data['fare_2000']
seaborn.lmplot(x='dist', y='fare_difference', data=data)
plt.show()
Total running time of the example: 9.49 seconds ( 0 minutes 9.49 seconds)
Solutions to the exercises of the course
Relating Gender and IQ Going back to the brain size + IQ data, test if the VIQ of male and female are different
after removing the effect of brain size, height and weight.
Notice that here ‘Gender’ is a categorical value. As it is a non-float data type, statsmodels is able to automatically
infer this.
Script output:
3.1. Statistics in Python
315
3.1. Statistics in Python
316
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
OLS Regression Results
==============================================================================
Dep. Variable:
VIQ
R-squared:
0.246
Model:
OLS
Adj. R-squared:
0.181
Method:
Least Squares
F-statistic:
3.809
Date:
Mon, 21 Sep 2015
Prob (F-statistic):
0.0184
Time:
07:37:45
Log-Likelihood:
-172.34
No. Observations:
39
AIC:
352.7
Df Residuals:
35
BIC:
359.3
Df Model:
3
==================================================================================
coef
std err
t
P>|t|
[95.0% Conf. Int.]
---------------------------------------------------------------------------------Intercept
166.6258
88.824
1.876
0.069
-13.696
346.948
Gender[T.Male]
8.8524
10.710
0.827
0.414
-12.890
30.595
MRI_Count
0.0002
6.46e-05
2.615
0.013
3.78e-05
0.000
Height
-3.0837
1.276
-2.417
0.021
-5.674
-0.494
==============================================================================
Omnibus:
7.373
Durbin-Watson:
2.109
Prob(Omnibus):
0.025
Jarque-Bera (JB):
2.252
Skew:
0.005
Prob(JB):
0.324
Kurtosis:
1.823
Cond. No.
2.40e+07
==============================================================================
Warnings:
[1] The condition number is large, 2.4e+07. This might indicate that there are
strong multicollinearity or other numerical problems.
<F test: F=array([[ 0.68319608]]), p=[[ 0.41408784]], df_denom=35, df_num=1>
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
c=(data['Gender'] == 'Female'), marker='o',
alpha=1, cmap='winter')
fig = plt.gcf()
fig.suptitle("blue: male, green: female", size=13)
plt.show()
Total running time of the example: 0.62 seconds ( 0 minutes 0.62 seconds)
3.2 Sympy : Symbolic Mathematics in Python
Author: Fabian Pedregosa
Objectives
1.
2.
3.
4.
5.
Evaluate expressions with arbitrary precision.
Perform algebraic manipulations on symbolic expressions.
Perform basic calculus tasks (limits, differentiation and integration) with symbolic expressions.
Solve polynomial and transcendental equations.
Solve some differential equations.
What is SymPy? SymPy is a Python library for symbolic mathematics. It aims to be an alternative to systems
such as Mathematica or Maple while keeping the code as simple as possible and easily extensible. SymPy is
written entirely in Python and does not require any external libraries.
Python source code: plot_brain_size.py
Sympy documentation and packages for installation can be found on http://www.sympy.org/
import pandas
from statsmodels.formula.api import ols
Chapters contents
data = pandas.read_csv('../brain_size.csv', sep=';', na_values='.')
• First Steps with SymPy (page 318)
– Using SymPy as a calculator (page 318)
– Exercises (page 319)
– Symbols (page 319)
• Algebraic manipulations (page 320)
– Expand (page 320)
– Simplify (page 320)
• Calculus (page 320)
– Limits (page 320)
– Differentiation (page 321)
– Series expansion (page 321)
– Integration (page 322)
– Exercises (page 322)
• Equation solving (page 322)
– Exercises (page 323)
• Linear Algebra (page 323)
– Matrices (page 323)
– Differential Equations (page 324)
model = ols('VIQ ~ Gender + MRI_Count + Height', data).fit()
print(model.summary())
# Here, we don't need to define a contrast, as we are testing a single
# coefficient of our model, and not a combination of coefficients.
# However, defining a contrast, which would then be a 'unit contrast',
# will give us the same results
print(model.f_test([0, 1, 0, 0]))
###############################################################################
# Here we plot a scatter matrix to get intuitions on our results.
# This goes beyond what was asked in the exercise
# This plotting is useful to get an intuitions on the relationships between
# our different variables
from pandas.tools import plotting
import matplotlib.pyplot as plt
# Fill in the missing values for Height for plotting
data['Height'].fillna(method='pad', inplace=True)
3.2.1 First Steps with SymPy
# The parameter 'c' is passed to plt.scatter and will control the color
# The same holds for parameters 'marker', 'alpha' and 'cmap', that
# control respectively the type of marker used, their transparency and
# the colormap
plotting.scatter_matrix(data[['VIQ', 'MRI_Count', 'Height']],
3.1. Statistics in Python
Using SymPy as a calculator
SymPy defines three numerical types: Real, Rational and Integer.
317
3.2. Sympy : Symbolic Mathematics in Python
318
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The Rational class represents a rational number as a pair of two Integers: the numerator and the denominator, so
Rational(1,2) represents 1/2, Rational(5,2) 5/2 and so on:
>>> from sympy import *
>>> a = Rational(1,2)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Printing
Here we use the following setting for printing
>>> sympy.init_printing(use_unicode=False, wrap_line=True)
>>> a
1/2
3.2.2 Algebraic manipulations
>>> a*2
1
SymPy uses mpmath in the background, which makes it possible to perform computations using arbitraryprecision arithmetic. That way, some special constants, like e, pi, oo (Infinity), are treated as symbols and can be
evaluated with arbitrary precision:
Expand
>>> pi**2
2
pi
Use this to expand an algebraic expression. It will try to denest powers and multiplications:
>>> expand((x + y)**3)
3
2
2
3
x + 3*x *y + 3*x*y + y
>>> 3*x*y**2 + 3*y*x**2 + x**3 + y**3
3
2
2
3
x + 3*x *y + 3*x*y + y
>>> pi.evalf()
3.14159265358979
>>> (pi + exp(1)).evalf()
5.85987448204884
as you see, evalf evaluates the expression to a floating-point number.
Further options can be given in form on keywords:
There is also a class representing mathematical infinity, called oo:
>>> expand(x + y, complex=True)
re(x) + re(y) + I*im(x) + I*im(y)
>>> I*im(x) + I*im(y) + re(x) + re(y)
re(x) + re(y) + I*im(x) + I*im(y)
>>> oo > 99999
True
>>> oo + 1
oo
>>> expand(cos(x + y), trig=True)
-sin(x)*sin(y) + cos(x)*cos(y)
>>> cos(x)*cos(y) - sin(x)*sin(y)
-sin(x)*sin(y) + cos(x)*cos(y)
Exercises
1. Calculate
SymPy is capable of performing powerful algebraic manipulations. We’ll take a look into some of the most
frequently used: expand and simplify.
√
2 with 100 decimals.
Simplify
2. Calculate 1/2 + 1/3 in rational arithmetic.
Use simplify if you would like to transform an expression into a simpler form:
Symbols
>>> simplify((x + x*y) / x)
y + 1
In contrast to other Computer Algebra Systems, in SymPy you have to declare symbolic variables explicitly:
Simplification is a somewhat vague term, and more precises alternatives to simplify exists: powsimp (simplification of exponents), trigsimp (for trigonometric expressions) , logcombine, radsimp, together.
>>> from sympy import *
>>> x = Symbol('x')
>>> y = Symbol('y')
Exercises
Then you can manipulate them:
1. Calculate the expanded form of (x + y)6 .
2. Simplify the trigonometric expression sin(x)/ cos(x)
>>> x + y + x - y
2*x
>>> (x + y)**2
2
(x + y)
3.2.3 Calculus
Symbols can now be manipulated using some of python operators: +, -, *, ** (arithmetic), &, |, ~ , >>, <<
(boolean).
Limits
Limits are easy to use in SymPy, they follow the syntax limit(function, variable, point), so to compute the limit of
f (x) as x → 0, you would issue limit(f, x, 0):
3.2. Sympy : Symbolic Mathematics in Python
319
3.2. Sympy : Symbolic Mathematics in Python
320
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> limit(sin(x)/x, x, 0)
1
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercises
1. Calculate limx→0 sin(x)/x
2. Calculate the derivative of log(x) for x.
you can also calculate the limit at infinity:
>>> limit(x, x, oo)
oo
Integration
>>> limit(1/x, x, oo)
0
SymPy has support for indefinite and definite integration of transcendental elementary and special functions via
integrate() facility, which uses powerful extended Risch-Norman algorithm and some heuristics and pattern
matching. You can integrate elementary functions:
>>> limit(x**x, x, 0)
1
>>> integrate(6*x**5, x)
6
x
>>> integrate(sin(x), x)
-cos(x)
>>> integrate(log(x), x)
x*log(x) - x
>>> integrate(2*x + sinh(x), x)
2
x + cosh(x)
Differentiation
You can differentiate any SymPy expression using diff(func, var). Examples:
>>> diff(sin(x), x)
cos(x)
>>> diff(sin(2*x), x)
2*cos(2*x)
>>> diff(tan(x), x)
2
tan (x) + 1
Also special functions are handled easily:
>>> integrate(exp(-x**2)*erf(x), x)
____
2
\/ pi *erf (x)
-------------4
You can check, that it is correct by:
>>> limit((tan(x+y) - tan(x))/y, y, 0)
2
tan (x) + 1
It is possible to compute definite integral:
Higher derivatives can be calculated using the diff(func, var, n) method:
>>> integrate(x**3, (x, -1, 1))
0
>>> integrate(sin(x), (x, 0, pi/2))
1
>>> integrate(cos(x), (x, -pi/2, pi/2))
2
>>> diff(sin(2*x), x, 1)
2*cos(2*x)
>>> diff(sin(2*x), x, 2)
-4*sin(2*x)
Also improper integrals are supported as well:
>>> diff(sin(2*x), x, 3)
-8*cos(2*x)
>>> integrate(exp(-x), (x, 0, oo))
1
>>> integrate(exp(-x**2), (x, -oo, oo))
____
\/ pi
Series expansion
SymPy also knows how to compute the Taylor series of an expression at a point. Use series(expr, var):
>>> series(cos(x), x)
2
4
x
x
/ 6\
1 - -- + -- + O\x /
2
24
>>> series(1/cos(x), x)
2
4
x
5*x
/ 6\
1 + -- + ---- + O\x /
2
24
Exercises
3.2.4 Equation solving
SymPy is able to solve algebraic equations, in one and several variables:
In [7]: solve(x**4 - 1, x)
Out[7]: [I, 1, -1, -I]
As you can see it takes as first argument an expression that is supposed to be equaled to 0. It is able to solve a large
part of polynomial equations, and is also capable of solving multiple equations with respect to multiple variables
giving a tuple as second argument:
3.2. Sympy : Symbolic Mathematics in Python
321
3.2. Sympy : Symbolic Mathematics in Python
322
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Differential Equations
In [8]: solve([x + 5*y - 2, -3*x + 6*y - 15], [x, y])
Out[8]: {y: 1, x: -3}
SymPy is capable of solving (some) Ordinary Differential. To solve differential equations, use dsolve. First, create
an undefined function by passing cls=Function to the symbols function:
It also has (limited) support for trascendental equations:
>>> f, g = symbols('f g', cls=Function)
In [9]: solve(exp(x) + 1, x)
Out[9]: [pi*I]
f and g are now undefined functions. We can call f(x), and it will represent an unknown function:
Another alternative in the case of polynomial equations is factor. factor returns the polynomial factorized
into irreducible terms, and is capable of computing the factorization over various domains:
In [10]: f = x**4 - 3*x**2 + 1
In [11]: factor(f)
Out[11]: (1 + x - x**2)*(1 - x - x**2)
>>> f(x).diff(x, x) + f(x)
2
d
f(x) + ---(f(x))
2
dx
In [12]: factor(f, modulus=5)
Out[12]: (2 + x)**2*(2 - x)**2
SymPy is also able to solve boolean equations, that is, to decide if a certain boolean expression is satisfiable or
not. For this, we use the function satisfiable:
In [13]: satisfiable(x & y)
Out[13]: {x: True, y: True}
This tells us that (x & y) is True whenever x and y are both True. If an expression cannot be true, i.e. no values of
its arguments can make the expression True, it will return False:
>>> dsolve(f(x).diff(x, x) + f(x), f(x))
f(x) = C1*sin(x) + C2*cos(x)
Keyword arguments can be given to this function in order to help if find the best possible resolution system. For
example, if you know that it is a separable equations, you can use keyword hint=’separable’ to force dsolve to
resolve it as a separable equation:
>>> dsolve(sin(x)*cos(f(x)) + cos(x)*sin(f(x))*f(x).diff(x), f(x), hint='separable')
/
_____________\
/
_____________\
|
/
C1
|
|
/
C1
|
[f(x) = - asin|
/ ------- + 1 | + pi, f(x) = asin|
/ ------- + 1 | + pi,
| /
2
|
| /
2
|
\\/
cos (x)
/
\\/
cos (x)
/
In [14]: satisfiable(x & ~x)
Out[14]: False
Exercises
/
_____________\
/
_____________\
|
/
C1
|
|
/
C1
|
f(x) = -asin|
/ ------- + 1 |, f(x) = asin|
/ ------- + 1 |]
| /
2
|
| /
2
|
\\/
cos (x)
/
\\/
cos (x)
/
1. Solve the system of equations x + y = 2, 2 · x + y = 0
2. Are there boolean values x, y that make (~x | y) & (~y | x) true?
3.2.5 Linear Algebra
Matrices
Exercises
1. Solve the Bernoulli differential equation
Matrices are created as instances from the Matrix class:
>>>
>>>
[1
[
[0
>>> f(x)
f(x)
from sympy import Matrix
Matrix([[1,0], [0,1]])
0]
]
1]
x
df (x)
+ f (x) − f (x)2 = 0
x
2. Solve the same equation using hint=’Bernoulli’. What do you observe ?
unlike a NumPy array, you can also put Symbols in it:
>>>
>>>
>>>
>>>
[1
[
[y
3.3 Scikit-image: image processing
x = Symbol('x')
y = Symbol('y')
A = Matrix([[1,x], [y,1]])
A
x]
]
1]
>>> A**2
[x*y + 1
[
[ 2*y
Author: Emmanuelle Gouillart
scikit-image is a Python package dedicated to image processing, and using natively NumPy arrays as image
objects. This chapter describes how to use scikit-image on various image processing tasks, and insists on the
link with other scientific Python modules such as NumPy and SciPy.
See also:
2*x
]
]
x*y + 1]
3.2. Sympy : Symbolic Mathematics in Python
For basic image manipulation, such as image cropping or simple filtering, a large number of simple operations
can be realized with NumPy and SciPy only. See Image manipulation and processing using Numpy and Scipy
323
3.3. Scikit-image: image processing
324
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
(page 222).
Note that you should be familiar with the content of the previous chapter before reading the current one, as basic
operations such as masking and labeling are a prerequisite.
Chapters contents
• Introduction and concepts (page 325)
– scikit-image and the SciPy ecosystem (page 326)
– What’s to be found in scikit-image (page 326)
• Input/output, data types and colorspaces (page 327)
– Data types (page 328)
– Colorspaces (page 328)
• Image preprocessing / enhancement (page 329)
– Local filters (page 329)
– Non-local filters (page 330)
– Mathematical morphology (page 330)
• Image segmentation (page 332)
– Binary segmentation: foreground + background (page 332)
– Marker based methods (page 333)
• Measuring regions’ properties (page 335)
• Data visualization and interaction (page 335)
• Feature extraction for computer vision (page 337)
scikit-image and the SciPy ecosystem
3.3.1 Introduction and concepts
Recent versions of scikit-image is packaged in most Scientific Python distributions, such as Anaconda or
Enthought Canopy. It is also packaged for Ubuntu/Debian.
Images are NumPy’s arrays np.ndarray
>>> import skimage
>>> from skimage import data
image np.ndarray
pixels array values: a[2, 3]
Most scikit-image functions take NumPy ndarrays as arguments
channels array dimensions
>>> camera = data.camera()
>>> camera.dtype
dtype('uint8')
>>> camera.shape
(512, 512)
>>> from skimage import restoration
>>> filtered_camera = restoration.denoise_bilateral(camera)
>>> type(filtered_camera)
<type 'numpy.ndarray'>
image encoding dtype (np.uint8, np.uint16, np.float)
filters functions (numpy, skimage, scipy)
>>>
>>>
>>>
>>>
>>>
>>>
# most functions are in subpackages
import numpy as np
check = np.zeros((9, 9))
check[::2, 1::2] = 1
check[1::2, ::2] = 1
import matplotlib.pyplot as plt
plt.imshow(check, cmap='gray', interpolation='nearest')
Other Python packages are available for image processing and work with NumPy arrays:
• scipy.ndimage : for nd-arrays. Basic filtering, mathematical morphology, regions properties
• Mahotas
Also, powerful image processing libraries have Python bindings:
• OpenCV (computer vision)
• ITK (3D images and registration)
• and many others
(but they are less Pythonic and NumPy friendly, to a variable extent).
What’s to be found in scikit-image
• Website: http://scikit-image.org/
3.3. Scikit-image: image processing
325
3.3. Scikit-image: image processing
326
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
• Gallery of examples (as in matplotlib or scikit-learn): http://scikit-image.org/docs/stable/auto_examples/
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Data types
Different kinds of functions, from boilerplate utility functions to high-level recent algorithms.
• Filters: functions transforming images into other images.
– NumPy machinery
– Common filtering algorithms
• Data reduction functions: computation of image histogram, position of local maxima, of corners, etc.
• Other actions: I/O, visualization, etc.
Image ndarrays can be represented either by integers
3.3.2 Input/output, data types and colorspaces
(signed or unsigned) or floats.
Careful with overflows with integer data types
I/O: skimage.io
>>> camera = data.camera()
>>> camera.dtype
dtype('uint8')
>>> camera_multiply = 3 * camera
>>> from skimage import io
Reading from files: skimage.io.imread()
>>> import os
>>> filename = os.path.join(skimage.data_dir, 'camera.png')
>>> camera = io.imread(filename)
Different integer sizes are possible: 8-, 16- or 32-bytes, signed or unsigned.
Warning: An important (if questionable) skimage convention: float images are supposed to lie in [-1, 1]
(in order to have comparable contrast for all float images)
>>> from skimage import img_as_float
>>> camera_float = img_as_float(camera)
>>> camera.max(), camera_float.max()
(255, 1.0)
Some image processing routines need to work with float arrays, and may hence output an array with a different
type and the data range from the input array
>>> try:
...
from skimage import filters
... except ImportError:
...
from skimage import filter as filters
>>> camera_sobel = filters.sobel(camera)
>>> camera_sobel.max()
0.591502...
Works with all data formats supported by the Python
Imaging Library (or any other I/O plugin provided to imread with the plugin keyword argument).
Warning: In the example above, we use the filters submodule of scikit-image, that has been renamed
from filter to filters between versions 0.10 and 0.11, in order to avoid a collision with Python’s built-in
name filter.
Also works with URL image paths:
>>> logo = io.imread('http://scikit-image.org/_static/img/logo.png')
Utility functions are provided in skimage to convert both the dtype and the data range, following skimage’s
conventions: util.img_as_float, util.img_as_ubyte, etc.
Saving to files:
See the user guide for more details.
>>> io.imsave('local_logo.png', logo)
Colorspaces
(imsave also uses an external plugin such as PIL)
Color images are of shape (N, M, 3) or (N, M, 4) (when an alpha channel encodes transparency)
>>> lena = data.lena()
>>> lena.shape
(512, 512, 3)
3.3. Scikit-image: image processing
327
3.3. Scikit-image: image processing
328
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Routines converting between different colorspaces (RGB, HSV, LAB etc.) are available in skimage.color :
color.rgb2hsv, color.lab2rgb, etc. Check the docstring for the expected dtype (and data range) of input
images.
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Non-local filters
Non-local filters use a large region of the image (or all the image) to transform the value of one pixel:
>>> from skimage import exposure
>>> camera = data.camera()
>>> camera_equalized = exposure.equalize_hist(camera)
3D images
Most functions of skimage can take 3D images as input arguments. Check the docstring to know if a
function can be used on 3D images (for example MRI or CT images).
Exercise
Open a color image on your disk as a NumPy array.
Find a skimage function computing the histogram of an image and plot the histogram of each
color channel
Convert the image to grayscale and plot its histogram.
Enhances contrast in large almost uniform regions.
3.3.3 Image preprocessing / enhancement
Mathematical morphology
Goals: denoising, feature (edges) extraction, ...
See https://en.wikipedia.org/wiki/Mathematical_morphology
Local filters
Probe an image with a simple shape (a structuring element), and modify this image according to how the shape
locally fits or misses the image.
Local filters replace the value of pixels by a function of the values of neighboring pixels. The function can be
linear or non-linear.
Default structuring element: 4-connectivity of a pixel
>>> from skimage import morphology
>>> morphology.diamond(1)
array([[0, 1, 0],
[1, 1, 1],
[0, 1, 0]], dtype=uint8)
Neighbourhood: square (choose size), disk, or more complicated structuring element.
Example : horizontal Sobel filter
>>> text = data.text()
>>> hsobel_text = filters.hsobel(text)
Uses the following linear kernel for computing horizontal gradients:
1
0
-1
2
0
-2
Erosion = minimum filter. Replace the value of a pixel by the minimal value covered by the structuring element.:
1
0
-1
3.3. Scikit-image: image processing
>>> a = np.zeros((7,7), dtype=np.int)
>>> a[1:6, 2:5] = 1
>>> a
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 1, 1, 1, 0, 0],
[0, 0, 0, 0, 0, 0, 0]])
>>> morphology.binary_erosion(a, morphology.diamond(1)).astype(np.uint8)
329
3.3. Scikit-image: image processing
330
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
scipy.ndimage implementation works on arbitrary-dimensional arrays.
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 1, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]], dtype=uint8)
>>> #Erosion removes objects smaller than the structure
>>> morphology.binary_erosion(a, morphology.diamond(2)).astype(np.uint8)
array([[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0],
[0, 0, 0, 0, 0, 0, 0]], dtype=uint8)
Example of filters comparison: image denoising
>>>
>>>
>>>
>>>
>>>
>>>
>>>
from skimage.morphology import disk
coins = data.coins()
coins_zoom = coins[10:80, 300:370]
median_coins = filters.rank.median(coins_zoom, disk(1))
from skimage import restoration
tv_coins = restoration.denoise_tv_chambolle(coins_zoom, weight=0.1)
gaussian_coins = filters.gaussian_filter(coins, sigma=2)
Dilation: maximum filter:
>>> a = np.zeros((5, 5))
>>> a[2, 2] = 1
>>> a
array([[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 1., 0., 0.],
[ 0., 0., 0., 0., 0.],
[ 0., 0., 0., 0., 0.]])
>>> morphology.binary_dilation(a, morphology.diamond(1)).astype(np.uint8)
array([[0, 0, 0, 0, 0],
[0, 0, 1, 0, 0],
[0, 1, 1, 1, 0],
[0, 0, 1, 0, 0],
[0, 0, 0, 0, 0]], dtype=uint8)
3.3.4 Image segmentation
Image segmentation is the attribution of different labels to different regions of the image, for example in order to
extract the pixels of an object of interest.
Binary segmentation: foreground + background
Opening: erosion + dilation:
Histogram-based method: Otsu thresholding
>>> a = np.zeros((5,5), dtype=np.int)
>>> a[1:4, 1:4] = 1; a[4, 4] = 1
>>> a
array([[0, 0, 0, 0, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 1, 1, 1, 0],
[0, 0, 0, 0, 1]])
>>> morphology.binary_opening(a, morphology.diamond(1)).astype(np.uint8)
array([[0, 0, 0, 0, 0],
[0, 0, 1, 0, 0],
[0, 1, 1, 1, 0],
[0, 0, 1, 0, 0],
[0, 0, 0, 0, 0]], dtype=uint8)
Tip: The Otsu method is a simple heuristic to find a threshold to separate the foreground from the background.
Earlier scikit-image versions
skimage.filters is called skimage.filter in earlier versions of scikit-image
from skimage import data
from skimage import filters
camera = data.camera()
val = filters.threshold_otsu(camera)
mask = camera < val
Opening removes small objects and smoothes corners.
Grayscale mathematical morphology
Mathematical morphology operations are also available for (non-binary) grayscale images (int or float type).
Erosion and dilation correspond to minimum (resp. maximum) filters.
Higher-level mathematical morphology are available: tophat, skeletonization, etc.
See also:
Basic mathematical morphology is also implemented in scipy.ndimage.morphology.
The
3.3. Scikit-image: image processing
331
3.3. Scikit-image: image processing
332
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Watershed segmentation
The Watershed (skimage.morphology.watershed()) is a region-growing approach that fills “basins” in
the image
Labeling connected components of a discrete image
Tip: Once you have separated foreground objects, it is use to separate them from each other. For this, we can
assign a different integer labels to each one.
Synthetic data:
>>>
>>>
>>>
>>>
>>>
>>>
>>>
n = 20
l = 256
im = np.zeros((l, l))
points = l * np.random.random((2, n ** 2))
im[(points[0]).astype(np.int), (points[1]).astype(np.int)] = 1
im = filters.gaussian_filter(im, sigma=l / (4. * n))
blobs = im > im.mean()
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
>>>
from skimage.morphology import watershed
from skimage.feature import peak_local_max
# Generate an initial image with two overlapping circles
x, y = np.indices((80, 80))
x1, y1, x2, y2 = 28, 28, 44, 52
r1, r2 = 16, 20
mask_circle1 = (x - x1) ** 2 + (y - y1) ** 2 < r1 ** 2
mask_circle2 = (x - x2) ** 2 + (y - y2) ** 2 < r2 ** 2
image = np.logical_or(mask_circle1, mask_circle2)
# Now we want to separate the two objects in image
# Generate the markers as local maxima of the distance
# to the background
from scipy import ndimage
distance = ndimage.distance_transform_edt(image)
local_maxi = peak_local_max(distance, indices=False, footprint=np.ones((3, 3)), labels=image)
markers = morphology.label(local_maxi)
labels_ws = watershed(-distance, markers, mask=image)
Random walker segmentation
The random walker algorithm (skimage.segmentation.random_walker()) is similar to the Watershed,
but with a more “probabilistic” approach. It is based on the idea of the diffusion of labels in the image:
Label all connected components:
>>>
>>>
>>>
>>>
>>>
>>> from skimage import measure
>>> all_labels = measure.label(blobs)
Label only foreground connected components:
from skimage import segmentation
# Transform markers image so that 0-valued pixels are to
# be labelled, and -1-valued pixels represent background
markers[~image] = -1
labels_rw = segmentation.random_walker(image, markers)
>>> blobs_labels = measure.label(blobs, background=0)
Postprocessing label images
skimage provides several utility functions that can be used on label images
(ie images where different discrete values identify different regions).
Functions
skimage.segmentation.clear_border(),
names
are
often
self-explaining:
skimage.segmentation.relabel_from_one(), skimage.morphology.remove_small_objects(),
etc.
See also:
scipy.ndimage.find_objects() is useful to return slices on object in an image.
Marker based methods
If you have markers inside a set of regions, you can use these to segment the regions.
3.3. Scikit-image: image processing
333
3.3. Scikit-image: image processing
334
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Exercise
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> coins_edges = segmentation.mark_boundaries(coins, clean_border.astype(np.int))
• Load the coins image from the data submodule.
• Separate the coins from the background by testing several segmentation methods: Otsu thresholding,
adaptive thresholding, and watershed or random walker segmentation.
• If necessary, use a postprocessing function to improve the coins / background segmentation.
3.3.5 Measuring regions’ properties
>>> from skimage import measure
Example: compute the size and perimeter of the two segmented regions:
>>> properties = measure.regionprops(labels_rw)
>>> [prop.area for prop in properties]
[770.0, 1168.0]
>>> [prop.perimeter for prop in properties]
[100.91..., 126.81...]
The (experimental) scikit-image viewer
skimage.viewer = matplotlib-based canvas for displaying images + experimental Qt-based GUI-toolkit
See also:
for some properties, functions are available as well in scipy.ndimage.measurements with a different API
(a list is returned).
>>> from skimage import viewer
>>> new_viewer = viewer.ImageViewer(coins)
>>> new_viewer.show()
Useful for displaying pixel values.
Exercise (continued)
For more interaction, plugins can be added to the viewer:
• Use the binary image of the coins and background from the previous exercise.
• Compute an image of labels for the different coins.
• Compute the size and eccentricity of all coins.
>>>
>>>
>>>
>>>
new_viewer = viewer.ImageViewer(coins)
from skimage.viewer.plugins import lineprofile
new_viewer += lineprofile.LineProfile()
new_viewer.show()
3.3.6 Data visualization and interaction
Meaningful visualizations are useful when testing a given processing pipeline.
Some image processing operations:
>>> coins = data.coins()
>>> mask = coins > filters.threshold_otsu(coins)
>>> clean_border = segmentation.clear_border(mask)
Visualize binary result:
>>> plt.figure()
<matplotlib.figure.Figure object at 0x...>
>>> plt.imshow(clean_border, cmap='gray')
<matplotlib.image.AxesImage object at 0x...>
Visualize contour
>>> plt.figure()
<matplotlib.figure.Figure object at 0x...>
>>> plt.imshow(coins, cmap='gray')
<matplotlib.image.AxesImage object at 0x...>
>>> plt.contour(clean_border, [0.5])
<matplotlib.contour.QuadContourSet ...>
Use skimage dedicated utility function:
3.3. Scikit-image: image processing
335
3.3. Scikit-image: image processing
336
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
>>> from skimage import feature
Example: detecting corners using Harris detector
from skimage.feature import corner_harris, corner_subpix, corner_peaks
from skimage.transform import warp, AffineTransform
tform = AffineTransform(scale=(1.3, 1.1), rotation=1, shear=0.7,
translation=(210, 50))
image = warp(data.checkerboard(), tform.inverse, output_shape=(350, 350))
coords = corner_peaks(corner_harris(image), min_distance=5)
coords_subpix = corner_subpix(image, coords, window_size=13)
(this example is taken from http://scikit-image.org/docs/stable/auto_examples/plot_corner.html)
Points of interest such as corners can then be used to match objects in different images, as described in http://scikitimage.org/docs/stable/auto_examples/plot_matching.html
3.4 Traits: building interactive dialogs
Author: Didrik Pinte
3.3.7 Feature extraction for computer vision
The Traits project allows you to simply add validation, initialization, delegation, notification and a graphical user
interface to Python object attributes.
Geometric or textural descriptor can be extracted from images in order to
• match parts of different images (e.g. for object detection)
Tip: In this tutorial we will explore the Traits toolset and learn how to dramatically reduce the amount of
boilerplate code you write, do rapid GUI application development, and understand the ideas which underly other
parts of the Enthought Tool Suite.
• and many other applications of Computer Vision
Traits and the Enthought Tool Suite are open source projects licensed under a BSD-style license.
• classify parts of the image (e.g. sky vs. buildings)
3.3. Scikit-image: image processing
337
3.4. Traits: building interactive dialogs
338
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Intended Audience
Intermediate to advanced Python programmers
Requirements
• Python 2.6 or 2.7 (www.python.org)
• Either wxPython (http://www.wxpython.org/), PyQt (https://riverbankcomputing.com/software/pyqt/intro)
or PySide (https://pyside.github.io/docs/pyside/)
• Numpy and Scipy (http://www.scipy.org)
• Enthought Tool Suite 3.x or higher (http://code.enthought.com/projects)
• All required software can be obtained by installing the EPD Free (https://store.enthought.com/)
Tutorial content
• Introduction (page 339)
• Example (page 340)
• What are Traits (page 341)
– Initialisation (page 342)
– Validation (page 342)
– Documentation (page 343)
– Visualization: opening a dialog (page 343)
– Deferral (page 345)
– Notification (page 350)
– Some more advanced traits (page 353)
The main packages of the Enthought Tool Suite are:
• Traits - component based approach to build our applications.
• Kiva - 2D primitives supporting path based rendering, affine transforms, alpha blending and more.
3.4.1 Introduction
• Enable - object based 2D drawing canvas.
Tip: The Enthought Tool Suite enable the construction of sophisticated application frameworks for data analysis,
2D plotting and 3D visualization. These powerful, reusable components are released under liberal BSD-style
licenses.
• Chaco - plotting toolkit for building complex interactive 2D plots.
• Mayavi - 3D visualization of scientific data based on VTK.
• Envisage - application plugin framework for building scriptable and extensible applications
In this tutorial, we will focus on Traits.
3.4.2 Example
Throughout this tutorial, we will use an example based on a water resource management simple case. We will try
to model a dam and reservoir system. The reservoir and the dams do have a set of parameters :
• Name
• Minimal and maximal capacity of the reservoir [hm3]
• Height and length of the dam [m]
• Catchment area [km2]
• Hydraulic head [m]
• Power of the turbines [MW]
• Minimal and maximal release [m3/s]
• Efficiency of the turbines
3.4. Traits: building interactive dialogs
339
3.4. Traits: building interactive dialogs
340
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The reservoir has a known behaviour. One part is related to the energy production based on the water released. A
simple formula for approximating electric power production at a hydroelectric plant is P = ρhrgk, where:
• P is Power in watts,
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
reservoir = Reservoir(name='Lac de Vouglans', max_storage=605)
Initialisation
• ρ is the density of water (~1000 kg/m3),
All the traits do have a default value that initialise the variables. For example, the basic python types do have the
following trait equivalents:
• h is height in meters,
• r is flow rate in cubic meters per second,
• g is acceleration due to gravity of 9.8 m/s2,
• k is a coefficient of efficiency ranging from 0 to 1.
Tip: Annual electric energy production depends on the available water supply. In some installations the water
flow rate can vary by a factor of 10:1 over the course of a year.
The second part of the behaviour is the state of the storage that depends on controlled and uncontrolled parameters
:
storaget+1 = storaget + inf lows − release − spillage − irrigation
Trait
Bool
Complex
Float
Int
Long
Str
Unicode
Python Type
Boolean
Complex number
Floating point number
Plain integer
Long integer
String
Unicode
Built-in Default Value
False
0+0j
0.0
0
0L
‘’
u’‘
A number of other predefined trait type do exist : Array, Enum, Range, Event, Dict, List, Color, Set, Expression,
Code, Callable, Type, Tuple, etc.
Custom default values can be defined in the code:
Warning: The data used in this tutorial are not real and might even not have sense in the reality.
from traits.api import HasTraits, Str, Float
class Reservoir(HasTraits):
3.4.3 What are Traits
A trait is a type definition that can be used for normal Python object attributes, giving the attributes some additional
characteristics:
name = Str
max_storage = Float(100)
reservoir = Reservoir(name='Lac de Vouglans')
• Standardization:
– Initialization
Complex initialisation
– Validation
When a complex initialisation is required for a trait, a _XXX_default magic method can be implemented. It
will be lazily called when trying to access the XXX trait. For example:
– Deferral
• Notification
def _name_default(self):
""" Complex initialisation of the reservoir name. """
• Visualization
return 'Undefined'
• Documentation
A class can freely mix trait-based attributes with normal Python attributes, or can opt to allow the use of only a
fixed or open set of trait attributes within the class. Trait attributes defined by a class are automatically inherited
by any subclass derived from the class.
Validation
The common way of creating a traits class is by extending from the HasTraits base class and defining class traits
:
Every trait does validation when the user tries to set its content:
from traits.api import HasTraits, Str, Float
reservoir = Reservoir(name='Lac de Vouglans', max_storage=605)
class Reservoir(HasTraits):
reservoir.max_storage = '230'
--------------------------------------------------------------------------TraitError
Traceback (most recent call last)
/Users/dpinte/projects/scipy-lecture-notes/advanced/traits/<ipython-input-7-979bdff9974a> in <modu
----> 1 reservoir.max_storage = '230'
name = Str
max_storage = Float
Warning: For Traits 3.x users
If using Traits 3.x, you need to adapt the namespace of the traits packages:
• traits.api should be enthought.traits.api
• traitsui.api should be enthought.traits.ui.api
Using a traits class like that is as simple as any other Python class. Note that the trait value are passed using
keyword arguments:
3.4. Traits: building interactive dialogs
341
/Users/dpinte/projects/ets/traits/traits/trait_handlers.pyc in error(self, object, name, value)
166
"""
167
raise TraitError( object, name, self.full_info( object, name, value ),
--> 168
value )
169
170
def arg_error ( self, method, arg_num, object, name, value ):
3.4. Traits: building interactive dialogs
342
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
TraitError: The 'max_storage' trait of a Reservoir instance must be a float, but a value of '23' <type
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
reservoir1 = Reservoir()
reservoir1.edit_traits()
Documentation
By essence, all the traits do provide documentation about the model itself. The declarative approach to the creation
of classes makes it self-descriptive:
from traits.api import HasTraits, Str, Float
class Reservoir(HasTraits):
name = Str
max_storage = Float(100)
The desc metadata of the traits can be used to provide a more descriptive information about the trait :
from traits.api import HasTraits, Str, Float
class Reservoir(HasTraits):
name = Str
max_storage = Float(100, desc='Maximal storage [hm3]')
TraitsUI simplifies the way user interfaces are created. Every trait on a HasTraits class has a default editor that
will manage the way the trait is rendered to the screen (e.g. the Range trait is displayed as a slider, etc.).
Let’s now define the complete reservoir class:
In the very same vein as the Traits declarative way of creating classes, TraitsUI provides a declarative interface to
build user interfaces code:
from traits.api import HasTraits, Str, Float, Range
from traits.api import HasTraits, Str, Float, Range
from traitsui.api import View
class Reservoir(HasTraits):
name = Str
max_storage = Float(1e6, desc='Maximal storage [hm3]')
max_release = Float(10, desc='Maximal release [m3/s]')
head = Float(10, desc='Hydraulic head [m]')
efficiency = Range(0, 1.)
class Reservoir(HasTraits):
name = Str
max_storage = Float(1e6, desc='Maximal storage [hm3]')
max_release = Float(10, desc='Maximal release [m3/s]')
head = Float(10, desc='Hydraulic head [m]')
efficiency = Range(0, 1.)
def energy_production(self, release):
''' Returns the energy production [Wh] for the given release [m3/s]
'''
power = 1000 * 9.81 * self.head * release * self.efficiency
return power * 3600
traits_view = View(
'name', 'max_storage', 'max_release', 'head', 'efficiency',
title = 'Reservoir',
resizable = True,
)
if __name__ == '__main__':
reservoir = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
head = 60,
efficiency = 0.8
)
def energy_production(self, release):
''' Returns the energy production [Wh] for the given release [m3/s]
'''
power = 1000 * 9.81 * self.head * release * self.efficiency
return power * 3600
if __name__ == '__main__':
reservoir = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
head = 60,
efficiency = 0.8
)
release = 80
print 'Releasing {} m3/s produces {} kWh'.format(
release, reservoir.energy_production(release)
)
Visualization: opening a dialog
reservoir.configure_traits()
The Traits library is also aware of user interfaces and can pop up a default view for the Reservoir class:
3.4. Traits: building interactive dialogs
343
3.4. Traits: building interactive dialogs
344
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
A special trait allows to manage events and trigger function calls using the magic _xxxx_fired method:
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range, Event
from reservoir import Reservoir
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
For the simplicity of the example, the release is considered in
hm3/timestep and not in m3/s.
"""
reservoir = Instance(Reservoir, ())
min_storage = Float
max_storage = DelegatesTo('reservoir')
min_release = Float
max_release = DelegatesTo('reservoir')
Deferral
Being able to defer the definition of a trait and its value to another object is a powerful feature of Traits.
# state attributes
storage = Range(low='min_storage', high='max_storage')
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Float(desc='Spillage [hm3]')
from reservoir import Reservoir
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
"""
reservoir = Instance(Reservoir, ())
min_storage = Float
max_storage = DelegatesTo('reservoir')
min_release = Float
max_release = DelegatesTo('reservoir')
update_storage = Event(desc='Updates the storage to the next time step')
def _update_storage_fired(self):
# update storage state
new_storage = self.storage - self.release + self.inflows
self.storage = min(new_storage, self.max_storage)
overflow = new_storage - self.max_storage
self.spillage = max(overflow, 0)
# state attributes
storage = Range(low='min_storage', high='max_storage')
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Float(desc='Spillage [hm3]')
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 5.0,
hydraulic_head = 60,
efficiency = 0.8
)
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
hydraulic_head = 60,
efficiency = 0.8
)
state = ReservoirState(reservoir=projectA, storage=15)
state.release = 5
state.inflows = 0
# release the maximum amount of water during 3 time steps
state.update_storage = True
state.print_state()
state.update_storage = True
state.print_state()
state.update_storage = True
state.print_state()
state = ReservoirState(reservoir=projectA, storage=10)
state.release = 90
state.inflows = 0
state.print_state()
print 'How do we update the current storage ?'
3.4. Traits: building interactive dialogs
345
3.4. Traits: building interactive dialogs
346
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Dependency between objects can be made automatic using the trait Property. The depends_on attribute expresses the dependency between the property and other traits. When the other traits gets changed, the property is
invalidated. Again, Traits uses magic method names for the property :
• _get_XXX for the getter of the XXX Property trait
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
)
state = ReservoirState(reservoir=projectA, storage=25)
state.release = 4
state.inflows = 0
• _set_XXX for the setter of the XXX Property trait
state.print_state()
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range
from traits.api import Property
Note: Caching property
from reservoir import Reservoir
Heavy computation or long running computation might be a problem when accessing a property where the inputs
have not changed. The @cached_property decorator can be used to cache the value and only recompute them once
invalidated.
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
Let’s extend the TraitsUI introduction with the ReservoirState example:
For the simplicity of the example, the release is considered in
hm3/timestep and not in m3/s.
"""
reservoir = Instance(Reservoir, ())
max_storage = DelegatesTo('reservoir')
min_release = Float
max_release = DelegatesTo('reservoir')
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range, Property
from traitsui.api import View, Item, Group, VGroup
from reservoir import Reservoir
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
# state attributes
storage = Property(depends_on='inflows, release')
For the simplicity of the example, the release is considered in
hm3/timestep and not in m3/s.
"""
reservoir = Instance(Reservoir, ())
name = DelegatesTo('reservoir')
max_storage = DelegatesTo('reservoir')
max_release = DelegatesTo('reservoir')
min_release = Float
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Property(
desc='Spillage [hm3]', depends_on=['storage', 'inflows', 'release']
)
### Private traits. ######################################################
_storage = Float
# state attributes
storage = Property(depends_on='inflows, release')
### Traits property implementation. ######################################
def _get_storage(self):
new_storage = self._storage - self.release + self.inflows
return min(new_storage, self.max_storage)
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Property(
desc='Spillage [hm3]', depends_on=['storage', 'inflows', 'release']
)
def _set_storage(self, storage_value):
self._storage = storage_value
def _get_spillage(self):
new_storage = self._storage - self.release
overflow = new_storage - self.max_storage
return max(overflow, 0)
### Traits view ##########################################################
traits_view = View(
Group(
VGroup(Item('name'), Item('storage'), Item('spillage'),
label = 'State', style = 'readonly'
),
VGroup(Item('inflows'), Item('release'), label='Control'),
)
)
+ self.inflows
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
### Private traits. ######################################################
_storage = Float
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 5,
hydraulic_head = 60,
efficiency = 0.8
3.4. Traits: building interactive dialogs
### Traits property implementation. ######################################
def _get_storage(self):
new_storage = self._storage - self.release + self.inflows
return min(new_storage, self.max_storage)
def _set_storage(self, storage_value):
347
3.4. Traits: building interactive dialogs
348
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
self._storage = storage_value
def _get_spillage(self):
new_storage = self._storage - self.release
overflow = new_storage - self.max_storage
return max(overflow, 0)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
head = Float(10, desc='Hydraulic head [m]')
efficiency = Range(0, 1.)
+ self.inflows
turbine = Instance(Turbine)
installed_capacity = PrototypedFrom('turbine', 'power')
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
if __name__ == '__main__':
turbine = Turbine(turbine_type='type1', power=5.0)
reservoir = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
head = 60,
efficiency = 0.8,
turbine = turbine,
)
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 5,
hydraulic_head = 60,
efficiency = 0.8
)
print 'installed capacity is initialised with turbine.power'
print reservoir.installed_capacity
print '-' * 15
print 'updating the turbine power updates the installed capacity'
turbine.power = 10
print reservoir.installed_capacity
state = ReservoirState(reservoir=projectA, storage=25)
state.release = 4
state.inflows = 0
print '-' * 15
print 'setting the installed capacity breaks the link between turbine.power'
print 'and the installed_capacity trait'
state.print_state()
state.configure_traits()
reservoir.installed_capacity = 8
print turbine.power, reservoir.installed_capacity
Notification
Traits implements a Listener pattern. For each trait a list of static and dynamic listeners can be fed with callbacks.
When the trait does change, all the listeners are called.
Static listeners are defined using the _XXX_changed magic methods:
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range
from reservoir import Reservoir
Some use cases need the delegation mechanism to be broken by the user when setting the value of the trait. The
PrototypeFrom trait implements this behaviour.
from traits.api import HasTraits, Str, Float, Range, PrototypedFrom, Instance
class Turbine(HasTraits):
turbine_type = Str
power = Float(1.0, desc='Maximal power delivered by the turbine [Mw]')
# state attributes
storage = Range(low='min_storage', high='max_storage')
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Float(desc='Spillage [hm3]')
class Reservoir(HasTraits):
name = Str
max_storage = Float(1e6, desc='Maximal storage [hm3]')
max_release = Float(10, desc='Maximal release [m3/s]')
3.4. Traits: building interactive dialogs
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
"""
reservoir = Instance(Reservoir, ())
min_storage = Float
max_storage = DelegatesTo('reservoir')
min_release = Float
max_release = DelegatesTo('reservoir')
349
3.4. Traits: building interactive dialogs
350
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
state = ReservoirState(reservoir=projectA, storage=10)
#register the dynamic listener
state.on_trait_change(wake_up_watchman_if_spillage, name='spillage')
state.release = 90
state.inflows = 0
state.print_state()
### Traits listeners #####################################################
def _release_changed(self, new):
"""When the release is higher than zero, warn all the inhabitants of
the valley.
"""
print 'Forcing spillage'
state.inflows = 100
state.release = 0
if new > 0:
print 'Warning, we are releasing {} hm3 of water'.format(new)
print 'Why do we have two executions of the callback ?'
The dynamic trait notification signatures are not the same as the static ones :
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
hydraulic_head = 60,
efficiency = 0.8
)
• def wake_up_watchman(): pass
• def wake_up_watchman(new): pass
• def wake_up_watchman(name, new): pass
• def wake_up_watchman(object, name, new): pass
• def wake_up_watchman(object, name, old, new): pass
Removing a dynamic listener can be done by:
state = ReservoirState(reservoir=projectA, storage=10)
state.release = 90
state.inflows = 0
state.print_state()
• calling the remove_trait_listener method on the trait with the listener method as argument,
• calling the on_trait_change method with listener method and the keyword remove=True,
• deleting the instance that holds the listener.
The static trait notification signatures can be:
Listeners can also be added to classes using the on_trait_change decorator:
• def _release_changed(self): pass
from traits.api import HasTraits, Instance, DelegatesTo, Float, Range
from traits.api import Property, on_trait_change
• def _release_changed(self, new): pass
• def _release_changed(self, old, new): pass
from reservoir import Reservoir
• def _release_changed(self, name, old, new pass
class ReservoirState(HasTraits):
"""Keeps track of the reservoir state given the initial storage.
Listening to all the changes
To listen to all the changes on a HasTraits class, the magic _any_trait_changed method can be implemented.
In many situations, you do not know in advance what type of listeners need to be activated. Traits offers the ability
to register listeners on the fly with the dynamic listeners
from reservoir import Reservoir
from reservoir_state_property import ReservoirState
# state attributes
storage = Property(depends_on='inflows, release')
def wake_up_watchman_if_spillage(new_value):
if new_value > 0:
print 'Wake up watchman! Spilling {} hm3'.format(new_value)
# control attributes
inflows = Float(desc='Inflows [hm3]')
release = Range(low='min_release', high='max_release')
spillage = Property(
desc='Spillage [hm3]', depends_on=['storage', 'inflows', 'release']
)
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 100.0,
hydraulic_head = 60,
efficiency = 0.8
)
3.4. Traits: building interactive dialogs
For the simplicity of the example, the release is considered in
hm3/timestep and not in m3/s.
"""
reservoir = Instance(Reservoir, ())
max_storage = DelegatesTo('reservoir')
min_release = Float
max_release = DelegatesTo('reservoir')
### Private traits. ######################################################
_storage = Float
351
3.4. Traits: building interactive dialogs
352
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
power = 1000 * 9.81 * self.head * release * self.efficiency
return power * 3600
### Traits property implementation. ######################################
def _get_storage(self):
new_storage = self._storage - self.release + self.inflows
return min(new_storage, self.max_storage)
traits_view = View(
Item('name'),
Item('max_storage'),
Item('max_release'),
Item('head'),
Item('efficiency'),
Item('irrigated_areas'),
resizable = True
)
def _set_storage(self, storage_value):
self._storage = storage_value
def _get_spillage(self):
new_storage = self._storage - self.release
overflow = new_storage - self.max_storage
return max(overflow, 0)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
+ self.inflows
if __name__ == '__main__':
upper_block = IrrigationArea(name='Section C', surface=2000, crop='Wheat')
@on_trait_change('storage')
def print_state(self):
print 'Storage\tRelease\tInflows\tSpillage'
str_format = '\t'.join(['{:7.2f}'for i in range(4)])
print str_format.format(self.storage, self.release, self.inflows,
self.spillage)
print '-' * 79
reservoir = Reservoir(
name='Project A',
max_storage=30,
max_release=100.0,
head=60,
efficiency=0.8,
irrigated_areas=[upper_block]
)
if __name__ == '__main__':
projectA = Reservoir(
name = 'Project A',
max_storage = 30,
max_release = 5,
hydraulic_head = 60,
efficiency = 0.8
)
release = 80
print 'Releasing {} m3/s produces {} kWh'.format(
release, reservoir.energy_production(release)
)
Trait listeners can be used to listen to changes in the content of the list to e.g. keep track of the total crop surface
on linked to a given reservoir.
state = ReservoirState(reservoir=projectA, storage=25)
state.release = 4
state.inflows = 0
The patterns supported by the on_trait_change method and decorator are powerful. The reader should look at the
docstring of HasTraits.on_trait_change for the details.
Some more advanced traits
from traits.api import HasTraits, Str, Float, Range, Enum, List, Property
from traitsui.api import View, Item
class IrrigationArea(HasTraits):
name = Str
surface = Float(desc='Surface [ha]')
crop = Enum('Alfalfa', 'Wheat', 'Cotton')
The following example demonstrate the usage of the Enum and List traits :
class Reservoir(HasTraits):
name = Str
max_storage = Float(1e6, desc='Maximal storage [hm3]')
max_release = Float(10, desc='Maximal release [m3/s]')
head = Float(10, desc='Hydraulic head [m]')
efficiency = Range(0, 1.)
from traits.api import HasTraits, Str, Float, Range, Enum, List
from traitsui.api import View, Item
class IrrigationArea(HasTraits):
name = Str
surface = Float(desc='Surface [ha]')
crop = Enum('Alfalfa', 'Wheat', 'Cotton')
irrigated_areas = List(IrrigationArea)
class Reservoir(HasTraits):
name = Str
max_storage = Float(1e6, desc='Maximal storage [hm3]')
max_release = Float(10, desc='Maximal release [m3/s]')
head = Float(10, desc='Hydraulic head [m]')
efficiency = Range(0, 1.)
irrigated_areas = List(IrrigationArea)
total_crop_surface = Property(depends_on='irrigated_areas.surface')
def _get_total_crop_surface(self):
return sum([iarea.surface for iarea in self.irrigated_areas])
def energy_production(self, release):
''' Returns the energy production [Wh] for the given release [m3/s]
'''
power = 1000 * 9.81 * self.head * release * self.efficiency
return power * 3600
def energy_production(self, release):
''' Returns the energy production [Wh] for the given release [m3/s]
'''
3.4. Traits: building interactive dialogs
353
3.4. Traits: building interactive dialogs
354
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
traits_view = View(
Item('name'),
Item('max_storage'),
Item('max_release'),
Item('head'),
Item('efficiency'),
Item('irrigated_areas'),
Item('total_crop_surface'),
resizable = True
)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
### Traits properties ####################################################
def _get_stock(self):
"""
fixme: should handle cases where we go over the max storage
"""
return self.initial_stock + (self.inflows - self.releases).cumsum()
def _get_month(self):
return np.arange(self.stock.size)
if __name__ == '__main__':
reservoir = Reservoir(
if __name__ == '__main__':
upper_block = IrrigationArea(name='Section C', surface=2000, crop='Wheat')
name = 'Project A',
max_storage = 30,
max_release = 100.0,
head = 60,
efficiency = 0.8
reservoir = Reservoir(
name='Project A',
max_storage=30,
max_release=100.0,
head=60,
efficiency=0.8,
irrigated_areas=[upper_block],
)
)
initial_stock = 10.
inflows_ts = np.array([6., 6, 4, 4, 1, 2, 0, 0, 3, 1, 5, 3])
releases_ts = np.array([4., 5, 3, 5, 3, 5, 5, 3, 2, 1, 3, 3])
release = 80
print 'Releasing {} m3/s produces {} kWh'.format(
release, reservoir.energy_production(release)
)
view = ReservoirEvolution(
reservoir = reservoir,
inflows = inflows_ts,
releases = releases_ts
)
The next example shows how the Array trait can be used to feed a specialised TraitsUI Item, the ChacoPlotItem:
view.configure_traits()
import numpy as np
from
from
from
from
traits.api import HasTraits, Array, Instance, Float, Property
traits.api import DelegatesTo
traitsui.api import View, Item, Group
chaco.chaco_plot_editor import ChacoPlotItem
from reservoir import Reservoir
class ReservoirEvolution(HasTraits):
reservoir = Instance(Reservoir)
name = DelegatesTo('reservoir')
inflows = Array(dtype=np.float64, shape=(None))
releass = Array(dtype=np.float64, shape=(None))
initial_stock = Float
stock = Property(depends_on='inflows, releases, initial_stock')
See also:
month = Property(depends_on='stock')
References
### Traits view ##########################################################
traits_view = View(
Item('name'),
Group(
ChacoPlotItem('month', 'stock', show_label=False),
),
width = 500,
resizable = True
)
3.4. Traits: building interactive dialogs
• ETS repositories: http://github.com/enthought
• Traits manual: http://docs.enthought.com/traits/traits_user_manual/index.html
• Traits UI manual: http://docs.enthought.com/traitsui/traitsui_user_manual/index.html
• Mailing list :
[email protected]
355
3.4. Traits: building interactive dialogs
356
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3.5 3D plotting with Mayavi
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3D plotting functions
Points
Author: Gaël Varoquaux
Tip: Mayavi is an interactive 3D plotting package. matplotlib (page 81) can also do simple 3D plotting, but
Mayavi relies on a more powerful engine ( VTK ) and is more suited to displaying large or complex data.
Chapters contents
• Mlab: the scripting interface (page 357)
– 3D plotting functions (page 358)
* Points (page 358)
* Lines (page 358)
* Elevation surface (page 359)
* Arbitrary regular mesh (page 359)
* Volumetric data (page 360)
– Figures and decorations (page 360)
* Figure management (page 360)
* Changing plot properties (page 360)
* Decorations (page 362)
• Interactive work (page 363)
– The “pipeline dialog” (page 363)
– The script recording button (page 364)
• Slicing and dicing data: sources, modules and filters (page 364)
– An example: inspecting magnetic fields (page 364)
– Different views on data: sources and modules (page 364)
* Different sources: scatters and fields (page 365)
* Transforming data: filters (page 366)
* mlab.pipeline: the scripting layer (page 366)
• Animating the data (page 366)
• Making interactive dialogs (page 367)
– A simple dialog (page 367)
– Making it interactive (page 368)
• Putting it together (page 369)
Hint: Points in 3D, represented with markers (or “glyphs”) and optionaly different sizes.
x, y, z, value = np.random.random((4, 40))
mlab.points3d(x, y, z, value)
Lines
3.5.1 Mlab: the scripting interface
Hint: A line connecting points in 3D, with optional thickness and varying color.
The mayavi.mlab module provides simple plotting functions to apply to numpy arrays, similar to matplotlib or
matlab’s plotting interface. Try using them in IPython, by starting IPython with the switch --gui=wx.
mlab.clf() # Clear the figure
t = np.linspace(0, 20, 200)
mlab.plot3d(np.sin(t), np.cos(t), 0.1*t, t)
3.5. 3D plotting with Mayavi
3.5. 3D plotting with Mayavi
357
358
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Elevation surface
Volumetric data
Hint: A surface given by its elevation, coded as a 2D array
Hint: If your data is dense in 3D, it is more difficult to display. One option is to take iso-contours of the data.
mlab.clf()
x, y = np.mgrid[-10:10:100j, -10:10:100j]
r = np.sqrt(x**2 + y**2)
z = np.sin(r)/r
mlab.surf(z, warp_scale='auto')
mlab.clf()
x, y, z = np.mgrid[-5:5:64j, -5:5:64j, -5:5:64j]
values = x*x*0.5 + y*y + z*z*2.0
mlab.contour3d(values)
Arbitrary regular mesh
This function works with a regular orthogonal grid: the value array is a 3D array that gives the shape of the
grid.
Hint: A surface mesh given by x, y, z positions of its node points
Figures and decorations
mlab.clf()
phi, theta = np.mgrid[0:np.pi:11j, 0:2*np.pi:11j]
x = np.sin(phi) * np.cos(theta)
y = np.sin(phi) * np.sin(theta)
z = np.cos(phi)
mlab.mesh(x, y, z)
mlab.mesh(x, y, z, representation='wireframe', color=(0, 0, 0))
Figure management
Tip: Here is a list of functions useful to control the current figure
Note: A surface is defined by points connected to form triangles or polygones. In mayavi.mlab.surf()
and mayavi.mlab.mesh(), the connectivity is implicity given by the layout of the arrays. See also
mayavi.mlab.triangular_mesh().
Our data is often more than points and values: it needs some connectivity information
Get the current figure:
Clear the current figure:
Set the current figure:
Save figure to image
file:
Change the view:
mlab.gcf()
mlab.clf()
mlab.figure(1, bgcolor=(1, 1, 1), fgcolor=(0.5, 0.5,
0.5)
mlab.savefig(’foo.png’, size=(300, 300))
mlab.view(azimuth=45, elevation=54, distance=1.)
Changing plot properties
3.5. 3D plotting with Mayavi
359
3.5. 3D plotting with Mayavi
360
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Tip: In general, many properties of the various objects on the figure can be changed. If these visualization are
created via mlab functions, the easiest way to change them is to use the keyword arguments of these functions,
as described in the docstrings.
Example docstring: mlab.mesh
Plots a surface using grid-spaced data supplied as 2D arrays.
Function signatures:
mesh(x, y, z, ...)
x, y, z are 2D arrays, all of the same shape, giving the positions of the vertices of the surface. The connectivity
between these points is implied by the connectivity on the arrays.
For simple structures (such as orthogonal grids) prefer the surf function, as it will create more efficient data
structures.
Keyword arguments:
color the color of the vtk object. Overides the colormap, if any, when specified.
This is specified as a triplet of float ranging from 0 to 1, eg (1, 1, 1) for white.
colormap type of colormap to use.
extent [xmin, xmax, ymin, ymax, zmin, zmax] Default is the x, y, z arrays extents.
Use this to change the extent of the object created.
figure Figure to populate.
line_width The with of the lines, if any used. Must be a float. Default: 2.0
mask boolean mask array to suppress some data points.
mask_points If supplied, only one out of ‘mask_points’ data point is displayed.
This option is usefull to reduce the number of points displayed on large datasets
Must be an integer or None.
mode the mode of the glyphs. Must be ‘2darrow’ or ‘2dcircle’ or ‘2dcross’ or
‘2ddash’ or ‘2ddiamond’ or ‘2dhooked_arrow’ or ‘2dsquare’ or ‘2dthick_arrow’
or ‘2dthick_cross’ or ‘2dtriangle’ or ‘2dvertex’ or ‘arrow’ or ‘cone’ or ‘cube’ or
‘cylinder’ or ‘point’ or ‘sphere’. Default: sphere
name the name of the vtk object created.
representation the representation type used for the surface. Must be ‘surface’ or
‘wireframe’ or ‘points’ or ‘mesh’ or ‘fancymesh’. Default: surface
resolution The resolution of the glyph created. For spheres, for instance, this is the
number of divisions along theta and phi. Must be an integer. Default: 8
scalars optional scalar data.
scale_factor scale factor of the glyphs used to represent the vertices, in fancy_mesh
mode. Must be a float. Default: 0.05
scale_mode the scaling mode for the glyphs (‘vector’, ‘scalar’, or ‘none’).
transparent make the opacity of the actor depend on the scalar.
tube_radius radius of the tubes used to represent the lines, in mesh mode. If None,
simple lines are used.
tube_sides number of sides of the tubes used to represent the lines. Must be an
integer. Default: 6
vmax vmax is used to scale the colormap If None, the max of the data will be used
vmin vmin is used to scale the colormap If None, the min of the data will be used
Example:
In [1]: import numpy as np
In [2]: r, theta = np.mgrid[0:10, -np.pi:np.pi:10j]
In [3]: x = r * np.cos(theta)
In [4]: y = r * np.sin(theta)
In [5]: z = np.sin(r)/r
In [6]: from mayavi import mlab
In [7]: mlab.mesh(x, y, z, colormap='gist_earth', extent=[0, 1, 0, 1, 0, 1])
Out[7]: <mayavi.modules.surface.Surface object at 0xde6f08c>
In [8]: mlab.mesh(x, y, z, extent=[0, 1, 0, 1, 0, 1],
...: representation='wireframe', line_width=1, color=(0.5, 0.5, 0.5))
Out[8]: <mayavi.modules.surface.Surface object at 0xdd6a71c>
Decorations
Tip: Different items can be added to the figure to carry extra information, such as a colorbar or a title.
In [9]: mlab.colorbar(Out[7], orientation='vertical')
Out[9]: <tvtk_classes.scalar_bar_actor.ScalarBarActor object at 0xd897f8c>
In [10]: mlab.title('polar mesh')
Out[10]: <enthought.mayavi.modules.text.Text object at 0xd8ed38c>
In [11]: mlab.outline(Out[7])
Out[11]: <enthought.mayavi.modules.outline.Outline object at 0xdd21b6c>
In [12]: mlab.axes(Out[7])
Out[12]: <enthought.mayavi.modules.axes.Axes object at 0xd2e4bcc>
3.5. 3D plotting with Mayavi
361
3.5. 3D plotting with Mayavi
362
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
The script recording button
To find out what code can be used to program these changes, click on the red button as you modify those properties,
and it will generate the corresponding lines of code.
3.5.3 Slicing and dicing data: sources, modules and filters
An example: inspecting magnetic fields
Suppose we are simulating the magnetic field generated by Helmholtz coils.
The
examples/compute_field.py script does this computation and gives you a B array, that is (3 x n),
where the first axis is the direction of the field (Bx, By, Bz), and the second axis the index number of the point.
Arrays X, Y and Z give the positions of these data points.
Excercise
Visualize this field. Your goal is to make sure that the simulation code is correct.
Warning: extent: If we specified extents for a plotting object, mlab.outline’ and ‘mlab.axes
don’t get them by default.
3.5.2 Interactive work
Tip: The quickest way to create beautiful visualization with Mayavi is probably to interactively tweak the various
settings.
The “pipeline dialog”
Click on the ‘Mayavi’ button in the scene, and you can control properties of objects with dialogs.
Suggestions
• If you compute the norm of the vector field, you can apply an isosurface to it.
• using mayavi.mlab.quiver3d() you can plot vectors. You can also use the ‘masking’ options
(in the GUI) to make the plot a bit less dense.
Different views on data: sources and modules
• Set the background of the figure in the Mayavi Scene node
Tip: As we see above, it may be desirable to look at the same data in different ways.
• Set the colormap in the Colors and legends node
Mayavi visualization are created by loading the data in a data source and then displayed on the screen using
modules.
• Right click on the node to add modules or filters
3.5. 3D plotting with Mayavi
363
3.5. 3D plotting with Mayavi
364
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
This can be seen by looking at the “pipeline” view. By right-clicking on the nodes of the pipeline, you can add
new modules.
Transforming data: filters
If you create a vector field, you may want to visualize the iso-contours of its magnitude. But the isosurface module
can only be applied to scalar data, and not vector data. We can use a filter, ExtractVectorNorm to add this
scalar value to the vector field.
Quiz
Why is it not possible to
mayavi.mlab.quiver3d()?
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
add
a
VectorCutPlane
to
the
vectors
created
by
Filters apply a transformation to data, and can be added between sources and modules
Excercice
Different sources: scatters and fields
Using the GUI, add the ExtractVectorNorm filter to display iso-contours of the field magnitude.
Tip: Data comes in different descriptions.
• A 3D block of regularly-spaced value is structured: it is easy to know how one measurement is related
to another neighboring and how to continuously interpolate between these. We can call such data a field,
borrowing from terminology used in physics, as it is continuously defined in space.
• A set of data points measured at random positions in a random order gives rise to much more difficult and
ill-posed interpolation problems: the data structure itself does not tell us what are the neighbors of a data
point. We call such data a scatter.
mlab.pipeline: the scripting layer
The mlab scripting layer builds pipelines for you. You can reproduce these pipelines programmatically with
the mlab.pipeline interface: each step has a corresponding mlab.pipeline function (simply convert
the name of the step to lower-case underscore-separated: ExtractVectorNorm gives extract_vector_norm). This
function takes as an argument the node that it applies to, as well as optional parameters, and returns the new node.
For example, iso-contours of the magnitude are coded as:
mlab.pipeline.iso_surface(mlab.pipeline.extract_vector_norm(field),
contours=[0.1*Bmax, 0.4*Bmax],
opacity=0.5)
Unstructured and unconnected data: a scatter
mlab.points3d, mlab.quiver3d
Structured and connected data: a field
mlab.contour3d
Data sources corresponding to scatters can be created with mayavi.mlab.pipeline.scalar_scatter()
or mayavi.mlab.pipeline.vector_scatter(); field data sources can be created with
mlab.pipeline.scalar_field() or mlab.pipeline.vector_field().
Exercice:
Excercice
1. Create a contour (for instance of the magnetic field norm) by using one of those functions and adding
the right module by clicking on the GUI dialog.
2. Create the right source to apply a ‘vector_cut_plane’ and reproduce the picture of the magnetic field
shown previously.
Note that one of the difficulties is providing the data in the right form (number of arrays, shape) to the
functions. This is often the case with real-life data.
Using the mlab.pipeline interface, generate a complete visualization, with iso-contours of the field magnitude, and a vector cut plane.
(click on the figure for a solution)
3.5.4 Animating the data
See also:
Sources are described in details in the Mayavi manual.
Tip: To make movies, or interactive application, you may want to change the data represented on a given
visualization.
If you have built a visualization, using the mlab plotting functions, or the mlab.pipeline function, we can
update the data by assigning new values to the mlab_source attributes
3.5. 3D plotting with Mayavi
365
3.5. 3D plotting with Mayavi
366
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
for embedding it in the dialog. The view of this dialog is defined by the view attribute of the object. In the init of
this object, we populate the 3D scene with a curve.
x , y , z = np.ogrid[-5:5:100j ,-5:5:100j, -5:5:100j]
scalars = np.sin(x * y * z) / (x * y * z)
Finally, the configure_traits method creates the dialog and starts the event loop.
iso = mlab.contour3d(scalars, transparent=True, contours=[0.5])
for i in range(1, 20):
scalars = np.sin(i * x * y * z) /(x * y * z)
iso.mlab_source.scalars = scalars
See also:
There are a few things to be aware of when doing dialogs with Mayavi. Please read the Mayavi documentation
See also:
Making it interactive
More details in the Mayavi documentation
Event loops
We can combine the Traits events handler (page 350) with the mlab_source to modify the visualization with
the dialog.
For the interaction with the user (for instance changing the view with the mouse), Mayavi needs some time
to process these events. The for loop above prevents this. The Mayavi documentation details a workaround
We will enable the user to vary the n_turns parameter in the definition of the curve. For this, we need:
• to define an n_turns attribute on our visualization object, so that it can appear in the dialog. We use a
Range type.
• to wire modification of this attribute to a recomputation of the curve.
on_traits_change decorator.
3.5.5 Making interactive dialogs
For this, we use the
It is very simple to make interactive dialogs with Mayavi using the Traits library (see the dedicated chapter Traits:
building interactive dialogs (page 338)).
A simple dialog
from traits.api import HasTraits, Instance
from traitsui.api import View, Item, HGroup
from mayavi.core.ui.api import SceneEditor, MlabSceneModel
def curve(n_turns):
"The function creating the x, y, z coordinates needed to plot"
phi = np.linspace(0, 2*np.pi, 2000)
return [np.cos(phi) * (1 + 0.5*np.cos(n_turns*phi)),
np.sin(phi) * (1 + 0.5*np.cos(n_turns*phi)),
0.5*np.sin(n_turns*phi)]
class Visualization(HasTraits):
"The class that contains the dialog"
scene
= Instance(MlabSceneModel, ())
def __init__(self):
HasTraits.__init__(self)
x, y, z = curve(n_turns=2)
# Populating our plot
self.plot = self.scene.mlab.plot3d(x, y, z)
from traits.api import Range, on_trait_change
class Visualization(HasTraits):
n_turns = Range(0, 30, 11)
scene
= Instance(MlabSceneModel, ())
# Describe the dialog
view = View(Item('scene', height=300, show_label=False,
editor=SceneEditor()),
HGroup('n_turns'), resizable=True)
def __init__(self):
HasTraits.__init__(self)
x, y, z = curve(self.n_turns)
self.plot = self.scene.mlab.plot3d(x, y, z)
# Fire up the dialog
Visualization().configure_traits()
@on_trait_change('n_turns')
def update_plot(self):
x, y, z = curve(self.n_turns)
self.plot.mlab_source.set(x=x, y=y, z=z)
Tip: Let us read a bit the code above (examples/mlab_dialog.py).
First, the curve function is used to compute the coordinate of the curve we want to plot.
Second, the dialog is defined by an object inheriting from HasTraits, as it is done with Traits (page 338). The
important point here is that a Mayavi scene is added as a specific Traits attribute (Instance). This is important
3.5. 3D plotting with Mayavi
367
view = View(Item('scene', height=300, show_label=False,
3.5. 3D plotting with Mayavi
368
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Chapters contents
editor=SceneEditor()),
HGroup('n_turns'), resizable=True)
• Loading an example dataset (page 370)
– Learning and Predicting (page 371)
• Classification (page 371)
– k-Nearest neighbors classifier (page 371)
– Support vector machines (SVMs) for classification (page 372)
• Clustering: grouping observations together (page 373)
– K-means clustering (page 374)
• Dimension Reduction with Principal Component Analysis (page 375)
• Putting it all together: face recognition (page 376)
• Linear model: from regression to sparsity (page 377)
– Sparse models (page 377)
• Model selection: choosing estimators and their parameters (page 378)
– Grid-search and cross-validated estimators (page 378)
# Fire up the dialog
Visualization().configure_traits()
Tip: Full code of the example: examples/mlab_dialog.py.
3.5.6 Putting it together
Exercise
Using the code from the magnetic field simulation, create a dialog that enable to move the 2 coils: change
their parameters.
Hint: to define a dialog entry for a vector of dimension 3
3.6.1 Loading an example dataset
direction = Array(float, value=(0, 0, 1), cols=3, shape=(3,))
You can look at the example_coil_application.py to see a full-blown application for coil design in 270 lines of
code.
3.6 scikit-learn: machine learning in Python
Authors: Fabian Pedregosa, Gael Varoquaux
First we will load some data to play with. The data we will use is a very simple flower database known as the Iris
dataset.
Prerequisites
•
•
•
•
We have 150 observations of the iris flower specifying some measurements: sepal length, sepal width, petal length
and petal width together with its subtype: Iris setosa, Iris versicolor, Iris virginica.
Numpy, Scipy
IPython
matplotlib
scikit-learn (http://scikit-learn.org)
To load the dataset into a Python object:
>>> from sklearn import datasets
>>> iris = datasets.load_iris()
This data is stored in the .data member, which is a (n_samples, n_features) array.
>>> iris.data.shape
(150, 4)
The class of each observation is stored in the .target attribute of the dataset. This is an integer 1D array of
length n_samples:
>>> iris.target.shape
(150,)
>>> import numpy as np
>>> np.unique(iris.target)
array([0, 1, 2])
3.6. scikit-learn: machine learning in Python
369
3.6. scikit-learn: machine learning in Python
370
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
An example of reshaping data: the digits dataset
The digits dataset consists of 1797 images, where each one is an 8x8 pixel image representing a hand-written
digit
>>> digits = datasets.load_digits()
>>> digits.images.shape
(1797, 8, 8)
>>> import pylab as pl
>>> pl.imshow(digits.images[0], cmap=pl.cm.gray_r)
<matplotlib.image.AxesImage object at ...>
The k-nearest neighbors classifier internally uses an algorithm based on ball trees to represent the samples it is
trained on.
To use this dataset with the scikit, we transform each 8x8 image into a vector of length 64
KNN (k-nearest neighbors) classification example:
>>> data = digits.images.reshape((digits.images.shape[0], -1))
>>> # Create and fit a nearest-neighbor classifier
>>> from sklearn import neighbors
>>> knn = neighbors.KNeighborsClassifier()
>>> knn.fit(iris.data, iris.target)
KNeighborsClassifier(...)
>>> knn.predict([[0.1, 0.2, 0.3, 0.4]])
array([0])
Learning and Predicting
Now that we’ve got some data, we would like to learn from it and predict on new one. In scikit-learn, we
learn from existing data by creating an estimator and calling its fit(X, Y) method.
Training set and testing set
>>> from sklearn import svm
>>> clf = svm.LinearSVC()
>>> clf.fit(iris.data, iris.target) # learn from the data
LinearSVC(...)
When experimenting with learning algorithms, it is important not to test the prediction of an estimator on
the data used to fit the estimator. Indeed, with the kNN estimator, we would always get perfect prediction on
the training set.
Once we have learned from the data, we can use our model to predict the most likely outcome on unseen data:
>>> clf.predict([[ 5.0,
array([0])
3.6,
1.3,
0.25]])
Note: We can access the parameters of the model via its attributes ending with an underscore:
>>> clf.coef_
array([[ 0...]])
>>> perm = np.random.permutation(iris.target.size)
>>> iris.data = iris.data[perm]
>>> iris.target = iris.target[perm]
>>> knn.fit(iris.data[:100], iris.target[:100])
KNeighborsClassifier(...)
>>> knn.score(iris.data[100:], iris.target[100:])
0.95999...
Bonus question: why did we use a random permutation?
3.6.2 Classification
Support vector machines (SVMs) for classification
k-Nearest neighbors classifier
Linear Support Vector Machines
The simplest possible classifier is the nearest neighbor: given a new observation, take the label of the training
samples closest to it in n-dimensional space, where n is the number of features in each sample.
SVMs try to construct a hyperplane maximizing the margin between the two classes. It selects a subset of the
input, called the support vectors, which are the observations closest to the separating hyperplane.
3.6. scikit-learn: machine learning in Python
3.6. scikit-learn: machine learning in Python
371
372
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
K-means clustering
The simplest clustering algorithm is k-means. This divides a set into k clusters, assigning each observation to a
cluster so as to minimize the distance of that observation (in n-dimensional space) to the cluster’s mean; the means
are then recomputed. This operation is run iteratively until the clusters converge, for a maximum for max_iter
rounds.
(An alternative implementation of k-means is available in SciPy’s cluster package. The scikit-learn
implementation differs from that by offering an object API and several additional features, including smart initialization.)
>>> from sklearn import cluster, datasets
>>> iris = datasets.load_iris()
>>> k_means = cluster.KMeans(n_clusters=3)
>>> k_means.fit(iris.data)
KMeans(...)
>>> print(k_means.labels_[::10])
[1 1 1 1 1 0 0 0 0 0 2 2 2 2 2]
>>> print(iris.target[::10])
[0 0 0 0 0 1 1 1 1 1 2 2 2 2 2]
>>> from sklearn import svm
>>> svc = svm.SVC(kernel='linear')
>>> svc.fit(iris.data, iris.target)
SVC(...)
There are several support vector machine implementations in scikit-learn. The most commonly used ones
are svm.SVC, svm.NuSVC and svm.LinearSVC; “SVC” stands for Support Vector Classifier (there also exist
SVMs for regression, which are called “SVR” in scikit-learn).
Excercise
Train an svm.SVC on the digits dataset. Leave out the last 10% and test prediction performance on these
observations.
Ground truth
K-means (3 clusters)
K-means (8 clusters)
Application to Image Compression
Using kernels
Classes are not always separable by a hyperplane, so it would be desirable to have a decision function that is not
linear but that may be for instance polynomial or exponential:
Linear kernel
Polynomial kernel
RBF kernel (Radial Basis Function)
Clustering can be seen as a way of choosing a small number of observations from the information. For
instance, this can be used to posterize an image (conversion of a continuous gradation of tone to several
regions of fewer tones):
>>> from scipy import misc
>>> lena = misc.lena().astype(np.float32)
>>> X = lena.reshape((-1, 1)) # We need an (n_sample, n_feature) array
>>> k_means = cluster.KMeans(n_clusters=5)
>>> k_means.fit(X)
KMeans(...)
>>> values = k_means.cluster_centers_.squeeze()
>>> labels = k_means.labels_
>>> lena_compressed = np.choose(labels, values)
>>> lena_compressed.shape = lena.shape
>>> svc = svm.SVC(kernel='linear')
>>> svc = svm.SVC(kernel='poly',
>>> svc = svm.SVC(kernel='rbf')
...
degree=3)
>>> # gamma: inverse of size of
>>> # degree: polynomial degree
>>> # radial kernel
Exercise
Which of the kernels noted above has a better prediction performance on the digits dataset?
Raw image
K-means quantization
3.6.3 Clustering: grouping observations together
Given the iris dataset, if we knew that there were 3 types of iris, but did not have access to their labels, we could
try unsupervised learning: we could cluster the observations into several groups by some criterion.
3.6. scikit-learn: machine learning in Python
373
3.6. scikit-learn: machine learning in Python
374
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3.6.4 Dimension Reduction with Principal Component Analysis
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
3.6.5 Putting it all together: face recognition
An example showcasing face recognition using Principal Component Analysis for dimension reduction and Support Vector Machines for classification.
The cloud of points spanned by the observations above is very flat in one direction, so that one feature can almost
be exactly computed using the 2 other. PCA finds the directions in which the data is not flat and it can reduce the
dimensionality of the data by projecting on a subspace.
Warning: Depending on your version of scikit-learn PCA will be in module decomposition or pca.
>>> from sklearn import decomposition
>>> pca = decomposition.PCA(n_components=2)
>>> pca.fit(iris.data)
PCA(copy=True, n_components=2, whiten=False)
>>> X = pca.transform(iris.data)
"""
Stripped-down version of the face recognition example by Olivier Grisel
Now we can visualize the (transformed) iris dataset:
http://scikit-learn.org/dev/auto_examples/applications/face_recognition.html
>>> import pylab as pl
>>> pl.scatter(X[:, 0], X[:, 1], c=iris.target)
<matplotlib.collections...Collection object at ...>
## original shape of images: 50, 37
"""
import numpy as np
import pylab as pl
from sklearn import cross_val, datasets, decomposition, svm
# ..
# .. load data ..
lfw_people = datasets.fetch_lfw_people(min_faces_per_person=70, resize=0.4)
perm = np.random.permutation(lfw_people.target.size)
lfw_people.data = lfw_people.data[perm]
lfw_people.target = lfw_people.target[perm]
faces = np.reshape(lfw_people.data, (lfw_people.target.shape[0], -1))
train, test = iter(cross_val.StratifiedKFold(lfw_people.target, k=4)).next()
X_train, X_test = faces[train], faces[test]
y_train, y_test = lfw_people.target[train], lfw_people.target[test]
PCA is not just useful for visualization of high dimensional datasets. It can also be used as a preprocessing step
to help speed up supervised methods that are not efficient with high dimensions.
# ..
# .. dimension reduction ..
pca = decomposition.RandomizedPCA(n_components=150, whiten=True)
pca.fit(X_train)
X_train_pca = pca.transform(X_train)
X_test_pca = pca.transform(X_test)
3.6. scikit-learn: machine learning in Python
3.6. scikit-learn: machine learning in Python
375
376
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Python Scientific lecture notes, Release 2013.2 beta (euroscipy 2013)
Different algorithms for a same problem
# ..
# .. classification ..
clf = svm.SVC(C=5., gamma=0.001)
clf.fit(X_train_pca, y_train)
Different algorithms can be used to solve the same mathematical problem. For instance the Lasso object in
the sklearn solves the lasso regression using a coordinate descent method, that is efficient on large datasets.
However, the sklearn also provides the LassoLARS object, using the LARS which is very efficient for problems in which the weight vector estimated is very sparse, that is problems with very few observations.
# ..
# .. predict on new images ..
for i in range(10):
print(lfw_people.target_names[clf.predict(X_test_pca[i])[0]])
_ = pl.imshow(X_test[i].reshape(50, 37), cmap=pl.cm.gray)
_ = raw_input()
3.6.7 Model selection: choosing estimators and their parameters
Grid-search and cross-validated estimators
Grid-search
3.6.6 Linear model: from regression to sparsity
The scikit-learn provides an object that, given data, computes the score during the fit of an estimator on a parameter
grid and chooses the parameters to maximize the cross-validation score. This object takes an estimator during the
construction and exposes an estimator API:
Diabetes dataset
The diabetes dataset consists of 10 physiological variables (age, sex, weight, blood pressure) measure on
442 patients, and an indication of disease progression after one year:
>>>
>>>
>>>
>>>
>>>
>>> from sklearn import svm, grid_search
>>> gammas = np.logspace(-6, -1, 10)
>>> svc = svm.SVC()
>>> clf = grid_search.GridSearchCV(estimator=svc, param_grid=dict(gamma=gammas),
...
n_jobs=-1)
>>> clf.fit(digits.data[:1000], digits.target[:1000])
GridSearchCV(cv=None,...)
>>> clf.best_score_
0.9...
>>> clf.best_estimator_.gamma
0.00059948425031894088
diabetes = datasets.load_diabetes()
diabetes_X_train = diabetes.data[:-20]
diabetes_X_test = diabetes.data[-20:]
diabetes_y_train = diabetes.target[:-20]
diabetes_y_test = diabetes.target[-20:]
The task at hand is to predict disease prediction from physiological variables.
Sparse models
To improve the conditioning of the problem (uninformative variables, mitigate the curse of dimensionality, as a
feature selection preprocessing, etc.), it would be interesting to select only the informative features and set noninformative ones to 0. This penalization approach, called Lasso, can set some coefficients to zero. Such methods
are called sparse method, and sparsity can be seen as an application of Occam’s razor: prefer simpler models to
complex ones.
>>> from sklearn import linear_model
>>> regr = linear_model.Lasso(alpha=.3)
>>> regr.fit(diabetes_X_train, diabetes_y_train)
Lasso(...)
>>> regr.coef_ # very sparse coefficients
array([
0.
,
-0.
, 497.34075682,
-0.
,
-0.
, -118.89291545,
430.9379595 ,
0.
])
>>> regr.score(diabetes_X_test, diabetes_y_test)
0.5510835453...
By default the GridSearchCV uses a 3-fold cross-validation. However, if it detects that a classifier is passed, rather
than a regressor, it uses a stratified 3-fold.
Cross-validated estimators
Cross-validation to set a parameter can be done more efficiently on an algorithm-by-algorithm basis. This is
why, for certain estimators, the scikit-learn exposes “CV” estimators, that set their parameter automatically by
cross-validation:
>>> from sklearn import linear_model, datasets
>>> lasso = linear_model.LassoCV()
>>> diabetes = datasets.load_diabetes()
>>> X_diabetes = diabetes.data
>>> y_diabetes = diabetes.target
>>> lasso.fit(X_diabetes, y_diabetes)
LassoCV(alphas=None, ...)
>>> # The estimator chose automatically its lambda:
>>> lasso.alpha_
0.012...
199.17441034,
0.
,
being the score very similar to linear regression (Least Squares):
>>> lin = linear_model.LinearRegression()
>>> lin.fit(diabetes_X_train, diabetes_y_train)
LinearRegression(...)
>>> lin.score(diabetes_X_test, diabetes_y_test)
0.5850753022...
These estimators are called similarly to their counterparts, with ‘CV’ appended to their name.
Exercise
On the diabetes dataset, find the optimal regularization parameter alpha.
3.6. scikit-learn: machine learning in Python
377
3.6. scikit-learn: machine learning in Python
378
Index
D
diff, 321, 323
differentiation, 321
dsolve, 323
E
equations
algebraic, 322
differential, 323
I
integration, 322
M
Matrix, 323
P
Python Enhancement Proposals
PEP 255, 142
PEP 3118, 178
PEP 3129, 152
PEP 318, 145, 152
PEP 342, 142
PEP 343, 152
PEP 380, 144
PEP 380#id13, 144
PEP 8, 147
S
solve, 322
379
Gaurav Pathak