update cp1
This commit is contained in:
skywateryang
parent
f6415c32be
commit
44319ae498
10
README.md
10
README.md
|
|
@ -38,31 +38,31 @@ Matplotlib可以说是python数据可视化最重要且常见的工具之一，
|
|||
|
||||
## 目录
|
||||
|
||||
* [第一回：Matplotlib初相识](https://nbviewer.jupyter.org/github/datawhalechina/fantastic-matplotlib/blob/main/%E7%AC%AC%E4%B8%80%E5%9B%9E%EF%BC%9AMatplotlib%E5%88%9D%E7%9B%B8%E8%AF%86.ipynb)
|
||||
* 第一回：Matplotlib初相识
|
||||
|
||||
> 和matplotlib的初次邂逅，赶紧拿出画布，画笔，一段奇幻的旅途即将开启
|
||||
|
||||
本回作为引入，介绍了matplotlib可视化绘图包的特点，以及如何用最简单的几行代码画出一幅可视化图表。
|
||||
|
||||
* [第二回：艺术画笔见乾坤](https://nbviewer.jupyter.org/github/datawhalechina/fantastic-matplotlib/blob/main/%E7%AC%AC%E4%BA%8C%E5%9B%9E%EF%BC%9A%E8%89%BA%E6%9C%AF%E7%94%BB%E7%AC%94%E8%A7%81%E4%B9%BE%E5%9D%A4.ipynb)
|
||||
* 第二回：艺术画笔见乾坤
|
||||
|
||||
> 挥舞起手中的艺术画笔，发挥想象力，在画布上自由地绘制图形
|
||||
|
||||
本回作为整个matplotlib宇宙中最重要的一个环节，重点介绍了matplotlib绘图的核心API，以及使用matplotlib绘制基本元素的方法
|
||||
|
||||
* [第三回：布局格式定方圆](https://nbviewer.jupyter.org/github/datawhalechina/fantastic-matplotlib/blob/main/%E7%AC%AC%E4%B8%89%E5%9B%9E%EF%BC%9A%E5%B8%83%E5%B1%80%E6%A0%BC%E5%BC%8F%E5%AE%9A%E6%96%B9%E5%9C%86.ipynb)
|
||||
* 第三回：布局格式定方圆
|
||||
|
||||
> 没有规矩不成方圆，你应当开始学会如何合理地在画布上布局了
|
||||
|
||||
本回介绍了常用的两种绘图布局方法，让使用者可以自由地在画布中进行布局
|
||||
|
||||
* [第四回：文字图例尽眉目](https://nbviewer.jupyter.org/github/datawhalechina/fantastic-matplotlib/blob/main/%E7%AC%AC%E5%9B%9B%E5%9B%9E%EF%BC%9A%E6%96%87%E5%AD%97%E5%9B%BE%E4%BE%8B%E5%B0%BD%E7%9C%89%E7%9B%AE.ipynb)
|
||||
* 第四回：文字图例尽眉目
|
||||
|
||||
> 为了让你的画流传更久远，快来学习下如何在画布上题字吧
|
||||
|
||||
本回介绍了如何在图像上，坐标轴上绘制文本，以及如何在图像上绘制图例。
|
||||
|
||||
* [第五回：样式色彩秀芳华](https://nbviewer.jupyter.org/github/datawhalechina/fantastic-matplotlib/blob/main/%E7%AC%AC%E4%BA%94%E5%9B%9E%EF%BC%9A%E6%A0%B7%E5%BC%8F%E8%89%B2%E5%BD%A9%E7%A7%80%E8%8A%B3%E5%8D%8E.ipynb)
|
||||
* 第五回：样式色彩秀芳华
|
||||
|
||||
> 下一步你需要学习下怎么样绘制出更加花样繁复，色彩绚丽的画了
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -1 +0,0 @@
|
|||
{}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -1,4 +0,0 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 8c8106cd161cd2ce86ae48c61840ee9f
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 8.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.9 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 6.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 116 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 10 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 64 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 8.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 9.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
|
|
@ -1,15 +0,0 @@
|
|||
# Content
|
||||
|
||||
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
|
||||
|
||||
第一回：Matplotlib初相识/index
|
||||
第二回：艺术画笔见乾坤/index
|
||||
第三回：布局格式定方圆/index
|
||||
第四回：文字图例尽眉目/index
|
||||
第五回：样式色彩秀芳华/index
|
||||
```
|
||||
|
||||
|
|
@ -1,141 +0,0 @@
|
|||
---
|
||||
jupytext:
|
||||
text_representation:
|
||||
format_name: myst
|
||||
kernelspec:
|
||||
display_name: Python 3
|
||||
name: python3
|
||||
---
|
||||
# 第一回：Matplotlib初相识
|
||||
|
||||
|
||||
|
||||
## 一、认识matplotlib
|
||||
|
||||
Matplotlib是一个Python 2D绘图库，能够以多种硬拷贝格式和跨平台的交互式环境生成出版物质量的图形，用来绘制各种静态，动态，交互式的图表。
|
||||
|
||||
Matplotlib可用于Python脚本，Python和IPython Shell、Jupyter notebook，Web应用程序服务器和各种图形用户界面工具包等。
|
||||
|
||||
Matplotlib是Python数据可视化库中的泰斗，它已经成为python中公认的数据可视化工具，我们所熟知的pandas和seaborn的绘图接口其实也是基于matplotlib所作的高级封装。
|
||||
|
||||
为了对matplotlib有更好的理解，让我们从一些最基本的概念开始认识它，再逐渐过渡到一些高级技巧中。
|
||||
|
||||
## 二、一个最简单的绘图例子
|
||||
|
||||
Matplotlib的图像是画在figure（如windows，jupyter窗体）上的，每一个figure又包含了一个或多个axes（一个可以指定坐标系的子区域）。最简单的创建figure以及axes的方式是通过`pyplot.subplots`命令，创建axes以后，可以使用`Axes.plot`绘制最简易的折线图。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots() # 创建一个包含一个axes的figure
|
||||
ax.plot([1, 2, 3, 4], [1, 4, 2, 3]); # 绘制图像
|
||||
```
|
||||
|
||||
**Trick**：
|
||||
在jupyter notebook中使用matplotlib时会发现，代码运行后自动打印出类似`<matplotlib.lines.Line2D at 0x23155916dc0>`这样一段话，这是因为matplotlib的绘图代码默认打印出最后一个对象。如果不想显示这句话，有以下三种方法，在本章节的代码示例中你能找到这三种方法的使用。
|
||||
|
||||
1. 在代码块最后加一个分号`;`
|
||||
2. 在代码块最后加一句plt.show()
|
||||
3. 在绘图时将绘图对象显式赋值给一个变量，如将plt.plot([1, 2, 3, 4]) 改成line =plt.plot([1, 2, 3, 4])
|
||||
|
||||
|
||||
|
||||
和MATLAB命令类似，你还可以通过一种更简单的方式绘制图像，`matplotlib.pyplot`方法能够直接在当前axes上绘制图像，如果用户未指定axes，matplotlib会帮你自动创建一个。所以上面的例子也可以简化为以下这一行代码。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
line =plt.plot([1, 2, 3, 4], [1, 4, 2, 3])
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 三、Figure的组成
|
||||
|
||||
现在我们来深入看一下figure的组成。通过一张figure解剖图，我们可以看到一个完整的matplotlib图像通常会包括以下四个层级，这些层级也被称为容器（container），下一节会详细介绍。在matplotlib的世界中，我们将通过各种命令方法来操纵图像中的每一个部分，从而达到数据可视化的最终效果，一副完整的图像实际上是各类子元素的集合。
|
||||
|
||||
- `Figure`：顶层级，用来容纳所有绘图元素
|
||||
|
||||
- `Axes`：matplotlib宇宙的核心，容纳了大量元素用来构造一幅幅子图，一个figure可以由一个或多个子图组成
|
||||
|
||||
- `Axis`：axes的下属层级，用于处理所有和坐标轴，网格有关的元素
|
||||
|
||||
- `Tick`：axis的下属层级，用来处理所有和刻度有关的元素
|
||||
|
||||
|
||||
|
||||
## 四、两种绘图接口
|
||||
|
||||
matplotlib提供了两种最常用的绘图接口
|
||||
|
||||
1. 显式创建figure和axes，在上面调用绘图方法，也被称为OO模式（object-oriented style)
|
||||
|
||||
2. 依赖pyplot自动创建figure和axes，并绘图
|
||||
|
||||
使用第一种绘图接口，是这样的：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
x = np.linspace(0, 2, 100)
|
||||
|
||||
fig, ax = plt.subplots()
|
||||
ax.plot(x, x, label='linear')
|
||||
ax.plot(x, x**2, label='quadratic')
|
||||
ax.plot(x, x**3, label='cubic')
|
||||
ax.set_xlabel('x label')
|
||||
ax.set_ylabel('y label')
|
||||
ax.set_title("Simple Plot")
|
||||
ax.legend()
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
而如果采用第二种绘图接口，绘制同样的图，代码是这样的：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
x = np.linspace(0, 2, 100)
|
||||
|
||||
plt.plot(x, x, label='linear')
|
||||
plt.plot(x, x**2, label='quadratic')
|
||||
plt.plot(x, x**3, label='cubic')
|
||||
plt.xlabel('x label')
|
||||
plt.ylabel('y label')
|
||||
plt.title("Simple Plot")
|
||||
plt.legend()
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 参考资料
|
||||
|
||||
[1.matplotlib官网用户指南](https://matplotlib.org/stable/tutorials/introductory/usage.html)
|
||||
|
||||
|
|
@ -1,256 +0,0 @@
|
|||
---
|
||||
jupytext:
|
||||
text_representation:
|
||||
format_name: myst
|
||||
kernelspec:
|
||||
display_name: Python 3
|
||||
name: python3
|
||||
---
|
||||
|
||||
# 第三回：布局格式定方圆
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import pandas as pd
|
||||
import matplotlib.pyplot as plt
|
||||
plt.rcParams['font.sans-serif'] = ['SimHei'] #用来正常显示中文标签
|
||||
plt.rcParams['axes.unicode_minus'] = False #用来正常显示负号
|
||||
```
|
||||
|
||||
## 一、子图
|
||||
|
||||
### 1. 使用 `plt.subplots` 绘制均匀状态下的子图
|
||||
|
||||
返回元素分别是画布和子图构成的列表，第一个数字为行，第二个为列
|
||||
|
||||
`figsize` 参数可以指定整个画布的大小
|
||||
|
||||
`sharex` 和 `sharey` 分别表示是否共享横轴和纵轴刻度
|
||||
|
||||
`tight_layout` 函数可以调整子图的相对大小使字符不会重叠
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, axs = plt.subplots(2, 5, figsize=(10, 4), sharex=True, sharey=True)
|
||||
fig.suptitle('样例1', size=20)
|
||||
for i in range(2):
|
||||
for j in range(5):
|
||||
axs[i][j].scatter(np.random.randn(10), np.random.randn(10))
|
||||
axs[i][j].set_title('第%d行，第%d列'%(i+1,j+1))
|
||||
axs[i][j].set_xlim(-5,5)
|
||||
axs[i][j].set_ylim(-5,5)
|
||||
if i==1: axs[i][j].set_xlabel('横坐标')
|
||||
if j==0: axs[i][j].set_ylabel('纵坐标')
|
||||
fig.tight_layout()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
除了常规的直角坐标系，也可以通过`projection`方法创建极坐标系下的图表
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
N = 150
|
||||
r = 2 * np.random.rand(N)
|
||||
theta = 2 * np.pi * np.random.rand(N)
|
||||
area = 200 * r**2
|
||||
colors = theta
|
||||
|
||||
|
||||
plt.subplot(projection='polar')
|
||||
plt.scatter(theta, r, c=colors, s=area, cmap='hsv', alpha=0.75);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 2. 使用 `GridSpec` 绘制非均匀子图
|
||||
|
||||
所谓非均匀包含两层含义，第一是指图的比例大小不同但没有跨行或跨列，第二是指图为跨列或跨行状态
|
||||
|
||||
利用 `add_gridspec` 可以指定相对宽度比例 `width_ratios` 和相对高度比例参数 `height_ratios`
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig = plt.figure(figsize=(10, 4))
|
||||
spec = fig.add_gridspec(nrows=2, ncols=5, width_ratios=[1,2,3,4,5], height_ratios=[1,3])
|
||||
fig.suptitle('样例2', size=20)
|
||||
for i in range(2):
|
||||
for j in range(5):
|
||||
ax = fig.add_subplot(spec[i, j])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
ax.set_title('第%d行，第%d列'%(i+1,j+1))
|
||||
if i==1: ax.set_xlabel('横坐标')
|
||||
if j==0: ax.set_ylabel('纵坐标')
|
||||
fig.tight_layout()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
在上面的例子中出现了 `spec[i, j]` 的用法，事实上通过切片就可以实现子图的合并而达到跨图的共能
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig = plt.figure(figsize=(10, 4))
|
||||
spec = fig.add_gridspec(nrows=2, ncols=6, width_ratios=[2,2.5,3,1,1.5,2], height_ratios=[1,2])
|
||||
fig.suptitle('样例3', size=20)
|
||||
# sub1
|
||||
ax = fig.add_subplot(spec[0, :3])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
# sub2
|
||||
ax = fig.add_subplot(spec[0, 3:5])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
# sub3
|
||||
ax = fig.add_subplot(spec[:, 5])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
# sub4
|
||||
ax = fig.add_subplot(spec[1, 0])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
# sub5
|
||||
ax = fig.add_subplot(spec[1, 1:5])
|
||||
ax.scatter(np.random.randn(10), np.random.randn(10))
|
||||
fig.tight_layout()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 二、子图上的方法
|
||||
|
||||
在 `ax` 对象上定义了和 `plt` 类似的图形绘制函数，常用的有： `plot, hist, scatter, bar, barh, pie`
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots(figsize=(4,3))
|
||||
ax.plot([1,2],[2,1]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots(figsize=(4,3))
|
||||
ax.hist(np.random.randn(1000));
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
常用直线的画法为： `axhline, axvline, axline` （水平、垂直、任意方向）
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots(figsize=(4,3))
|
||||
ax.axhline(0.5,0.2,0.8)
|
||||
ax.axvline(0.5,0.2,0.8)
|
||||
ax.axline([0.3,0.3],[0.7,0.7]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
使用 `grid` 可以加灰色网格
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots(figsize=(4,3))
|
||||
ax.grid(True)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
使用 `set_xscale, set_title, set_xlabel` 分别可以设置坐标轴的规度（指对数坐标等）、标题、轴名
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, axs = plt.subplots(1, 2, figsize=(10, 4))
|
||||
fig.suptitle('大标题', size=20)
|
||||
for j in range(2):
|
||||
axs[j].plot(list('abcd'), [10**i for i in range(4)])
|
||||
if j==0:
|
||||
axs[j].set_yscale('log')
|
||||
axs[j].set_title('子标题1')
|
||||
axs[j].set_ylabel('对数坐标')
|
||||
else:
|
||||
axs[j].set_title('子标题1')
|
||||
axs[j].set_ylabel('普通坐标')
|
||||
fig.tight_layout()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
与一般的 `plt` 方法类似， `legend, annotate, arrow, text` 对象也可以进行相应的绘制
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots()
|
||||
ax.arrow(0, 0, 1, 1, head_width=0.03, head_length=0.05, facecolor='red', edgecolor='blue')
|
||||
ax.text(x=0, y=0,s='这是一段文字', fontsize=16, rotation=70, rotation_mode='anchor', color='green')
|
||||
ax.annotate('这是中点', xy=(0.5, 0.5), xytext=(0.8, 0.2), arrowprops=dict(facecolor='yellow', edgecolor='black'), fontsize=16);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig, ax = plt.subplots()
|
||||
ax.plot([1,2],[2,1],label="line1")
|
||||
ax.plot([1,1],[1,2],label="line1")
|
||||
ax.legend(loc=1);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
其中，图例的 `loc` 参数如下：
|
||||
|
||||
| string | code |
|
||||
| ---- | ---- |
|
||||
| best | 0 |
|
||||
| upper right | 1 |
|
||||
| upper left | 2 |
|
||||
| lower left | 3 |
|
||||
| lower right | 4 |
|
||||
| right | 5 |
|
||||
| center left | 6 |
|
||||
| center right | 7 |
|
||||
| lower center | 8 |
|
||||
| upper center | 9 |
|
||||
| center | 10 |
|
||||
|
||||
|
||||
## 参考资料
|
||||
|
||||
[1.matplotlib官网布局使用指南](https://matplotlib.org/stable/tutorials/intermediate/gridspec.html#sphx-glr-tutorials-intermediate-gridspec-py)
|
||||
|
|
@ -1,760 +0,0 @@
|
|||
---
|
||||
jupytext:
|
||||
text_representation:
|
||||
format_name: myst
|
||||
kernelspec:
|
||||
display_name: Python 3
|
||||
name: python3
|
||||
---
|
||||
# 第二回：艺术画笔见乾坤
|
||||
|
||||
|
||||
## 一、概述
|
||||
|
||||
### 1. matplotlib的三层api
|
||||
matplotlib的原理或者说基础逻辑是，用Artist对象在画布(canvas)上绘制(Render)图形。
|
||||
就和人作画的步骤类似：
|
||||
1. 准备一块画布或画纸
|
||||
2. 准备好颜料、画笔等制图工具
|
||||
3. 作画
|
||||
|
||||
|
||||
所以matplotlib有三个层次的API：
|
||||
|
||||
`matplotlib.backend_bases.FigureCanvas` 代表了绘图区，所有的图像都是在绘图区完成的
|
||||
`matplotlib.backend_bases.Renderer` 代表了渲染器，可以近似理解为画笔，控制如何在 FigureCanvas 上画图。
|
||||
`matplotlib.artist.Artist` 代表了具体的图表组件，即调用了Renderer的接口在Canvas上作图。
|
||||
前两者处理程序和计算机的底层交互的事项，第三项Artist就是具体的调用接口来做出我们想要的图，比如图形、文本、线条的设定。所以通常来说，我们95%的时间，都是用来和matplotlib.artist.Artist类打交道的。
|
||||
|
||||
|
||||
|
||||
### 2. Artist的分类
|
||||
Artist有两种类型：`primitives` 和`containers`。
|
||||
|
||||
`primitive`是基本要素，它包含一些我们要在绘图区作图用到的标准图形对象，如**曲线Line2D，文字text，矩形Rectangle，图像image**等。
|
||||
|
||||
`container`是容器，即用来装基本要素的地方，包括**图形figure、坐标系Axes和坐标轴Axis**。他们之间的关系如下图所示：
|
||||
|
||||
|
||||
### 3. matplotlib标准用法
|
||||
matplotlib的标准使用流程为：
|
||||
1. 创建一个`Figure`实例
|
||||
2. 使用`Figure`实例创建一个或者多个`Axes`或`Subplot`实例
|
||||
3. 使用`Axes`实例的辅助方法来创建`primitive`
|
||||
|
||||
值得一提的是，Axes是一种容器，它可能是matplotlib API中最重要的类，并且我们大多数时间都花在和它打交道上。更具体的信息会在第三节容器小节说明。
|
||||
|
||||
一个流程示例及说明如下：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
|
||||
# step 1
|
||||
# 我们用 matplotlib.pyplot.figure() 创建了一个Figure实例
|
||||
fig = plt.figure()
|
||||
|
||||
# step 2
|
||||
# 然后用Figure实例创建了一个两行一列(即可以有两个subplot)的绘图区，并同时在第一个位置创建了一个subplot
|
||||
ax = fig.add_subplot(2, 1, 1) # two rows, one column, first plot
|
||||
|
||||
# step 3
|
||||
# 然后用Axes实例的方法画了一条曲线
|
||||
t = np.arange(0.0, 1.0, 0.01)
|
||||
s = np.sin(2*np.pi*t)
|
||||
line, = ax.plot(t, s, color='blue', lw=2)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 二、基本元素 - primitives
|
||||
各容器中可能会包含多种`基本要素-primitives`, 所以先介绍下primitives，再介绍容器。
|
||||
|
||||
本章重点介绍下 `primitives` 的几种类型：**曲线-Line2D，矩形-Rectangle，图像-image** （其中文本-Text较为复杂，会在之后单独详细说明。）
|
||||
|
||||
|
||||
### 1. 2DLines
|
||||
在matplotlib中曲线的绘制，主要是通过类 `matplotlib.lines.Line2D` 来完成的。
|
||||
它的基类: `matplotlib.artist.Artist`
|
||||
|
||||
matplotlib中`线-line`的含义：它表示的可以是连接所有顶点的实线样式，也可以是每个顶点的标记。此外，这条线也会受到绘画风格的影响，比如，我们可以创建虚线种类的线。
|
||||
|
||||
它的构造函数：
|
||||
|
||||
> class matplotlib.lines.Line2D(xdata, ydata, linewidth=None, linestyle=None, color=None, marker=None, markersize=None, markeredgewidth=None, markeredgecolor=None, markerfacecolor=None, markerfacecoloralt='none', fillstyle=None, antialiased=None, dash_capstyle=None, solid_capstyle=None, dash_joinstyle=None, solid_joinstyle=None, pickradius=5, drawstyle=None, markevery=None, **kwargs)
|
||||
|
||||
|
||||
|
||||
其中常用的的参数有：
|
||||
+ **xdata**:需要绘制的line中点的在x轴上的取值，若忽略，则默认为range(1,len(ydata)+1)
|
||||
+ **ydata**:需要绘制的line中点的在y轴上的取值
|
||||
+ **linewidth**:线条的宽度
|
||||
+ **linestyle**:线型
|
||||
+ **color**:线条的颜色
|
||||
+ **marker**:点的标记，详细可参考[markers API](https://matplotlib.org/api/markers_api.html#module-matplotlib.markers)
|
||||
+ **markersize**:标记的size
|
||||
|
||||
|
||||
其他详细参数可参考[Line2D官方文档](https://matplotlib.org/api/_as_gen/matplotlib.lines.Line2D.html#examples-using-matplotlib-lines-line2d)
|
||||
|
||||
#### a. 如何设置Line2D的属性
|
||||
有三种方法可以用设置线的属性。
|
||||
1) 直接在plot()函数中设置
|
||||
2) 通过获得线对象，对线对象进行设置
|
||||
3) 获得线属性，使用setp()函数设置
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 1) 直接在plot()函数中设置
|
||||
import matplotlib.pyplot as plt
|
||||
x = range(0,5)
|
||||
y = [2,5,7,8,10]
|
||||
plt.plot(x,y, linewidth=10); # 设置线的粗细参数为10
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 2) 通过获得线对象，对线对象进行设置
|
||||
x = range(0,5)
|
||||
y = [2,5,7,8,10]
|
||||
line, = plt.plot(x, y, '-')
|
||||
line.set_antialiased(False) # 关闭抗锯齿功能
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 3) 获得线属性，使用setp()函数设置
|
||||
x = range(0,5)
|
||||
y = [2,5,7,8,10]
|
||||
lines = plt.plot(x, y)
|
||||
plt.setp(lines, color='r', linewidth=10);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### b. 如何绘制lines
|
||||
1) 绘制直线line
|
||||
2) errorbar绘制误差折线图
|
||||
|
||||
|
||||
|
||||
绘制直线line常用的方法有两种:
|
||||
+ **pyplot方法绘制**
|
||||
+ **Line2D对象绘制**
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 1. pyplot方法绘制
|
||||
import matplotlib.pyplot as plt
|
||||
x = range(0,5)
|
||||
y = [2,5,7,8,10]
|
||||
plt.plot(x,y);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 2. Line2D对象绘制
|
||||
import matplotlib.pyplot as plt
|
||||
from matplotlib.lines import Line2D
|
||||
|
||||
fig = plt.figure()
|
||||
ax = fig.add_subplot(111)
|
||||
line = Line2D(x, y)
|
||||
ax.add_line(line)
|
||||
ax.set_xlim(min(x), max(x))
|
||||
ax.set_ylim(min(y), max(y))
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**2) errorbar绘制误差折线图**
|
||||
pyplot里有个专门绘制误差线的功能，通过`errorbar`类实现，它的构造函数：
|
||||
|
||||
>matplotlib.pyplot.errorbar(x, y, yerr=None, xerr=None, fmt='', ecolor=None, elinewidth=None, capsize=None, barsabove=False, lolims=False, uplims=False, xlolims=False, xuplims=False, errorevery=1, capthick=None, \*, data=None, \**kwargs)
|
||||
|
||||
其中最主要的参数是前几个:
|
||||
+ **x**：需要绘制的line中点的在x轴上的取值
|
||||
+ **y**：需要绘制的line中点的在y轴上的取值
|
||||
+ **yerr**：指定y轴水平的误差
|
||||
+ **xerr**：指定x轴水平的误差
|
||||
+ **fmt**：指定折线图中某个点的颜色，形状，线条风格，例如‘co--’
|
||||
+ **ecolor**：指定error bar的颜色
|
||||
+ **elinewidth**：指定error bar的线条宽度
|
||||
|
||||
|
||||
绘制errorbar
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
fig = plt.figure()
|
||||
x = np.arange(10)
|
||||
y = 2.5 * np.sin(x / 20 * np.pi)
|
||||
yerr = np.linspace(0.05, 0.2, 10)
|
||||
plt.errorbar(x, y + 3, yerr=yerr, label='both limits (default)');
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 2. patches
|
||||
matplotlib.patches.Patch类是二维图形类。它的基类是matplotlib.artist.Artist，它的构造函数：
|
||||
详细清单见 [matplotlib.patches API](https://matplotlib.org/api/patches_api.html)
|
||||
|
||||
|
||||
|
||||
> Patch(edgecolor=None, facecolor=None, color=None,
|
||||
linewidth=None, linestyle=None, antialiased=None,
|
||||
hatch=None, fill=True, capstyle=None, joinstyle=None,
|
||||
**kwargs)
|
||||
|
||||
|
||||
#### a. Rectangle-矩形
|
||||
`Rectangle`矩形类在官网中的定义是： 通过锚点xy及其宽度和高度生成。
|
||||
Rectangle本身的主要比较简单，即xy控制锚点，width和height分别控制宽和高。它的构造函数：
|
||||
|
||||
> class matplotlib.patches.Rectangle(xy, width, height, angle=0.0, **kwargs)
|
||||
|
||||
在实际中最常见的矩形图是**`hist直方图`和`bar条形图`**。
|
||||
|
||||
|
||||
|
||||
**1) hist-直方图**
|
||||
|
||||
>matplotlib.pyplot.hist(x,bins=None,range=None, density=None, bottom=None, histtype='bar', align='mid', log=False, color=None, label=None, stacked=False, normed=None)
|
||||
|
||||
下面是一些常用的参数：
|
||||
+ **x**: 数据集，最终的直方图将对数据集进行统计
|
||||
+ **bins**: 统计的区间分布
|
||||
+ **range**: tuple, 显示的区间，range在没有给出bins时生效
|
||||
+ **density**: bool，默认为false，显示的是频数统计结果，为True则显示频率统计结果，这里需要注意，频率统计结果=区间数目/(总数*区间宽度)，和normed效果一致，官方推荐使用density
|
||||
+ **histtype**: 可选{'bar', 'barstacked', 'step', 'stepfilled'}之一，默认为bar，推荐使用默认配置，step使用的是梯状，stepfilled则会对梯状内部进行填充，效果与bar类似
|
||||
+ **align**: 可选{'left', 'mid', 'right'}之一，默认为'mid'，控制柱状图的水平分布，left或者right，会有部分空白区域，推荐使用默认
|
||||
+ **log**: bool，默认False,即y坐标轴是否选择指数刻度
|
||||
+ **stacked**: bool，默认为False，是否为堆积状图
|
||||
|
||||
hist绘制直方图
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
x=np.random.randint(0,100,100) #生成[0-100)之间的100个数据,即 数据集
|
||||
bins=np.arange(0,101,10) #设置连续的边界值，即直方图的分布区间[0,10),[10,20)...
|
||||
plt.hist(x,bins,color='fuchsia',alpha=0.5)#alpha设置透明度，0为完全透明
|
||||
plt.xlabel('scores')
|
||||
plt.ylabel('count')
|
||||
plt.xlim(0,100)#设置x轴分布范围
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
`Rectangle`矩形类绘制直方图
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import pandas as pd
|
||||
import re
|
||||
df = pd.DataFrame(columns = ['data'])
|
||||
df.loc[:,'data'] = x
|
||||
df['fenzu'] = pd.cut(df['data'], bins=bins, right = False,include_lowest=True)
|
||||
|
||||
df_cnt = df['fenzu'].value_counts().reset_index()
|
||||
df_cnt.loc[:,'mini'] = df_cnt['index'].astype(str).map(lambda x:re.findall('\[(.*)\,',x)[0]).astype(int)
|
||||
df_cnt.loc[:,'maxi'] = df_cnt['index'].astype(str).map(lambda x:re.findall('\,(.*)\)',x)[0]).astype(int)
|
||||
df_cnt.loc[:,'width'] = df_cnt['maxi']- df_cnt['mini']
|
||||
df_cnt.sort_values('mini',ascending = True,inplace = True)
|
||||
df_cnt.reset_index(inplace = True,drop = True)
|
||||
|
||||
#用Rectangle把hist绘制出来
|
||||
import matplotlib.pyplot as plt
|
||||
|
||||
fig = plt.figure()
|
||||
ax1 = fig.add_subplot(111)
|
||||
|
||||
for i in df_cnt.index:
|
||||
rect = plt.Rectangle((df_cnt.loc[i,'mini'],0),df_cnt.loc[i,'width'],df_cnt.loc[i,'fenzu'])
|
||||
ax1.add_patch(rect)
|
||||
|
||||
ax1.set_xlim(0, 100)
|
||||
ax1.set_ylim(0, 16)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**2) bar-柱状图**
|
||||
|
||||
> matplotlib.pyplot.bar(left, height, alpha=1, width=0.8, color=, edgecolor=, label=, lw=3)
|
||||
|
||||
下面是一些常用的参数：
|
||||
+ **left**：x轴的位置序列，一般采用range函数产生一个序列，但是有时候可以是字符串
|
||||
+ **height**：y轴的数值序列，也就是柱形图的高度，一般就是我们需要展示的数据；
|
||||
+ **alpha**：透明度，值越小越透明
|
||||
+ **width**：为柱形图的宽度，一般这是为0.8即可；
|
||||
+ **color或facecolor**：柱形图填充的颜色；
|
||||
+ **edgecolor**：图形边缘颜色
|
||||
+ **label**：解释每个图像代表的含义，这个参数是为legend()函数做铺垫的，表示该次bar的标签
|
||||
|
||||
|
||||
|
||||
有两种方式绘制柱状图
|
||||
+ bar绘制柱状图
|
||||
+ `Rectangle`矩形类绘制柱状图
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# bar绘制柱状图
|
||||
import matplotlib.pyplot as plt
|
||||
y = range(1,17)
|
||||
plt.bar(np.arange(16), y, alpha=0.5, width=0.5, color='yellow', edgecolor='red', label='The First Bar', lw=3);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# Rectangle矩形类绘制柱状图
|
||||
#import matplotlib.pyplot as plt
|
||||
fig = plt.figure()
|
||||
ax1 = fig.add_subplot(111)
|
||||
|
||||
for i in range(1,17):
|
||||
rect = plt.Rectangle((i+0.25,0),0.5,i)
|
||||
ax1.add_patch(rect)
|
||||
ax1.set_xlim(0, 16)
|
||||
ax1.set_ylim(0, 16)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
#### b. Polygon-多边形
|
||||
matplotlib.patches.Polygon类是多边形类。其基类是matplotlib.patches.Patch，它的构造函数：
|
||||
|
||||
> class matplotlib.patches.Polygon(xy, closed=True, **kwargs)
|
||||
|
||||
xy是一个N×2的numpy array，为多边形的顶点。
|
||||
closed为True则指定多边形将起点和终点重合从而显式关闭多边形。
|
||||
|
||||
|
||||
matplotlib.patches.Polygon类中常用的是fill类，它是基于xy绘制一个填充的多边形，它的定义：
|
||||
|
||||
> matplotlib.pyplot.fill(*args, data=None, **kwargs)
|
||||
|
||||
参数说明 : 关于x、y和color的序列，其中color是可选的参数，每个多边形都是由其节点的x和y位置列表定义的，后面可以选择一个颜色说明符。您可以通过提供多个x、y、[颜色]组来绘制多个多边形。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 用fill来绘制图形
|
||||
import matplotlib.pyplot as plt
|
||||
x = np.linspace(0, 5 * np.pi, 1000)
|
||||
y1 = np.sin(x)
|
||||
y2 = np.sin(2 * x)
|
||||
plt.fill(x, y1, color = "g", alpha = 0.3);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### c. Wedge-契形
|
||||
matplotlib.patches.Polygon类是多边形类。其基类是matplotlib.patches.Patch，它的构造函数：
|
||||
|
||||
> class matplotlib.patches.Wedge(center, r, theta1, theta2, width=None, **kwargs)
|
||||
|
||||
一个Wedge-契形 是以坐标x,y为中心，半径为r，从θ1扫到θ2(单位是度)。
|
||||
如果宽度给定，则从内半径r -宽度到外半径r画出部分楔形。wedge中比较常见的是绘制饼状图。
|
||||
|
||||
|
||||
matplotlib.pyplot.pie语法：
|
||||
> matplotlib.pyplot.pie(x, explode=None, labels=None, colors=None, autopct=None, pctdistance=0.6, shadow=False, labeldistance=1.1, startangle=0, radius=1, counterclock=True, wedgeprops=None, textprops=None, center=0, 0, frame=False, rotatelabels=False, *, normalize=None, data=None)
|
||||
|
||||
制作数据x的饼图，每个楔子的面积用x/sum(x)表示。
|
||||
其中最主要的参数是前4个：
|
||||
+ **x**：契型的形状，一维数组。
|
||||
+ **explode**：如果不是等于None，则是一个len(x)数组，它指定用于偏移每个楔形块的半径的分数。
|
||||
+ **labels**：用于指定每个契型块的标记，取值是列表或为None。
|
||||
+ **colors**：饼图循环使用的颜色序列。如果取值为None，将使用当前活动循环中的颜色。
|
||||
+ **startangle**：饼状图开始的绘制的角度。
|
||||
|
||||
pie绘制饼状图
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
labels = 'Frogs', 'Hogs', 'Dogs', 'Logs'
|
||||
sizes = [15, 30, 45, 10]
|
||||
explode = (0, 0.1, 0, 0)
|
||||
fig1, ax1 = plt.subplots()
|
||||
ax1.pie(sizes, explode=explode, labels=labels, autopct='%1.1f%%', shadow=True, startangle=90)
|
||||
ax1.axis('equal') # Equal aspect ratio ensures that pie is drawn as a circle.
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
wedge绘制饼图
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
from matplotlib.patches import Circle, Wedge
|
||||
from matplotlib.collections import PatchCollection
|
||||
|
||||
fig = plt.figure()
|
||||
ax1 = fig.add_subplot(111)
|
||||
theta1 = 0
|
||||
sizes = [15, 30, 45, 10]
|
||||
patches = []
|
||||
patches += [
|
||||
Wedge((0.3, 0.3), .2, 0, 54), # Full circle
|
||||
Wedge((0.3, 0.3), .2, 54, 162), # Full ring
|
||||
Wedge((0.3, 0.3), .2, 162, 324), # Full sector
|
||||
Wedge((0.3, 0.3), .2, 324, 360), # Ring sector
|
||||
]
|
||||
colors = 100 * np.random.rand(len(patches))
|
||||
p = PatchCollection(patches, alpha=0.4)
|
||||
p.set_array(colors)
|
||||
ax1.add_collection(p)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### 3. collections
|
||||
collections类是用来绘制一组对象的集合，collections有许多不同的子类，如RegularPolyCollection, CircleCollection, Pathcollection, 分别对应不同的集合子类型。其中比较常用的就是散点图，它是属于PathCollection子类，scatter方法提供了该类的封装，根据x与y绘制不同大小或颜色标记的散点图。 它的构造方法：
|
||||
|
||||
> Axes.scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None, vmin=None, vmax=None, alpha=None, linewidths=None, verts=<deprecated parameter>, edgecolors=None, *, plotnonfinite=False, data=None, **kwargs)
|
||||
|
||||
|
||||
其中最主要的参数是前5个：
|
||||
+ **x**：数据点x轴的位置
|
||||
+ **y**：数据点y轴的位置
|
||||
+ **s**：尺寸大小
|
||||
+ **c**：可以是单个颜色格式的字符串，也可以是一系列颜色
|
||||
+ **marker**: 标记的类型
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 用scatter绘制散点图
|
||||
x = [0,2,4,6,8,10]
|
||||
y = [10]*len(x)
|
||||
s = [20*2**n for n in range(len(x))]
|
||||
plt.scatter(x,y,s=s)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 4. images
|
||||
images是matplotlib中绘制image图像的类，其中最常用的imshow可以根据数组绘制成图像，它的构造函数：
|
||||
> class matplotlib.image.AxesImage(ax, cmap=None, norm=None, interpolation=None, origin=None, extent=None, filternorm=True, filterrad=4.0, resample=False, **kwargs)
|
||||
|
||||
imshow根据数组绘制图像
|
||||
> matplotlib.pyplot.imshow(X, cmap=None, norm=None, aspect=None, interpolation=None, alpha=None, vmin=None, vmax=None, origin=None, extent=None, shape=<deprecated parameter>, filternorm=1, filterrad=4.0, imlim=<deprecated parameter>, resample=None, url=None, *, data=None, **kwargs）
|
||||
|
||||
使用imshow画图时首先需要传入一个数组，数组对应的是空间内的像素位置和像素点的值，interpolation参数可以设置不同的差值方法，具体效果如下。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
methods = [None, 'none', 'nearest', 'bilinear', 'bicubic', 'spline16',
|
||||
'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric',
|
||||
'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos']
|
||||
|
||||
|
||||
grid = np.random.rand(4, 4)
|
||||
|
||||
fig, axs = plt.subplots(nrows=3, ncols=6, figsize=(9, 6),
|
||||
subplot_kw={'xticks': [], 'yticks': []})
|
||||
|
||||
for ax, interp_method in zip(axs.flat, methods):
|
||||
ax.imshow(grid, interpolation=interp_method, cmap='viridis')
|
||||
ax.set_title(str(interp_method))
|
||||
|
||||
plt.tight_layout()
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 三、对象容器 - Object container
|
||||
容器会包含一些`primitives`，并且容器还有它自身的属性。
|
||||
比如`Axes Artist`，它是一种容器，它包含了很多`primitives`，比如`Line2D`，`Text`；同时，它也有自身的属性，比如`xscal`，用来控制X轴是`linear`还是`log`的。
|
||||
|
||||
### 1. Figure容器
|
||||
`matplotlib.figure.Figure`是`Artist`最顶层的`container`-对象容器，它包含了图表中的所有元素。一张图表的背景就是在`Figure.patch`的一个矩形`Rectangle`。
|
||||
当我们向图表添加`Figure.add_subplot()`或者`Figure.add_axes()`元素时，这些都会被添加到`Figure.axes`列表中。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig = plt.figure()
|
||||
ax1 = fig.add_subplot(211) # 作一幅2*1的图，选择第1个子图
|
||||
ax2 = fig.add_axes([0.1, 0.1, 0.7, 0.3]) # 位置参数，四个数分别代表了(left,bottom,width,height)
|
||||
print(ax1)
|
||||
print(fig.axes) # fig.axes 中包含了subplot和axes两个实例, 刚刚添加的
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
由于`Figure`维持了`current axes`，因此你不应该手动的从`Figure.axes`列表中添加删除元素，而是要通过`Figure.add_subplot()`、`Figure.add_axes()`来添加元素，通过`Figure.delaxes()`来删除元素。但是你可以迭代或者访问`Figure.axes`中的`Axes`，然后修改这个`Axes`的属性。
|
||||
|
||||
比如下面的遍历axes里的内容，并且添加网格线：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig = plt.figure()
|
||||
ax1 = fig.add_subplot(211)
|
||||
|
||||
for ax in fig.axes:
|
||||
ax.grid(True)
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
`Figure`也有它自己的`text、line、patch、image`。你可以直接通过`add primitive`语句直接添加。但是注意`Figure`默认的坐标系是以像素为单位，你可能需要转换成figure坐标系：(0,0)表示左下点，(1,1)表示右上点。
|
||||
|
||||
**Figure容器的常见属性：**
|
||||
`Figure.patch`属性：Figure的背景矩形
|
||||
`Figure.axes`属性：一个Axes实例的列表（包括Subplot)
|
||||
`Figure.images`属性：一个FigureImages patch列表
|
||||
`Figure.lines`属性：一个Line2D实例的列表（很少使用）
|
||||
`Figure.legends`属性：一个Figure Legend实例列表（不同于Axes.legends)
|
||||
`Figure.texts`属性：一个Figure Text实例列表
|
||||
|
||||
### 2. Axes容器
|
||||
|
||||
`matplotlib.axes.Axes`是matplotlib的核心。大量的用于绘图的`Artist`存放在它内部，并且它有许多辅助方法来创建和添加`Artist`给它自己，而且它也有许多赋值方法来访问和修改这些`Artist`。
|
||||
|
||||
和`Figure`容器类似，`Axes`包含了一个patch属性，对于笛卡尔坐标系而言，它是一个`Rectangle`；对于极坐标而言，它是一个`Circle`。这个patch属性决定了绘图区域的形状、背景和边框。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
import matplotlib
|
||||
|
||||
fig = plt.figure()
|
||||
ax = fig.add_subplot(111)
|
||||
rect = ax.patch # axes的patch是一个Rectangle实例
|
||||
rect.set_facecolor('green')
|
||||
```
|
||||
|
||||
|
||||
|
||||
`Axes`有许多方法用于绘图，如`.plot()、.text()、.hist()、.imshow()`等方法用于创建大多数常见的`primitive`(如`Line2D，Rectangle，Text，Image`等等）。在`primitives`中已经涉及，不再赘述。
|
||||
|
||||
Subplot就是一个特殊的Axes，其实例是位于网格中某个区域的Subplot实例。其实你也可以在任意区域创建Axes，通过Figure.add_axes([left,bottom,width,height])来创建一个任意区域的Axes，其中left,bottom,width,height都是[0—1]之间的浮点数，他们代表了相对于Figure的坐标。
|
||||
|
||||
你不应该直接通过`Axes.lines`和`Axes.patches`列表来添加图表。因为当创建或添加一个对象到图表中时，`Axes`会做许多自动化的工作:
|
||||
它会设置Artist中figure和axes的属性，同时默认Axes的转换；
|
||||
它也会检视Artist中的数据，来更新数据结构，这样数据范围和呈现方式可以根据作图范围自动调整。
|
||||
|
||||
你也可以使用Axes的辅助方法`.add_line()`和`.add_patch()`方法来直接添加。
|
||||
|
||||
另外Axes还包含两个最重要的Artist container：
|
||||
|
||||
`ax.xaxis`：XAxis对象的实例，用于处理x轴tick以及label的绘制
|
||||
`ax.yaxis`：YAxis对象的实例，用于处理y轴tick以及label的绘制
|
||||
会在下面章节详细说明。
|
||||
|
||||
**Axes容器**的常见属性有：
|
||||
`artists`: Artist实例列表
|
||||
`patch`: Axes所在的矩形实例
|
||||
`collections`: Collection实例
|
||||
`images`: Axes图像
|
||||
`legends`: Legend 实例
|
||||
`lines`: Line2D 实例
|
||||
`patches`: Patch 实例
|
||||
`texts`: Text 实例
|
||||
`xaxis`: matplotlib.axis.XAxis 实例
|
||||
`yaxis`: matplotlib.axis.YAxis 实例
|
||||
|
||||
### 3. Axis容器
|
||||
|
||||
`matplotlib.axis.Axis`实例处理`tick line`、`grid line`、`tick label`以及`axis label`的绘制，它包括坐标轴上的刻度线、刻度`label`、坐标网格、坐标轴标题。通常你可以独立的配置y轴的左边刻度以及右边的刻度，也可以独立地配置x轴的上边刻度以及下边的刻度。
|
||||
|
||||
刻度包括主刻度和次刻度，它们都是Tick刻度对象。
|
||||
|
||||
`Axis`也存储了用于自适应，平移以及缩放的`data_interval`和`view_interval`。它还有Locator实例和Formatter实例用于控制刻度线的位置以及刻度label。
|
||||
|
||||
每个Axis都有一个`label`属性，也有主刻度列表和次刻度列表。这些`ticks`是`axis.XTick`和`axis.YTick`实例，它们包含着`line primitive`以及`text primitive`用来渲染刻度线以及刻度文本。
|
||||
|
||||
刻度是动态创建的，只有在需要创建的时候才创建（比如缩放的时候）。Axis也提供了一些辅助方法来获取刻度文本、刻度线位置等等：
|
||||
常见的如下：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 不用print，直接显示结果
|
||||
from IPython.core.interactiveshell import InteractiveShell
|
||||
InteractiveShell.ast_node_interactivity = "all"
|
||||
|
||||
fig, ax = plt.subplots()
|
||||
x = range(0,5)
|
||||
y = [2,5,7,8,10]
|
||||
plt.plot(x, y, '-')
|
||||
|
||||
axis = ax.xaxis # axis为X轴对象
|
||||
axis.get_ticklocs() # 获取刻度线位置
|
||||
axis.get_ticklabels() # 获取刻度label列表(一个Text实例的列表）。 可以通过minor=True|False关键字参数控制输出minor还是major的tick label。
|
||||
axis.get_ticklines() # 获取刻度线列表(一个Line2D实例的列表）。 可以通过minor=True|False关键字参数控制输出minor还是major的tick line。
|
||||
axis.get_data_interval()# 获取轴刻度间隔
|
||||
axis.get_view_interval()# 获取轴视角（位置）的间隔
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
下面的例子展示了如何调整一些轴和刻度的属性(忽略美观度，仅作调整参考)：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
fig = plt.figure() # 创建一个新图表
|
||||
rect = fig.patch # 矩形实例并将其设为黄色
|
||||
rect.set_facecolor('lightgoldenrodyellow')
|
||||
|
||||
ax1 = fig.add_axes([0.1, 0.3, 0.4, 0.4]) # 创一个axes对象，从(0.1,0.3)的位置开始，宽和高都为0.4，
|
||||
rect = ax1.patch # ax1的矩形设为灰色
|
||||
rect.set_facecolor('lightslategray')
|
||||
|
||||
|
||||
for label in ax1.xaxis.get_ticklabels():
|
||||
# 调用x轴刻度标签实例，是一个text实例
|
||||
label.set_color('red') # 颜色
|
||||
label.set_rotation(45) # 旋转角度
|
||||
label.set_fontsize(16) # 字体大小
|
||||
|
||||
for line in ax1.yaxis.get_ticklines():
|
||||
# 调用y轴刻度线条实例, 是一个Line2D实例
|
||||
line.set_color('green') # 颜色
|
||||
line.set_markersize(25) # marker大小
|
||||
line.set_markeredgewidth(2)# marker粗细
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### 4. Tick容器
|
||||
|
||||
`matplotlib.axis.Tick`是从`Figure`到`Axes`到`Axis`到`Tick`中最末端的容器对象。
|
||||
`Tick`包含了`tick`、`grid line`实例以及对应的`label`。
|
||||
|
||||
所有的这些都可以通过`Tick`的属性获取，常见的`tick`属性有
|
||||
`Tick.tick1line`：Line2D实例
|
||||
`Tick.tick2line`：Line2D实例
|
||||
`Tick.gridline`：Line2D实例
|
||||
`Tick.label1`：Text实例
|
||||
`Tick.label2`：Text实例
|
||||
|
||||
y轴分为左右两个，因此tick1对应左侧的轴；tick2对应右侧的轴。
|
||||
x轴分为上下两个，因此tick1对应下侧的轴；tick2对应上侧的轴。
|
||||
|
||||
下面的例子展示了，如何将Y轴右边轴设为主轴，并将标签设置为美元符号且为绿色：
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
import matplotlib
|
||||
|
||||
fig, ax = plt.subplots()
|
||||
ax.plot(100*np.random.rand(20))
|
||||
|
||||
# 设置ticker的显示格式
|
||||
formatter = matplotlib.ticker.FormatStrFormatter('$%1.2f')
|
||||
ax.yaxis.set_major_formatter(formatter)
|
||||
|
||||
# 设置ticker的参数，右侧为主轴，颜色为绿色
|
||||
ax.yaxis.set_tick_params(which='major', labelcolor='green',
|
||||
labelleft=False, labelright=True);
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 参考资料
|
||||
[1. matplotlib设计的基本逻辑](https://zhuanlan.zhihu.com/p/32693665)
|
||||
[2. matplotlib.artist api](https://matplotlib.org/api/artist_api.html)
|
||||
[3. matplotlib官方教程](https://matplotlib.org/tutorials/intermediate/artists.html#sphx-glr-tutorials-intermediate-artists-py)
|
||||
[4. AI算法工程师手册](https://www.bookstack.cn/read/huaxiaozhuan-ai/spilt.2.333f5abdbabf383d.md)
|
||||
|
||||
|
||||
|
||||
|
|
@ -1,285 +0,0 @@
|
|||
---
|
||||
jupytext:
|
||||
text_representation:
|
||||
format_name: myst
|
||||
kernelspec:
|
||||
display_name: Python 3
|
||||
name: python3
|
||||
---
|
||||
# 第五回：样式色彩秀芳华
|
||||
|
||||
|
||||
第五回详细介绍matplotlib中样式和颜色的使用，绘图样式和颜色是丰富可视化图表的重要手段，因此熟练掌握本章可以让可视化图表变得更美观，突出重点和凸显艺术性。
|
||||
关于绘图样式，常见的有4种方法，分别是修改预定义样式，自定义样式，rcparams和matplotlibrc文件。
|
||||
关于颜色使用，本章介绍了常见的5种表示单色颜色的基本方法，以及colormap多色显示的方法。
|
||||
|
||||
## 一、matplotlib的绘图样式（style）
|
||||
|
||||
在matplotlib中，要想设置绘制样式，最简单的方法是在绘制元素时单独设置样式。
|
||||
但是有时候，当用户在做专题报告时，往往会希望保持整体风格的统一而不用对每张图一张张修改，因此matplotlib库还提供了四种批量修改全局样式的方式
|
||||
|
||||
### 1.matplotlib预先定义样式
|
||||
|
||||
matplotlib贴心地提供了许多内置的样式供用户使用，使用方法很简单，只需在python脚本的最开始输入想使用style的名称即可调用，尝试调用不同内置样式，比较区别
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib as mpl
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use('default')
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use('ggplot')
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
那么matplotlib究竟内置了那些样式供使用呢？总共以下26种丰富的样式可供选择。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
print(plt.style.available)
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### 2.用户自定义stylesheet
|
||||
|
||||
在任意路径下创建一个后缀名为mplstyle的样式清单，编辑文件添加以下样式内容
|
||||
|
||||
> axes.titlesize : 24
|
||||
> axes.labelsize : 20
|
||||
> lines.linewidth : 3
|
||||
> lines.markersize : 10
|
||||
> xtick.labelsize : 16
|
||||
> ytick.labelsize : 16
|
||||
|
||||
引用自定义stylesheet后观察图表变化。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use('https://raw.githubusercontent.com/datawhalechina/fantastic-matplotlib/main/file/presentation.mplstyle')
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
值得特别注意的是，matplotlib支持混合样式的引用，只需在引用时输入一个样式列表，若是几个样式中涉及到同一个参数，右边的样式表会覆盖左边的值。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use(['dark_background', 'https://raw.githubusercontent.com/datawhalechina/fantastic-matplotlib/main/file/presentation.mplstyle'])
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 3.设置rcparams
|
||||
|
||||
我们还可以通过修改默认rc设置的方式改变样式，所有rc设置都保存在一个叫做 matplotlib.rcParams的变量中。
|
||||
修改过后再绘图，可以看到绘图样式发生了变化。
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use('default') # 恢复到默认样式
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
mpl.rcParams['lines.linewidth'] = 2
|
||||
mpl.rcParams['lines.linestyle'] = '--'
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
另外matplotlib也还提供了了一种更便捷的修改样式方式，可以一次性修改多个样式。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
mpl.rc('lines', linewidth=4, linestyle='-.')
|
||||
plt.plot([1,2,3,4],[2,3,4,5]);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 4.修改matplotlibrc文件
|
||||
|
||||
由于matplotlib是使用matplotlibrc文件来控制样式的，也就是上一节提到的rc setting，所以我们还可以通过修改matplotlibrc文件的方式改变样式。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 查找matplotlibrc文件的路径
|
||||
mpl.matplotlib_fname()
|
||||
```
|
||||
|
||||
找到路径后，就可以直接编辑样式文件了，打开后看到的文件格式大致是这样的，文件中列举了所有的样式参数，找到想要修改的参数，比如lines.linewidth: 8，并将前面的注释符号去掉，此时再绘图发现样式以及生效了。
|
||||
|
||||
|
||||
|
||||
## 二、matplotlib的色彩设置（color）
|
||||
|
||||
在可视化中，如何选择合适的颜色和搭配组合也是需要仔细考虑的，色彩选择要能够反映出可视化图像的主旨。
|
||||
从可视化编码的角度对颜色进行分析，可以将颜色分为`色相、亮度和饱和度`三个视觉通道。通常来说：
|
||||
`色相`： 没有明显的顺序性、一般不用来表达数据量的高低，而是用来表达数据列的类别。
|
||||
`明度和饱和度`： 在视觉上很容易区分出优先级的高低、被用作表达顺序或者表达数据量视觉通道。
|
||||
具体关于色彩理论部分的知识，不属于本教程的重点，请参阅有关拓展材料学习。
|
||||
[ECharts数据可视化实验室](https://vis.baidu.com/chartcolor/basis/)
|
||||
[学会这6个可视化配色基本技巧，还原数据本身的意义](https://zhuanlan.zhihu.com/p/88892542)
|
||||
|
||||
在matplotlib中，设置颜色有以下几种方式：
|
||||
|
||||
### 1.RGB或RGBA
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
plt.style.use('default')
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 颜色用[0,1]之间的浮点数表示，四个分量按顺序分别为(red, green, blue, alpha)，其中alpha透明度可省略
|
||||
plt.plot([1,2,3],[4,5,6],color=(0.1, 0.2, 0.5))
|
||||
plt.plot([4,5,6],[1,2,3],color=(0.1, 0.2, 0.5, 0.5));
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 2.HEX RGB 或 RGBA
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 用十六进制颜色码表示，同样最后两位表示透明度，可省略
|
||||
plt.plot([1,2,3],[4,5,6],color='#0f0f0f')
|
||||
plt.plot([4,5,6],[1,2,3],color='#0f0f0f80');
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
RGB颜色和HEX颜色之间是可以一一对应的，以下网址提供了两种色彩表示方法的转换工具。
|
||||
[https://www.colorhexa.com/](https://www.colorhexa.com/)
|
||||
|
||||
### 3.灰度色阶
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 当只有一个位于[0,1]的值时，表示灰度色阶
|
||||
plt.plot([1,2,3],[4,5,6],color='0.5');
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 4.单字符基本颜色
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# matplotlib有八个基本颜色，可以用单字符串来表示，分别是'b', 'g', 'r', 'c', 'm', 'y', 'k', 'w'，对应的是blue, green, red, cyan, magenta, yellow, black, and white的英文缩写
|
||||
plt.plot([1,2,3],[4,5,6],color='m');
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 5.颜色名称
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# matplotlib提供了颜色对照表，可供查询颜色对应的名称
|
||||
plt.plot([1,2,3],[4,5,6],color='tan');
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 6.使用colormap设置一组颜色
|
||||
|
||||
有些图表支持使用colormap的方式配置一组颜色，从而在可视化中通过色彩的变化表达更多信息。
|
||||
|
||||
在matplotlib中，colormap共有五种类型:
|
||||
|
||||
- 顺序（Sequential）。通常使用单一色调，逐渐改变亮度和颜色渐渐增加，用于表示有顺序的信息
|
||||
- 发散（Diverging）。改变两种不同颜色的亮度和饱和度，这些颜色在中间以不饱和的颜色相遇;当绘制的信息具有关键中间值（例如地形）或数据偏离零时，应使用此值。
|
||||
- 循环（Cyclic）。改变两种不同颜色的亮度，在中间和开始/结束时以不饱和的颜色相遇。用于在端点处环绕的值，例如相角，风向或一天中的时间。
|
||||
- 定性（Qualitative）。常是杂色，用来表示没有排序或关系的信息。
|
||||
- 杂色（Miscellaneous）。一些在特定场景使用的杂色组合，如彩虹，海洋，地形等。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
x = np.random.randn(50)
|
||||
y = np.random.randn(50)
|
||||
plt.scatter(x,y,c=x,cmap='RdPu');
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
在以下官网页面可以查询上述五种colormap的字符串表示和颜色图的对应关系
|
||||
[https://matplotlib.org/stable/tutorials/colors/colormaps.html](https://matplotlib.org/stable/tutorials/colors/colormaps.html)
|
||||
|
||||
|
||||
|
||||
## 参考资料
|
||||
[1.matplotlib官网样式使用指南](https://matplotlib.org/stable/tutorials/introductory/customizing.html?highlight=rcparams)
|
||||
[2.matplotlib官网色彩使用指南](https://matplotlib.org/stable/tutorials/colors/colors.html#sphx-glr-tutorials-colors-colors-py)
|
||||
|
||||
|
|
@ -1,668 +0,0 @@
|
|||
---
|
||||
jupytext:
|
||||
text_representation:
|
||||
format_name: myst
|
||||
kernelspec:
|
||||
display_name: Python 3
|
||||
name: python3
|
||||
---
|
||||
# 第四回：文字图例尽眉目
|
||||
|
||||
|
||||
|
||||
## 一、Figure和Axes上的文本
|
||||
|
||||
Matplotlib具有广泛的文本支持，包括对数学表达式的支持、对栅格和矢量输出的TrueType支持、具有任意旋转的换行分隔文本以及Unicode支持。
|
||||
|
||||
下面的命令是介绍了通过pyplot API和objected-oriented API分别创建文本的方式。
|
||||
|
||||
|
||||
| pyplot API | OO API | description |
|
||||
| ---------- | ---------- | --------------------------- |
|
||||
| text | text | 在 Axes的任意位置添加text |
|
||||
| title | set_title | 在 Axes添加title |
|
||||
| figtext | text | 在Figure的任意位置添加text. |
|
||||
| suptitle | suptitle | 在 Figure添加title |
|
||||
| xlabel | set_xlabel | 在Axes的x-axis添加label |
|
||||
| ylabel | set_ylabel | 在Axes的y-axis添加label |
|
||||
|
||||
### 1.text
|
||||
pyplot API：matplotlib.pyplot.text(x, y, s, fontdict=None, \*\*kwargs)
|
||||
OO API:Axes.text(self, x, y, s, fontdict=None, \*\*kwargs)
|
||||
**参数**：此方法接受以下描述的参数：
|
||||
s:此参数是要添加的文本。
|
||||
xy:此参数是放置文本的点(x，y)。
|
||||
fontdict:此参数是一个可选参数，并且是一个覆盖默认文本属性的字典。如果fontdict为None，则由rcParams确定默认值。
|
||||
**返回值**：此方法返回作为创建的文本实例的文本。
|
||||
|
||||
fontdict主要参数具体介绍，更多参数请参考[官网说明](https://matplotlib.org/api/text_api.html?highlight=text#matplotlib.text.Text)：
|
||||
|
||||
|
||||
|
||||
| Property | Description |
|
||||
| ----------------------------------------- | :----------------------------------------------------------- |
|
||||
| alpha | float or None 该参数指透明度，越接近0越透明，越接近1越不透明 |
|
||||
| backgroundcolor | color |
|
||||
| bbox | dict with properties for patches.FancyBboxPatch 这个是用来设置text周围的box外框 |
|
||||
| color or c | color 指的是字体的颜色 |
|
||||
| fontfamily or family | {FONTNAME, 'serif', 'sans-serif', 'cursive', 'fantasy', 'monospace'} 该参数指的是字体的类型 |
|
||||
| fontproperties or font or font_properties | font_manager.FontProperties or str or pathlib.Path |
|
||||
| fontsize or size | float or {'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large'} 该参数指字体大小 |
|
||||
| fontstretch or stretch | {a numeric value in range 0-1000, 'ultra-condensed', 'extra-condensed', 'condensed', 'semi-condensed', 'normal', 'semi-expanded', 'expanded', 'extra-expanded', 'ultra-expanded'} 该参数是指从字体中选择正常、压缩或扩展的字体 |
|
||||
| fontstyle or style | {'normal', 'italic', 'oblique'} 该参数是指字体的样式是否倾斜等 |
|
||||
| fontweight or weight | {a numeric value in range 0-1000, 'ultralight', 'light', 'normal', 'regular', 'book', 'medium', 'roman', 'semibold', 'demibold', 'demi', 'bold', 'heavy', 'extra bold', 'black'} |
|
||||
| horizontalalignment or ha | {'center', 'right', 'left'} 该参数是指选择文本左对齐右对齐还是居中对齐 |
|
||||
| label | object |
|
||||
| linespacing | float (multiple of font size) |
|
||||
| position | (float, float) |
|
||||
| rotation | float or {'vertical', 'horizontal'} 该参数是指text逆时针旋转的角度，“horizontal”等于0，“vertical”等于90。我们可以根据自己设定来选择合适角度 |
|
||||
| verticalalignment or va | {'center', 'top', 'bottom', 'baseline', 'center_baseline'} |
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
from matplotlib.font_manager import FontProperties
|
||||
import numpy as np
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#fontdict学习的案例
|
||||
#学习的过程中请尝试更换不同的fontdict字典的内容，以便于更好的掌握
|
||||
#---------设置字体样式，分别是字体，颜色，宽度，大小
|
||||
font1 = {'family': 'SimSun',#华文楷体
|
||||
'alpha':0.7,#透明度
|
||||
'color': 'purple',
|
||||
'weight': 'normal',
|
||||
'size': 16,
|
||||
}
|
||||
font2 = {'family': 'Times New Roman',
|
||||
'color': 'red',
|
||||
'weight': 'normal',
|
||||
'size': 16,
|
||||
}
|
||||
font3 = {'family': 'serif',
|
||||
'color': 'blue',
|
||||
'weight': 'bold',
|
||||
'size': 14,
|
||||
}
|
||||
font4 = {'family': 'Calibri',
|
||||
'color': 'navy',
|
||||
'weight': 'normal',
|
||||
'size': 17,
|
||||
}
|
||||
#-----------四种不同字体显示风格-----
|
||||
|
||||
#-------建立函数----------
|
||||
x = np.linspace(0.0, 5.0, 100)
|
||||
y = np.cos(2*np.pi*x) * np.exp(-x/3)
|
||||
#-------绘制图像，添加标注----------
|
||||
plt.plot(x, y, '--')
|
||||
plt.title('震荡曲线', fontdict=font1)
|
||||
#------添加文本在指定的坐标处------------
|
||||
plt.text(2, 0.65, r'$\cos(2 \pi x) \exp(-x/3)$', fontdict=font2)
|
||||
#---------设置坐标标签
|
||||
plt.xlabel('Y=time (s)', fontdict=font3)
|
||||
plt.ylabel('X=voltage(mv)', fontdict=font4)
|
||||
|
||||
# 调整图像边距
|
||||
plt.subplots_adjust(left=0.15)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### 2.title和set_title
|
||||
pyplot API：matplotlib.pyplot.title(label, fontdict=None, loc=None, pad=None, \*, y=None, \*\*kwargs)
|
||||
OO API:Axes.set_title(self, label, fontdict=None, loc=None, pad=None, \*, y=None, \*\*kwargs)
|
||||
该命令是用来设置axes的标题。
|
||||
**参数**：此方法接受以下描述的参数:
|
||||
label：str，此参数是要添加的文本
|
||||
fontdict：dict，此参数是控制title文本的外观，默认fontdict如下：
|
||||
```python
|
||||
{'fontsize': rcParams['axes.titlesize'],
|
||||
'fontweight': rcParams['axes.titleweight'],
|
||||
'color': rcParams['axes.titlecolor'],
|
||||
'verticalalignment': 'baseline',
|
||||
'horizontalalignment': loc}
|
||||
```
|
||||
loc：str，{'center', 'left', 'right'}默认为center
|
||||
pad：float,该参数是指标题偏离图表顶部的距离，默认为6。
|
||||
y：float，该参数是title所在axes垂向的位置。默认值为1，即title位于axes的顶部。
|
||||
kwargs：该参数是指可以设置的一些奇特文本的属性。
|
||||
**返回值**：此方法返回作为创建的title实例的文本。
|
||||
|
||||
### 3.figtext和text
|
||||
pyplot API：matplotlib.pyplot.figtext(x, y, s, fontdict=None, \*\*kwargs)
|
||||
OO API:text(self, x, y, s, fontdict=None,\*\*kwargs)
|
||||
**参数**：此方法接受以下描述的参数:
|
||||
x,y：float，此参数是指在figure中放置文本的位置。一般取值是在\[0,1\]范围内。使用transform关键字可以更改坐标系。
|
||||
s:str,此参数是指文本
|
||||
fontdict:dict,此参数是一个可选参数，并且是一个覆盖默认文本属性的字典。如果fontdict为None，则由rcParams确定默认值。
|
||||
**返回值**：此方法返回作为创建的文本实例的文本。
|
||||
|
||||
### 4.suptitle
|
||||
pyplot API：matplotlib.pyplot.suptitle(t, \*\*kwargs)
|
||||
OO API:suptitle(self, t, \*\*kwargs)
|
||||
**参数**：此方法接受以下描述的参数:
|
||||
t: str,标题的文本
|
||||
x：float,默认值是0.5.该参数是指文本在figure坐标系下的x坐标
|
||||
y：float,默认值是0.95.该参数是指文本在figure坐标系下的y坐标
|
||||
horizontalalignment, ha:该参数是指选择文本水平对齐方式，有三种选择{'center', 'left', right'}，默认值是 'center'
|
||||
verticalalignment, va：该参数是指选择文本垂直对齐方式，有四种选择{'top', 'center', 'bottom', 'baseline'}，默认值是 'top'
|
||||
fontsize, size：该参数是指文本的大小，默认值是依据rcParams的设置：rcParams["figure.titlesize"] (default: 'large')
|
||||
fontweight, weight：该参数是用来设置字重。默认值是依据rcParams的设置：rcParams["figure.titleweight"] (default: 'normal')
|
||||
fontproperties:None or dict,该参数是可选参数，如果该参数被指定，字体的大小将从该参数的默认值中提取。
|
||||
**返回值**：此方法返回作为创建的title实例的文本。
|
||||
|
||||
### 5.xlabel和ylabel
|
||||
|
||||
pyplot API：matplotlib.pyplot.xlabel(xlabel, fontdict=None, labelpad=None, \*, loc=None, \*\*kwargs)
|
||||
     matplotlib.pyplot.ylabel(ylabel, fontdict=None, labelpad=None,\*, loc=None, \*\*kwargs)
|
||||
OO API:  Axes.set_xlabel(self, xlabel, fontdict=None, labelpad=None, \*, loc=None, \*\*kwargs)
|
||||
     Axes.set_ylabel(self, ylabel, fontdict=None, labelpad=None,\*, loc=None, \*\*kwargs)
|
||||
**参数**：此方法接受以下描述的参数:
|
||||
xlabel或者ylabel：label的文本
|
||||
labelpad:设置label距离轴(axis)的距离
|
||||
loc:{'left', 'center', 'right'},默认为center
|
||||
\*\*kwargs:[文本](https://matplotlib.org/api/text_api.html#matplotlib.text.Text)属性
|
||||
**返回值**：此方法返回作为创建的xlabel和ylabel实例的文本。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#文本属性的输入一种是通过**kwargs属性这种方式，一种是通过操作 matplotlib.font_manager.FontProperties 方法
|
||||
#该案例中对于x_label采用**kwargs调整字体属性，y_label则采用 matplotlib.font_manager.FontProperties 方法调整字体属性
|
||||
#该链接是FontProperties方法的介绍 https://matplotlib.org/api/font_manager_api.html#matplotlib.font_manager.FontProperties
|
||||
x1 = np.linspace(0.0, 5.0, 100)
|
||||
y1 = np.cos(2 * np.pi * x1) * np.exp(-x1)
|
||||
|
||||
font = FontProperties()
|
||||
font.set_family('serif')
|
||||
font.set_name('Times New Roman')
|
||||
font.set_style('italic')
|
||||
|
||||
fig, ax = plt.subplots(figsize=(5, 3))
|
||||
fig.subplots_adjust(bottom=0.15, left=0.2)
|
||||
ax.plot(x1, y1)
|
||||
ax.set_xlabel('time [s]', fontsize='large', fontweight='bold')
|
||||
ax.set_ylabel('Damped oscillation [V]', fontproperties=font)
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 6.字体的属性设置
|
||||
字体设置一般有全局字体设置和自定义局部字体设置两种方法。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#首先可以查看matplotlib所有可用的字体
|
||||
from matplotlib import font_manager
|
||||
font_family = font_manager.fontManager.ttflist
|
||||
font_name_list = [i.name for i in font_family]
|
||||
for font in font_name_list[:10]:
|
||||
print(f'{font}\n')
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
[为方便在图中加入合适的字体，可以尝试了解中文字体的英文名称,该链接告诉了常用中文的英文名称](https://www.cnblogs.com/chendc/p/9298832.html)
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#该block讲述如何在matplotlib里面，修改字体默认属性，完成全局字体的更改。
|
||||
import matplotlib.pyplot as plt
|
||||
plt.rcParams['font.sans-serif'] = ['SimSun'] # 指定默认字体为新宋体。
|
||||
plt.rcParams['axes.unicode_minus'] = False # 解决保存图像时 负号'-' 显示为方块和报错的问题。
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#局部字体的修改方法1
|
||||
import matplotlib.pyplot as plt
|
||||
import matplotlib.font_manager as fontmg
|
||||
|
||||
x = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
|
||||
plt.plot(x, label='小示例图标签')
|
||||
|
||||
# 直接用字体的名字。
|
||||
plt.xlabel('x 轴名称参数', fontproperties='Microsoft YaHei', fontsize=16) # 设置x轴名称，采用微软雅黑字体
|
||||
plt.ylabel('y 轴名称参数', fontproperties='Microsoft YaHei', fontsize=14) # 设置Y轴名称
|
||||
plt.title('坐标系的标题', fontproperties='Microsoft YaHei', fontsize=20) # 设置坐标系标题的字体
|
||||
plt.legend(loc='lower right', prop={"family": 'Microsoft YaHei'}, fontsize=10); # 小示例图的字体设置
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#局部字体的修改方法2
|
||||
import matplotlib.pyplot as plt
|
||||
import matplotlib.font_manager as fontmg
|
||||
|
||||
x = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
|
||||
plt.plot(x, label='小示例图标签')
|
||||
#fname为你系统中的字体库路径
|
||||
my_font1 = fontmg.FontProperties(fname=r'C:\Windows\Fonts\simhei.ttf') # 读取系统中的 黑体 字体。
|
||||
my_font2 = fontmg.FontProperties(fname=r'C:\Windows\Fonts\simkai.ttf') # 读取系统中的 楷体 字体。
|
||||
# fontproperties 设置中文显示，fontsize 设置字体大小
|
||||
plt.xlabel('x 轴名称参数', fontproperties=my_font1, fontsize=16) # 设置x轴名称
|
||||
plt.ylabel('y 轴名称参数', fontproperties=my_font1, fontsize=14) # 设置Y轴名称
|
||||
plt.title('坐标系的标题', fontproperties=my_font2, fontsize=20) # 标题的字体设置
|
||||
plt.legend(loc='lower right', prop=my_font1, fontsize=10); # 小示例图的字体设置
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 7.数学表达式
|
||||
在文本标签中使用数学表达式。有关MathText的概述，请参见 [写数学表达式](https://matplotlib.org/tutorials/text/mathtext.html#sphx-glr-tutorials-text-mathtext-py),但由于数学表达式的练习想必我们都在markdown语法和latex语法中多少有接触，故在此不继续展开，愿意深入学习的可以参看官方文档.下面是一个官方案例，供参考了解。
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
t = np.arange(0.0, 2.0, 0.01)
|
||||
s = np.sin(2*np.pi*t)
|
||||
|
||||
plt.plot(t, s)
|
||||
plt.title(r'$\alpha_i > \beta_i$', fontsize=20)
|
||||
plt.text(1, -0.6, r'$\sum_{i=0}^\infty x_i$', fontsize=20)
|
||||
plt.text(0.6, 0.6, r'$\mathcal{A}\mathrm{sin}(2 \omega t)$',
|
||||
fontsize=20)
|
||||
plt.xlabel('time (s)')
|
||||
plt.ylabel('volts (mV)')
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#这是对前七节学习内容的总结案例
|
||||
import matplotlib
|
||||
import matplotlib.pyplot as plt
|
||||
|
||||
fig = plt.figure()
|
||||
ax = fig.add_subplot(111)
|
||||
fig.subplots_adjust(top=0.85)
|
||||
|
||||
# 分别在figure和subplot上设置title
|
||||
fig.suptitle('bold figure suptitle', fontsize=14, fontweight='bold')
|
||||
ax.set_title('axes title')
|
||||
|
||||
ax.set_xlabel('xlabel')
|
||||
ax.set_ylabel('ylabel')
|
||||
|
||||
# 设置x-axis和y-axis的范围都是[0, 10]
|
||||
ax.axis([0, 10, 0, 10])
|
||||
|
||||
ax.text(3, 8, 'boxed italics text in data coords', style='italic',
|
||||
bbox={'facecolor': 'red', 'alpha': 0.5, 'pad': 10})
|
||||
|
||||
ax.text(2, 6, r'an equation: $E=mc^2$', fontsize=15)
|
||||
font1 = {'family': 'Times New Roman',
|
||||
'color': 'purple',
|
||||
'weight': 'normal',
|
||||
'size': 10,
|
||||
}
|
||||
ax.text(3, 2, 'unicode: Institut für Festkörperphysik',fontdict=font1)
|
||||
ax.text(0.95, 0.01, 'colored text in axes coords',
|
||||
verticalalignment='bottom', horizontalalignment='right',
|
||||
transform=ax.transAxes,
|
||||
color='green', fontsize=15)
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
## 二、Tick上的文本
|
||||
|
||||
设置tick（刻度）和ticklabel（刻度标签）也是可视化中经常需要操作的步骤，matplotlib既提供了自动生成刻度和刻度标签的模式（默认状态），同时也提供了许多让使用者灵活设置的方式。
|
||||
|
||||
### 1.简单模式
|
||||
可以使用axis的`set_ticks`方法手动设置标签位置，使用axis的`set_ticklabels`方法手动设置标签格式
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
import matplotlib
|
||||
x1 = np.linspace(0.0, 5.0, 100)
|
||||
y1 = np.cos(2 * np.pi * x1) * np.exp(-x1)
|
||||
```
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 使用axis的set_ticks方法手动设置标签位置的例子，该案例中由于tick设置过大，所以会影响绘图美观，不建议用此方式进行设置tick
|
||||
fig, axs = plt.subplots(2, 1, figsize=(5, 3), tight_layout=True)
|
||||
axs[0].plot(x1, y1)
|
||||
axs[1].plot(x1, y1)
|
||||
axs[1].xaxis.set_ticks(np.arange(0., 10.1, 2.))
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 使用axis的set_ticklabels方法手动设置标签格式的例子
|
||||
fig, axs = plt.subplots(2, 1, figsize=(5, 3), tight_layout=True)
|
||||
axs[0].plot(x1, y1)
|
||||
axs[1].plot(x1, y1)
|
||||
ticks = np.arange(0., 8.1, 2.)
|
||||
tickla = [f'{tick:1.2f}' for tick in ticks]
|
||||
axs[1].xaxis.set_ticks(ticks)
|
||||
axs[1].xaxis.set_ticklabels(tickla)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#一般绘图时会自动创建刻度，而如果通过上面的例子使用set_ticks创建刻度可能会导致tick的范围与所绘制图形的范围不一致的问题。
|
||||
#所以在下面的案例中，axs[1]中set_xtick的设置要与数据范围所对应，然后再通过set_xticklabels设置刻度所对应的标签
|
||||
import numpy as np
|
||||
import matplotlib.pyplot as plt
|
||||
fig, axs = plt.subplots(2, 1, figsize=(6, 4), tight_layout=True)
|
||||
x1 = np.linspace(0.0, 6.0, 100)
|
||||
y1 = np.cos(2 * np.pi * x1) * np.exp(-x1)
|
||||
axs[0].plot(x1, y1)
|
||||
axs[0].set_xticks([0,1,2,3,4,5,6])
|
||||
|
||||
axs[1].plot(x1, y1)
|
||||
axs[1].set_xticks([0,1,2,3,4,5,6])#要将x轴的刻度放在数据范围中的哪些位置
|
||||
axs[1].set_xticklabels(['zero','one', 'two', 'three', 'four', 'five','six'],#设置刻度对应的标签
|
||||
rotation=30, fontsize='small')#rotation选项设定x刻度标签倾斜30度。
|
||||
axs[1].xaxis.set_ticks_position('bottom')#set_ticks_position()方法是用来设置刻度所在的位置，常用的参数有bottom、top、both、none
|
||||
print(axs[1].xaxis.get_ticklines())
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### 2.Tick Locators and Formatters
|
||||
|
||||
除了上述的简单模式，还可以使用`Tick Locators and Formatters`完成对于刻度位置和刻度标签的设置。
|
||||
其中[Axis.set_major_locator](https://matplotlib.org/api/_as_gen/matplotlib.axis.Axis.set_major_locator.html#matplotlib.axis.Axis.set_major_locator)和[Axis.set_minor_locator](https://matplotlib.org/api/_as_gen/matplotlib.axis.Axis.set_minor_locator.html#matplotlib.axis.Axis.set_minor_locator)方法用来设置标签的位置，[Axis.set_major_formatter](https://matplotlib.org/api/_as_gen/matplotlib.axis.Axis.set_major_formatter.html#matplotlib.axis.Axis.set_major_formatter)和[Axis.set_minor_formatter](https://matplotlib.org/api/_as_gen/matplotlib.axis.Axis.set_minor_formatter.html#matplotlib.axis.Axis.set_minor_formatter)方法用来设置标签的格式。这种方式的好处是不用显式地列举出刻度值列表。
|
||||
|
||||
set_major_formatter和set_minor_formatter这两个formatter格式命令可以接收字符串格式（matplotlib.ticker.StrMethodFormatter）或函数参数（matplotlib.ticker.FuncFormatter）来设置刻度值的格式 。
|
||||
|
||||
#### a) Tick Formatters
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 接收字符串格式的例子
|
||||
fig, axs = plt.subplots(2, 2, figsize=(8, 5), tight_layout=True)
|
||||
for n, ax in enumerate(axs.flat):
|
||||
ax.plot(x1*10., y1)
|
||||
|
||||
formatter = matplotlib.ticker.FormatStrFormatter('%1.1f')
|
||||
axs[0, 1].xaxis.set_major_formatter(formatter)
|
||||
|
||||
formatter = matplotlib.ticker.FormatStrFormatter('-%1.1f')
|
||||
axs[1, 0].xaxis.set_major_formatter(formatter)
|
||||
|
||||
formatter = matplotlib.ticker.FormatStrFormatter('%1.5f')
|
||||
axs[1, 1].xaxis.set_major_formatter(formatter)
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 接收函数的例子
|
||||
def formatoddticks(x, pos):
|
||||
"""Format odd tick positions."""
|
||||
if x % 2:
|
||||
return f'{x:1.2f}'
|
||||
else:
|
||||
return ''
|
||||
|
||||
fig, ax = plt.subplots(figsize=(5, 3), tight_layout=True)
|
||||
ax.plot(x1, y1)
|
||||
ax.xaxis.set_major_formatter(formatoddticks)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### b) Tick Locators
|
||||
|
||||
|
||||
在普通的绘图中，我们可以直接通过上图的set_ticks进行设置刻度的位置，缺点是需要自己指定或者接受matplotlib默认给定的刻度。当需要更改刻度的位置时，matplotlib给了常用的几种locator的类型。如果要绘制更复杂的图，可以先设置locator的类型，然后通过axs.xaxis.set_major_locator(locator)绘制即可
|
||||
locator=plt.MaxNLocator(nbins=7)
|
||||
locator=plt.FixedLocator(locs=[0,0.5,1.5,2.5,3.5,4.5,5.5,6])#直接指定刻度所在的位置
|
||||
locator=plt.AutoLocator()#自动分配刻度值的位置
|
||||
locator=plt.IndexLocator(offset=0.5, base=1)#面元间距是1，从0.5开始
|
||||
locator=plt.MultipleLocator(1.5)#将刻度的标签设置为1.5的倍数
|
||||
locator=plt.LinearLocator(numticks=5)#线性划分5等分，4个刻度
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
# 接收各种locator的例子
|
||||
fig, axs = plt.subplots(2, 2, figsize=(8, 5), tight_layout=True)
|
||||
for n, ax in enumerate(axs.flat):
|
||||
ax.plot(x1*10., y1)
|
||||
|
||||
locator = matplotlib.ticker.AutoLocator()
|
||||
axs[0, 0].xaxis.set_major_locator(locator)
|
||||
|
||||
locator = matplotlib.ticker.MaxNLocator(nbins=10)
|
||||
axs[0, 1].xaxis.set_major_locator(locator)
|
||||
|
||||
|
||||
locator = matplotlib.ticker.MultipleLocator(5)
|
||||
axs[1, 0].xaxis.set_major_locator(locator)
|
||||
|
||||
|
||||
locator = matplotlib.ticker.FixedLocator([0,7,14,21,28])
|
||||
axs[1, 1].xaxis.set_major_locator(locator)
|
||||
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
此外`matplotlib.dates` 模块还提供了特殊的设置日期型刻度格式和位置的方式
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
import matplotlib.dates as mdates
|
||||
import datetime
|
||||
# 特殊的日期型locator和formatter
|
||||
locator = mdates.DayLocator(bymonthday=[1,15,25])
|
||||
formatter = mdates.DateFormatter('%b %d')
|
||||
|
||||
fig, ax = plt.subplots(figsize=(5, 3), tight_layout=True)
|
||||
ax.xaxis.set_major_locator(locator)
|
||||
ax.xaxis.set_major_formatter(formatter)
|
||||
base = datetime.datetime(2017, 1, 1, 0, 0, 1)
|
||||
time = [base + datetime.timedelta(days=x) for x in range(len(x1))]
|
||||
ax.plot(time, y1)
|
||||
ax.tick_params(axis='x', rotation=70)
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**其他进阶案例**
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#这个案例中展示了如何进行坐标轴的移动，如何更改刻度值的样式
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
x = np.linspace(-3,3,50)
|
||||
y1 = 2*x+1
|
||||
y2 = x**2
|
||||
plt.figure()
|
||||
plt.plot(x,y2)
|
||||
plt.plot(x,y1,color='red',linewidth=1.0,linestyle = '--')
|
||||
plt.xlim((-3,5))
|
||||
plt.ylim((-3,5))
|
||||
plt.xlabel('x')
|
||||
plt.ylabel('y')
|
||||
new_ticks1 = np.linspace(-3,5,5)
|
||||
plt.xticks(new_ticks1)
|
||||
plt.yticks([-2,0,2,5],[r'$one\ shu$',r'$\alpha$',r'$three$',r'four'])
|
||||
'''
|
||||
上一行代码是将y轴上的小标改成文字,其中，空格需要增加\，即'\ ',$可将格式更改成数字模式，如果需要输入数学形式的α，则需要用\转换，即\alpha
|
||||
如果使用面向对象的命令进行画图，那么下面两行代码可以实现与 plt.yticks([-2,0,2,5],[r'$one\ shu$',r'$\alpha$',r'$three$',r'four']) 同样的功能
|
||||
axs.set_yticks([-2,0,2,5])
|
||||
axs.set_yticklabels([r'$one\ shu$',r'$\alpha$',r'$three$',r'four'])
|
||||
'''
|
||||
ax = plt.gca()#gca = 'get current axes' 获取现在的轴
|
||||
'''
|
||||
ax = plt.gca()是获取当前的axes，其中gca代表的是get current axes。
|
||||
fig=plt.gcf是获取当前的figure，其中gcf代表的是get current figure。
|
||||
|
||||
许多函数都是对当前的Figure或Axes对象进行处理，
|
||||
例如plt.plot()实际上会通过plt.gca()获得当前的Axes对象ax，然后再调用ax.plot()方法实现真正的绘图。
|
||||
|
||||
而在本例中则可以通过ax.spines方法获得当前顶部和右边的轴并将其颜色设置为不可见
|
||||
然后将左边轴和底部的轴所在的位置重新设置
|
||||
最后再通过set_ticks_position方法设置ticks在x轴或y轴的位置，本示例中因所设置的bottom和left是ticks在x轴或y轴的默认值，所以这两行的代码也可以不写
|
||||
'''
|
||||
ax.spines['top'].set_color('none')
|
||||
ax.spines['right'].set_color('none')
|
||||
ax.spines['left'].set_position(('data',0))
|
||||
ax.spines['bottom'].set_position(('data',0))#axes 百分比
|
||||
ax.xaxis.set_ticks_position('bottom') #设置ticks在x轴的位置
|
||||
ax.yaxis.set_ticks_position('left') #设置ticks在y轴的位置
|
||||
plt.show()
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 三、[legend](https://matplotlib.org/api/_as_gen/matplotlib.pyplot.legend.html#matplotlib.pyplot.legend)（图例）
|
||||
|
||||
图例的设置会使用一些常见术语，为了清楚起见，这些术语在此处进行说明：
|
||||
** legend entry（图例条目）**
|
||||
图例有一个或多个legend entries组成。一个entry由一个key和一个label组成。
|
||||
** legend key（图例键）**
|
||||
每个 legend label左面的colored/patterned marker（彩色/图案标记）
|
||||
** legend label（图例标签）**
|
||||
描述由key来表示的handle的文本
|
||||
** legend handle（图例句柄）**
|
||||
用于在图例中生成适当图例条目的原始对象
|
||||
|
||||
以下面这个图为例，右侧的方框中的共有两个legend entry；两个legend key，分别是一个蓝色和一个黄色的legend key；两个legend label，一个名为‘Line up’和一个名为‘Line Down’的legend label
|
||||
|
||||
|
||||
常用的几个参数：
|
||||
|
||||
(1)设置图列位置
|
||||
|
||||
plt.legend(loc='upper center') 等同于plt.legend(loc=9)，对应关系如下表。
|
||||
|
||||
|
||||
|
||||
| loc by number | loc by text |
|
||||
| ------------- | -------------- |
|
||||
| 0 | 'best' |
|
||||
| 1 | 'upper right' |
|
||||
| 2 | 'upper left' |
|
||||
| 3 | 'lower left' |
|
||||
| 4 | 'lower right' |
|
||||
| 5 | 'right' |
|
||||
| 6 | 'center left' |
|
||||
| 7 | 'center right' |
|
||||
| 8 | 'lower center' |
|
||||
| 9 | 'upper center' |
|
||||
| 10 | 'center' |
|
||||
|
||||
|
||||
(2)设置图例字体大小
|
||||
|
||||
fontsize : int or float or {‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’}
|
||||
|
||||
(3)设置图例边框及背景
|
||||
|
||||
plt.legend(loc='best',frameon=False) #去掉图例边框
|
||||
plt.legend(loc='best',edgecolor='blue') #设置图例边框颜色
|
||||
plt.legend(loc='best',facecolor='blue') #设置图例背景颜色,若无边框,参数无效
|
||||
|
||||
(4)设置图例标题
|
||||
|
||||
legend = plt.legend(["CH", "US"], title='China VS Us')
|
||||
|
||||
(5)设置图例名字及对应关系
|
||||
|
||||
legend = plt.legend([p1, p2], ["CH", "US"])
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
line_up, = plt.plot([1, 2, 3], label='Line 2')
|
||||
line_down, = plt.plot([3, 2, 1], label='Line 1')
|
||||
plt.legend([line_up, line_down], ['Line Up', 'Line Down'],loc=5, title='line',frameon=False);#loc参数设置图例所在的位置，title设置图例的标题，frameon参数将图例边框给去掉
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
```{code-cell} ipython3
|
||||
#这个案例是显示多图例legend
|
||||
import matplotlib.pyplot as plt
|
||||
import numpy as np
|
||||
x = np.random.uniform(-1, 1, 4)
|
||||
y = np.random.uniform(-1, 1, 4)
|
||||
p1, = plt.plot([1,2,3])
|
||||
p2, = plt.plot([3,2,1])
|
||||
l1 = plt.legend([p2, p1], ["line 2", "line 1"], loc='upper left')
|
||||
|
||||
p3 = plt.scatter(x[0:2], y[0:2], marker = 'D', color='r')
|
||||
p4 = plt.scatter(x[2:], y[2:], marker = 'D', color='g')
|
||||
# 下面这行代码由于添加了新的legend，所以会将l1从legend中给移除
|
||||
plt.legend([p3, p4], ['label', 'label1'], loc='lower right', scatterpoints=1)
|
||||
# 为了保留之前的l1这个legend，所以必须要通过plt.gca()获得当前的axes，然后将l1作为单独的artist
|
||||
plt.gca().add_artist(l1);
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## 参考资料
|
||||
|
||||
[1.matplotlib官网文字使用指南](https://matplotlib.org/stable/tutorials/text/text_intro.html#sphx-glr-tutorials-text-text-intro-py
|
||||
)
|
||||
Binary file not shown.
|
|
@ -1,861 +0,0 @@
|
|||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
div.section::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 270px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 450px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, figure.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, figure.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, figure.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, figure.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar,
|
||||
aside.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
clear: right;
|
||||
overflow-x: auto;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition, div.topic, blockquote {
|
||||
clear: left;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- content of sidebars/topics/admonitions -------------------------------- */
|
||||
|
||||
div.sidebar > :last-child,
|
||||
aside.sidebar > :last-child,
|
||||
div.topic > :last-child,
|
||||
div.admonition > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sidebar::after,
|
||||
aside.sidebar::after,
|
||||
div.topic::after,
|
||||
div.admonition::after,
|
||||
blockquote::after {
|
||||
display: block;
|
||||
content: '';
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > :first-child,
|
||||
td > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > :last-child,
|
||||
td > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure, figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption, figcaption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number,
|
||||
figcaption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text,
|
||||
figcaption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:first-child > :first-child,
|
||||
:not(li) > ul > li:first-child > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
:not(li) > ol > li:last-child > :last-child,
|
||||
:not(li) > ul > li:last-child > :last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
ol.simple ol p,
|
||||
ol.simple ul p,
|
||||
ul.simple ol p,
|
||||
ul.simple ul p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple > li:not(:first-child) > p,
|
||||
ul.simple > li:not(:first-child) > p {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
ol.simple p,
|
||||
ul.simple p {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
margin-right: 0.5em;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > :first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dl > dd:last-child,
|
||||
dl > dd:last-child > :last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tbody {
|
||||
display: block;
|
||||
}
|
||||
|
||||
table.highlighttable tr {
|
||||
display: flex;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos {
|
||||
padding-right: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td.code {
|
||||
flex: 1;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
.highlight .hll {
|
||||
display: block;
|
||||
}
|
||||
|
||||
div.highlight pre,
|
||||
table.highlighttable pre {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption + div {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
margin-top: 1em;
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
table.highlighttable td.linenos,
|
||||
span.linenos,
|
||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: absolute;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1,117 +0,0 @@
|
|||
:root {
|
||||
/*****************************************************************************
|
||||
* Theme config
|
||||
**/
|
||||
--pst-header-height: 60px;
|
||||
|
||||
/*****************************************************************************
|
||||
* Font size
|
||||
**/
|
||||
--pst-font-size-base: 15px; /* base font size - applied at body / html level */
|
||||
|
||||
/* heading font sizes */
|
||||
--pst-font-size-h1: 36px;
|
||||
--pst-font-size-h2: 32px;
|
||||
--pst-font-size-h3: 26px;
|
||||
--pst-font-size-h4: 21px;
|
||||
--pst-font-size-h5: 18px;
|
||||
--pst-font-size-h6: 16px;
|
||||
|
||||
/* smaller then heading font sizes*/
|
||||
--pst-font-size-milli: 12px;
|
||||
|
||||
--pst-sidebar-font-size: .9em;
|
||||
--pst-sidebar-caption-font-size: .9em;
|
||||
|
||||
/*****************************************************************************
|
||||
* Font family
|
||||
**/
|
||||
/* These are adapted from https://systemfontstack.com/ */
|
||||
--pst-font-family-base-system: -apple-system, BlinkMacSystemFont, Segoe UI, "Helvetica Neue",
|
||||
Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol;
|
||||
--pst-font-family-monospace-system: "SFMono-Regular", Menlo, Consolas, Monaco,
|
||||
Liberation Mono, Lucida Console, monospace;
|
||||
|
||||
--pst-font-family-base: var(--pst-font-family-base-system);
|
||||
--pst-font-family-heading: var(--pst-font-family-base);
|
||||
--pst-font-family-monospace: var(--pst-font-family-monospace-system);
|
||||
|
||||
/*****************************************************************************
|
||||
* Color
|
||||
*
|
||||
* Colors are defined in rgb string way, "red, green, blue"
|
||||
**/
|
||||
--pst-color-primary: 19, 6, 84;
|
||||
--pst-color-success: 40, 167, 69;
|
||||
--pst-color-info: 0, 123, 255; /*23, 162, 184;*/
|
||||
--pst-color-warning: 255, 193, 7;
|
||||
--pst-color-danger: 220, 53, 69;
|
||||
--pst-color-text-base: 51, 51, 51;
|
||||
|
||||
--pst-color-h1: var(--pst-color-primary);
|
||||
--pst-color-h2: var(--pst-color-primary);
|
||||
--pst-color-h3: var(--pst-color-text-base);
|
||||
--pst-color-h4: var(--pst-color-text-base);
|
||||
--pst-color-h5: var(--pst-color-text-base);
|
||||
--pst-color-h6: var(--pst-color-text-base);
|
||||
--pst-color-paragraph: var(--pst-color-text-base);
|
||||
--pst-color-link: 0, 91, 129;
|
||||
--pst-color-link-hover: 227, 46, 0;
|
||||
--pst-color-headerlink: 198, 15, 15;
|
||||
--pst-color-headerlink-hover: 255, 255, 255;
|
||||
--pst-color-preformatted-text: 34, 34, 34;
|
||||
--pst-color-preformatted-background: 250, 250, 250;
|
||||
--pst-color-inline-code: 232, 62, 140;
|
||||
|
||||
--pst-color-active-navigation: 19, 6, 84;
|
||||
--pst-color-navbar-link: 77, 77, 77;
|
||||
--pst-color-navbar-link-hover: var(--pst-color-active-navigation);
|
||||
--pst-color-navbar-link-active: var(--pst-color-active-navigation);
|
||||
--pst-color-sidebar-link: 77, 77, 77;
|
||||
--pst-color-sidebar-link-hover: var(--pst-color-active-navigation);
|
||||
--pst-color-sidebar-link-active: var(--pst-color-active-navigation);
|
||||
--pst-color-sidebar-expander-background-hover: 244, 244, 244;
|
||||
--pst-color-sidebar-caption: 77, 77, 77;
|
||||
--pst-color-toc-link: 119, 117, 122;
|
||||
--pst-color-toc-link-hover: var(--pst-color-active-navigation);
|
||||
--pst-color-toc-link-active: var(--pst-color-active-navigation);
|
||||
|
||||
/*****************************************************************************
|
||||
* Icon
|
||||
**/
|
||||
|
||||
/* font awesome icons*/
|
||||
--pst-icon-check-circle: '\f058';
|
||||
--pst-icon-info-circle: '\f05a';
|
||||
--pst-icon-exclamation-triangle: '\f071';
|
||||
--pst-icon-exclamation-circle: '\f06a';
|
||||
--pst-icon-times-circle: '\f057';
|
||||
--pst-icon-lightbulb: '\f0eb';
|
||||
|
||||
/*****************************************************************************
|
||||
* Admonitions
|
||||
**/
|
||||
|
||||
--pst-color-admonition-default: var(--pst-color-info);
|
||||
--pst-color-admonition-note: var(--pst-color-info);
|
||||
--pst-color-admonition-attention: var(--pst-color-warning);
|
||||
--pst-color-admonition-caution: var(--pst-color-warning);
|
||||
--pst-color-admonition-warning: var(--pst-color-warning);
|
||||
--pst-color-admonition-danger: var(--pst-color-danger);
|
||||
--pst-color-admonition-error: var(--pst-color-danger);
|
||||
--pst-color-admonition-hint: var(--pst-color-success);
|
||||
--pst-color-admonition-tip: var(--pst-color-success);
|
||||
--pst-color-admonition-important: var(--pst-color-success);
|
||||
|
||||
--pst-icon-admonition-default: var(--pst-icon-info-circle);
|
||||
--pst-icon-admonition-note: var(--pst-icon-info-circle);
|
||||
--pst-icon-admonition-attention: var(--pst-icon-exclamation-circle);
|
||||
--pst-icon-admonition-caution: var(--pst-icon-exclamation-triangle);
|
||||
--pst-icon-admonition-warning: var(--pst-icon-exclamation-triangle);
|
||||
--pst-icon-admonition-danger: var(--pst-icon-exclamation-triangle);
|
||||
--pst-icon-admonition-error: var(--pst-icon-times-circle);
|
||||
--pst-icon-admonition-hint: var(--pst-icon-lightbulb);
|
||||
--pst-icon-admonition-tip: var(--pst-icon-lightbulb);
|
||||
--pst-icon-admonition-important: var(--pst-icon-exclamation-circle);
|
||||
|
||||
}
|
||||
|
|
@ -1,321 +0,0 @@
|
|||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||
this.initOnKeyListeners();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated === 'undefined')
|
||||
return string;
|
||||
return (typeof translated === 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated === 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) === 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this === '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keydown(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box, textarea, dropdown or button
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
||||
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
|
||||
&& !event.shiftKey) {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1',
|
||||
LANGUAGE: 'zh',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
LINK_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: true
|
||||
};
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 286 B |
|
|
@ -1,19 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- Generator: Adobe Illustrator 23.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
|
||||
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
|
||||
viewBox="0 0 44.4 44.4" style="enable-background:new 0 0 44.4 44.4;" xml:space="preserve">
|
||||
<style type="text/css">
|
||||
.st0{fill:none;stroke:#F5A252;stroke-width:5;stroke-miterlimit:10;}
|
||||
.st1{fill:none;stroke:#579ACA;stroke-width:5;stroke-miterlimit:10;}
|
||||
.st2{fill:none;stroke:#E66581;stroke-width:5;stroke-miterlimit:10;}
|
||||
</style>
|
||||
<title>logo</title>
|
||||
<g>
|
||||
<path class="st0" d="M33.9,6.4c3.6,3.9,3.4,9.9-0.5,13.5s-9.9,3.4-13.5-0.5s-3.4-9.9,0.5-13.5l0,0C24.2,2.4,30.2,2.6,33.9,6.4z"/>
|
||||
<path class="st1" d="M35.1,27.3c2.6,4.6,1.1,10.4-3.5,13c-4.6,2.6-10.4,1.1-13-3.5s-1.1-10.4,3.5-13l0,0
|
||||
C26.6,21.2,32.4,22.7,35.1,27.3z"/>
|
||||
<path class="st2" d="M25.9,17.8c2.6,4.6,1.1,10.4-3.5,13s-10.4,1.1-13-3.5s-1.1-10.4,3.5-13l0,0C17.5,11.7,23.3,13.2,25.9,17.8z"/>
|
||||
<path class="st1" d="M19.2,26.4c3.1-4.3,9.1-5.2,13.3-2.1c1.1,0.8,2,1.8,2.7,3"/>
|
||||
<path class="st0" d="M19.9,19.4c-3.6-3.9-3.4-9.9,0.5-13.5s9.9-3.4,13.5,0.5"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
Before Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.4 KiB |
|
|
@ -1 +0,0 @@
|
|||
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" width="38.73" height="50" viewBox="0 0 38.73 50"><defs><style>.cls-1{fill:#767677;}.cls-2{fill:#f37726;}.cls-3{fill:#9e9e9e;}.cls-4{fill:#616262;}.cls-5{font-size:17.07px;fill:#fff;font-family:Roboto-Regular, Roboto;}</style></defs><title>logo_jupyterhub</title><g id="Canvas"><path id="path7_fill" data-name="path7 fill" class="cls-1" d="M39.51,3.53a3,3,0,0,1-1.7,2.9A3,3,0,0,1,34.48,6a3,3,0,0,1-.82-3.26,3,3,0,0,1,1.05-1.41A3,3,0,0,1,37.52.86a2.88,2.88,0,0,1,1,.6,3,3,0,0,1,.7.93,3.18,3.18,0,0,1,.28,1.14Z" transform="translate(-1.87 -0.69)"/><path id="path8_fill" data-name="path8 fill" class="cls-2" d="M21.91,38.39c-8,0-15.06-2.87-18.7-7.12a19.93,19.93,0,0,0,37.39,0C37,35.52,30,38.39,21.91,38.39Z" transform="translate(-1.87 -0.69)"/><path id="path9_fill" data-name="path9 fill" class="cls-2" d="M21.91,10.78c8,0,15.05,2.87,18.69,7.12a19.93,19.93,0,0,0-37.39,0C6.85,13.64,13.86,10.78,21.91,10.78Z" transform="translate(-1.87 -0.69)"/><path id="path10_fill" data-name="path10 fill" class="cls-3" d="M10.88,46.66a3.86,3.86,0,0,1-.52,2.15,3.81,3.81,0,0,1-1.62,1.51,3.93,3.93,0,0,1-2.19.34,3.79,3.79,0,0,1-2-.94,3.73,3.73,0,0,1-1.14-1.9,3.79,3.79,0,0,1,.1-2.21,3.86,3.86,0,0,1,1.33-1.78,3.92,3.92,0,0,1,3.54-.53,3.85,3.85,0,0,1,2.14,1.93,3.74,3.74,0,0,1,.37,1.43Z" transform="translate(-1.87 -0.69)"/><path id="path11_fill" data-name="path11 fill" class="cls-4" d="M4.12,9.81A2.18,2.18,0,0,1,2.9,9.48a2.23,2.23,0,0,1-.84-1A2.26,2.26,0,0,1,1.9,7.26a2.13,2.13,0,0,1,.56-1.13,2.18,2.18,0,0,1,2.36-.56,2.13,2.13,0,0,1,1,.76,2.18,2.18,0,0,1,.42,1.2A2.22,2.22,0,0,1,4.12,9.81Z" transform="translate(-1.87 -0.69)"/></g><text class="cls-5" transform="translate(5.24 30.01)">Hub</text></svg>
|
||||
|
Before Width: | Height: | Size: 1.7 KiB |
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,297 +0,0 @@
|
|||
/*
|
||||
* language_data.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
|
||||
|
||||
|
||||
/* Non-minified version is copied as a separate JS file, is available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
var Stemmer = function() {
|
||||
|
||||
var step2list = {
|
||||
ational: 'ate',
|
||||
tional: 'tion',
|
||||
enci: 'ence',
|
||||
anci: 'ance',
|
||||
izer: 'ize',
|
||||
bli: 'ble',
|
||||
alli: 'al',
|
||||
entli: 'ent',
|
||||
eli: 'e',
|
||||
ousli: 'ous',
|
||||
ization: 'ize',
|
||||
ation: 'ate',
|
||||
ator: 'ate',
|
||||
alism: 'al',
|
||||
iveness: 'ive',
|
||||
fulness: 'ful',
|
||||
ousness: 'ous',
|
||||
aliti: 'al',
|
||||
iviti: 'ive',
|
||||
biliti: 'ble',
|
||||
logi: 'log'
|
||||
};
|
||||
|
||||
var step3list = {
|
||||
icate: 'ic',
|
||||
ative: '',
|
||||
alize: 'al',
|
||||
iciti: 'ic',
|
||||
ical: 'ic',
|
||||
ful: '',
|
||||
ness: ''
|
||||
};
|
||||
|
||||
var c = "[^aeiou]"; // consonant
|
||||
var v = "[aeiouy]"; // vowel
|
||||
var C = c + "[^aeiouy]*"; // consonant sequence
|
||||
var V = v + "[aeiou]*"; // vowel sequence
|
||||
|
||||
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
|
||||
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
|
||||
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
|
||||
var s_v = "^(" + C + ")?" + v; // vowel in stem
|
||||
|
||||
this.stemWord = function (w) {
|
||||
var stem;
|
||||
var suffix;
|
||||
var firstch;
|
||||
var origword = w;
|
||||
|
||||
if (w.length < 3)
|
||||
return w;
|
||||
|
||||
var re;
|
||||
var re2;
|
||||
var re3;
|
||||
var re4;
|
||||
|
||||
firstch = w.substr(0,1);
|
||||
if (firstch == "y")
|
||||
w = firstch.toUpperCase() + w.substr(1);
|
||||
|
||||
// Step 1a
|
||||
re = /^(.+?)(ss|i)es$/;
|
||||
re2 = /^(.+?)([^s])s$/;
|
||||
|
||||
if (re.test(w))
|
||||
w = w.replace(re,"$1$2");
|
||||
else if (re2.test(w))
|
||||
w = w.replace(re2,"$1$2");
|
||||
|
||||
// Step 1b
|
||||
re = /^(.+?)eed$/;
|
||||
re2 = /^(.+?)(ed|ing)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(fp[1])) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1];
|
||||
re2 = new RegExp(s_v);
|
||||
if (re2.test(stem)) {
|
||||
w = stem;
|
||||
re2 = /(at|bl|iz)$/;
|
||||
re3 = new RegExp("([^aeiouylsz])\\1$");
|
||||
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re2.test(w))
|
||||
w = w + "e";
|
||||
else if (re3.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
else if (re4.test(w))
|
||||
w = w + "e";
|
||||
}
|
||||
}
|
||||
|
||||
// Step 1c
|
||||
re = /^(.+?)y$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(s_v);
|
||||
if (re.test(stem))
|
||||
w = stem + "i";
|
||||
}
|
||||
|
||||
// Step 2
|
||||
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step2list[suffix];
|
||||
}
|
||||
|
||||
// Step 3
|
||||
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
suffix = fp[2];
|
||||
re = new RegExp(mgr0);
|
||||
if (re.test(stem))
|
||||
w = stem + step3list[suffix];
|
||||
}
|
||||
|
||||
// Step 4
|
||||
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
|
||||
re2 = /^(.+?)(s|t)(ion)$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
if (re.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
else if (re2.test(w)) {
|
||||
var fp = re2.exec(w);
|
||||
stem = fp[1] + fp[2];
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re2.test(stem))
|
||||
w = stem;
|
||||
}
|
||||
|
||||
// Step 5
|
||||
re = /^(.+?)e$/;
|
||||
if (re.test(w)) {
|
||||
var fp = re.exec(w);
|
||||
stem = fp[1];
|
||||
re = new RegExp(mgr1);
|
||||
re2 = new RegExp(meq1);
|
||||
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
|
||||
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
|
||||
w = stem;
|
||||
}
|
||||
re = /ll$/;
|
||||
re2 = new RegExp(mgr1);
|
||||
if (re.test(w) && re2.test(w)) {
|
||||
re = /.$/;
|
||||
w = w.replace(re,"");
|
||||
}
|
||||
|
||||
// and turn initial Y back to y
|
||||
if (firstch == "y")
|
||||
w = firstch.toLowerCase() + w.substr(1);
|
||||
return w;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
var splitChars = (function() {
|
||||
var result = {};
|
||||
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
|
||||
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
|
||||
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
|
||||
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
|
||||
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
|
||||
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
|
||||
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
|
||||
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
|
||||
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
|
||||
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
|
||||
var i, j, start, end;
|
||||
for (i = 0; i < singles.length; i++) {
|
||||
result[singles[i]] = true;
|
||||
}
|
||||
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
|
||||
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
|
||||
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
|
||||
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
|
||||
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
|
||||
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
|
||||
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
|
||||
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
|
||||
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
|
||||
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
|
||||
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
|
||||
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
|
||||
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
|
||||
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
|
||||
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
|
||||
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
|
||||
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
|
||||
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
|
||||
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
|
||||
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
|
||||
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
|
||||
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
|
||||
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
|
||||
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
|
||||
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
|
||||
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
|
||||
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
|
||||
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
|
||||
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
|
||||
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
|
||||
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
|
||||
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
|
||||
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
|
||||
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
|
||||
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
|
||||
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
|
||||
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
|
||||
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
|
||||
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
|
||||
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
|
||||
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
|
||||
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
|
||||
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
|
||||
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
|
||||
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
|
||||
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
|
||||
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
|
||||
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
|
||||
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
|
||||
for (i = 0; i < ranges.length; i++) {
|
||||
start = ranges[i][0];
|
||||
end = ranges[i][1];
|
||||
for (j = start; j <= end; j++) {
|
||||
result[j] = true;
|
||||
}
|
||||
}
|
||||
return result;
|
||||
})();
|
||||
|
||||
function splitQuery(query) {
|
||||
var result = [];
|
||||
var start = -1;
|
||||
for (var i = 0; i < query.length; i++) {
|
||||
if (splitChars[query.charCodeAt(i)]) {
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start, i));
|
||||
start = -1;
|
||||
}
|
||||
} else if (start === -1) {
|
||||
start = i;
|
||||
}
|
||||
}
|
||||
if (start !== -1) {
|
||||
result.push(query.slice(start));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
|
|
@ -1,183 +0,0 @@
|
|||
/* Whole cell */
|
||||
div.container.cell {
|
||||
padding-left: 0;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
/* Removing all background formatting so we can control at the div level */
|
||||
.cell_input div.highlight, .cell_input pre, .cell_output .output * {
|
||||
border: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
.cell_output .output pre, .cell_input pre {
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
/* Input cells */
|
||||
div.cell div.cell_input {
|
||||
padding-left: 0em;
|
||||
padding-right: 0em;
|
||||
border: 1px #ccc solid;
|
||||
background-color: #f7f7f7;
|
||||
border-left-color: green;
|
||||
border-left-width: medium;
|
||||
}
|
||||
|
||||
div.cell_input > div, div.cell_output div.output > div.highlight {
|
||||
margin: 0em !important;
|
||||
border: none !important;
|
||||
}
|
||||
|
||||
/* All cell outputs */
|
||||
.cell_output {
|
||||
padding-left: 1em;
|
||||
padding-right: 0em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
/* Outputs from jupyter_sphinx overrides to remove extra CSS */
|
||||
div.section div.jupyter_container {
|
||||
padding: .4em;
|
||||
margin: 0 0 .4em 0;
|
||||
background-color: none;
|
||||
border: none;
|
||||
-moz-box-shadow: none;
|
||||
-webkit-box-shadow: none;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
/* Text outputs from cells */
|
||||
.cell_output .output.text_plain,
|
||||
.cell_output .output.traceback,
|
||||
.cell_output .output.stream,
|
||||
.cell_output .output.stderr
|
||||
{
|
||||
background: #fcfcfc;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 0em;
|
||||
box-shadow: none;
|
||||
}
|
||||
|
||||
.cell_output .output.text_plain,
|
||||
.cell_output .output.stream,
|
||||
.cell_output .output.stderr {
|
||||
border: 1px solid #f7f7f7;
|
||||
}
|
||||
|
||||
.cell_output .output.stderr {
|
||||
background: #fdd;
|
||||
}
|
||||
|
||||
.cell_output .output.traceback {
|
||||
border: 1px solid #ffd6d6;
|
||||
}
|
||||
|
||||
/* Math align to the left */
|
||||
.cell_output .MathJax_Display {
|
||||
text-align: left !important;
|
||||
}
|
||||
|
||||
/* Pandas tables. Pulled from the Jupyter / nbsphinx CSS */
|
||||
div.cell_output table {
|
||||
border: none;
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
color: black;
|
||||
font-size: 1em;
|
||||
table-layout: fixed;
|
||||
}
|
||||
div.cell_output thead {
|
||||
border-bottom: 1px solid black;
|
||||
vertical-align: bottom;
|
||||
}
|
||||
div.cell_output tr,
|
||||
div.cell_output th,
|
||||
div.cell_output td {
|
||||
text-align: right;
|
||||
vertical-align: middle;
|
||||
padding: 0.5em 0.5em;
|
||||
line-height: normal;
|
||||
white-space: normal;
|
||||
max-width: none;
|
||||
border: none;
|
||||
}
|
||||
div.cell_output th {
|
||||
font-weight: bold;
|
||||
}
|
||||
div.cell_output tbody tr:nth-child(odd) {
|
||||
background: #f5f5f5;
|
||||
}
|
||||
div.cell_output tbody tr:hover {
|
||||
background: rgba(66, 165, 245, 0.2);
|
||||
}
|
||||
|
||||
|
||||
/* Inline text from `paste` operation */
|
||||
|
||||
span.pasted-text {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
span.pasted-inline img {
|
||||
max-height: 2em;
|
||||
}
|
||||
|
||||
tbody span.pasted-inline img {
|
||||
max-height: none;
|
||||
}
|
||||
|
||||
/* Font colors for translated ANSI escape sequences
|
||||
Color values are adapted from share/jupyter/nbconvert/templates/classic/static/style.css
|
||||
*/
|
||||
div.highlight .-Color-Bold {
|
||||
font-weight: bold;
|
||||
}
|
||||
div.highlight .-Color[class*=-Black] {
|
||||
color :#3E424D
|
||||
}
|
||||
div.highlight .-Color[class*=-Red] {
|
||||
color: #E75C58
|
||||
}
|
||||
div.highlight .-Color[class*=-Green] {
|
||||
color: #00A250
|
||||
}
|
||||
div.highlight .-Color[class*=-Yellow] {
|
||||
color: yellow
|
||||
}
|
||||
div.highlight .-Color[class*=-Blue] {
|
||||
color: #208FFB
|
||||
}
|
||||
div.highlight .-Color[class*=-Magenta] {
|
||||
color: #D160C4
|
||||
}
|
||||
div.highlight .-Color[class*=-Cyan] {
|
||||
color: #60C6C8
|
||||
}
|
||||
div.highlight .-Color[class*=-White] {
|
||||
color: #C5C1B4
|
||||
}
|
||||
div.highlight .-Color[class*=-BGBlack] {
|
||||
background-color: #3E424D
|
||||
}
|
||||
div.highlight .-Color[class*=-BGRed] {
|
||||
background-color: #E75C58
|
||||
}
|
||||
div.highlight .-Color[class*=-BGGreen] {
|
||||
background-color: #00A250
|
||||
}
|
||||
div.highlight .-Color[class*=-BGYellow] {
|
||||
background-color: yellow
|
||||
}
|
||||
div.highlight .-Color[class*=-BGBlue] {
|
||||
background-color: #208FFB
|
||||
}
|
||||
div.highlight .-Color[class*=-BGMagenta] {
|
||||
background-color: #D160C4
|
||||
}
|
||||
div.highlight .-Color[class*=-BGCyan] {
|
||||
background-color: #60C6C8
|
||||
}
|
||||
div.highlight .-Color[class*=-BGWhite] {
|
||||
background-color: #C5C1B4
|
||||
}
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
/*
|
||||
* plot_directive.css
|
||||
* ~~~~~~~~~~~~
|
||||
*
|
||||
* Stylesheet controlling images created using the `plot` directive within
|
||||
* Sphinx.
|
||||
*
|
||||
* :copyright: Copyright 2020-* by the Matplotlib development team.
|
||||
* :license: Matplotlib, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
img.plot-directive {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 90 B |
|
|
@ -1,82 +0,0 @@
|
|||
pre { line-height: 125%; }
|
||||
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
|
||||
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
|
||||
.highlight .hll { background-color: #ffffcc }
|
||||
.highlight { background: #f8f8f8; }
|
||||
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
|
||||
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
|
||||
.highlight .g { color: #000000 } /* Generic */
|
||||
.highlight .k { color: #204a87; font-weight: bold } /* Keyword */
|
||||
.highlight .l { color: #000000 } /* Literal */
|
||||
.highlight .n { color: #000000 } /* Name */
|
||||
.highlight .o { color: #ce5c00; font-weight: bold } /* Operator */
|
||||
.highlight .x { color: #000000 } /* Other */
|
||||
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
|
||||
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
|
||||
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
|
||||
.highlight .cp { color: #8f5902; font-style: italic } /* Comment.Preproc */
|
||||
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
|
||||
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
|
||||
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
|
||||
.highlight .gd { color: #a40000 } /* Generic.Deleted */
|
||||
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
|
||||
.highlight .gr { color: #ef2929 } /* Generic.Error */
|
||||
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
||||
.highlight .gi { color: #00A000 } /* Generic.Inserted */
|
||||
.highlight .go { color: #000000; font-style: italic } /* Generic.Output */
|
||||
.highlight .gp { color: #8f5902 } /* Generic.Prompt */
|
||||
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
|
||||
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
||||
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
|
||||
.highlight .kc { color: #204a87; font-weight: bold } /* Keyword.Constant */
|
||||
.highlight .kd { color: #204a87; font-weight: bold } /* Keyword.Declaration */
|
||||
.highlight .kn { color: #204a87; font-weight: bold } /* Keyword.Namespace */
|
||||
.highlight .kp { color: #204a87; font-weight: bold } /* Keyword.Pseudo */
|
||||
.highlight .kr { color: #204a87; font-weight: bold } /* Keyword.Reserved */
|
||||
.highlight .kt { color: #204a87; font-weight: bold } /* Keyword.Type */
|
||||
.highlight .ld { color: #000000 } /* Literal.Date */
|
||||
.highlight .m { color: #0000cf; font-weight: bold } /* Literal.Number */
|
||||
.highlight .s { color: #4e9a06 } /* Literal.String */
|
||||
.highlight .na { color: #c4a000 } /* Name.Attribute */
|
||||
.highlight .nb { color: #204a87 } /* Name.Builtin */
|
||||
.highlight .nc { color: #000000 } /* Name.Class */
|
||||
.highlight .no { color: #000000 } /* Name.Constant */
|
||||
.highlight .nd { color: #5c35cc; font-weight: bold } /* Name.Decorator */
|
||||
.highlight .ni { color: #ce5c00 } /* Name.Entity */
|
||||
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
|
||||
.highlight .nf { color: #000000 } /* Name.Function */
|
||||
.highlight .nl { color: #f57900 } /* Name.Label */
|
||||
.highlight .nn { color: #000000 } /* Name.Namespace */
|
||||
.highlight .nx { color: #000000 } /* Name.Other */
|
||||
.highlight .py { color: #000000 } /* Name.Property */
|
||||
.highlight .nt { color: #204a87; font-weight: bold } /* Name.Tag */
|
||||
.highlight .nv { color: #000000 } /* Name.Variable */
|
||||
.highlight .ow { color: #204a87; font-weight: bold } /* Operator.Word */
|
||||
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
|
||||
.highlight .mb { color: #0000cf; font-weight: bold } /* Literal.Number.Bin */
|
||||
.highlight .mf { color: #0000cf; font-weight: bold } /* Literal.Number.Float */
|
||||
.highlight .mh { color: #0000cf; font-weight: bold } /* Literal.Number.Hex */
|
||||
.highlight .mi { color: #0000cf; font-weight: bold } /* Literal.Number.Integer */
|
||||
.highlight .mo { color: #0000cf; font-weight: bold } /* Literal.Number.Oct */
|
||||
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
|
||||
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
|
||||
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
|
||||
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
|
||||
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
|
||||
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
|
||||
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
|
||||
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
|
||||
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
|
||||
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
|
||||
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
|
||||
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
|
||||
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
|
||||
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
|
||||
.highlight .fm { color: #000000 } /* Name.Function.Magic */
|
||||
.highlight .vc { color: #000000 } /* Name.Variable.Class */
|
||||
.highlight .vg { color: #000000 } /* Name.Variable.Global */
|
||||
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
|
||||
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
|
||||
.highlight .il { color: #0000cf; font-weight: bold } /* Literal.Number.Integer.Long */
|
||||
|
|
@ -1,522 +0,0 @@
|
|||
/*
|
||||
* searchtools.js
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
if (!Scorer) {
|
||||
/**
|
||||
* Simple result scoring code.
|
||||
*/
|
||||
var Scorer = {
|
||||
// Implement the following function to further tweak the score for each result
|
||||
// The function takes a result array [filename, title, anchor, descr, score]
|
||||
// and returns the new score.
|
||||
/*
|
||||
score: function(result) {
|
||||
return result[4];
|
||||
},
|
||||
*/
|
||||
|
||||
// query matches the full name of an object
|
||||
objNameMatch: 11,
|
||||
// or matches in the last dotted part of the object name
|
||||
objPartialMatch: 6,
|
||||
// Additive scores depending on the priority of the object
|
||||
objPrio: {0: 15, // used to be importantResults
|
||||
1: 5, // used to be objectResults
|
||||
2: -5}, // used to be unimportantResults
|
||||
// Used when the priority is not in the mapping.
|
||||
objPrioDefault: 0,
|
||||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
if (!splitQuery) {
|
||||
function splitQuery(query) {
|
||||
return query.split(/\s+/);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search Module
|
||||
*/
|
||||
var Search = {
|
||||
|
||||
_index : null,
|
||||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var virtualDocument = document.implementation.createHTMLDocument('virtual');
|
||||
var htmlElement = $(htmlString, virtualDocument);
|
||||
htmlElement.find('.headerlink').remove();
|
||||
docContent = htmlElement.find('[role=main]')[0];
|
||||
if(docContent === undefined) {
|
||||
console.warn("Content block not found. Sphinx search tries to obtain it " +
|
||||
"via '[role=main]'. Could you check your theme or template.");
|
||||
return "";
|
||||
}
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
var query = params.q[0];
|
||||
$('input[name="q"]')[0].value = query;
|
||||
this.performSearch(query);
|
||||
}
|
||||
},
|
||||
|
||||
loadIndex : function(url) {
|
||||
$.ajax({type: "GET", url: url, data: null,
|
||||
dataType: "script", cache: true,
|
||||
complete: function(jqxhr, textstatus) {
|
||||
if (textstatus != "success") {
|
||||
document.getElementById("searchindexloader").src = url;
|
||||
}
|
||||
}});
|
||||
},
|
||||
|
||||
setIndex : function(index) {
|
||||
var q;
|
||||
this._index = index;
|
||||
if ((q = this._queued_query) !== null) {
|
||||
this._queued_query = null;
|
||||
Search.query(q);
|
||||
}
|
||||
},
|
||||
|
||||
hasIndex : function() {
|
||||
return this._index !== null;
|
||||
},
|
||||
|
||||
deferQuery : function(query) {
|
||||
this._queued_query = query;
|
||||
},
|
||||
|
||||
stopPulse : function() {
|
||||
this._pulse_status = 0;
|
||||
},
|
||||
|
||||
startPulse : function() {
|
||||
if (this._pulse_status >= 0)
|
||||
return;
|
||||
function pulse() {
|
||||
var i;
|
||||
Search._pulse_status = (Search._pulse_status + 1) % 4;
|
||||
var dotString = '';
|
||||
for (i = 0; i < Search._pulse_status; i++)
|
||||
dotString += '.';
|
||||
Search.dots.text(dotString);
|
||||
if (Search._pulse_status > -1)
|
||||
window.setTimeout(pulse, 500);
|
||||
}
|
||||
pulse();
|
||||
},
|
||||
|
||||
/**
|
||||
* perform a search for something (or wait until index is loaded)
|
||||
*/
|
||||
performSearch : function(query) {
|
||||
// create the required interface elements
|
||||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
this.startPulse();
|
||||
|
||||
// index already loaded, the browser was quick!
|
||||
if (this.hasIndex())
|
||||
this.query(query);
|
||||
else
|
||||
this.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query : function(query) {
|
||||
var i;
|
||||
|
||||
// stem the searchterms and add them to the correct list
|
||||
var stemmer = new Stemmer();
|
||||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = splitQuery(query);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
// stem the word
|
||||
var word = stemmer.stemWord(tmp[i].toLowerCase());
|
||||
// prevent stemmer from cutting word smaller than two chars
|
||||
if(word.length < 3 && tmp[i].length >= 3) {
|
||||
word = tmp[i];
|
||||
}
|
||||
var toAppend;
|
||||
// select the correct list
|
||||
if (word[0] == '-') {
|
||||
toAppend = excluded;
|
||||
word = word.substr(1);
|
||||
}
|
||||
else {
|
||||
toAppend = searchterms;
|
||||
hlterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
// only add if not already in the list
|
||||
if (!$u.contains(toAppend, word))
|
||||
toAppend.push(word);
|
||||
}
|
||||
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
|
||||
|
||||
// console.debug('SEARCH: searching for:');
|
||||
// console.info('required: ', searchterms);
|
||||
// console.info('excluded: ', excluded);
|
||||
|
||||
// prepare search
|
||||
var terms = this._index.terms;
|
||||
var titleterms = this._index.titleterms;
|
||||
|
||||
// array of [filename, title, anchor, descr, score]
|
||||
var results = [];
|
||||
$('#search-progress').empty();
|
||||
|
||||
// lookup as object
|
||||
for (i = 0; i < objectterms.length; i++) {
|
||||
var others = [].concat(objectterms.slice(0, i),
|
||||
objectterms.slice(i+1, objectterms.length));
|
||||
results = results.concat(this.performObjectSearch(objectterms[i], others));
|
||||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
for (i = 0; i < results.length; i++)
|
||||
results[i][4] = Scorer.score(results[i]);
|
||||
}
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort(function(a, b) {
|
||||
var left = a[4];
|
||||
var right = b[4];
|
||||
if (left > right) {
|
||||
return 1;
|
||||
} else if (left < right) {
|
||||
return -1;
|
||||
} else {
|
||||
// same score: sort alphabetically
|
||||
left = a[1].toLowerCase();
|
||||
right = b[1].toLowerCase();
|
||||
return (left > right) ? -1 : ((left < right) ? 1 : 0);
|
||||
}
|
||||
});
|
||||
|
||||
// for debugging
|
||||
//Search.lastresults = results.slice(); // a copy
|
||||
//console.info('search results:', Search.lastresults);
|
||||
|
||||
// print the results
|
||||
var resultCount = results.length;
|
||||
function displayNextItem() {
|
||||
// results left, load the summary and display it
|
||||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li></li>');
|
||||
var requestUrl = "";
|
||||
var linkUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
dirname = dirname.substring(0, dirname.length-6);
|
||||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||
linkUrl = requestUrl;
|
||||
|
||||
} else {
|
||||
// normal html builders
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
linkUrl +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
}});
|
||||
} else {
|
||||
// no source available, just display title
|
||||
Search.output.append(listItem);
|
||||
setTimeout(function() {
|
||||
displayNextItem();
|
||||
}, 5);
|
||||
}
|
||||
}
|
||||
// search finished, update title and status message
|
||||
else {
|
||||
Search.stopPulse();
|
||||
Search.title.text(_('Search Results'));
|
||||
if (!resultCount)
|
||||
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
|
||||
else
|
||||
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
|
||||
Search.status.fadeIn(500);
|
||||
}
|
||||
}
|
||||
displayNextItem();
|
||||
},
|
||||
|
||||
/**
|
||||
* search for object names
|
||||
*/
|
||||
performObjectSearch : function(object, otherterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var docnames = this._index.docnames;
|
||||
var objects = this._index.objects;
|
||||
var objnames = this._index.objnames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i;
|
||||
var results = [];
|
||||
|
||||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
var fullnameLower = fullname.toLowerCase()
|
||||
if (fullnameLower.indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullnameLower.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
score += Scorer.objPartialMatch;
|
||||
}
|
||||
var match = objects[prefix][name];
|
||||
var objname = objnames[match[1]][2];
|
||||
var title = titles[match[0]];
|
||||
// If more than one term searched for, we require other words to be
|
||||
// found in the name/title/description
|
||||
if (otherterms.length > 0) {
|
||||
var haystack = (prefix + ' ' + name + ' ' +
|
||||
objname + ' ' + title).toLowerCase();
|
||||
var allfound = true;
|
||||
for (i = 0; i < otherterms.length; i++) {
|
||||
if (haystack.indexOf(otherterms[i]) == -1) {
|
||||
allfound = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!allfound) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
var descr = objname + _(', in ') + title;
|
||||
|
||||
var anchor = match[3];
|
||||
if (anchor === '')
|
||||
anchor = fullname;
|
||||
else if (anchor == '-')
|
||||
anchor = objnames[match[1]][1] + '-' + fullname;
|
||||
// add custom score for some objects according to scorer
|
||||
if (Scorer.objPrio.hasOwnProperty(match[2])) {
|
||||
score += Scorer.objPrio[match[2]];
|
||||
} else {
|
||||
score += Scorer.objPrioDefault;
|
||||
}
|
||||
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
|
||||
*/
|
||||
escapeRegExp : function(string) {
|
||||
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
},
|
||||
|
||||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var docnames = this._index.docnames;
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
var word_regex = this.escapeRegExp(word);
|
||||
for (var w in terms) {
|
||||
if (w.match(word_regex) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word_regex) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {};
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap && fileMap[file].indexOf(word) === -1)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
}
|
||||
}
|
||||
|
||||
// now check if the files don't contain excluded terms
|
||||
for (file in fileMap) {
|
||||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
searchterms.filter(function(term){return term.length > 2}).length
|
||||
if (
|
||||
fileMap[file].length != searchterms.length &&
|
||||
fileMap[file].length != filteredTermCount
|
||||
) continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
|
||||
}
|
||||
}
|
||||
return results;
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
var i = textLower.indexOf(this.toLowerCase());
|
||||
if (i > -1)
|
||||
start = i;
|
||||
});
|
||||
start = Math.max(start - 120, 0);
|
||||
var excerpt = ((start > 0) ? '...' : '') +
|
||||
$.trim(text.substr(start, 240)) +
|
||||
((start + 240 - text.length) ? '...' : '');
|
||||
var rv = $('<div class="context"></div>').text(excerpt);
|
||||
$.each(hlwords, function() {
|
||||
rv = rv.highlightText(this, 'highlighted');
|
||||
});
|
||||
return rv;
|
||||
}
|
||||
};
|
||||
|
||||
$(document).ready(function() {
|
||||
Search.init();
|
||||
});
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
var initTriggerNavBar=()=>{if($(window).width()<768){$("#navbar-toggler").trigger("click")}}
|
||||
var scrollToActive=()=>{var navbar=document.getElementById('site-navigation')
|
||||
var active_pages=navbar.querySelectorAll(".active")
|
||||
var active_page=active_pages[active_pages.length-1]
|
||||
if(active_page!==undefined&&active_page.offsetTop>($(window).height()*.5)){navbar.scrollTop=active_page.offsetTop-($(window).height()*.2)}}
|
||||
var sbRunWhenDOMLoaded=cb=>{if(document.readyState!='loading'){cb()}else if(document.addEventListener){document.addEventListener('DOMContentLoaded',cb)}else{document.attachEvent('onreadystatechange',function(){if(document.readyState=='complete')cb()})}}
|
||||
function toggleFullScreen(){var navToggler=$("#navbar-toggler");if(!document.fullscreenElement){document.documentElement.requestFullscreen();if(!navToggler.hasClass("collapsed")){navToggler.click();}}else{if(document.exitFullscreen){document.exitFullscreen();if(navToggler.hasClass("collapsed")){navToggler.click();}}}}
|
||||
var initTooltips=()=>{$(document).ready(function(){$('[data-toggle="tooltip"]').tooltip();});}
|
||||
var initTocHide=()=>{var scrollTimeout;var throttle=200;var tocHeight=$("#bd-toc-nav").outerHeight(true)+$(".bd-toc").outerHeight(true);var hideTocAfter=tocHeight+200;var checkTocScroll=function(){var margin_content=$(".margin, .tag_margin, .full-width, .full_width, .tag_full-width, .tag_full_width, .sidebar, .tag_sidebar, .popout, .tag_popout");margin_content.each((index,item)=>{var topOffset=$(item).offset().top-$(window).scrollTop();var bottomOffset=topOffset+$(item).outerHeight(true);var topOverlaps=((topOffset>=0)&&(topOffset<hideTocAfter));var bottomOverlaps=((bottomOffset>=0)&&(bottomOffset<hideTocAfter));var removeToc=(topOverlaps||bottomOverlaps);if(removeToc&&window.pageYOffset>20){$("div.bd-toc").removeClass("show")
|
||||
return false}else{$("div.bd-toc").addClass("show")};})};var manageScrolledClassOnBody=function(){if(window.scrollY>0){document.body.classList.add("scrolled");}else{document.body.classList.remove("scrolled");}}
|
||||
$(window).on('scroll',function(){if(!scrollTimeout){scrollTimeout=setTimeout(function(){checkTocScroll();manageScrolledClassOnBody();scrollTimeout=null;},throttle);}});}
|
||||
var initThebeSBT=()=>{var title=$("div.section h1")[0]
|
||||
if(!$(title).next().hasClass("thebe-launch-button")){$("<button class='thebe-launch-button'></button>").insertAfter($(title))}
|
||||
initThebe();}
|
||||
sbRunWhenDOMLoaded(initTooltips)
|
||||
sbRunWhenDOMLoaded(initTriggerNavBar)
|
||||
sbRunWhenDOMLoaded(scrollToActive)
|
||||
sbRunWhenDOMLoaded(initTocHide)
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,90 +0,0 @@
|
|||
/* Visibility of the target */
|
||||
.toggle, div.admonition.toggle .admonition-title ~ * {
|
||||
transition: opacity .5s, height .5s;
|
||||
}
|
||||
|
||||
.toggle-hidden:not(.admonition) {
|
||||
visibility: hidden;
|
||||
opacity: 0;
|
||||
height: 1.5em;
|
||||
margin: 0px;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
/* Overrides for admonition toggles */
|
||||
|
||||
/* Titles should cut off earlier to avoid overlapping w/ button */
|
||||
div.admonition.toggle p.admonition-title {
|
||||
padding-right: 25%;
|
||||
}
|
||||
|
||||
/* hides all the content of a page until de-toggled */
|
||||
div.admonition.toggle-hidden .admonition-title ~ * {
|
||||
height: 0;
|
||||
margin: 0;
|
||||
float: left; /* so they overlap when hidden */
|
||||
opacity: 0;
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
/* Toggle buttons inside admonitions so we see the title */
|
||||
.toggle.admonition {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.toggle.admonition.admonition-title:after {
|
||||
content: "" !important;
|
||||
}
|
||||
|
||||
/* Note, we'll over-ride this in sphinx-book-theme */
|
||||
.toggle.admonition button.toggle-button {
|
||||
margin-right: 0.5em;
|
||||
right: 0em;
|
||||
position: absolute;
|
||||
top: .2em;
|
||||
}
|
||||
|
||||
/* General button style */
|
||||
button.toggle-button {
|
||||
background: #999;
|
||||
border: none;
|
||||
z-index: 100;
|
||||
right: -2.5em;
|
||||
margin-left: -2.5em; /* A hack to keep code blocks from being pushed left */
|
||||
position: relative;
|
||||
float: right;
|
||||
border-radius: 100%;
|
||||
width: 1.5em;
|
||||
height: 1.5em;
|
||||
padding: 0px;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
button.toggle-button.toggle-button-hidden:before {
|
||||
content: "Click to show";
|
||||
position: absolute;
|
||||
font-size: .8em;
|
||||
left: -6.5em;
|
||||
bottom: .4em;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/* Plus / minus toggles */
|
||||
.toggle-button .bar {
|
||||
background-color: white;
|
||||
position: absolute;
|
||||
left: 15%;
|
||||
top: 43%;
|
||||
width: 16px;
|
||||
height: 3px;
|
||||
}
|
||||
|
||||
.toggle-button .vertical {
|
||||
transition: all 0.25s ease-in-out;
|
||||
transform-origin: center;
|
||||
}
|
||||
|
||||
.toggle-button-hidden .vertical {
|
||||
transform: rotate(-90deg);
|
||||
}
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
var initToggleItems = () => {
|
||||
var itemsToToggle = document.querySelectorAll(togglebuttonSelector);
|
||||
console.log(itemsToToggle, togglebuttonSelector)
|
||||
// Add the button to each admonition and hook up a callback to toggle visibility
|
||||
itemsToToggle.forEach((item, index) => {
|
||||
var toggleID = `toggle-${index}`;
|
||||
var buttonID = `button-${toggleID}`;
|
||||
var collapseButton = `
|
||||
<button id="${buttonID}" class="toggle-button" data-target="${toggleID}" data-button="${buttonID}">
|
||||
<div class="bar horizontal" data-button="${buttonID}"></div>
|
||||
<div class="bar vertical" data-button="${buttonID}"></div>
|
||||
</button>`;
|
||||
|
||||
item.setAttribute('id', toggleID);
|
||||
|
||||
if (!item.classList.contains("toggle")){
|
||||
item.classList.add("toggle");
|
||||
}
|
||||
|
||||
// If it's an admonition block, then we'll add the button inside
|
||||
if (item.classList.contains("admonition")) {
|
||||
item.insertAdjacentHTML("afterbegin", collapseButton);
|
||||
} else {
|
||||
item.insertAdjacentHTML('beforebegin', collapseButton);
|
||||
}
|
||||
|
||||
thisButton = $(`#${buttonID}`);
|
||||
thisButton.on('click', toggleClickHandler);
|
||||
if (!item.classList.contains("toggle-shown")) {
|
||||
toggleHidden(thisButton[0]);
|
||||
}
|
||||
})
|
||||
};
|
||||
|
||||
// This should simply add / remove the collapsed class and change the button text
|
||||
var toggleHidden = (button) => {
|
||||
target = button.dataset['target']
|
||||
var itemToToggle = document.getElementById(target);
|
||||
if (itemToToggle.classList.contains("toggle-hidden")) {
|
||||
itemToToggle.classList.remove("toggle-hidden");
|
||||
button.classList.remove("toggle-button-hidden");
|
||||
} else {
|
||||
itemToToggle.classList.add("toggle-hidden");
|
||||
button.classList.add("toggle-button-hidden");
|
||||
}
|
||||
}
|
||||
|
||||
var toggleClickHandler = (click) => {
|
||||
button = document.getElementById(click.target.dataset['button']);
|
||||
toggleHidden(button);
|
||||
}
|
||||
|
||||
// If we want to blanket-add toggle classes to certain cells
|
||||
var addToggleToSelector = () => {
|
||||
const selector = "";
|
||||
if (selector.length > 0) {
|
||||
document.querySelectorAll(selector).forEach((item) => {
|
||||
item.classList.add("toggle");
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// Helper function to run when the DOM is finished
|
||||
const sphinxToggleRunWhenDOMLoaded = cb => {
|
||||
if (document.readyState != 'loading') {
|
||||
cb()
|
||||
} else if (document.addEventListener) {
|
||||
document.addEventListener('DOMContentLoaded', cb)
|
||||
} else {
|
||||
document.attachEvent('onreadystatechange', function() {
|
||||
if (document.readyState == 'complete') cb()
|
||||
})
|
||||
}
|
||||
}
|
||||
sphinxToggleRunWhenDOMLoaded(addToggleToSelector)
|
||||
sphinxToggleRunWhenDOMLoaded(initToggleItems)
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
|
@ -1,34 +0,0 @@
|
|||
Font Awesome Free License
|
||||
-------------------------
|
||||
|
||||
Font Awesome Free is free, open source, and GPL friendly. You can use it for
|
||||
commercial projects, open source projects, or really almost whatever you want.
|
||||
Full Font Awesome Free license: https://fontawesome.com/license/free.
|
||||
|
||||
# Icons: CC BY 4.0 License (https://creativecommons.org/licenses/by/4.0/)
|
||||
In the Font Awesome Free download, the CC BY 4.0 license applies to all icons
|
||||
packaged as SVG and JS file types.
|
||||
|
||||
# Fonts: SIL OFL 1.1 License (https://scripts.sil.org/OFL)
|
||||
In the Font Awesome Free download, the SIL OFL license applies to all icons
|
||||
packaged as web and desktop font files.
|
||||
|
||||
# Code: MIT License (https://opensource.org/licenses/MIT)
|
||||
In the Font Awesome Free download, the MIT license applies to all non-font and
|
||||
non-icon files.
|
||||
|
||||
# Attribution
|
||||
Attribution is required by MIT, SIL OFL, and CC BY licenses. Downloaded Font
|
||||
Awesome Free files already contain embedded comments with sufficient
|
||||
attribution, so you shouldn't need to do anything additional when using these
|
||||
files normally.
|
||||
|
||||
We've kept attribution comments terse, so we ask that you do not actively work
|
||||
to remove them from files, especially code. They're a great way for folks to
|
||||
learn about Font Awesome.
|
||||
|
||||
# Brand Icons
|
||||
All brand icons are trademarks of their respective owners. The use of these
|
||||
trademarks does not indicate endorsement of the trademark holder by Font
|
||||
Awesome, nor vice versa. **Please do not use brand logos for any purpose except
|
||||
to represent the company, product, or service to which they refer.**
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue