Skip to content
Snippets Groups Projects
04_numpy.md 32.4 KiB
Newer Older
# Numpy


This section introduces you to [`numpy`](http://www.numpy.org/), Python's
numerical computing library.


Numpy is not actually part of the standard Python library. But it is a
fundamental part of the Python ecosystem - it forms the basis for many
important Python libraries, and it (along with its partners
[`scipy`](https://www.scipy.org/), [`matplotlib`](https://matplotlib.org/) and
[`pandas`](https://pandas.pydata.org/)) is what makes Python an attractive
alternative to Matlab as a scientific computing platform.


## Contents


* [The Python list versus the Numpy array](#the-python-list-versus-the-numpy-array)
* [Numpy basics](#numpy-basics)
  * [Creating arrays](#creating-arrays)
  * [Loading text files](#loading-text-files)
  * [Array properties](#array-properties)
  * [Descriptive statistics](#descriptive-statistics)
  * [Reshaping and rearranging arrays](#reshaping-and-rearranging-arrays)
Paul McCarthy's avatar
Paul McCarthy committed
* [Operating on arrays](#operating-on-arrays)
  * [Scalar operations](#scalar-operations)
  * [Multi-variate operations](#multi-variate-operations)
  * [Matrix multplication](#matrix-multiplication)
  * [Broadcasting](#broadcasting)
  * [Linear algebra](#linear-algebra)
* [Array indexing](#array-indexing)
  * [Indexing multi-dimensional arrays](#indexing-multi-dimensional-arrays)
  * [Boolean indexing](#boolean-indexing)
  * [Coordinate array indexing](#coordinate-array-indexing)
* [Exercises](#exercises)
  * [Load an array from a file and do stuff with it](#load-an-array-from-a-file-and-do-stuff-with-it)
  * [Concatenate affine transforms](#concatenate-affine-transforms)
Paul McCarthy's avatar
Paul McCarthy committed
* [Appendix A: Generating random numbers](#appendix-generating-random-numbers)
* [Appendix B: Importing Numpy](#appendix-importing-numpy)
* [Appendix C: Vectors in Numpy](#appendix-vectors-in-numpy)
* [Appendix D: The Numpy `matrix`](#appendix-the-numpy-matrix)
Paul McCarthy's avatar
Paul McCarthy committed
* [Useful references](#useful-references)


<a class="anchor" id="the-python-list-versus-the-numpy-array"></a>
## The Python list versus the Numpy array


Numpy adds a new data type to the Python language - the `array` (more
specifically, the `ndarray`). A Numpy `array` is a N-dimensional array of
homogeneously-typed numerical data.


You have already been introduced to the Python `list`, which you can easily
use to store a handful of numbers (or anything else):


```
data = [10, 8, 12, 14, 7, 6, 11]
```


You could also emulate a 2D or ND matrix by using lists of lists, for example:


```
xyz_coords = [[-11.4,   1.0,  22.6],
              [ 22.7, -32.8,  19.1],
              [ 62.8, -18.2, -34.5]]
```


For simple tasks, you could stick with processing your data using python
lists, and the built-in
Paul McCarthy's avatar
Paul McCarthy committed
[`math`](https://docs.python.org/3/library/math.html) library. And this
might be tempting, because it does look quite a lot like what you might type
into Matlab.


But __BEWARE!__ A Python list is a terrible data structure for scientific
computing!


Paul McCarthy's avatar
Paul McCarthy committed
This is a major source of confusion for people who are learning Python, and
are trying to write efficient code. It is _crucial_ to be able to distinguish
between a Python list and a Numpy array.
___Python list == Matlab cell array:___ A list in Python is akin to a cell
array in Matlab - they can store anything, but are extremely inefficient, and
unwieldy when you have more than a couple of dimensions.
___Numpy array == Matlab matrix:___ These are in contrast to the Numpy array
and Matlab matrix, which are both thin wrappers around a contiguous chunk of
memory, and which provide blazing-fast performance (because behind the scenes
in both Numpy and Matlab, it's C, C++ and FORTRAN all the way down).


So you should strongly consider turning those lists into Numpy arrays:


```
import numpy as np

data = np.array([10, 8, 12, 14, 7, 6, 11])

xyz_coords = np.array([[-11.4,   1.0,  22.6],
                       [ 22.7, -32.8,  19.1],
                       [ 62.8, -18.2, -34.5]])
```


If you look carefully at the code above, you will notice that we are still
actually using Python lists. We have declared our data sets in exactly the
same way as we did earlier, by denoting them with square brackets `[` and `]`.


The key difference here is that these lists immediately get converted into
Numpy arrays, by passing them to the `np.array` function.  To clarify this
point, we could rewrite this code in the following equivalent manner:


```
import numpy as np

# Define our data sets as python lists
data       = [10, 8, 12, 14, 7, 6, 11]
xyz_coords = [[-11.4,   1.0,  22.6],
              [ 22.7, -32.8,  19.1],
              [ 62.8, -18.2, -34.5]]

# Convert them to numpy arrays
data       = np.array(data)
xyz_coords = np.array(xyz_coords)
```


Of course, in practice, we would never create a Numpy array in this way - we
will be loading our data from text or binary files directly into a Numpy
array, thus completely bypassing the use of Python lists and the costly
list-to-array conversion.  I'm emphasising this to help you understand the
difference between Python lists and Numpy arrays. Apologies if you've already
got it, [forgiveness
please](https://www.youtube.com/watch?v=ZeHflFNR4kQ&feature=youtu.be&t=128).


<a class="anchor" id="numpy-basics"></a>
## Numpy basics


Let's get started.


```
import numpy as np
```


<a class="anchor" id="creating-arrays"></a>
### Creating arrays


Numpy has quite a few functions which behave similarly to their equivalents in
Matlab:


```
print('np.zeros gives us zeros:                       ', np.zeros(5))
print('np.ones gives us ones:                         ', np.ones(5))
print('np.arange gives us a range:                    ', np.arange(5))
print('np.linspace gives us N linearly spaced numbers:', np.linspace(0, 1, 5))
Paul McCarthy's avatar
Paul McCarthy committed
print('np.random.random gives us random numbers [0-1]:', np.random.random(5))
print('np.random.randint gives us random integers:    ', np.random.randint(1, 10, 5))
print('np.eye gives us an identity matrix:')
print(np.eye(4))
print('np.diag gives us a diagonal matrix:')
print(np.diag([1, 2, 3, 4]))
```


Paul McCarthy's avatar
Paul McCarthy committed
> See the [appendix](#appendix-generating-random-numbers) for more information
> on generating random numbers in Numpy.


The `zeros` and `ones` functions can also be used to generate N-dimensional
arrays:


```
z = np.zeros((3, 4))
o = np.ones((2, 10))
print(z)
print(o)
```


> Note that, in a 2D Numpy array, the first axis corresponds to rows, and the
> second to columns - just like in Matlab.


<a class="anchor" id="loading-text-files"></a>
### Loading text files


The `numpy.loadtxt` function is capable of loading numerical data from
plain-text files. By default it expects space-separated data:


```
data = np.loadtxt('04_numpy/space_separated.txt')
print('data in 04_numpy/space_separated.txt:')
print(data)
```


But you can also specify the delimiter to expect<sup>1</sup>:


```
data = np.loadtxt('04_numpy/comma_separated.txt', delimiter=',')
print('data in 04_numpy/comma_separated.txt:')
print(data)
```


> <sup>1</sup> And many other things such as file headers, footers, comments,
> and newline characters - see the
> [docs](https://docs.scipy.org/doc/numpy/reference/generated/numpy.loadtxt.html)
> for more information.


Of course you can also save data out to a text file just as easily, with
[`numpy.savetxt`](https://docs.scipy.org/doc/numpy/reference/generated/numpy.savetxt.html):


```
data = np.random.randint(1, 10, (10, 10))
np.savetxt('mydata.txt', data, delimiter=',', fmt='%i')

with open('mydata.txt', 'rt') as f:
    for line in f:
        print(line.strip())
```


> The `fmt` argument to the `numpy.savetxt` function uses a specification
> language similar to that used in the C `printf` function - in the example
> above, `'%i`' indicates that the values of the array should be output as
> signed integers. See the [`numpy.savetxt`
> documentation](https://docs.scipy.org/doc/numpy/reference/generated/numpy.savetxt.html)
> for more details on specifying the output format.

<a class="anchor" id="array-properties"></a>
### Array properties


Numpy is a bit different than Matlab in the way that you interact with
arrays. In Matlab, you would typically pass an array to a built-in function,
e.g. `size(M)`, `ndims(M)`, etc. In contrast, a Numpy array is a Python
object which has _attributes_ that contain basic information about the array:


```
z = np.zeros((2, 3, 4))
print(z)
print('Shape:                     ', z.shape)
print('Number of dimensions:      ', z.ndim)
print('Number of elements:        ', z.size)
print('Data type:                 ', z.dtype)
print('Number of bytes:           ', z.nbytes)
print('Length of first dimension: ', len(z))
```


> As depicted above, passing a Numpy array to the built-in `len` function will
> only give you the length of the first dimension, so you will typically want
> to avoid using it - instead, use the `size` attribute if you want to know
> how many elements are in an array, or the `shape` attribute if you want to
> know the array shape.


<a class="anchor" id="descriptive-statistics"></a>
### Descriptive statistics


Similarly, a Numpy array has a set of methods<sup>2</sup> which allow you to
calculate basic descriptive statistics on an array:


```
a = np.random.random(10)
print('a: ', a)
print('min:          ', a.min())
print('max:          ', a.max())
print('index of min: ', a.argmin())  # remember that in Python, list indices
print('index of max: ', a.argmax())  # start from zero - Numpy is the same!
print('mean:         ', a.mean())
print('variance:     ', a.var())
print('stddev:       ', a.std())
print('sum:          ', a.sum())
print('prod:         ', a.prod())
```


These methods can also be applied to arrays with multiple dimensions:


```
a = np.random.randint(1, 10, (3, 3))
print('a:')
print(a)
print('min:             ', a.min())
print('row mins:        ', a.min(axis=1))
print('col mins:        ', a.min(axis=0))
print('Min index      : ', a.argmin())
print('Row min indices: ', a.argmin(axis=1))
```


Note that, for a multi-dimensional array, the `argmin` and `argmax` methods
will return the (0-based) index of the minimum/maximum values into a
Paul McCarthy's avatar
Paul McCarthy committed
[flattened](https://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.flatten.html)
> <sup>2</sup> Python, being an object-oriented language, distinguishes
Paul McCarthy's avatar
Paul McCarthy committed
> between _functions_ and _methods_. Hopefully we all know what a function
> is - a _method_ is simply the term used to refer to a function that is
> associated with a specific object. Similarly, the term _attribute_ is used
> to refer to some piece of information that is attached to an object, such as
> `z.shape`, or `z.dtype`.


<a class="anchor" id="reshaping-and-rearranging-arrays"></a>
### Reshaping and rearranging arrays


A numpy array can be reshaped very easily, using the `reshape` method.

```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(16).reshape(4, 4)
b = a.reshape((2, 8))
print('a:')
print(a)
print('b:')
print(b)
```


Note that this does not modify the underlying data in any way - the `reshape`
method returns a _view_ of the same array, just indexed differently:


```
a[3, 3] = 12345
b[0, 7] = 54321
print('a:')
print(a)
print('b:')
print(b)
```


If you need to create a reshaped copy of an array, use the `np.array`
function:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(16).reshape((4, 4))
b = np.array(a.reshape(2, 8))
a[3, 3] = 12345
b[0, 7] = 54321
print('a:')
print(a)
print('b:')
print(b)
```


The `T` attribute is a shortcut to obtain the transpose of an array.


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(16).reshape((4, 4))
print(a)
print(a.T)
```


The `transpose` method allows you to obtain more complicated rearrangements
Paul McCarthy's avatar
Paul McCarthy committed
of an N-dimensional array's axes:
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(24).reshape((2, 3, 4))
b = a.transpose((2, 0, 1))
print('a: ', a.shape)
print(a)
print('b:', b.shape)
print(b)
```


> Note again that the `T` attribute and `transpose` method return _views_ of
> your array.


Numpy has some useful functions which allow you to concatenate or stack
multiple arrays into one. The `concatenate` function does what it says on the
tin:


```
a = np.zeros(3)
b = np.ones(3)

print('1D concatenation:', np.concatenate((a, b)))

a = np.zeros((3, 3))
b = np.ones((3, 3))

print('2D column-wise concatenation:')
print(np.concatenate((a, b), axis=1))

print('2D row-wise concatenation:')

# The axis parameter defaults to 0,
# so it is not strictly necessary here.
print(np.concatenate((a, b), axis=0))
```


The `hstack`, `vstack` and `dstack` functions allow you to concatenate vectors
or arrays along the first, second, or third dimension respectively:

```
a = np.zeros(3)
b = np.ones(3)

print('a: ', a)
print('b: ', b)

hstacked = np.hstack((a, b))
vstacked = np.vstack((a, b))
dstacked = np.dstack((a, b))

print('hstacked: (shape {}):'.format(hstacked.shape))
print( hstacked)
print('vstacked: (shape {}):'.format(vstacked.shape))
print( vstacked)
print('dstacked: (shape {}):'.format(dstacked.shape))
print( dstacked)
```

Alternatively, you can use the `stack` function and give the index of the dimension along which the array
Paul McCarthy's avatar
Paul McCarthy committed
should be stacked as the `axis` keyword (so, `np.vstack((a, b))` is equivalent to `np.stack((a, b), axis=1)`).
Paul McCarthy's avatar
Paul McCarthy committed
<a class="anchor" id="operating-on-arrays"></a>
## Operating on arrays


If you are coming from Matlab, you should read this section as, while many
Numpy operations behave similarly to Matlab, there are a few important
behaviours which differ from what you might expect.


<a class="anchor" id="scalar-operations"></a>
### Scalar operations


All of the mathematical operators you know and love can be applied to Numpy
arrays:


```
a = np.arange(1, 10).reshape((3, 3))
print('a:')
print(a)
print('a + 2:')
print( a + 2)
print('a * 3:')
print( a * 3)
print('a % 2:')
print( a % 2)
```


<a class="anchor" id="multi-variate-operations"></a>
Paul McCarthy's avatar
Paul McCarthy committed
### Multi-variate operations
Paul McCarthy's avatar
Paul McCarthy committed
Many operations in Numpy operate on an element-wise basis. For example:
Paul McCarthy's avatar
Paul McCarthy committed
a = np.ones(5)
b = np.random.randint(1, 10, 5)

print('a:     ', a)
print('b:     ', b)
print('a + b: ', a + b)
print('a * b: ', a * b)
```


This also extends to higher dimensional arrays:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.ones((4, 4))
b = np.arange(16).reshape((4, 4))

print('a:')
print(a)
print('b:')
print(b)

print('a + b')
print(a + b)
print('a * b')
print(a * b)
```


Wait ... what's that you say? Oh, I couldn't understand because of all the
froth coming out of your mouth. I guess you're angry that `a * b` didn't give
you the matrix product, like it would have in Matlab.  Well all I can say is
Paul McCarthy's avatar
Paul McCarthy committed
that Numpy is not Matlab. Matlab operations are typically consistent with
linear algebra notation. This is not the case in Numpy. Get over it.
[Get yourself a calmative](https://youtu.be/M_w_n-8w3IQ?t=32).


<a class="anchor" id="matrix-multiplication"></a>
Paul McCarthy's avatar
Paul McCarthy committed
### Matrix multiplication


When your heart rate has returned to its normal caffeine-induced state, you
Paul McCarthy's avatar
Paul McCarthy committed
can use the `@` operator or the `dot` method, to perform matrix
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(1, 5).reshape((2, 2))
b = a.T

print('a:')
print(a)
print('b:')
print(b)

print('a @ b')
print(a @ b)

print('a.dot(b)')
print(a.dot(b))

print('b.dot(a)')
print(b.dot(a))
```


Paul McCarthy's avatar
Paul McCarthy committed
> The `@` matrix multiplication operator is a relatively recent addition to
> Python and Numpy, so you might not see it all that often in existing
> code. But it's here to stay, so if you don't need to worry about
> backwards-compatibility, go ahead and use it!
One potential source of confusion for those of you who are used to Matlab's
linear algebra-based take on things is that Numpy treats row and column
vectors differently - you should take a break now and skim over the [appendix
on vectors in Numpy](#appendix-vectors-in-numpy).


For matrix-by-vector multiplications, a 1-dimensional Numpy array may be
treated as _either_ a row vector _or_ a column vector, depending on where
it is in the expression:


```
a = np.arange(1, 5).reshape((2, 2))
b = np.random.randint(1, 10, 2)

print('a:')
print(a)
print('b:', b)

print('a @ b - b is a column vector:')
print(a @ b)
print('b @ a - b is a row vector:')
print(b @ a)
```


If you really can't stand using `@` to denote matrix multiplication, and just
want things to be like they were back in Matlab-land, you do have the option
of using a different Numpy data type - the `matrix` - which behaves a bit more
like what you might expect from Matlab.  You can find a brief overview of the
`matrix` data type in [the appendix](appendix-the-numpy-matrix).


<a class="anchor" id="broadcasting"></a>
### Broadcasting


Paul McCarthy's avatar
Paul McCarthy committed
One of the coolest features of Numpy is *broadcasting*<sup>3</sup>.
Paul McCarthy's avatar
Paul McCarthy committed
Broadcasting allows you to perform element-wise operations on arrays which
Paul McCarthy's avatar
Paul McCarthy committed
have a different shape. For each axis in the two arrays, Numpy will implicitly
expand the shape of the smaller axis to match the shape of the larger one. You
never need to use `repmat` ever again!


> <sup>3</sup>Mathworks have shamelessly stolen Numpy's broadcasting behaviour
Paul McCarthy's avatar
Paul McCarthy committed
> and included it in Matlab versions from 2016b onwards, referring to it as
> _implicit expansion_.
Paul McCarthy's avatar
Paul McCarthy committed
Broadcasting allows you to, for example, add the elements of a 1D vector to
all of the rows or columns of a 2D array:
Paul McCarthy's avatar
Paul McCarthy committed
```
a = np.arange(9).reshape((3, 3))
Paul McCarthy's avatar
Paul McCarthy committed
b = np.arange(1, 4)
Paul McCarthy's avatar
Paul McCarthy committed
print('a:')
print(a)
print('b: ', b)
print('a * b (row-wise broadcasting):')
print(a * b)
print('a * b.T (column-wise broadcasting):')
print(a * b.reshape(-1, 1))
```


Paul McCarthy's avatar
Paul McCarthy committed
> Here we used a handy feature of the `reshape` method - if you pass `-1` for
> the size of one dimension, it will automatically determine the size to use
> for that dimension.


Paul McCarthy's avatar
Paul McCarthy committed
Here is a more useful example, where we use broadcasting to de-mean the rows
or columns of an array:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(9).reshape((3, 3))
Paul McCarthy's avatar
Paul McCarthy committed
print('a:')
print(a)

Paul McCarthy's avatar
Paul McCarthy committed
print('a (cols demeaned):')
Paul McCarthy's avatar
Paul McCarthy committed
print(a - a.mean(axis=0))

Paul McCarthy's avatar
Paul McCarthy committed
print('a (rows demeaned):')
Paul McCarthy's avatar
Paul McCarthy committed
print(a - a.mean(axis=1).reshape(-1, 1))
```
Paul McCarthy's avatar
Paul McCarthy committed
> As demonstrated above, many functions in Numpy accept an `axis` parameter,
> allowing you to apply the function along a specific axis. Omitting the
> `axis` parameter will apply the function to the whole array.


Paul McCarthy's avatar
Paul McCarthy committed
Broadcasting can sometimes be confusing, but the rules which Numpy follows to
align arrays of different sizes, and hence determine how the broadcasting
should be applied, are pretty straightforward. If something is not working,
and you can't figure out why refer to the [official
documentation](https://docs.scipy.org/doc/numpy/user/basics.broadcasting.html).

In short the broadcasting rules are:
Paul McCarthy's avatar
Paul McCarthy committed
1. If the input arrays have a different number of dimensions, the ones with fewer
    dimensions will have new dimensions with length 1 prepended until all arrays
    have the same number of dimensions. So adding a 2D array shaped (3, 3) with
    a 1D array of length (3, ), is equivalent to adding the two 2D arrays with
    shapes (3, 3) and (1, 3).
2. Once, all the arrays have the same number of dimensions, the arrays are combined
Paul McCarthy's avatar
Paul McCarthy committed
    elementwise. Each dimension is compatible between the two arrays if they have
    equal length or one has a length of 1. In the latter case the dimension will
    be repeated using a procedure equivalent to Matlab's `repmat`).
Paul McCarthy's avatar
Paul McCarthy committed

<a class="anchor" id="linear-algebra"></a>
### Linear algebra


Numpy is first and foremost a library for general-purpose numerical computing.
But it does have a range of linear algebra functionality, hidden away in the
[`numpy.linalg`](https://docs.scipy.org/doc/numpy/reference/routines.linalg.html)
module. Here are a couple of quick examples:


```
import numpy.linalg as npla

a = np.array([[1, 2, 3,  4],
              [0, 5, 6,  7],
              [0, 0, 8,  9],
              [0, 0, 0, 10]])

print('a:')
print(a)

print('inv(a)')
print(npla.inv(a))

eigvals, eigvecs = npla.eig(a)

print('eigenvalues and vectors of a:')
for val, vec in zip(eigvals, eigvecs):
    print('{:2.0f} - {}'.format(val, vec))
```
<a class="anchor" id="array-indexing"></a>
## Array indexing


Just like in Matlab, slicing up your arrays is a breeze in Numpy.  If you are
after some light reading, you might want to check out the [comprehensive Numpy
Indexing
reference](https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html).


> As with indexing regular Python lists, array indices start from 0, and end
> indices (if specified) are exclusive.


Let's whet our appetites with some basic 1D array slicing. Numpy supports the
Paul McCarthy's avatar
Paul McCarthy committed
standard Python
[__slice__](https://www.pythoncentral.io/how-to-slice-listsarrays-and-tuples-in-python/)
notation for indexing, where you can specify the start and end indices, and
the step size, via the `start:stop:step` syntax:
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(10)

print('a:                              ', a)
print('first element:                  ', a[0])
print('first two elements:             ', a[:2])
print('last element:                   ', a[a.shape[0] - 1])
print('last element again:             ', a[-1])
print('last two elements:              ', a[-2:])
print('middle four elements:           ', a[3:7])
Paul McCarthy's avatar
Paul McCarthy committed
print('Every second element:           ', a[1::2])
print('Every second element, reversed: ', a[-1::-2])
```


Note that slicing an array in this way returns a _view_, not a copy, into that
array:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(10)
print('a:', a)
every2nd = a[::2]
print('every 2nd:', every2nd)
every2nd += 10
<a class="anchor" id="indexing-multi-dimensional-arrays"></a>
### Indexing multi-dimensional arrays

Multi-dimensional array indexing works in much the same way as one-dimensional
indexing but with, well, more dimensions. Use commas within the square
brackets to separate the slices for each dimension:
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(25).reshape((5, 5))
print('a:')
print(a)
print(' First row:     ', a[  0, :])
print(' Last row:      ', a[ -1, :])
print(' second column: ', a[  :, 1])
print(' Centre:')
print(a[1:4, 1:4])
```


For arrays with more than two dimensions, the ellipsis (`...`) is a handy
feature - it allows you to specify a slice comprising all elements along
more than one dimension:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(27).reshape((3, 3, 3))
print('a:')
print(a)
print('All elements at x=0:')
print(a[0, ...])
print('All elements at z=2:')
print(a[..., 2])
print('All elements at x=0, z=2:')
print(a[0, ..., 2])
```


<a class="anchor" id="boolean-indexing"></a>
### Boolean indexing


A numpy array can be indexed with a boolean array of the same shape. For
example:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(10)

print('a:                          ', a)
print('a > 5:                      ', a > 4)
print('elements in a that are > 5: ', a[a > 5])
```


In contrast to the simple indexing we have already seen, boolean indexing will
return a _copy_ of the indexed data, __not__ a view. For example:


```
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(10)
b = a[a > 5]
print('a: ', a)
print('b: ', b)
print('Setting b[0] to 999')
b[0] = 999
print('a: ', a)
print('b: ', b)
```


> In general, any 'simple' indexing operation on a Numpy array, where the
> indexing object comprises integers, slices (using the standard Python
> `start:stop:step` notation), colons (`:`) and/or ellipses (`...`), will
> result in a __view__ into the indexed array. Any 'advanced' indexing
> operation, where the indexing object contains anything else (e.g. boolean or
> integer arrays, or even python lists), will result in a __copy__ of the
> data.


Logical operators `~` (not), `&` (and) and `|` (or) can be used to manipulate
and combine boolean Numpy arrays:

Paul McCarthy's avatar
Paul McCarthy committed
a    = np.arange(10)
gt5  = a > 5
even = a % 2 == 0

print('a:                                    ', a)
Paul McCarthy's avatar
Paul McCarthy committed
print('elements in a which are > 5:          ', a[ gt5])
print('elements in a which are <= 5:         ', a[~gt5])
Paul McCarthy's avatar
Paul McCarthy committed
print('elements in a which are even:         ', a[ even])
print('elements in a which are odd:          ', a[~even])
print('elements in a which are > 5 and even: ', a[gt5 &  even])
print('elements in a which are > 5 or odd:   ', a[gt5 | ~even])
```


Paul McCarthy's avatar
Paul McCarthy committed
Numpy also has two handy functions, `all` and `any`, which respectively allow
you to perform boolean `and` and `or` operations along the axes of an array:


```
a = np.arange(9).reshape((3, 3))

print('a:')
print(a)
print('rows with any element divisible by 3: ', np.any(a % 3 == 0, axis=1))
print('cols with any element divisible by 3: ', np.any(a % 3 == 0, axis=0))
print('rows with all elements divisible by 3:', np.all(a % 3 == 0, axis=1))
print('cols with all elements divisible by 3:', np.all(a % 3 == 0, axis=0))
```




<a class="anchor" id="coordinate-array-indexing"></a>
### Coordinate array indexing


You can index a numpy array using another array containing coordinates into
the first array.  As with boolean indexing, this will result in a copy of the
data.  Generally, you will need to have a separate array, or list, of
Paul McCarthy's avatar
Paul McCarthy committed
coordinates for each axis of the array you wish to index:
Paul McCarthy's avatar
Paul McCarthy committed
a = np.arange(16).reshape((4, 4))
Paul McCarthy's avatar
Paul McCarthy committed
print('a:')
rows    = [0, 2, 3]
cols    = [1, 0, 2]
indexed = a[rows, cols]
for r, c, v in zip(rows, cols, indexed):
    print('a[{}, {}] = {}'.format(r, c, v))
```
Paul McCarthy's avatar
Paul McCarthy committed
The `numpy.where` function can be combined with boolean arrays to easily
generate coordinate arrays for values which meet some condition:
Paul McCarthy's avatar
Paul McCarthy committed


```
a = np.arange(16).reshape((4, 4))
print('a:')
print(a)

evenrows, evencols = np.where(a % 2 == 0)
Paul McCarthy's avatar
Paul McCarthy committed

print('even row coordinates:', evenrows)
print('even col coordinates:', evencols)
Paul McCarthy's avatar
Paul McCarthy committed

print(a[evenrows, evencols])
Paul McCarthy's avatar
Paul McCarthy committed
```



<a class="anchor" id="exercises"></a>
## Exercises


The challenge for each of these exercises is to complete them in as few lines
of code as possible!


> You can find example answers to the exercises in `04_numpy/.solutions`.


<a class="anchor" id="load-an-array-from-a-file-and-do-stuff-with-it"></a>
### Load an array from a file and do stuff with it


Load the file `04_numpy/2d_array.txt`, and calculate and print the mean for
each column.  If your code doesn't work, you might want to __LOOK AT YOUR
DATA__, as you will have learnt if you have ever attended the FSL course.


> Bonus: Find the hidden message (hint:
> [chr](https://docs.python.org/3/library/functions.html#chr))


<a class="anchor" id="concatenate-affine-transforms"></a>
### Concatenate affine transforms


Given all of the files in `04_numpy/xfms/`, create a transformation matrix
which can transform coordinates from subject 1 functional space to subject 2
functional space<sup>4</sup>.
Write some code to transform the following coordinates from subject 1
functional space to subject 2 functional space, to test that your matrix is
correct:
| __Subject 1 coordinates__ | __Subject 2 coordinates__ |
|:-------------------------:|:-------------------------:|
| `[ 0.0,   0.0,   0.0]`    | `[ 3.21,   4.15, -9.89]`  |
| `[-5.0, -20.0,  10.0]`    | `[-0.87, -14.36, -1.13]`  |
| `[20.0,  25.0,  60.0]`    | `[29.58,  27.61, 53.37]`  |


> <sup>4</sup> Even though these are FLIRT transforms, this is just a toy
> example.  Look
Paul McCarthy's avatar
Paul McCarthy committed
> [here](https://users.fmrib.ox.ac.uk/~paulmc/fsleyes/fslpy/latest/fsl.transform.flirt.html)
Paul McCarthy's avatar
Paul McCarthy committed
> [here](https://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FLIRT/FAQ#What_is_the_format_of_the_matrix_used_by_FLIRT.2C_and_how_does_it_relate_to_the_transformation_parameters.3F)
> if you actually need to work with FLIRT transforms.



Paul McCarthy's avatar
Paul McCarthy committed
<a class="anchor" id="appendix-generating-random-numbers"></a>
## Appendix A: Generating random numbers
Numpy's
[`numpy.random`](https://docs.scipy.org/doc/numpy/reference/routines.random.html)
module is where you should go if you want to introduce a little randomness
into your code.  You have already seen a couple of functions for generating
uniformly distributed real or integer data:


```
import numpy.random as npr

print('Random floats between 0.0 (inclusive) and 1.0 (exclusive):')
print(npr.random((3, 3)))

print('Random integers in a specified range:')
print(npr.randint(1, 100, (3, 3)))
```


You can also draw random data from other distributions - here are just a few
examples: