Commit 9186cc5398db5448b046b6f4fce2466b42d5ed3e
1 parent
e015f56cc3
Exists in
master
CM7
Showing 32 changed files with 4199 additions and 8 deletions
- chunks/doc-np-genfromtxt.md
- chunks/doc-np-mean.md
- chunks/doc-plt-annotate.md
- chunks/doc-plt-bar.md
- chunks/doc-plt-barh.md
- chunks/doc-plt-contour.md
- chunks/doc-plt-contourf.md
- chunks/doc-plt-grid.md
- chunks/doc-plt-hist.md
- chunks/doc-plt-imshow.md
- chunks/doc-plt-legend.md
- chunks/doc-plt-plot-show-savefig.md
- chunks/doc-plt-plot.md
- chunks/doc-plt-savefig.md
- chunks/doc-plt-scatter-and-many.md
- chunks/doc-plt-scatter.md
- chunks/doc-plt-show.md
- chunks/doc-plt-subplot.md
- chunks/doc-plt-text.md
- chunks/doc-plt-title.md
- chunks/doc-plt-xlabel.md
- chunks/doc-plt-xlim.md
- chunks/doc-plt-xscale.md
- chunks/doc-plt-xticks.md
- chunks/q/np-slice-shape-1.md
- chunks/q/np-slice-shape-2.md
- cours-07.html
- index.html
- media/numpy/broadcast-col.svg
- media/numpy/broadcast-row.svg
- media/numpy/broadcast-rowcol.svg
- media/numpy/broadcast-value.svg
chunks/doc-np-genfromtxt.md
View file @
9186cc5
| 1 | +## Charger des données avec `np.genfromtxt` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Premier paramètre : nom du fichier</li> | |
| 5 | +<li>Paramètre nommé <code>delimiter</code> : séparateur de colones (ex : <code>","</code>) | |
| 6 | +<li>Autres paramètres pour les cas plus avancés</li> | |
| 7 | +</ul> | |
| 8 | + | |
| 9 | +<div class='scroll'> | |
| 10 | +Python Library Documentation: function genfromtxt in numpy | |
| 11 | + | |
| 12 | +<dl><dt><a name="-numpy.genfromtxt"><strong>numpy.genfromtxt</strong></a> = genfromtxt(fname, dtype=<class 'float'>, comments='#', delimiter=None, skip_header=0, skip_footer=0, converters=None, missing_values=None, filling_values=None, usecols=None, names=None, excludelist=None, deletechars=None, replace_space='_', autostrip=False, case_sensitive=True, defaultfmt='f%i', unpack=None, usemask=False, loose=True, invalid_raise=True, max_rows=None)</dt><dd><tt>Load data from a text file, with missing values handled as specified.<br> | |
| 13 | + <br> | |
| 14 | +Each line past the first `skip_header` lines is split at the `delimiter`<br> | |
| 15 | +character, and characters following the `comments` character are discarded.<br> | |
| 16 | + <br> | |
| 17 | +Parameters<br> | |
| 18 | +----------<br> | |
| 19 | +fname : file, str, pathlib.Path, list of str, generator<br> | |
| 20 | + File, filename, list, or generator to read. If the filename<br> | |
| 21 | + extension is `.gz` or `.bz2`, the file is first decompressed. Note<br> | |
| 22 | + that generators must return byte strings in Python 3k. The strings<br> | |
| 23 | + in a list or produced by a generator are treated as lines.<br> | |
| 24 | +dtype : dtype, optional<br> | |
| 25 | + Data type of the resulting array.<br> | |
| 26 | + If None, the dtypes will be determined by the contents of each<br> | |
| 27 | + column, individually.<br> | |
| 28 | +comments : str, optional<br> | |
| 29 | + The character used to indicate the start of a comment.<br> | |
| 30 | + All the characters occurring on a line after a comment are discarded<br> | |
| 31 | +delimiter : str, int, or sequence, optional<br> | |
| 32 | + The string used to separate values. By default, any consecutive<br> | |
| 33 | + whitespaces act as delimiter. An integer or sequence of integers<br> | |
| 34 | + can also be provided as width(s) of each field.<br> | |
| 35 | +skiprows : int, optional<br> | |
| 36 | + `skiprows` was removed in numpy 1.10. Please use `skip_header` instead.<br> | |
| 37 | +skip_header : int, optional<br> | |
| 38 | + The number of lines to skip at the beginning of the file.<br> | |
| 39 | +skip_footer : int, optional<br> | |
| 40 | + The number of lines to skip at the end of the file.<br> | |
| 41 | +converters : variable, optional<br> | |
| 42 | + The set of functions that convert the data of a column to a value.<br> | |
| 43 | + The converters can also be used to provide a default value<br> | |
| 44 | + for missing data: ``converters = {3: lambda s: float(s or 0)}``.<br> | |
| 45 | +missing : variable, optional<br> | |
| 46 | + `missing` was removed in numpy 1.10. Please use `missing_values`<br> | |
| 47 | + instead.<br> | |
| 48 | +missing_values : variable, optional<br> | |
| 49 | + The set of strings corresponding to missing data.<br> | |
| 50 | +filling_values : variable, optional<br> | |
| 51 | + The set of values to be used as default when the data are missing.<br> | |
| 52 | +usecols : sequence, optional<br> | |
| 53 | + Which columns to read, with 0 being the first. For example,<br> | |
| 54 | + ``usecols = (1, 4, 5)`` will extract the 2nd, 5th and 6th columns.<br> | |
| 55 | +names : {None, True, str, sequence}, optional<br> | |
| 56 | + If `names` is True, the field names are read from the first valid line<br> | |
| 57 | + after the first `skip_header` lines.<br> | |
| 58 | + If `names` is a sequence or a single-string of comma-separated names,<br> | |
| 59 | + the names will be used to define the field names in a structured dtype.<br> | |
| 60 | + If `names` is None, the names of the dtype fields will be used, if any.<br> | |
| 61 | +excludelist : sequence, optional<br> | |
| 62 | + A list of names to exclude. This list is appended to the default list<br> | |
| 63 | + ['return','file','print']. Excluded names are appended an underscore:<br> | |
| 64 | + for example, `file` would become `file_`.<br> | |
| 65 | +deletechars : str, optional<br> | |
| 66 | + A string combining invalid characters that must be deleted from the<br> | |
| 67 | + names.<br> | |
| 68 | +defaultfmt : str, optional<br> | |
| 69 | + A format used to define default field names, such as "f%i" or "f_%02i".<br> | |
| 70 | +autostrip : bool, optional<br> | |
| 71 | + Whether to automatically strip white spaces from the variables.<br> | |
| 72 | +replace_space : char, optional<br> | |
| 73 | + Character(s) used in replacement of white spaces in the variables<br> | |
| 74 | + names. By default, use a '_'.<br> | |
| 75 | +case_sensitive : {True, False, 'upper', 'lower'}, optional<br> | |
| 76 | + If True, field names are case sensitive.<br> | |
| 77 | + If False or 'upper', field names are converted to upper case.<br> | |
| 78 | + If 'lower', field names are converted to lower case.<br> | |
| 79 | +unpack : bool, optional<br> | |
| 80 | + If True, the returned array is transposed, so that arguments may be<br> | |
| 81 | + unpacked using ``x, y, z = loadtxt(...)``<br> | |
| 82 | +usemask : bool, optional<br> | |
| 83 | + If True, return a masked array.<br> | |
| 84 | + If False, return a regular array.<br> | |
| 85 | +loose : bool, optional<br> | |
| 86 | + If True, do not raise errors for invalid values.<br> | |
| 87 | +invalid_raise : bool, optional<br> | |
| 88 | + If True, an exception is raised if an inconsistency is detected in the<br> | |
| 89 | + number of columns.<br> | |
| 90 | + If False, a warning is emitted and the offending lines are skipped.<br> | |
| 91 | +max_rows : int, optional<br> | |
| 92 | + The maximum number of rows to read. Must not be used with skip_footer<br> | |
| 93 | + at the same time. If given, the value must be at least 1. Default is<br> | |
| 94 | + to read the entire file.<br> | |
| 95 | + <br> | |
| 96 | + .. versionadded:: 1.10.0<br> | |
| 97 | + <br> | |
| 98 | +Returns<br> | |
| 99 | +-------<br> | |
| 100 | +out : ndarray<br> | |
| 101 | + Data read from the text file. If `usemask` is True, this is a<br> | |
| 102 | + masked array.<br> | |
| 103 | + <br> | |
| 104 | +See Also<br> | |
| 105 | +--------<br> | |
| 106 | +numpy.loadtxt : equivalent function when no data is missing.<br> | |
| 107 | + <br> | |
| 108 | +Notes<br> | |
| 109 | +-----<br> | |
| 110 | +* When spaces are used as delimiters, or when no delimiter has been given<br> | |
| 111 | + as input, there should not be any missing data between two fields.<br> | |
| 112 | +* When the variables are named (either by a flexible dtype or with `names`,<br> | |
| 113 | + there must not be any header in the file (else a ValueError<br> | |
| 114 | + exception is raised).<br> | |
| 115 | +* Individual values are not stripped of spaces by default.<br> | |
| 116 | + When using a custom converter, make sure the function does remove spaces.<br> | |
| 117 | + <br> | |
| 118 | +References<br> | |
| 119 | +----------<br> | |
| 120 | +.. [1] NumPy User Guide, section `I/O with NumPy<br> | |
| 121 | + <<a href="http://docs.scipy.org/doc/numpy/user/basics.io.genfromtxt.html>`_">http://docs.scipy.org/doc/numpy/user/basics.io.genfromtxt.html>`_</a>.<br> | |
| 122 | + <br> | |
| 123 | +Examples<br> | |
| 124 | +---------<br> | |
| 125 | +>>> from io import StringIO<br> | |
| 126 | +>>> import numpy as np<br> | |
| 127 | + <br> | |
| 128 | +Comma delimited file with mixed dtype<br> | |
| 129 | + <br> | |
| 130 | +>>> s = StringIO("1,1.3,abcde")<br> | |
| 131 | +>>> data = np.genfromtxt(s, dtype=[('myint','i8'),('myfloat','f8'),<br> | |
| 132 | +... ('mystring','S5')], delimiter=",")<br> | |
| 133 | +>>> data<br> | |
| 134 | +array((1, 1.3, 'abcde'),<br> | |
| 135 | + dtype=[('myint', '<i8'), ('myfloat', '<f8'), ('mystring', '|S5')])<br> | |
| 136 | + <br> | |
| 137 | +Using dtype = None<br> | |
| 138 | + <br> | |
| 139 | +>>> s.seek(0) # needed for StringIO example only<br> | |
| 140 | +>>> data = np.genfromtxt(s, dtype=None,<br> | |
| 141 | +... names = ['myint','myfloat','mystring'], delimiter=",")<br> | |
| 142 | +>>> data<br> | |
| 143 | +array((1, 1.3, 'abcde'),<br> | |
| 144 | + dtype=[('myint', '<i8'), ('myfloat', '<f8'), ('mystring', '|S5')])<br> | |
| 145 | + <br> | |
| 146 | +Specifying dtype and names<br> | |
| 147 | + <br> | |
| 148 | +>>> s.seek(0)<br> | |
| 149 | +>>> data = np.genfromtxt(s, dtype="i8,f8,S5",<br> | |
| 150 | +... names=['myint','myfloat','mystring'], delimiter=",")<br> | |
| 151 | +>>> data<br> | |
| 152 | +array((1, 1.3, 'abcde'),<br> | |
| 153 | + dtype=[('myint', '<i8'), ('myfloat', '<f8'), ('mystring', '|S5')])<br> | |
| 154 | + <br> | |
| 155 | +An example with fixed-width columns<br> | |
| 156 | + <br> | |
| 157 | +>>> s = StringIO("11.3abcde")<br> | |
| 158 | +>>> data = np.genfromtxt(s, dtype=None, names=['intvar','fltvar','strvar'],<br> | |
| 159 | +... delimiter=[1,3,5])<br> | |
| 160 | +>>> data<br> | |
| 161 | +array((1, 1.3, 'abcde'),<br> | |
| 162 | + dtype=[('intvar', '<i8'), ('fltvar', '<f8'), ('strvar', '|S5')])</tt></dd></dl> | |
| 163 | + | |
| 164 | +</div></div> |
chunks/doc-np-mean.md
View file @
9186cc5
| 1 | +## Moyenne d'un tableau avec `np.mean` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Premier paramètre : tableau à traiter</li> | |
| 5 | +<li>Paramètre nommé <code>axis</code> : axe selon lequel moyenner</li> | |
| 6 | +<li>Paramètre nommé <code>keepdims</code> : conserve le nombre de dimensions (si <code>keepdims=True</code>) </li> | |
| 7 | +</ul> | |
| 8 | + | |
| 9 | +<div class='scroll'> | |
| 10 | +Python Library Documentation: function mean in numpy | |
| 11 | + | |
| 12 | +<dl><dt><a name="-numpy.mean"><strong>numpy.mean</strong></a> = mean(a, axis=None, dtype=None, out=None, keepdims=<class 'numpy._globals._NoValue'>)</dt><dd><tt>Compute the arithmetic mean along the specified axis.<br> | |
| 13 | + <br> | |
| 14 | +Returns the average of the array elements. The average is taken over<br> | |
| 15 | +the flattened array by default, otherwise over the specified axis.<br> | |
| 16 | +`float64` intermediate and return values are used for integer inputs.<br> | |
| 17 | + <br> | |
| 18 | +Parameters<br> | |
| 19 | +----------<br> | |
| 20 | +a : array_like<br> | |
| 21 | + Array containing numbers whose mean is desired. If `a` is not an<br> | |
| 22 | + array, a conversion is attempted.<br> | |
| 23 | +axis : None or int or tuple of ints, optional<br> | |
| 24 | + Axis or axes along which the means are computed. The default is to<br> | |
| 25 | + compute the mean of the flattened array.<br> | |
| 26 | + <br> | |
| 27 | + .. versionadded:: 1.7.0<br> | |
| 28 | + <br> | |
| 29 | + If this is a tuple of ints, a mean is performed over multiple axes,<br> | |
| 30 | + instead of a single axis or all the axes as before.<br> | |
| 31 | +dtype : data-type, optional<br> | |
| 32 | + Type to use in computing the mean. For integer inputs, the default<br> | |
| 33 | + is `float64`; for floating point inputs, it is the same as the<br> | |
| 34 | + input dtype.<br> | |
| 35 | +out : ndarray, optional<br> | |
| 36 | + Alternate output array in which to place the result. The default<br> | |
| 37 | + is ``None``; if provided, it must have the same shape as the<br> | |
| 38 | + expected output, but the type will be cast if necessary.<br> | |
| 39 | + See `doc.ufuncs` for details.<br> | |
| 40 | + <br> | |
| 41 | +keepdims : bool, optional<br> | |
| 42 | + If this is set to True, the axes which are reduced are left<br> | |
| 43 | + in the result as dimensions with size one. With this option,<br> | |
| 44 | + the result will broadcast correctly against the input array.<br> | |
| 45 | + <br> | |
| 46 | + If the default value is passed, then `keepdims` will not be<br> | |
| 47 | + passed through to the `mean` method of sub-classes of<br> | |
| 48 | + `ndarray`, however any non-default value will be. If the<br> | |
| 49 | + sub-classes `sum` method does not implement `keepdims` any<br> | |
| 50 | + exceptions will be raised.<br> | |
| 51 | + <br> | |
| 52 | +Returns<br> | |
| 53 | +-------<br> | |
| 54 | +m : ndarray, see dtype parameter above<br> | |
| 55 | + If `out=None`, returns a new array containing the mean values,<br> | |
| 56 | + otherwise a reference to the output array is returned.<br> | |
| 57 | + <br> | |
| 58 | +See Also<br> | |
| 59 | +--------<br> | |
| 60 | +average : Weighted average<br> | |
| 61 | +std, var, nanmean, nanstd, nanvar<br> | |
| 62 | + <br> | |
| 63 | +Notes<br> | |
| 64 | +-----<br> | |
| 65 | +The arithmetic mean is the sum of the elements along the axis divided<br> | |
| 66 | +by the number of elements.<br> | |
| 67 | + <br> | |
| 68 | +Note that for floating-point input, the mean is computed using the<br> | |
| 69 | +same precision the input has. Depending on the input data, this can<br> | |
| 70 | +cause the results to be inaccurate, especially for `float32` (see<br> | |
| 71 | +example below). Specifying a higher-precision accumulator using the<br> | |
| 72 | +`dtype` keyword can alleviate this issue.<br> | |
| 73 | + <br> | |
| 74 | +By default, `float16` results are computed using `float32` intermediates<br> | |
| 75 | +for extra precision.<br> | |
| 76 | + <br> | |
| 77 | +Examples<br> | |
| 78 | +--------<br> | |
| 79 | +>>> a = np.array([[1, 2], [3, 4]])<br> | |
| 80 | +>>> np.mean(a)<br> | |
| 81 | +2.5<br> | |
| 82 | +>>> np.mean(a, axis=0)<br> | |
| 83 | +array([ 2., 3.])<br> | |
| 84 | +>>> np.mean(a, axis=1)<br> | |
| 85 | +array([ 1.5, 3.5])<br> | |
| 86 | + <br> | |
| 87 | +In single precision, `mean` can be inaccurate:<br> | |
| 88 | + <br> | |
| 89 | +>>> a = np.zeros((2, 512*512), dtype=np.float32)<br> | |
| 90 | +>>> a[0, :] = 1.0<br> | |
| 91 | +>>> a[1, :] = 0.1<br> | |
| 92 | +>>> np.mean(a)<br> | |
| 93 | +0.54999924<br> | |
| 94 | + <br> | |
| 95 | +Computing the mean in float64 is more accurate:<br> | |
| 96 | + <br> | |
| 97 | +>>> np.mean(a, dtype=np.float64)<br> | |
| 98 | +0.55000000074505806</tt></dd></dl> | |
| 99 | + | |
| 100 | +</div></div> |
chunks/doc-plt-annotate.md
View file @
9186cc5
| 1 | +## Annoter un point avec `plt.annotate` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Paramètre 1 : texte à afficher (chaîne de caractères)</li> | |
| 5 | +<li>Paramètre 2 : paire (2-uplet) position "x,y" du point à annoter</li> | |
| 6 | +<li>Paramètre 3 : paire (2-uplet) position "x,y" du texte</li> | |
| 7 | +<li>Paramètres nommés intéressants : <code>arrowprops=dict(arrowstyle= "->")</code> (pour tracer une flêche), <code>xycoords</code> (repère pour les coordonnées du point annoté), <code>textcoords</code> (repère pour les coordonnées du texte)</li> | |
| 8 | +</ul> | |
| 9 | + | |
| 10 | +<div class='scroll'> | |
| 11 | +Python Library Documentation: function annotate in matplotlib.pyplot | |
| 12 | + | |
| 13 | +<dl><dt><a name="-matplotlib.pyplot.annotate"><strong>matplotlib.pyplot.annotate</strong></a> = annotate(*args, **kwargs)</dt><dd><tt>Create an annotation: a piece of text referring to a data<br> | |
| 14 | +point.<br> | |
| 15 | + <br> | |
| 16 | +Parameters<br> | |
| 17 | +----------<br> | |
| 18 | +s : string<br> | |
| 19 | + label<br> | |
| 20 | + <br> | |
| 21 | +xy : (x, y)<br> | |
| 22 | + position of element to annotate. See *xycoords* to control what<br> | |
| 23 | + coordinate system this value is interpretated in.<br> | |
| 24 | + <br> | |
| 25 | +xytext : (x, y) , optional, default: None<br> | |
| 26 | + position of the label `s`. See *textcoords* to control what<br> | |
| 27 | + coordinate system this value is interpreted in.<br> | |
| 28 | + <br> | |
| 29 | +xycoords : string, optional, default: "data"<br> | |
| 30 | + string that indicates what type of coordinates `xy` is. Examples:<br> | |
| 31 | + "figure points", "figure pixels", "figure fraction", "axes<br> | |
| 32 | + points", .... See `matplotlib.text.Annotation` for more details.<br> | |
| 33 | + <br> | |
| 34 | +textcoords : string, optional, default: None<br> | |
| 35 | + string that indicates what type of coordinates `text` is. Examples:<br> | |
| 36 | + "figure points", "figure pixels", "figure fraction", "axes<br> | |
| 37 | + points", .... See `matplotlib.text.Annotation` for more details.<br> | |
| 38 | + <br> | |
| 39 | +arrowprops : `matplotlib.lines.Line2D` properties, optional<br> | |
| 40 | + Dictionary of line properties for the arrow that connects<br> | |
| 41 | + the annotation to the point. If the dictionnary has a key<br> | |
| 42 | + `arrowstyle`, a `~matplotlib.patches.FancyArrowPatch`<br> | |
| 43 | + instance is created and drawn. See<br> | |
| 44 | + `matplotlib.text.Annotation` for more details on valid<br> | |
| 45 | + options. Default is None.<br> | |
| 46 | + <br> | |
| 47 | +Returns<br> | |
| 48 | +-------<br> | |
| 49 | +a : `~matplotlib.text.Annotation`<br> | |
| 50 | + <br> | |
| 51 | + <br> | |
| 52 | +Notes<br> | |
| 53 | +-----<br> | |
| 54 | + <br> | |
| 55 | +*arrowprops*, if not *None*, is a dictionary of line properties<br> | |
| 56 | +(see :class:`matplotlib.lines.Line2D`) for the arrow that connects<br> | |
| 57 | +annotation to the point.<br> | |
| 58 | + <br> | |
| 59 | +If the dictionary has a key *arrowstyle*, a<br> | |
| 60 | +`~matplotlib.patches.FancyArrowPatch` instance is created with<br> | |
| 61 | +the given dictionary and is drawn. Otherwise, a<br> | |
| 62 | +`~matplotlib.patches.YAArrow` patch instance is created and<br> | |
| 63 | +drawn. Valid keys for `~matplotlib.patches.YAArrow` are:<br> | |
| 64 | + <br> | |
| 65 | + <br> | |
| 66 | +========= ===========================================================<br> | |
| 67 | +Key Description<br> | |
| 68 | +========= ===========================================================<br> | |
| 69 | +width the width of the arrow in points<br> | |
| 70 | +frac the fraction of the arrow length occupied by the head<br> | |
| 71 | +headwidth the width of the base of the arrow head in points<br> | |
| 72 | +shrink oftentimes it is convenient to have the arrowtip<br> | |
| 73 | + and base a bit away from the text and point being<br> | |
| 74 | + annotated. If *d* is the distance between the text and<br> | |
| 75 | + annotated point, shrink will shorten the arrow so the tip<br> | |
| 76 | + and base are shink percent of the distance *d* away from<br> | |
| 77 | + the endpoints. i.e., ``shrink=0.05 is 5%``<br> | |
| 78 | +? any key for :class:`matplotlib.patches.polygon`<br> | |
| 79 | +========= ===========================================================<br> | |
| 80 | + <br> | |
| 81 | + <br> | |
| 82 | +Valid keys for `~matplotlib.patches.FancyArrowPatch` are:<br> | |
| 83 | + <br> | |
| 84 | + <br> | |
| 85 | +=============== ======================================================<br> | |
| 86 | +Key Description<br> | |
| 87 | +=============== ======================================================<br> | |
| 88 | +arrowstyle the arrow style<br> | |
| 89 | +connectionstyle the connection style<br> | |
| 90 | +relpos default is (0.5, 0.5)<br> | |
| 91 | +patchA default is bounding box of the text<br> | |
| 92 | +patchB default is None<br> | |
| 93 | +shrinkA default is 2 points<br> | |
| 94 | +shrinkB default is 2 points<br> | |
| 95 | +mutation_scale default is text size (in points)<br> | |
| 96 | +mutation_aspect default is 1.<br> | |
| 97 | +? any key for :class:`matplotlib.patches.PathPatch`<br> | |
| 98 | +=============== ======================================================<br> | |
| 99 | + <br> | |
| 100 | + <br> | |
| 101 | +*xycoords* and *textcoords* are strings that indicate the<br> | |
| 102 | +coordinates of *xy* and *xytext*, and may be one of the<br> | |
| 103 | +following values:<br> | |
| 104 | + <br> | |
| 105 | +================= ===================================================<br> | |
| 106 | +Property Description<br> | |
| 107 | +================= ===================================================<br> | |
| 108 | +'figure points' points from the lower left corner of the figure<br> | |
| 109 | +'figure pixels' pixels from the lower left corner of the figure<br> | |
| 110 | +'figure fraction' 0,0 is lower left of figure and 1,1 is upper right<br> | |
| 111 | +'axes points' points from lower left corner of axes<br> | |
| 112 | +'axes pixels' pixels from lower left corner of axes<br> | |
| 113 | +'axes fraction' 0,0 is lower left of axes and 1,1 is upper right<br> | |
| 114 | +'data' use the coordinate system of the object being<br> | |
| 115 | + annotated (default)<br> | |
| 116 | +'offset points' Specify an offset (in points) from the *xy* value<br> | |
| 117 | + <br> | |
| 118 | +'polar' you can specify *theta*, *r* for the annotation,<br> | |
| 119 | + even in cartesian plots. Note that if you<br> | |
| 120 | + are using a polar axes, you do not need<br> | |
| 121 | + to specify polar for the coordinate<br> | |
| 122 | + system since that is the native "data" coordinate<br> | |
| 123 | + system.<br> | |
| 124 | +================= ===================================================<br> | |
| 125 | + <br> | |
| 126 | +If a 'points' or 'pixels' option is specified, values will be<br> | |
| 127 | +added to the bottom-left and if negative, values will be<br> | |
| 128 | +subtracted from the top-right. e.g.::<br> | |
| 129 | + <br> | |
| 130 | + # 10 points to the right of the left border of the axes and<br> | |
| 131 | + # 5 points below the top border<br> | |
| 132 | + xy=(10,-5), xycoords='axes points'<br> | |
| 133 | + <br> | |
| 134 | +You may use an instance of<br> | |
| 135 | +:class:`~matplotlib.transforms.Transform` or<br> | |
| 136 | +:class:`~matplotlib.artist.Artist`. See<br> | |
| 137 | +:ref:`plotting-guide-annotation` for more details.<br> | |
| 138 | + <br> | |
| 139 | +The *annotation_clip* attribute controls the visibility of the<br> | |
| 140 | +annotation when it goes outside the axes area. If `True`, the<br> | |
| 141 | +annotation will only be drawn when the *xy* is inside the<br> | |
| 142 | +axes. If `False`, the annotation will always be drawn<br> | |
| 143 | +regardless of its position. The default is `None`, which<br> | |
| 144 | +behave as `True` only if *xycoords* is "data".<br> | |
| 145 | + <br> | |
| 146 | +Additional kwargs are `~matplotlib.text.Text` properties:<br> | |
| 147 | + <br> | |
| 148 | + agg_filter: unknown<br> | |
| 149 | + alpha: float (0.0 transparent through 1.0 opaque) <br> | |
| 150 | + animated: [True | False] <br> | |
| 151 | + axes: an :class:`~matplotlib.axes.Axes` instance <br> | |
| 152 | + backgroundcolor: any matplotlib color <br> | |
| 153 | + bbox: FancyBboxPatch prop dict <br> | |
| 154 | + clip_box: a :class:`matplotlib.transforms.Bbox` instance <br> | |
| 155 | + clip_on: [True | False] <br> | |
| 156 | + clip_path: [ (:class:`~matplotlib.path.Path`, :class:`~matplotlib.transforms.Transform`) | :class:`~matplotlib.patches.Patch` | None ] <br> | |
| 157 | + color: any matplotlib color <br> | |
| 158 | + contains: a callable function <br> | |
| 159 | + family or name or fontfamily or fontname: [FONTNAME | 'serif' | 'sans-serif' | 'cursive' | 'fantasy' | 'monospace' ] <br> | |
| 160 | + figure: a :class:`matplotlib.figure.Figure` instance <br> | |
| 161 | + fontproperties or font_properties: a :class:`matplotlib.font_manager.FontProperties` instance <br> | |
| 162 | + gid: an id string <br> | |
| 163 | + horizontalalignment or ha: [ 'center' | 'right' | 'left' ] <br> | |
| 164 | + label: string or anything printable with '%s' conversion. <br> | |
| 165 | + linespacing: float (multiple of font size) <br> | |
| 166 | + multialignment: ['left' | 'right' | 'center' ] <br> | |
| 167 | + path_effects: unknown<br> | |
| 168 | + picker: [None|float|boolean|callable] <br> | |
| 169 | + position: (x,y) <br> | |
| 170 | + rasterized: [True | False | None] <br> | |
| 171 | + rotation: [ angle in degrees | 'vertical' | 'horizontal' ] <br> | |
| 172 | + rotation_mode: unknown<br> | |
| 173 | + size or fontsize: [size in points | 'xx-small' | 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ] <br> | |
| 174 | + sketch_params: unknown<br> | |
| 175 | + snap: unknown<br> | |
| 176 | + stretch or fontstretch: [a numeric value in range 0-1000 | 'ultra-condensed' | 'extra-condensed' | 'condensed' | 'semi-condensed' | 'normal' | 'semi-expanded' | 'expanded' | 'extra-expanded' | 'ultra-expanded' ] <br> | |
| 177 | + style or fontstyle: [ 'normal' | 'italic' | 'oblique'] <br> | |
| 178 | + text: string or anything printable with '%s' conversion. <br> | |
| 179 | + transform: :class:`~matplotlib.transforms.Transform` instance <br> | |
| 180 | + url: a url string <br> | |
| 181 | + usetex: unknown<br> | |
| 182 | + variant or fontvariant: [ 'normal' | 'small-caps' ] <br> | |
| 183 | + verticalalignment or va or ma: [ 'center' | 'top' | 'bottom' | 'baseline' ] <br> | |
| 184 | + visible: [True | False] <br> | |
| 185 | + weight or fontweight: [a numeric value in range 0-1000 | 'ultralight' | 'light' | 'normal' | 'regular' | 'book' | 'medium' | 'roman' | 'semibold' | 'demibold' | 'demi' | 'bold' | 'heavy' | 'extra bold' | 'black' ] <br> | |
| 186 | + wrap: unknown<br> | |
| 187 | + x: float <br> | |
| 188 | + y: float <br> | |
| 189 | + zorder: any number <br> | |
| 190 | + <br> | |
| 191 | +Examples<br> | |
| 192 | +--------<br> | |
| 193 | + <br> | |
| 194 | +.. plot:: mpl_examples/pylab_examples/annotation_demo2.py</tt></dd></dl> | |
| 195 | + | |
| 196 | +</div></div> |
chunks/doc-plt-bar.md
View file @
9186cc5
| 1 | +## Tracer un diagramme en barres avec `plt.bar` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Paramètre 1 : liste/tableau des positions horizontales (gauche de chaque barre)</li> | |
| 5 | +<li>Paramètre 2 : liste/tableau des hauteurs (valeur verticale)</li> | |
| 6 | +<li>Paramètre nommé <code>width</code> : largeur de l'ensemble des barres</li> | |
| 7 | +</ul> | |
| 8 | + | |
| 9 | +<div class='scroll'> | |
| 10 | +Python Library Documentation: function bar in matplotlib.pyplot | |
| 11 | + | |
| 12 | +<dl><dt><a name="-matplotlib.pyplot.bar"><strong>matplotlib.pyplot.bar</strong></a> = bar(left, height, width=0.8, bottom=None, hold=None, data=None, **kwargs)</dt><dd><tt>Make a bar plot.<br> | |
| 13 | + <br> | |
| 14 | +Make a bar plot with rectangles bounded by:<br> | |
| 15 | + <br> | |
| 16 | + `left`, `left` + `width`, `bottom`, `bottom` + `height`<br> | |
| 17 | + (left, right, bottom and top edges)<br> | |
| 18 | + <br> | |
| 19 | +Parameters<br> | |
| 20 | +----------<br> | |
| 21 | +left : sequence of scalars<br> | |
| 22 | + the x coordinates of the left sides of the bars<br> | |
| 23 | + <br> | |
| 24 | +height : sequence of scalars<br> | |
| 25 | + the heights of the bars<br> | |
| 26 | + <br> | |
| 27 | +width : scalar or array-like, optional<br> | |
| 28 | + the width(s) of the bars<br> | |
| 29 | + default: 0.8<br> | |
| 30 | + <br> | |
| 31 | +bottom : scalar or array-like, optional<br> | |
| 32 | + the y coordinate(s) of the bars<br> | |
| 33 | + default: None<br> | |
| 34 | + <br> | |
| 35 | +color : scalar or array-like, optional<br> | |
| 36 | + the colors of the bar faces<br> | |
| 37 | + <br> | |
| 38 | +edgecolor : scalar or array-like, optional<br> | |
| 39 | + the colors of the bar edges<br> | |
| 40 | + <br> | |
| 41 | +linewidth : scalar or array-like, optional<br> | |
| 42 | + width of bar edge(s). If None, use default<br> | |
| 43 | + linewidth; If 0, don't draw edges.<br> | |
| 44 | + default: None<br> | |
| 45 | + <br> | |
| 46 | +tick_label : string or array-like, optional<br> | |
| 47 | + the tick labels of the bars<br> | |
| 48 | + default: None<br> | |
| 49 | + <br> | |
| 50 | +xerr : scalar or array-like, optional<br> | |
| 51 | + if not None, will be used to generate errorbar(s) on the bar chart<br> | |
| 52 | + default: None<br> | |
| 53 | + <br> | |
| 54 | +yerr : scalar or array-like, optional<br> | |
| 55 | + if not None, will be used to generate errorbar(s) on the bar chart<br> | |
| 56 | + default: None<br> | |
| 57 | + <br> | |
| 58 | +ecolor : scalar or array-like, optional<br> | |
| 59 | + specifies the color of errorbar(s)<br> | |
| 60 | + default: None<br> | |
| 61 | + <br> | |
| 62 | +capsize : scalar, optional<br> | |
| 63 | + determines the length in points of the error bar caps<br> | |
| 64 | + default: None, which will take the value from the<br> | |
| 65 | + ``errorbar.capsize`` :data:`rcParam<matplotlib.rcParams>`.<br> | |
| 66 | + <br> | |
| 67 | +error_kw : dict, optional<br> | |
| 68 | + dictionary of kwargs to be passed to errorbar method. *ecolor* and<br> | |
| 69 | + *capsize* may be specified here rather than as independent kwargs.<br> | |
| 70 | + <br> | |
| 71 | +align : {'edge', 'center'}, optional<br> | |
| 72 | + If 'edge', aligns bars by their left edges (for vertical bars) and<br> | |
| 73 | + by their bottom edges (for horizontal bars). If 'center', interpret<br> | |
| 74 | + the `left` argument as the coordinates of the centers of the bars.<br> | |
| 75 | + To align on the align bars on the right edge pass a negative<br> | |
| 76 | + `width`.<br> | |
| 77 | + <br> | |
| 78 | +orientation : {'vertical', 'horizontal'}, optional<br> | |
| 79 | + The orientation of the bars.<br> | |
| 80 | + <br> | |
| 81 | +log : boolean, optional<br> | |
| 82 | + If true, sets the axis to be log scale.<br> | |
| 83 | + default: False<br> | |
| 84 | + <br> | |
| 85 | +Returns<br> | |
| 86 | +-------<br> | |
| 87 | +bars : matplotlib.container.BarContainer<br> | |
| 88 | + Container with all of the bars + errorbars<br> | |
| 89 | + <br> | |
| 90 | +Notes<br> | |
| 91 | +-----<br> | |
| 92 | +The optional arguments `color`, `edgecolor`, `linewidth`,<br> | |
| 93 | +`xerr`, and `yerr` can be either scalars or sequences of<br> | |
| 94 | +length equal to the number of bars. This enables you to use<br> | |
| 95 | +bar as the basis for stacked bar charts, or candlestick plots.<br> | |
| 96 | +Detail: `xerr` and `yerr` are passed directly to<br> | |
| 97 | +:meth:`errorbar`, so they can also have shape 2xN for<br> | |
| 98 | +independent specification of lower and upper errors.<br> | |
| 99 | + <br> | |
| 100 | +Other optional kwargs:<br> | |
| 101 | + <br> | |
| 102 | + agg_filter: unknown<br> | |
| 103 | + alpha: float or None <br> | |
| 104 | + animated: [True | False] <br> | |
| 105 | + antialiased or aa: [True | False] or None for default <br> | |
| 106 | + axes: an :class:`~matplotlib.axes.Axes` instance <br> | |
| 107 | + capstyle: ['butt' | 'round' | 'projecting'] <br> | |
| 108 | + clip_box: a :class:`matplotlib.transforms.Bbox` instance <br> | |
| 109 | + clip_on: [True | False] <br> | |
| 110 | + clip_path: [ (:class:`~matplotlib.path.Path`, :class:`~matplotlib.transforms.Transform`) | :class:`~matplotlib.patches.Patch` | None ] <br> | |
| 111 | + color: matplotlib color spec<br> | |
| 112 | + contains: a callable function <br> | |
| 113 | + edgecolor or ec: mpl color spec, or None for default, or 'none' for no color <br> | |
| 114 | + facecolor or fc: mpl color spec, or None for default, or 'none' for no color <br> | |
| 115 | + figure: a :class:`matplotlib.figure.Figure` instance <br> | |
| 116 | + fill: [True | False] <br> | |
| 117 | + gid: an id string <br> | |
| 118 | + hatch: ['/' | '\\' | '|' | '-' | '+' | 'x' | 'o' | 'O' | '.' | '*'] <br> | |
| 119 | + joinstyle: ['miter' | 'round' | 'bevel'] <br> | |
| 120 | + label: string or anything printable with '%s' conversion. <br> | |
| 121 | + linestyle or ls: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | ``'-'`` | ``'--'`` | ``'-.'`` | ``':'`` | ``'None'`` | ``' '`` | ``''``]<br> | |
| 122 | + linewidth or lw: float or None for default <br> | |
| 123 | + path_effects: unknown<br> | |
| 124 | + picker: [None|float|boolean|callable] <br> | |
| 125 | + rasterized: [True | False | None] <br> | |
| 126 | + sketch_params: unknown<br> | |
| 127 | + snap: unknown<br> | |
| 128 | + transform: :class:`~matplotlib.transforms.Transform` instance <br> | |
| 129 | + url: a url string <br> | |
| 130 | + visible: [True | False] <br> | |
| 131 | + zorder: any number <br> | |
| 132 | + <br> | |
| 133 | +See also<br> | |
| 134 | +--------<br> | |
| 135 | +barh: Plot a horizontal bar plot.<br> | |
| 136 | + <br> | |
| 137 | +Examples<br> | |
| 138 | +--------<br> | |
| 139 | + <br> | |
| 140 | +**Example:** A stacked bar chart.<br> | |
| 141 | + <br> | |
| 142 | +.. plot:: mpl_examples/pylab_examples/bar_stacked.py<br> | |
| 143 | + <br> | |
| 144 | +Notes<br> | |
| 145 | +-----<br> | |
| 146 | + <br> | |
| 147 | +In addition to the above described arguments, this function can take a<br> | |
| 148 | +**data** keyword argument. If such a **data** argument is given, the<br> | |
| 149 | +following arguments are replaced by **data[<arg>]**:<br> | |
| 150 | + <br> | |
| 151 | +* All arguments with the following names: 'bottom', 'ecolor', 'width', 'height', 'linewidth', 'color', 'tick_label', 'yerr', 'left', 'edgecolor', 'xerr'.<br> | |
| 152 | + <br> | |
| 153 | + <br> | |
| 154 | + <br> | |
| 155 | + <br> | |
| 156 | +Additional kwargs: hold = [True|False] overrides default hold state</tt></dd></dl> | |
| 157 | + | |
| 158 | +</div></div> |
chunks/doc-plt-barh.md
View file @
9186cc5
| 1 | +## … barres horizontales avec `plt.barh` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Paramètre 1 : liste/tableau des positions verticale (bas de chaque barre)</li> | |
| 5 | +<li>Paramètre 2 : liste/tableau des largeur (valeur horizontale)</li> | |
| 6 | +<li>Paramètre nommé <code>height</code> : hauteur de l'ensemble des barres</li> | |
| 7 | +</ul> | |
| 8 | + | |
| 9 | +<div class='scroll'> | |
| 10 | +Python Library Documentation: function barh in matplotlib.pyplot | |
| 11 | + | |
| 12 | +<dl><dt><a name="-matplotlib.pyplot.barh"><strong>matplotlib.pyplot.barh</strong></a> = barh(bottom, width, height=0.8, left=None, hold=None, **kwargs)</dt><dd><tt>Make a horizontal bar plot.<br> | |
| 13 | + <br> | |
| 14 | +Make a horizontal bar plot with rectangles bounded by:<br> | |
| 15 | + <br> | |
| 16 | + `left`, `left` + `width`, `bottom`, `bottom` + `height`<br> | |
| 17 | + (left, right, bottom and top edges)<br> | |
| 18 | + <br> | |
| 19 | +`bottom`, `width`, `height`, and `left` can be either scalars<br> | |
| 20 | +or sequences<br> | |
| 21 | + <br> | |
| 22 | +Parameters<br> | |
| 23 | +----------<br> | |
| 24 | +bottom : scalar or array-like<br> | |
| 25 | + the y coordinate(s) of the bars<br> | |
| 26 | + <br> | |
| 27 | +width : scalar or array-like<br> | |
| 28 | + the width(s) of the bars<br> | |
| 29 | + <br> | |
| 30 | +height : sequence of scalars, optional, default: 0.8<br> | |
| 31 | + the heights of the bars<br> | |
| 32 | + <br> | |
| 33 | +left : sequence of scalars<br> | |
| 34 | + the x coordinates of the left sides of the bars<br> | |
| 35 | + <br> | |
| 36 | +Returns<br> | |
| 37 | +--------<br> | |
| 38 | +`matplotlib.patches.Rectangle` instances.<br> | |
| 39 | + <br> | |
| 40 | +Other parameters<br> | |
| 41 | +----------------<br> | |
| 42 | +color : scalar or array-like, optional<br> | |
| 43 | + the colors of the bars<br> | |
| 44 | + <br> | |
| 45 | +edgecolor : scalar or array-like, optional<br> | |
| 46 | + the colors of the bar edges<br> | |
| 47 | + <br> | |
| 48 | +linewidth : scalar or array-like, optional, default: None<br> | |
| 49 | + width of bar edge(s). If None, use default<br> | |
| 50 | + linewidth; If 0, don't draw edges.<br> | |
| 51 | + <br> | |
| 52 | +tick_label : string or array-like, optional, default: None<br> | |
| 53 | + the tick labels of the bars<br> | |
| 54 | + <br> | |
| 55 | +xerr : scalar or array-like, optional, default: None<br> | |
| 56 | + if not None, will be used to generate errorbar(s) on the bar chart<br> | |
| 57 | + <br> | |
| 58 | +yerr : scalar or array-like, optional, default: None<br> | |
| 59 | + if not None, will be used to generate errorbar(s) on the bar chart<br> | |
| 60 | + <br> | |
| 61 | +ecolor : scalar or array-like, optional, default: None<br> | |
| 62 | + specifies the color of errorbar(s)<br> | |
| 63 | + <br> | |
| 64 | +capsize : scalar, optional<br> | |
| 65 | + determines the length in points of the error bar caps<br> | |
| 66 | + default: None, which will take the value from the<br> | |
| 67 | + ``errorbar.capsize`` :data:`rcParam<matplotlib.rcParams>`.<br> | |
| 68 | + <br> | |
| 69 | +error_kw :<br> | |
| 70 | + dictionary of kwargs to be passed to errorbar method. `ecolor` and<br> | |
| 71 | + `capsize` may be specified here rather than as independent kwargs.<br> | |
| 72 | + <br> | |
| 73 | +align : ['edge' | 'center'], optional, default: 'edge'<br> | |
| 74 | + If `edge`, aligns bars by their left edges (for vertical bars) and<br> | |
| 75 | + by their bottom edges (for horizontal bars). If `center`, interpret<br> | |
| 76 | + the `left` argument as the coordinates of the centers of the bars.<br> | |
| 77 | + <br> | |
| 78 | +log : boolean, optional, default: False<br> | |
| 79 | + If true, sets the axis to be log scale<br> | |
| 80 | + <br> | |
| 81 | +Notes<br> | |
| 82 | +-----<br> | |
| 83 | +The optional arguments `color`, `edgecolor`, `linewidth`,<br> | |
| 84 | +`xerr`, and `yerr` can be either scalars or sequences of<br> | |
| 85 | +length equal to the number of bars. This enables you to use<br> | |
| 86 | +bar as the basis for stacked bar charts, or candlestick plots.<br> | |
| 87 | +Detail: `xerr` and `yerr` are passed directly to<br> | |
| 88 | +:meth:`errorbar`, so they can also have shape 2xN for<br> | |
| 89 | +independent specification of lower and upper errors.<br> | |
| 90 | + <br> | |
| 91 | +Other optional kwargs:<br> | |
| 92 | + <br> | |
| 93 | + agg_filter: unknown<br> | |
| 94 | + alpha: float or None <br> | |
| 95 | + animated: [True | False] <br> | |
| 96 | + antialiased or aa: [True | False] or None for default <br> | |
| 97 | + axes: an :class:`~matplotlib.axes.Axes` instance <br> | |
| 98 | + capstyle: ['butt' | 'round' | 'projecting'] <br> | |
| 99 | + clip_box: a :class:`matplotlib.transforms.Bbox` instance <br> | |
| 100 | + clip_on: [True | False] <br> | |
| 101 | + clip_path: [ (:class:`~matplotlib.path.Path`, :class:`~matplotlib.transforms.Transform`) | :class:`~matplotlib.patches.Patch` | None ] <br> | |
| 102 | + color: matplotlib color spec<br> | |
| 103 | + contains: a callable function <br> | |
| 104 | + edgecolor or ec: mpl color spec, or None for default, or 'none' for no color <br> | |
| 105 | + facecolor or fc: mpl color spec, or None for default, or 'none' for no color <br> | |
| 106 | + figure: a :class:`matplotlib.figure.Figure` instance <br> | |
| 107 | + fill: [True | False] <br> | |
| 108 | + gid: an id string <br> | |
| 109 | + hatch: ['/' | '\\' | '|' | '-' | '+' | 'x' | 'o' | 'O' | '.' | '*'] <br> | |
| 110 | + joinstyle: ['miter' | 'round' | 'bevel'] <br> | |
| 111 | + label: string or anything printable with '%s' conversion. <br> | |
| 112 | + linestyle or ls: ['solid' | 'dashed', 'dashdot', 'dotted' | (offset, on-off-dash-seq) | ``'-'`` | ``'--'`` | ``'-.'`` | ``':'`` | ``'None'`` | ``' '`` | ``''``]<br> | |
| 113 | + linewidth or lw: float or None for default <br> | |
| 114 | + path_effects: unknown<br> | |
| 115 | + picker: [None|float|boolean|callable] <br> | |
| 116 | + rasterized: [True | False | None] <br> | |
| 117 | + sketch_params: unknown<br> | |
| 118 | + snap: unknown<br> | |
| 119 | + transform: :class:`~matplotlib.transforms.Transform` instance <br> | |
| 120 | + url: a url string <br> | |
| 121 | + visible: [True | False] <br> | |
| 122 | + zorder: any number <br> | |
| 123 | + <br> | |
| 124 | +See also<br> | |
| 125 | +--------<br> | |
| 126 | +bar: Plot a vertical bar plot.<br> | |
| 127 | + <br> | |
| 128 | + <br> | |
| 129 | + <br> | |
| 130 | +Additional kwargs: hold = [True|False] overrides default hold state</tt></dd></dl> | |
| 131 | + | |
| 132 | +</div></div> |
chunks/doc-plt-contour.md
View file @
9186cc5
| 1 | +## Tr. des lignes de niveau avec `plt.contour` {autodoc} | |
| 2 | +<div class='scrollatbottom'> | |
| 3 | +<ul> | |
| 4 | +<li>Plusieurs combinaisons de paramètres possibles | |
| 5 | +<ul> | |
| 6 | +<li>soit un tableau 2D de valeurs "z"</li> | |
| 7 | +<li>soit 3 tableaux 1D/1D/2D (ou 2D/2D/2D) de valeurs "x", "y", "z" (pour donner les positions sur les axes x et y)</li> | |
| 8 | +<li>dans les deux cas, optionellement en plus, une liste des valeurs des lignes de niveaux</li> | |
| 9 | +</ul> | |
| 10 | +</li> | |
| 11 | +<li>Paramètres nommés intéressants : <code>extent</code> (bornes x et y), <code>cmap</code> (couleurs), <code>alpha</code> (opacité), <code>norm</code> (normalisation des "z")</li> | |
| 12 | +</ul> | |
| 13 | + | |
| 14 | + | |
| 15 | +<div class='scroll'> | |
| 16 | +Python Library Documentation: function contour in matplotlib.pyplot | |
| 17 | + | |
| 18 | +<dl><dt><a name="-matplotlib.pyplot.contour"><strong>matplotlib.pyplot.contour</strong></a> = contour(*args, **kwargs)</dt><dd><tt>Plot contours.<br> | |
| 19 | + <br> | |
| 20 | +:func:`~matplotlib.pyplot.contour` and<br> | |
| 21 | +:func:`~matplotlib.pyplot.contourf` draw contour lines and<br> | |
| 22 | +filled contours, respectively. Except as noted, function<br> | |
| 23 | +signatures and return values are the same for both versions.<br> | |
| 24 | + <br> | |
| 25 | +:func:`~matplotlib.pyplot.contourf` differs from the MATLAB<br> | |
| 26 | +version in that it does not draw the polygon edges.<br> | |
| 27 | +To draw edges, add line contours with<br> | |
| 28 | +calls to :func:`~matplotlib.pyplot.contour`.<br> | |
| 29 | + <br> | |
| 30 | + <br> | |
| 31 | +Call signatures::<br> | |
| 32 | + <br> | |
| 33 | + contour(Z)<br> | |
| 34 | + <br> | |
| 35 | +make a contour plot of an array *Z*. The level values are chosen<br> | |
| 36 | +automatically.<br> | |
| 37 | + <br> | |
| 38 | +::<br> | |
| 39 | + <br> | |
| 40 | + contour(X,Y,Z)<br> | |
| 41 | + <br> | |
| 42 | +*X*, *Y* specify the (x, y) coordinates of the surface<br> | |
| 43 | + <br> | |
| 44 | +::<br> | |
| 45 | + <br> | |
| 46 | + contour(Z,N)<br> | |
| 47 | + contour(X,Y,Z,N)<br> | |
| 48 | + <br> | |
| 49 | +contour up to *N* automatically-chosen levels.<br> | |
| 50 | + <br> | |
| 51 | +::<br> | |
| 52 | + <br> | |
| 53 | + contour(Z,V)<br> | |
| 54 | + contour(X,Y,Z,V)<br> | |
| 55 | + <br> | |
| 56 | +draw contour lines at the values specified in sequence *V*,<br> | |
| 57 | +which must be in increasing order.<br> | |
| 58 | + <br> | |
| 59 | +::<br> | |
| 60 | + <br> | |
| 61 | + contourf(..., V)<br> | |
| 62 | + <br> | |
| 63 | +fill the ``len(V)-1`` regions between the values in *V*,<br> | |
| 64 | +which must be in increasing order.<br> | |
| 65 | + <br> | |
| 66 | +::<br> | |
| 67 | + <br> | |
| 68 | + contour(Z, **kwargs)<br> | |
| 69 | + <br> | |
| 70 | +Use keyword args to control colors, linewidth, origin, cmap ... see<br> | |
| 71 | +below for more details.<br> | |
| 72 | + <br> | |
| 73 | +*X* and *Y* must both be 2-D with the same shape as *Z*, or they<br> | |
| 74 | +must both be 1-D such that ``len(X)`` is the number of columns in<br> | |
| 75 | +*Z* and ``len(Y)`` is the number of rows in *Z*.<br> | |
| 76 | + <br> | |
| 77 | +``C = contour(...)`` returns a<br> | |
| 78 | +:class:`~matplotlib.contour.QuadContourSet` object.<br> | |
| 79 | + <br> | |
| 80 | +Optional keyword arguments:<br> | |
| 81 | + <br> | |
| 82 | + *corner_mask*: [ *True* | *False* | 'legacy' ]<br> | |
| 83 | + Enable/disable corner masking, which only has an effect if *Z* is<br> | |
| 84 | + a masked array. If *False*, any quad touching a masked point is<br> | |
| 85 | + masked out. If *True*, only the triangular corners of quads<br> | |
| 86 | + nearest those points are always masked out, other triangular<br> | |
| 87 | + corners comprising three unmasked points are contoured as usual.<br> | |
| 88 | + If 'legacy', the old contouring algorithm is used, which is<br> | |
| 89 | + equivalent to *False* and is deprecated, only remaining whilst the<br> | |
| 90 | + new algorithm is tested fully.<br> | |
| 91 | + <br> | |
| 92 | + If not specified, the default is taken from<br> | |
| 93 | + rcParams['contour.corner_mask'], which is True unless it has<br> | |
| 94 | + been modified.<br> | |
| 95 | + <br> | |
| 96 | + *colors*: [ *None* | string | (mpl_colors) ]<br> | |
| 97 | + If *None*, the colormap specified by cmap will be used.<br> | |
| 98 | + <br> | |
| 99 | + If a string, like 'r' or 'red', all levels will be plotted in this<br> | |
| 100 | + color.<br> | |
| 101 | + <br> | |
| 102 | + If a tuple of matplotlib color args (string, float, rgb, etc),<br> | |
| 103 | + different levels will be plotted in different colors in the order<br> | |
| 104 | + specified.<br> | |
| 105 | + <br> | |
| 106 | + *alpha*: float<br> | |
| 107 | + The alpha blending value<br> | |
| 108 | + <br> | |
| 109 | + *cmap*: [ *None* | Colormap ]<br> | |
| 110 | + A cm :class:`~matplotlib.colors.Colormap` instance or<br> | |
| 111 | + *None*. If *cmap* is *None* and *colors* is *None*, a<br> | |
| 112 | + default Colormap is used.<br> | |
| 113 | + <br> | |
| 114 | + *norm*: [ *None* | Normalize ]<br> | |
| 115 | + A :class:`matplotlib.colors.Normalize` instance for<br> | |
| 116 | + scaling data values to colors. If *norm* is *None* and<br> | |
| 117 | + *colors* is *None*, the default linear scaling is used.<br> | |
| 118 | + <br> | |
| 119 | + *vmin*, *vmax*: [ *None* | scalar ]<br> | |
| 120 | + If not *None*, either or both of these values will be<br> | |
| 121 | + supplied to the :class:`matplotlib.colors.Normalize`<br> | |
| 122 | + instance, overriding the default color scaling based on<br> | |
| 123 | + *levels*.<br> | |
| 124 | + <br> | |
| 125 | + *levels*: [level0, level1, ..., leveln]<br> | |
| 126 | + A list of floating point numbers indicating the level<br> | |
| 127 | + curves to draw, in increasing order; e.g., to draw just<br> | |
| 128 | + the zero contour pass ``levels=[0]``<br> | |
| 129 | + <br> | |
| 130 | + *origin*: [ *None* | 'upper' | 'lower' | 'image' ]<br> | |
| 131 | + If *None*, the first value of *Z* will correspond to the<br> | |
| 132 | + lower left corner, location (0,0). If 'image', the rc<br> | |
| 133 | + value for ``image.origin`` will be used.<br> | |
| 134 | + <br> | |
| 135 | + This keyword is not active if *X* and *Y* are specified in<br> | |
| 136 | + the call to contour.<br> | |
| 137 | + <br> | |
| 138 | + *extent*: [ *None* | (x0,x1,y0,y1) ]<br> | |
| 139 | + <br> | |
| 140 | + If *origin* is not *None*, then *extent* is interpreted as<br> | |
| 141 | + in :func:`matplotlib.pyplot.imshow`: it gives the outer<br> | |
| 142 | + pixel boundaries. In this case, the position of Z[0,0]<br> | |
| 143 | + is the center of the pixel, not a corner. If *origin* is<br> | |
| 144 | + *None*, then (*x0*, *y0*) is the position of Z[0,0], and<br> | |
| 145 | + (*x1*, *y1*) is the position of Z[-1,-1].<br> | |
| 146 | + <br> | |
| 147 | + This keyword is not active if *X* and *Y* are specified in<br> | |
| 148 | + the call to contour.<br> | |
| 149 | + <br> | |
| 150 | + *locator*: [ *None* | ticker.Locator subclass ]<br> | |
| 151 | + If *locator* is *None*, the default<br> | |
| 152 | + :class:`~matplotlib.ticker.MaxNLocator` is used. The<br> | |
| 153 | + locator is used to determine the contour levels if they<br> | |
| 154 | + are not given explicitly via the *V* argument.<br> | |
| 155 | + <br> | |
| 156 | + *extend*: [ 'neither' | 'both' | 'min' | 'max' ]<br> | |
| 157 | + Unless this is 'neither', contour levels are automatically<br> | |
| 158 | + added to one or both ends of the range so that all data<br> | |
| 159 | + are included. These added ranges are then mapped to the<br> | |
| 160 | + special colormap values which default to the ends of the<br> | |
| 161 | + colormap range, but can be set via<br> | |
| 162 | + :meth:`matplotlib.colors.Colormap.set_under` and<br> | |
| 163 | + :meth:`matplotlib.colors.Colormap.set_over` methods.<br> | |
| 164 | + <br> | |
| 165 | + *xunits*, *yunits*: [ *None* | registered units ]<br> | |
| 166 | + Override axis units by specifying an instance of a<br> | |
| 167 | + :class:`matplotlib.units.ConversionInterface`.<br> | |
| 168 | + <br> | |
| 169 | + *antialiased*: [ *True* | *False* ]<br> | |
| 170 | + enable antialiasing, overriding the defaults. For<br> | |
| 171 | + filled contours, the default is *True*. For line contours,<br> | |
| 172 | + it is taken from rcParams['lines.antialiased'].<br> | |
| 173 | + <br> | |
| 174 | + *nchunk*: [ 0 | integer ]<br> | |
| 175 | + If 0, no subdivision of the domain. Specify a positive integer to<br> | |
| 176 | + divide the domain into subdomains of *nchunk* by *nchunk* quads.<br> | |
| 177 | + Chunking reduces the maximum length of polygons generated by the<br> | |
| 178 | + contouring algorithm which reduces the rendering workload passed<br> | |
| 179 | + on to the backend and also requires slightly less RAM. It can<br> | |
| 180 | + however introduce rendering artifacts at chunk boundaries depending<br> | |
| 181 | + on the backend, the *antialiased* flag and value of *alpha*.<br> | |
| 182 | + <br> | |
| 183 | +contour-only keyword arguments:<br> | |
| 184 | + <br> | |
| 185 | + *linewidths*: [ *None* | number | tuple of numbers ]<br> | |
| 186 | + If *linewidths* is *None*, the default width in<br> | |
| 187 | + ``lines.linewidth`` in ``matplotlibrc`` is used.<br> | |
| 188 | + <br> | |
| 189 | + If a number, all levels will be plotted with this linewidth.<br> | |
| 190 | + <br> | |
| 191 | + If a tuple, different levels will be plotted with different<br> | |
| 192 | + linewidths in the order specified.<br> | |
| 193 | + <br> | |
| 194 | + *linestyles*: [ *None* | 'solid' | 'dashed' | 'dashdot' | 'dotted' ]<br> | |
| 195 | + If *linestyles* is *None*, the default is 'solid' unless<br> | |
| 196 | + the lines are monochrome. In that case, negative<br> | |
| 197 | + contours will take their linestyle from the ``matplotlibrc``<br> | |
| 198 | + ``contour.negative_linestyle`` setting.<br> | |
| 199 | + <br> | |
| 200 | + *linestyles* can also be an iterable of the above strings<br> | |
| 201 | + specifying a set of linestyles to be used. If this<br> | |
| 202 | + iterable is shorter than the number of contour levels<br> | |
| 203 | + it will be repeated as necessary.<br> | |
| 204 | + <br> | |
| 205 | +contourf-only keyword arguments:<br> | |
| 206 | + <br> | |
| 207 | + *hatches*:<br> | |
| 208 | + A list of cross hatch patterns to use on the filled areas.<br> | |
| 209 | + If None, no hatching will be added to the contour.<br> | |
| 210 | + Hatching is supported in the PostScript, PDF, SVG and Agg<br> | |
| 211 | + backends only.<br> | |
| 212 | + <br> | |
| 213 | + <br> | |
| 214 | +Note: contourf fills intervals that are closed at the top; that<br> | |
| 215 | +is, for boundaries *z1* and *z2*, the filled region is::<br> | |
| 216 | + <br> | |
| 217 | + z1 < z <= z2<br> | |
| 218 | + <br> | |
| 219 | +There is one exception: if the lowest boundary coincides with<br> | |
| 220 | +the minimum value of the *z* array, then that minimum value<br> | |
| 221 | +will be included in the lowest interval.<br> | |
| 222 | + <br> | |
| 223 | +**Examples:**<br> | |
| 224 | + <br> | |
| 225 | +.. plot:: mpl_examples/pylab_examples/contour_demo.py<br> | |
| 226 | + <br> | |
| 227 | +.. plot:: mpl_examples/pylab_examples/contourf_demo.py<br> | |
| 228 | + <br> | |
| 229 | +.. plot:: mpl_examples/pylab_examples/contour_corner_mask.py<br> | |
| 230 | + <br> | |
| 231 | + <br> | |
| 232 | + <br> | |
| 233 | +Additional kwargs: hold = [True|False] overrides default hold state</tt></dd></dl> | |
| 234 | + | |
| 235 | +</div></div> |