#!/usr/bin/env python
# coding: utf-8

# # Hierarchical Indexing

# Up to this point we've been focused primarily on one-dimensional and two-dimensional data, stored in Pandas `Series` and `DataFrame` objects, respectively.
# Often it is useful to go beyond this and store higher-dimensional data—that is, data indexed by more than one or two keys.
# Early Pandas versions provided `Panel` and `Panel4D` objects that could be thought of as 3D or 4D analogs to the 2D `DataFrame`, but they were somewhat clunky to use in practice. A far more common pattern for handling higher-dimensional data is to make use of *hierarchical indexing* (also known as *multi-indexing*) to incorporate multiple index *levels* within a single index.
# In this way, higher-dimensional data can be compactly represented within the familiar one-dimensional `Series` and two-dimensional `DataFrame` objects.
# (If you're interested in true *N*-dimensional arrays with Pandas-style flexible indices, you can look into the excellent [Xarray package](https://xarray.pydata.org/).)
# 
# In this chapter, we'll explore the direct creation of `MultiIndex` objects; considerations when indexing, slicing, and computing statistics across multiply indexed data; and useful routines for converting between simple and hierarchically indexed representations of data.
# 
# We begin with the standard imports:

# In[1]:


import pandas as pd
import numpy as np


# ## A Multiply Indexed Series
# 
# Let's start by considering how we might represent two-dimensional data within a one-dimensional `Series`.
# For concreteness, we will consider a series of data where each point has a character and numerical key.

# ### The Bad Way
# 
# Suppose you would like to track data about states from two different years.
# Using the Pandas tools we've already covered, you might be tempted to simply use Python tuples as keys:

# In[2]:


index = [('California', 2010), ('California', 2020),
         ('New York', 2010), ('New York', 2020),
         ('Texas', 2010), ('Texas', 2020)]
populations = [37253956, 39538223,
               19378102, 20201249,
               25145561, 29145505]
pop = pd.Series(populations, index=index)
pop


# With this indexing scheme, you can straightforwardly index or slice the series based on this tuple index:

# In[3]:


pop[('California', 2020):('Texas', 2010)]


# But the convenience ends there. For example, if you need to select all values from 2010, you'll need to do some messy (and potentially slow) munging to make it happen:

# In[4]:


pop[[i for i in pop.index if i[1] == 2010]]


# This produces the desired result, but is not as clean (or as efficient for large datasets) as the slicing syntax we've grown to love in Pandas.

# ### The Better Way: The Pandas MultiIndex
# Fortunately, Pandas provides a better way.
# Our tuple-based indexing is essentially a rudimentary multi-index, and the Pandas `MultiIndex` type gives us the types of operations we wish to have.
# We can create a multi-index from the tuples as follows:

# In[5]:


index = pd.MultiIndex.from_tuples(index)


# The `MultiIndex` represents multiple *levels* of indexing—in this case, the state names and the years—as well as multiple *labels* for each data point which encode these levels.
# 
# If we reindex our series with this `MultiIndex`, we see the hierarchical representation of the data:

# In[6]:


pop = pop.reindex(index)
pop


# Here the first two columns of the Series representation show the multiple index values, while the third column shows the data.
# Notice that some entries are missing in the first column: in this multi-index representation, any blank entry indicates the same value as the line above it.

# Now to access all data for which the second index is 2020, we can use the Pandas slicing notation:

# In[7]:


pop[:, 2020]


# The result is a singly indexed Series with just the keys we're interested in.
# This syntax is much more convenient (and the operation is much more efficient!) than the home-spun tuple-based multi-indexing solution that we started with.
# We'll now further discuss this sort of indexing operation on hierarchically indexed data.

# ### MultiIndex as Extra Dimension
# 
# You might notice something else here: we could easily have stored the same data using a simple `DataFrame` with index and column labels.
# In fact, Pandas is built with this equivalence in mind. The `unstack` method will quickly convert a multiply indexed `Series` into a conventionally indexed `DataFrame`:

# In[8]:


pop_df = pop.unstack()
pop_df


# Naturally, the ``stack`` method provides the opposite operation:

# In[9]:


pop_df.stack()


# Seeing this, you might wonder why would we would bother with hierarchical indexing at all.
# The reason is simple: just as we were able to use multi-indexing to manipulate two-dimensional data within a one-dimensional `Series`, we can also use it to manipulate data of three or more dimensions in a `Series` or `DataFrame`.
# Each extra level in a multi-index represents an extra dimension of data; taking advantage of this property gives us much more flexibility in the types of data we can represent. Concretely, we might want to add another column of demographic data for each state at each year (say, population under 18); with a `MultiIndex` this is as easy as adding another column to the ``DataFrame``:

# In[10]:


pop_df = pd.DataFrame({'total': pop,
                       'under18': [9284094, 8898092,
                                   4318033, 4181528,
                                   6879014, 7432474]})
pop_df


# In addition, all the ufuncs and other functionality discussed in [Operating on Data in Pandas](03.03-Operations-in-Pandas.ipynb) work with hierarchical indices as well.
# Here we compute the fraction of people under 18 by year, given the above data:

# In[11]:


f_u18 = pop_df['under18'] / pop_df['total']
f_u18.unstack()


# This allows us to easily and quickly manipulate and explore even high-dimensional data.

# ## Methods of MultiIndex Creation
# 
# The most straightforward way to construct a multiply indexed `Series` or `DataFrame` is to simply pass a list of two or more index arrays to the constructor. For example:

# In[12]:


df = pd.DataFrame(np.random.rand(4, 2),
                  index=[['a', 'a', 'b', 'b'], [1, 2, 1, 2]],
                  columns=['data1', 'data2'])
df


# The work of creating the ``MultiIndex`` is done in the background.
# 
# Similarly, if you pass a dictionary with appropriate tuples as keys, Pandas will automatically recognize this and use a ``MultiIndex`` by default:

# In[13]:


data = {('California', 2010): 37253956,
        ('California', 2020): 39538223,
        ('New York', 2010): 19378102,
        ('New York', 2020): 20201249,
        ('Texas', 2010): 25145561,
        ('Texas', 2020): 29145505}
pd.Series(data)


# Nevertheless, it is sometimes useful to explicitly create a `MultiIndex`; we'll look at a couple of methods for doing this next.

# ### Explicit MultiIndex Constructors
# 
# For more flexibility in how the index is constructed, you can instead use the constructor methods available in the `pd.MultiIndex` class.
# For example, as we did before, you can construct a `MultiIndex` from a simple list of arrays giving the index values within each level:

# In[14]:


pd.MultiIndex.from_arrays([['a', 'a', 'b', 'b'], [1, 2, 1, 2]])


# Or you can construct it from a list of tuples giving the multiple index values of each point:

# In[15]:


pd.MultiIndex.from_tuples([('a', 1), ('a', 2), ('b', 1), ('b', 2)])


# You can even construct it from a Cartesian product of single indices:

# In[16]:


pd.MultiIndex.from_product([['a', 'b'], [1, 2]])


# Similarly, you can construct a `MultiIndex` directly using its internal encoding by passing `levels` (a list of lists containing available index values for each level) and `codes` (a list of lists that reference these labels):

# In[17]:


pd.MultiIndex(levels=[['a', 'b'], [1, 2]],
              codes=[[0, 0, 1, 1], [0, 1, 0, 1]])


# Any of these objects can be passed as the `index` argument when creating a `Series` or `DataFrame`, or be passed to the `reindex` method of an existing `Series` or `DataFrame`.

# ### MultiIndex Level Names
# 
# Sometimes it is convenient to name the levels of the `MultiIndex`.
# This can be accomplished by passing the `names` argument to any of the previously discussed `MultiIndex` constructors, or by setting the `names` attribute of the index after the fact:

# In[18]:


pop.index.names = ['state', 'year']
pop


# With more involved datasets, this can be a useful way to keep track of the meaning of various index values.

# ### MultiIndex for Columns
# 
# In a `DataFrame`, the rows and columns are completely symmetric, and just as the rows can have multiple levels of indices, the columns can have multiple levels as well.
# Consider the following, which is a mock-up of some (somewhat realistic) medical data:

# In[19]:


# hierarchical indices and columns
index = pd.MultiIndex.from_product([[2013, 2014], [1, 2]],
                                   names=['year', 'visit'])
columns = pd.MultiIndex.from_product([['Bob', 'Guido', 'Sue'], ['HR', 'Temp']],
                                     names=['subject', 'type'])

# mock some data
data = np.round(np.random.randn(4, 6), 1)
data[:, ::2] *= 10
data += 37

# create the DataFrame
health_data = pd.DataFrame(data, index=index, columns=columns)
health_data


# This is fundamentally four-dimensional data, where the dimensions are the subject, the measurement type, the year, and the visit number.
# With this in place we can, for example, index the top-level column by the person's name and get a full `DataFrame` containing just that person's information:

# In[20]:


health_data['Guido']


# ## Indexing and Slicing a MultiIndex
# 
# Indexing and slicing on a `MultiIndex` is designed to be intuitive, and it helps if you think about the indices as added dimensions.
# We'll first look at indexing multiply indexed `Series`, and then multiply indexed `DataFrame` objects.

# ### Multiply Indexed Series
# 
# Consider the multiply indexed `Series` of state populations we saw earlier:

# In[21]:


pop


# We can access single elements by indexing with multiple terms:

# In[22]:


pop['California', 2010]


# The `MultiIndex` also supports *partial indexing*, or indexing just one of the levels in the index.
# The result is another `Series`, with the lower-level indices maintained:

# In[23]:


pop['California']


# Partial slicing is available as well, as long as the `MultiIndex` is sorted (see the discussion in [Sorted and Unsorted Indices](#Sorted-and-unsorted-indices)):

# In[24]:


pop.loc['California':'New York']


# With sorted indices, partial indexing can be performed on lower levels by passing an empty slice in the first index:

# In[25]:


pop[:, 2010]


# Other types of indexing and selection (discussed in [Data Indexing and Selection](03.02-Data-Indexing-and-Selection.ipynb)) work as well; for example, selection based on Boolean masks:

# In[26]:


pop[pop > 22000000]


# Selection based on fancy indexing also works:

# In[27]:


pop[['California', 'Texas']]


# ### Multiply Indexed DataFrames
# 
# A multiply indexed `DataFrame` behaves in a similar manner.
# Consider our toy medical `DataFrame` from before:

# In[28]:


health_data


# Remember that columns are primary in a `DataFrame`, and the syntax used for multiply indexed `Series` applies to the columns.
# For example, we can recover Guido's heart rate data with a simple operation:

# In[29]:


health_data['Guido', 'HR']


# Also, as with the single-index case, we can use the `loc`, `iloc`, and `ix` indexers introduced in [Data Indexing and Selection](03.02-Data-Indexing-and-Selection.ipynb). For example:

# In[30]:


health_data.iloc[:2, :2]


# These indexers provide an array-like view of the underlying two-dimensional data, but each individual index in `loc` or `iloc` can be passed a tuple of multiple indices. For example:

# In[31]:


health_data.loc[:, ('Bob', 'HR')]


# Working with slices within these index tuples is not especially convenient; trying to create a slice within a tuple will lead to a syntax error:

# In[32]:


health_data.loc[(:, 1), (:, 'HR')]


# You could get around this by building the desired slice explicitly using Python's built-in `slice` function, but a better way in this context is to use an `IndexSlice` object, which Pandas provides for precisely this situation.
# For example:

# In[33]:


idx = pd.IndexSlice
health_data.loc[idx[:, 1], idx[:, 'HR']]


# As you can see, there are many ways to interact with data in multiply indexed `Series` and ``DataFrame``s, and as with many tools in this book the best way to become familiar with them is to try them out!

# ## Rearranging Multi-Indexes
# 
# One of the keys to working with multiply indexed data is knowing how to effectively transform the data.
# There are a number of operations that will preserve all the information in the dataset, but rearrange it for the purposes of various computations.
# We saw a brief example of this in the `stack` and `unstack` methods, but there are many more ways to finely control the rearrangement of data between hierarchical indices and columns, and we'll explore them here.

# ### Sorted and Unsorted Indices
# 
# Earlier I briefly mentioned a caveat, but I should emphasize it more here.
# *Many of the `MultiIndex` slicing operations will fail if the index is not sorted.*
# Let's take a closer look.
# 
# We'll start by creating some simple multiply indexed data where the indices are *not lexographically sorted*:

# In[34]:


index = pd.MultiIndex.from_product([['a', 'c', 'b'], [1, 2]])
data = pd.Series(np.random.rand(6), index=index)
data.index.names = ['char', 'int']
data


# If we try to take a partial slice of this index, it will result in an error:

# In[35]:


try:
    data['a':'b']
except KeyError as e:
    print("KeyError", e)


# Although it is not entirely clear from the error message, this is the result of the `MultiIndex` not being sorted.
# For various reasons, partial slices and other similar operations require the levels in the `MultiIndex` to be in sorted (i.e., lexographical) order.
# Pandas provides a number of convenience routines to perform this type of sorting, such as the `sort_index` and `sortlevel` methods of the `DataFrame`.
# We'll use the simplest, `sort_index`, here:

# In[36]:


data = data.sort_index()
data


# With the index sorted in this way, partial slicing will work as expected:

# In[37]:


data['a':'b']


# ### Stacking and Unstacking Indices
# 
# As we saw briefly before, it is possible to convert a dataset from a stacked multi-index to a simple two-dimensional representation, optionally specifying the level to use:

# In[38]:


pop.unstack(level=0)


# In[39]:


pop.unstack(level=1)


# The opposite of `unstack` is `stack`, which here can be used to recover the original series:

# In[40]:


pop.unstack().stack()


# ### Index Setting and Resetting
# 
# Another way to rearrange hierarchical data is to turn the index labels into columns; this can be accomplished with the `reset_index` method.
# Calling this on the population dictionary will result in a `DataFrame` with `state` and `year` columns holding the information that was formerly in the index.
# For clarity, we can optionally specify the name of the data for the column representation:

# In[41]:


pop_flat = pop.reset_index(name='population')
pop_flat


# A common pattern is to build a `MultiIndex` from the column values.
# This can be done with the `set_index` method of the `DataFrame`, which returns a multiply indexed `DataFrame`:

# In[42]:


pop_flat.set_index(['state', 'year'])


# In practice, this type of reindexing is one of the more useful patterns when exploring real-world datasets.