Tutorial: Masked Arrays¶
Prerequisites¶
Before reading this tutorial, you should know a bit of Python. If you would like to refresh your memory, take a look at the Python tutorial.
If you want to be able to run the examples in this tutorial, you should also have matplotlib installed on your computer.
Learner profile¶
This tutorial is for people who have a basic understanding of NumPy and want to
understand how masked arrays and the numpy.ma module can be used in
practice.
Learning Objectives¶
After this tutorial, you should be able to:
Understand what are masked arrays and how they can be created
Understand how to access and modify data for masked arrays
Decide when the use of masked arrays is appropriate in some of your applications
What are masked arrays?¶
Consider the following problem. You have a dataset with missing or invalid
entries. If you’re doing any kind of processing on this data, and want to
skip or flag these unwanted entries without just deleting them, you may have
to use conditionals or filter your data somehow. The numpy.ma module
provides some of the same funcionality of
NumPy ndarrays with added structure to ensure
invalid entries are not used in computation.
From the Reference Guide:
A masked array is the combination of a standard
numpy.ndarrayand a mask. A mask is eithernomask, indicating that no value of the associated array is invalid, or an array of booleans that determines for each element of the associated array whether the value is valid or not. When an element of the mask isFalse, the corresponding element of the associated array is valid and is said to be unmasked. When an element of the mask isTrue, the corresponding element of the associated array is said to be masked (invalid).
We can think of a MaskedArray as a
combination of:
Data, as a regular
numpy.ndarrayof any shape or datatype;A boolean mask with the same shape as the data;
A
fill_value, a value that may be used to replace the invalid entries in order to return a standardnumpy.ndarray.
When can they be useful?¶
There are a few situations where masked arrays can be more useful than just eliminating the invalid entries of an array:
When you want to preserve the values you masked for later processing, without copying the array;
When you have to handle many arrays, each with their own mask. If the mask is part of the array, you avoid bugs and the code is possibly more compact;
When you have different flags for missing or invalid values, and wish to preserve these flags without replacing them in the original dataset, but exclude them from computations;
If you can’t avoid or eliminate missing values, but don’t want to deal with
NaN(Not A Number) values in your operations.
Masked arrays are also a good idea since the numpy.ma module also
comes with a specific implementation of most NumPy universal functions
(ufuncs), which means that you can still apply fast vectorized
functions and operations on masked data. The output is then a masked array.
We’ll see some examples of how this works in practice below.
Using masked arrays to see COVID-19 data¶
From Kaggle it is possible to
download a dataset with initial data about the COVID-19 outbreak in the
beginning of 2020. We are going to look at a small subset of this data,
contained in the file who_covid_19_sit_rep_time_series.csv.
In [1]: import numpy as np
In [2]: import os
# The os.getcwd() function returns the current folder; you can change
# the filepath variable to point to the folder where you saved the .csv file
In [3]: filepath = os.getcwd()
In [4]: filename = os.path.join(filepath, "who_covid_19_sit_rep_time_series.csv")
The data file contains data of different types and is organized as follows:
The first row is a header line that (mostly) describes the data in each column that follow in the rows below, and beginning in the fourth column, the header is the date of the observation.
The second through seventh row contain summary data that is of a different type than that which we are going to examine, so we will need to exclude that from the data with which we will work.
The numerical data we wish to work with begins at column 4, row 8, and extends from there to the rightmost column and the lowermost row.
Let’s explore the data inside this file for the first 14 days of records. To
gather data from the .csv file, we will use the numpy.genfromtxt
function, making sure we select only the columns with actual numbers instead of
the first three columns which contain location data. We also skip the first 7
rows of this file, since they contain other data we are not interested in.
Separately, we will extract the information about dates and location for this
data.
# Note we are using skip_header and usecols to read only portions of the
# data file into each variable.
# Read just the dates for columns 3-7 from the first row
In [5]: dates = np.genfromtxt(filename, dtype=np.unicode_, delimiter=",",
...: max_rows=1, usecols=range(3, 17),
...: encoding="utf-8-sig")
...:
# Read the names of the geographic locations from the first two
# columns, skipping the first seven rows
In [6]: locations = np.genfromtxt(filename, dtype=np.unicode_, delimiter=",",
...: skip_header=7, usecols=(0, 1),
...: encoding="utf-8-sig")
...:
# Read the numeric data from just the first 14 days
In [7]: nbcases = np.genfromtxt(filename, dtype=np.int_, delimiter=",",
...: skip_header=7, usecols=range(3, 17),
...: encoding="utf-8-sig")
...:
Included in the numpy.genfromtxt function call, we have selected the
numpy.dtype for each subset of the data (either an integer -
numpy.int_ - or a string of characters - numpy.unicode_). We
have also used the encoding argument to select utf-8-sig as the encoding
for the file (read more about encoding in the official Python documentation). You
can read more about the numpy.genfromtxt function from
the Reference Documentation or from the
Basic IO tutorial.
Exploring the data¶
First of all, we can plot the whole set of data we have and see what it looks
like. In order to get a readable plot, we select only a few of the dates to
show in our x-axis ticks. Note also that in
our plot command, we use nbcases.T (the transpose of the nbcases array)
since this means we will plot each row of the file as a separate line. We choose
to plot a dashed line (using the '--' line style). See the
matplotlib documentation for more info on this.
In [8]: import matplotlib.pyplot as plt
In [9]: selected_dates = [0, 3, 11, 13]
In [10]: plt.plot(dates, nbcases.T, '--');
In [11]: plt.xticks(selected_dates, dates[selected_dates]);
In [12]: plt.title("COVID-19 cumulative cases from Jan 21 to Feb 3 2020");
Note
If you are executing the commands above in the IPython shell, it might be
necessary to use the command plt.show() to show the image window. Note
also that we use a semicolon at the end of a line to suppress its output, but
this is optional.
The graph has a strange shape from January 24th to February 1st. It would be
interesing to know where this data comes from. If we look at the locations
array we extracted from the .csv file, we can see that we have two columns,
where the first would contain regions and the second would contain the name of
the country. However, only the first few rows contain data for the the first
column (province names in China). Following that, we only have country names. So
it would make sense to group all the data from China into a single row. For
this, we’ll select from the nbcases array only the rows for which the
second entry of the locations array corresponds to China. Next, we’ll use
the numpy.sum function to sum all the selected rows (axis=0):
In [13]: china_total = nbcases[locations[:, 1] == 'China'].sum(axis=0)
In [14]: china_total
Out[14]:
array([ 247, 288, 556, 817, -22, -22, -15, -10, -9,
-7, -4, 11820, 14410, 17237])
Something’s wrong with this data - we are not supposed to have negative values in a cumulative data set. What’s going on?
Missing data¶
Looking at the data, here’s what we find: there is a period with missing data:
In [15]: nbcases
Out[15]:
array([[ 258, 270, 375, ..., 7153, 9074, 11177],
[ 14, 17, 26, ..., 520, 604, 683],
[ -1, 1, 1, ..., 422, 493, 566],
...,
[ -1, -1, -1, ..., -1, -1, -1],
[ -1, -1, -1, ..., -1, -1, -1],
[ -1, -1, -1, ..., -1, -1, -1]])
All the -1 values we are seeing come from numpy.genfromtxt
attempting to read missing data from the original .csv file. Obviously, we
don’t want to compute missing data as -1 - we just want to skip this value
so it doesn’t interfere in our analysis. After importing the numpy.ma
module, we’ll create a new array, this time masking the invalid values:
In [16]: from numpy import ma
In [17]: nbcases_ma = ma.masked_values(nbcases, -1)
If we look at the nbcases_ma masked array, this is what we have:
In [18]: nbcases_ma
Out[18]:
masked_array(
data=[[258, 270, 375, ..., 7153, 9074, 11177],
[14, 17, 26, ..., 520, 604, 683],
[--, 1, 1, ..., 422, 493, 566],
...,
[--, --, --, ..., --, --, --],
[--, --, --, ..., --, --, --],
[--, --, --, ..., --, --, --]],
mask=[[False, False, False, ..., False, False, False],
[False, False, False, ..., False, False, False],
[ True, False, False, ..., False, False, False],
...,
[ True, True, True, ..., True, True, True],
[ True, True, True, ..., True, True, True],
[ True, True, True, ..., True, True, True]],
fill_value=-1)
We can see that this is a different kind of array. As mentioned in the
introduction, it has three attributes (data, mask and fill_value).
Keep in mind that the mask attribute has a True value for elements
corresponding to invalid data (represented by two dashes in the data
attribute).
Note
Adding -1 to missing data is not a problem with numpy.genfromtxt;
in this particular case, substituting the missing value with 0 might have
been fine, but we’ll see later that this is far from a general solution.
Also, it is possible to call the numpy.genfromtxt function using the
usemask parameter. If usemask=True, numpy.genfromtxt
automatically returns a masked array.
Let’s try and see what the data looks like excluding the first row (data from the Hubei province in China) so we can look at the missing data more closely:
In [19]: plt.plot(dates, nbcases_ma[1:].T, '--');
In [20]: plt.xticks(selected_dates, dates[selected_dates]);
In [21]: plt.title("COVID-19 cumulative cases from Jan 21 to Feb 3 2020");
Now that our data has been masked, let’s try summing up all the cases in China:
In [22]: china_masked = nbcases_ma[locations[:, 1] == 'China'].sum(axis=0)
In [23]: china_masked
Out[23]:
masked_array(data=[278, 309, 574, 835, 10, 10, 17, 22, 23, 25, 28, 11821,
14411, 17238],
mask=[False, False, False, False, False, False, False, False,
False, False, False, False, False, False],
fill_value=999999)
Note that china_masked is a masked array, so it has a different data
structure than a regular NumPy array. Now, we can access its data directly by
using the .data attribute:
In [24]: china_total = china_masked.data
In [25]: china_total
Out[25]:
array([ 278, 309, 574, 835, 10, 10, 17, 22, 23,
25, 28, 11821, 14411, 17238])
That is better: no more negative values. However, we can still see that for some days, the cumulative number of cases seems to go down (from 835 to 10, for example), which does not agree with the definition of “cumulative data”. If we look more closely at the data, we can see that in the period where there was missing data in mainland China, there was valid data for Hong Kong, Taiwan, Macau and “Unspecified” regions of China. Maybe we can remove those from the total sum of cases in China, to get a better understanding of the data.
First, we’ll identify the indices of locations in mainland China:
In [26]: china_mask = ((locations[:, 1] == 'China') &
....: (locations[:, 0] != 'Hong Kong') &
....: (locations[:, 0] != 'Taiwan') &
....: (locations[:, 0] != 'Macau') &
....: (locations[:, 0] != 'Unspecified*'))
....:
Now, china_mask is an array of boolean values (True or False); we
can check that the indices are what we wanted with the ma.nonzero method
for masked arrays:
In [27]: china_mask.nonzero()
Out[27]:
(array([ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16,
17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 29, 31, 33]),)
Now we can correctly sum entries for mainland China:
In [28]: china_total = nbcases_ma[china_mask].sum(axis=0)
In [29]: china_total
Out[29]:
masked_array(data=[278, 308, 440, 446, --, --, --, --, --, --, --, 11791,
14380, 17205],
mask=[False, False, False, False, True, True, True, True,
True, True, True, False, False, False],
fill_value=999999)
We can replace the data with this information and plot a new graph, focusing on Mainland China:
In [30]: plt.plot(dates, china_total.T, '--');
In [31]: plt.xticks(selected_dates, dates[selected_dates]);
In [32]: plt.title("COVID-19 cumulative cases from Jan 21 to Feb 3 2020 - Mainland China");
It’s clear that masked arrays are the right solution here. We cannot represent the missing data without mischaracterizing the evolution of the curve.
Fitting Data¶
One possibility we can think of is to interpolate the missing data to estimate
the number of cases in late January. Observe that we can select the masked
elements using the .mask attribute:
In [33]: china_total.mask
Out[33]:
array([False, False, False, False, True, True, True, True, True,
True, True, False, False, False])
In [34]: invalid = china_total[china_total.mask]
In [35]: invalid
Out[35]:
masked_array(data=[--, --, --, --, --, --, --],
mask=[ True, True, True, True, True, True, True],
fill_value=999999,
dtype=int64)
We can also access the valid entries by using the logical negation for this mask:
In [36]: valid = china_total[~china_total.mask]
In [37]: valid
Out[37]:
masked_array(data=[278, 308, 440, 446, 11791, 14380, 17205],
mask=[False, False, False, False, False, False, False],
fill_value=999999)
Now, if we want to create a very simple approximation for this data, we should
take into account the valid entries around the invalid ones. So first let’s
select the dates for which the data is valid. Note that we can use the mask
from the china_total masked array to index the dates array:
In [38]: dates[~china_total.mask]
Out[38]:
array(['1/21/20', '1/22/20', '1/23/20', '1/24/20', '2/1/20', '2/2/20',
'2/3/20'], dtype='<U7')
Finally, we can use the numpy.polyfit and numpy.polyval
functions to create a cubic polynomial that fits the data as best as possible:
In [39]: t = np.arange(len(china_total))
In [40]: params = np.polyfit(t[~china_total.mask], valid, 3)
In [41]: cubic_fit = np.polyval(params, t)
In [42]: plt.plot(t, china_total);
In [43]: plt.plot(t, cubic_fit, '--');
This plot is not so readable since the lines seem to be over each other, so let’s summarize in a more elaborate plot. We’ll plot the real data when available, and show the cubic fit for unavailable data, using this fit to compute an estimate to the observed number of cases on January 28th 2020, 7 days after the beginning of the records:
In [44]: plt.plot(t, china_total, label='Mainland China');
In [45]: plt.plot(t[china_total.mask], cubic_fit[china_total.mask], '--',
....: color='orange', label='Cubic estimate');
....:
In [46]: plt.plot(7, np.polyval(params, 7), 'r*', label='7 days after start');
In [47]: plt.xticks([0, 7, 13], dates[[0, 7, 13]]);
In [48]: plt.yticks([0, np.polyval(params, 7), 10000, 17500]);
In [49]: plt.legend();
In [50]: plt.title("COVID-19 cumulative cases from Jan 21 to Feb 3 2020 - Mainland China\n"
....: "Cubic estimate for 7 days after start");
....:
More reading¶
Topics not covered in this tutorial can be found in the documentation: