-import copy
-import io
-from pathlib import Path
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
+import copy
+import io
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Union
-import matplotlib.pyplot as plt
-from matplotlib import axes, figure, gridspec
+import matplotlib.pyplot as plt
+from matplotlib import axes, figure, gridspec
__all__ = ["insert_image", "Template"]
try:
- import requests
+ import requests
except ImportError: # pragma: no cover
if TYPE_CHECKING:
- import requests
+ import requests
else:
requests = None
try:
- from PIL import Image
- from PIL.ExifTags import TAGS
- from PIL.Image import Resampling, Transpose # type:ignore
+ from PIL import Image
+ from PIL.ExifTags import TAGS
+ from PIL.Image import Resampling, Transpose # type:ignore
except ImportError: # pragma: no cover
if TYPE_CHECKING:
- from PIL import Image
- from PIL.ExifTags import TAGS
- from PIL.Image import Resampling, Transpose # type:ignore
+ from PIL import Image
+ from PIL.ExifTags import TAGS
+ from PIL.Image import Resampling, Transpose # type:ignore
else:
TAGS, Image = None, None
-def _calc_extents(size: int, scale: float) -> Tuple[float, float]:
+def _calc_extents(size: int, scale: float) -> Tuple[float, float]:
"""
Calculates the view limits needed to see a
centered image at the desired scale.
@@ -137,7 +137,7 @@ Source code for mpl_template.template
return -lower, upper
-def _image_path_or_url(path: str) -> Union[str, io.BytesIO]:
+def _image_path_or_url(path: str) -> Union[str, io.BytesIO]:
"""
Prepares image path or url for loading into format ready for
loading by PIL.Image.open()
@@ -173,64 +173,55 @@ Source code for mpl_template.template
return str(Path(path).resolve())
-def _apply_exif_rotation(im):
+def _apply_exif_rotation(im: Image.Image):
"""Apply exif rotation tag to a PIL image object
Parameters
----------
- im : PIL.Image
+ im : PIL.Image.Image
image object that may contain rotation data
Returns
-------
- PIL.Image
+ PIL.Image.Image
"""
- if TAGS is None or Image is None: # pragma: no cover
- raise ImportError("The `pillow` library is required to manipulate images.")
- i = im.copy()
-
- try:
- exif = {TAGS.get(tag): value for tag, value in im._getexif().items()}
-
- # this section adapted from the following SO post:
- # https://stackoverflow.com/a/1608846/7486933
-
- orientation = exif.get("Orientation")
- if orientation == 1:
- # Nothing
- i = im.copy()
- elif orientation == 2:
- # Vertical Mirror
- i = im.transpose(Transpose.FLIP_LEFT_RIGHT)
- elif orientation == 3:
- # Rotation 180°
- i = im.transpose(Transpose.ROTATE_180)
- elif orientation == 4:
- # Horizontal Mirror
- i = im.transpose(Transpose.FLIP_TOP_BOTTOM)
- elif orientation == 5:
- # Horizontal Mirror + Rotation 90° CCW
- i = im.transpose(Transpose.FLIP_TOP_BOTTOM).transpose(Transpose.ROTATE_90)
- elif orientation == 6:
- # Rotation 270°
- i = im.transpose(Transpose.ROTATE_270)
- elif orientation == 7:
- # Horizontal Mirror + Rotation 270°
- i = im.transpose(Transpose.FLIP_TOP_BOTTOM).transpose(Transpose.ROTATE_270)
- elif orientation == 8:
- # Rotation 90°
- i = im.transpose(Transpose.ROTATE_90)
- else: # pragma: no cover
- raise Exception("Invalid EXIF Orientation Value")
- return i
-
- except (AttributeError, KeyError, IndexError):
+
+ exif = {TAGS.get(tag): value for tag, value in im.getexif().items()}
+
+ # this section adapted from the following SO post:
+ # https://stackoverflow.com/a/1608846/7486933
+
+ orientation = exif.get("Orientation")
+ if orientation in [None, 1]:
return im
+ if orientation == 2:
+ # Vertical Mirror
+ return im.transpose(Transpose.FLIP_LEFT_RIGHT)
+ if orientation == 3:
+ # Rotation 180°
+ return im.transpose(Transpose.ROTATE_180)
+ if orientation == 4:
+ # Horizontal Mirror
+ return im.transpose(Transpose.FLIP_TOP_BOTTOM)
+ if orientation == 5:
+ # Horizontal Mirror + Rotation 90° CCW
+ return im.transpose(Transpose.FLIP_TOP_BOTTOM).transpose(Transpose.ROTATE_90)
+ if orientation == 6:
+ # Rotation 270°
+ return im.transpose(Transpose.ROTATE_270)
+ if orientation == 7:
+ # Horizontal Mirror + Rotation 270°
+ return im.transpose(Transpose.FLIP_TOP_BOTTOM).transpose(Transpose.ROTATE_270)
+ if orientation == 8:
+ # Rotation 90°
+ return im.transpose(Transpose.ROTATE_90)
+
+ raise Exception("Invalid EXIF Orientation Value") # pragma: no cover
[docs]
-
def insert_image(
+
def insert_image(
ax: axes.Axes,
image_path: str,
scale: float = 1.0,
@@ -312,9 +303,12 @@
Source code for mpl_template.template
kwargs = {"xticks": [], "yticks": [], "zorder": 1} | kwargs
- imgaxes = ax.figure.add_axes(ax.get_position(), **kwargs)
+ imgaxes = ax.figure.add_axes(
+ ax.get_position(), # type: ignore
+ **kwargs,
+ )
bbox = ax.get_window_extent().transformed(
- ax.get_figure().dpi_scale_trans.inverted() # type: ignore
+ ax.get_figure().dpi_scale_trans.inverted(), # type: ignore
)
width, height = bbox.width, bbox.height
width *= dpi
@@ -372,7 +366,7 @@ Source code for mpl_template.template
-def _get_default_tb_spans(
+def _get_default_tb_spans(
rows: Tuple[int, ...], cols: Tuple[int, ...]
) -> List[Dict[str, Any]]:
spans = [
@@ -385,7 +379,7 @@ Source code for mpl_template.template
return spans
-def _validate_margins(
+def _validate_margins(
margins: Optional[Tuple[int, int, int, int]] = None, base=10.0
) -> Tuple[int, int, int, int]:
if margins is None:
@@ -398,7 +392,7 @@ Source code for mpl_template.template
[docs]
-
class Template:
+
class Template:
"""
Class to construct a report figure template using matplotlib
which includes a figure border, script path, and title block.
@@ -493,7 +487,7 @@
Source code for mpl_template.template
"""
- def __init__(
+ def __init__(
self,
margins: Optional[Tuple[int, int, int, int]] = None,
titleblock_content=None,
@@ -545,34 +539,34 @@ Source code for mpl_template.template
self._titleblock_axes = []
@property
- def base(self):
+ def base(self):
return self._base
@property
- def titleblock_axes(self):
+ def titleblock_axes(self):
return self._titleblock_axes
@property
- def margins(self):
+ def margins(self):
return self._margins
@margins.setter
- def margins(self, value): # pragma: no cover
+ def margins(self, value): # pragma: no cover
self._margins = _validate_margins(value)
self.left, self.right, self.top, self.bottom = self._margins
@property
- def titleblock_content(self):
+ def titleblock_content(self):
if self._titleblock_content is None:
self._titleblock_content = self.default_spans
return self._titleblock_content
@titleblock_content.setter # pragma: no cover
- def titleblock_content(self, value):
+ def titleblock_content(self, value):
self._titleblock_content = value
@property
- def fig(self) -> figure.Figure:
+ def fig(self) -> figure.Figure:
if self._fig is None:
self._fig = plt.figure(**self._fig_options)
if self.is_draft: # pragma: no branch
@@ -580,11 +574,11 @@ Source code for mpl_template.template
return self._fig
@fig.setter
- def fig(self, value): # pragma: no cover
+ def fig(self, value): # pragma: no cover
self._fig = value
@property
- def gsfig(self):
+ def gsfig(self):
if self._gsfig is None: # pragma: no branch
row = int(self.fig.get_figheight() * self.base)
col = int(self.fig.get_figwidth() * self.base)
@@ -594,31 +588,31 @@ Source code for mpl_template.template
return self._gsfig
@gsfig.setter
- def gsfig(self, value): # pragma: no cover
+ def gsfig(self, value): # pragma: no cover
self._gsfig = value
@property
- def watermark(self):
+ def watermark(self):
if self._watermark is None:
self._watermark = self.add_watermark()
return self._watermark
@watermark.setter
- def watermark(self, value):
+ def watermark(self, value):
self._watermark = value
@property
- def path_text(self):
+ def path_text(self):
if self._path_text is None:
self._path_text = str(Path.cwd() / self.script_name)
return self._path_text
@path_text.setter
- def path_text(self, value):
+ def path_text(self, value):
self._path_text = value
@property
- def gstitleblock(self):
+ def gstitleblock(self):
if self._gstitleblock is None:
self._gstitleblock = self.gsfig[
-(self.bottom + self.t_h) or None : -self.bottom or None,
@@ -627,12 +621,12 @@ Source code for mpl_template.template
return self._gstitleblock
@gstitleblock.setter
- def gstitleblock(self, value):
+ def gstitleblock(self, value):
self._gstitleblock = value
self._gstitleblock_subspec = None
@property
- def gstitleblock_subspec(self):
+ def gstitleblock_subspec(self):
if self._gstitleblock_subspec is None:
self._gstitleblock_subspec = gridspec.GridSpecFromSubplotSpec(
self.t_h,
@@ -644,24 +638,24 @@ Source code for mpl_template.template
return self._gstitleblock_subspec
@gstitleblock_subspec.setter
- def gstitleblock_subspec(self, value): # pragma: no cover
+ def gstitleblock_subspec(self, value): # pragma: no cover
self._gstitleblock_subspec = value
- def add_frame(self):
+ def add_frame(self):
fheight = self.base * self.fig.get_figheight()
fwidth = self.base * self.fig.get_figwidth()
_left = self.left / fwidth
_right = self.right / fwidth
_bottom = self.bottom / fheight
_top = self.top / fheight
- rect = [_left, _bottom, 1 - (_left + _right), 1 - (_bottom + _top)]
+ rect = (_left, _bottom, 1 - (_left + _right), 1 - (_bottom + _top))
frame = self.fig.add_axes(
rect, zorder=100, facecolor="none", xticks=[], yticks=[], label="frame"
)
return frame
- def add_watermark(self, text=None):
+ def add_watermark(self, text=None):
if text is None: # pragma: no branch
text = "DRAFT"
x = (0.5 * self.base) / (self.base * self.fig.get_figwidth())
@@ -681,7 +675,7 @@ Source code for mpl_template.template
self.watermark = watermark
return self.watermark
- def add_titleblock(self):
+ def add_titleblock(self):
if len(self.titleblock_axes) > 0:
return self.titleblock_axes
@@ -713,9 +707,9 @@ Source code for mpl_template.template
return self.titleblock_axes
- def add_page(self): # pragma: no cover
+ def add_page(self): # pragma: no cover
ax = self.fig.add_axes(
- [0, 0, 1, 1],
+ (0, 0, 1, 1),
zorder=1000,
facecolor="none",
xticks=[],
@@ -724,7 +718,7 @@ Source code for mpl_template.template
)
return ax
- def add_path_text(self):
+ def add_path_text(self):
x = self.left / (self.base * self.fig.get_figwidth())
y = abs(
(self.bottom - 0.15 * self.base) / (self.base * self.fig.get_figheight())
@@ -741,9 +735,9 @@ Source code for mpl_template.template
return textobj
- def populate_titleblock(self):
+ def populate_titleblock(self):
for i, (ax, dct) in enumerate(
- zip(self.titleblock_axes, self.titleblock_content)
+ zip(self.titleblock_axes, self.titleblock_content, strict=True)
):
assert ax.get_label() == dct.get("name", "b_{}".format(i)), (
"Axes are out of order."
@@ -776,7 +770,7 @@ Source code for mpl_template.template
img_ax.set_label("img_b_{}".format(i))
img_ax.axis("off")
- def setup_figure(self) -> figure.Figure:
+ def setup_figure(self) -> figure.Figure:
_ = self.add_frame()
_ = self.add_titleblock()
_ = self.add_path_text()
@@ -784,7 +778,7 @@ Source code for mpl_template.template
return self.fig
- def blank(self, with_labels=True) -> figure.Figure:
+ def blank(self, with_labels=True) -> figure.Figure:
self.add_frame()
axes = self.add_titleblock()
if with_labels:
diff --git a/docs/_sources/notebooks/tutorial/Template_Docs.ipynb.txt b/docs/_sources/notebooks/tutorial/Template_Docs.ipynb.txt
index f343d1d..26e0440 100644
--- a/docs/_sources/notebooks/tutorial/Template_Docs.ipynb.txt
+++ b/docs/_sources/notebooks/tutorial/Template_Docs.ipynb.txt
@@ -17,8 +17,9 @@
"source": [
"import copy\n",
"import os\n",
- "import matplotlib.pyplot as plt\n",
+ "\n",
"import matplotlib.gridspec as gs\n",
+ "import matplotlib.pyplot as plt\n",
"import numpy as np\n",
"\n",
"from mpl_template import Template, insert_image\n",
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
index 93a4776..9c0c9b8 100644
--- a/docs/_static/basic.css
+++ b/docs/_static/basic.css
@@ -741,14 +741,6 @@ abbr, acronym {
cursor: help;
}
-.translated {
- background-color: rgba(207, 255, 207, 0.2)
-}
-
-.untranslated {
- background-color: rgba(255, 207, 207, 0.2)
-}
-
/* -- code displays --------------------------------------------------------- */
pre {
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 882be4b..ed79561 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
- VERSION: '0.6.0',
+ VERSION: '0.7.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/docs/_static/js/versions.js b/docs/_static/js/versions.js
index 26cf995..88c235b 100644
--- a/docs/_static/js/versions.js
+++ b/docs/_static/js/versions.js
@@ -1,6 +1,6 @@
const themeFlyoutDisplay = "hidden";
-const themeVersionSelector = "True";
-const themeLanguageSelector = "True";
+const themeVersionSelector = true;
+const themeLanguageSelector = true;
if (themeFlyoutDisplay === "attached") {
function renderLanguages(config) {
@@ -8,10 +8,14 @@ if (themeFlyoutDisplay === "attached") {
return "";
}
+ // Insert the current language to the options on the selector
+ let languages = config.projects.translations.concat(config.projects.current);
+ languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
+
const languagesHTML = `
- Languages
- ${config.projects.translations
+ ${languages
.map(
(translation) => `
-
diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css
index 483d0fc..27836fa 100644
--- a/docs/_static/pygments.css
+++ b/docs/_static/pygments.css
@@ -6,9 +6,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
-.highlight .err { border: 1px solid #FF0000 } /* Error */
+.highlight .err { border: 1px solid #F00 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
-.highlight .o { color: #666666 } /* Operator */
+.highlight .o { color: #666 } /* Operator */
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
@@ -25,34 +25,34 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.highlight .gt { color: #0044DD } /* Generic.Traceback */
+.highlight .gt { color: #04D } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
-.highlight .m { color: #666666 } /* Literal.Number */
+.highlight .m { color: #666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #687822 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
-.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
-.highlight .no { color: #880000 } /* Name.Constant */
-.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */
+.highlight .no { color: #800 } /* Name.Constant */
+.highlight .nd { color: #A2F } /* Name.Decorator */
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
-.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nf { color: #00F } /* Name.Function */
.highlight .nl { color: #767600 } /* Name.Label */
-.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
-.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
-.highlight .w { color: #bbbbbb } /* Text.Whitespace */
-.highlight .mb { color: #666666 } /* Literal.Number.Bin */
-.highlight .mf { color: #666666 } /* Literal.Number.Float */
-.highlight .mh { color: #666666 } /* Literal.Number.Hex */
-.highlight .mi { color: #666666 } /* Literal.Number.Integer */
-.highlight .mo { color: #666666 } /* Literal.Number.Oct */
+.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #BBB } /* Text.Whitespace */
+.highlight .mb { color: #666 } /* Literal.Number.Bin */
+.highlight .mf { color: #666 } /* Literal.Number.Float */
+.highlight .mh { color: #666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
@@ -67,9 +67,9 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
-.highlight .fm { color: #0000FF } /* Name.Function.Magic */
+.highlight .fm { color: #00F } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
-.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */
+.highlight .il { color: #666 } /* Literal.Number.Integer.Long */
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index 2c774d1..91f4be5 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -513,9 +513,11 @@ const Search = {
// perform the search on the required terms
searchTerms.forEach((word) => {
const files = [];
+ // find documents, if any, containing the query word in their text/title term indices
+ // use Object.hasOwnProperty to avoid mismatching against prototype properties
const arr = [
- { files: terms[word], score: Scorer.term },
- { files: titleTerms[word], score: Scorer.title },
+ { files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
+ { files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
];
// add support for partial matches
if (word.length > 2) {
@@ -547,8 +549,9 @@ const Search = {
// set score for the word in each file
recordFiles.forEach((file) => {
- if (!scoreMap.has(file)) scoreMap.set(file, {});
- scoreMap.get(file)[word] = record.score;
+ if (!scoreMap.has(file)) scoreMap.set(file, new Map());
+ const fileScores = scoreMap.get(file);
+ fileScores.set(word, record.score);
});
});
@@ -587,7 +590,7 @@ const Search = {
break;
// select one (max) score for the file.
- const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
+ const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
// add result to the result list
results.push([
docNames[file],
diff --git a/docs/api.html b/docs/api.html
index 1a85736..4951507 100644
--- a/docs/api.html
+++ b/docs/api.html
@@ -6,15 +6,15 @@
- Template API Reference — mpl-template 0.6.0 documentation
-
+ Template API Reference — mpl-template<br /><span style="font-size:.7rem">v0.7.0</span> 0.7.0 documentation
+
-
+
-
+
@@ -33,7 +33,7 @@
- mpl-template
+ mpl-template
v0.7.0
-titleblock_cols (tuple of int, optional (default=(16, 16, 8))) – The specification (in tenths of an inch) of the rulers for
+
titleblock_cols (tuple of int, optional (default=(16, 16, 8))) – The specification (in tenths of an inch) of the rulers for
each column in the title block.
titleblock_rows (tuple of int, optional (default=(8, 5, 3))) – The specification (in tenths of an inch) of the rulers for
+
titleblock_rows (tuple of int, optional (default=(8, 5, 3))) – The specification (in tenths of an inch) of the rulers for
each rows in the title block.
draft (bool, optional (default=True)) – Toggles the inclusion of a draft watermark.
base (int, optional (default=10)) – Number of gridspec rows and columns per inch.
dpi (int, optional (default=300)) – Resolution of the final figure in dots per inch.
draft (bool, optional (default=True)) – Toggles the inclusion of a draft watermark.
base (int, optional (default=10)) – Number of gridspec rows and columns per inch.
dpi (int, optional (default=300)) – Resolution of the final figure in dots per inch.
**figkwargs – Additional keyword arguments passed to plt.figure
@@ -162,7 +162,7 @@
Examples
To produce an empty figure containing a border object,
and 5 title block objects:
->>> from mpl_template import Template
+>>> from mpl_template import Template
>>> report_fig = Template(figsize=(8.5, 11), scriptname="path/to/script.py")
>>> fig = report_fig.blank()
@@ -178,21 +178,21 @@
insert_image API Reference
-
-mpl_template.template.insert_image(ax: Axes, image_path: str, scale: float = 1.0, dpi: float = 300.0, expand: bool = False, **kwargs) → Axes[source]
+mpl_template.template.insert_image(ax: Axes, image_path: str, scale: float = 1.0, dpi: float = 300.0, expand: bool = False, **kwargs) → Axes[source]
Centers an image within an axes object
- Parameters:
ax (matplotlib.Axes) – the axes into which the image should be inserted.
image_path (str) – Path to an existing image file.
scale (float, optional) – The relative scale of the desired output.
+
image_path (str) – Path to an existing image file.
scale (float, optional) – The relative scale of the desired output.
Values should be positive floats.
E.g. scale = 2 will double the image’s size
relative to the given matplotlib.Axes object.
scale = 0.5 will scale the image to half of the
given matplotlib.Axes object.
dpi (int, optional (default=300)) – The Dots (pixel) Per Inch of the image.
expand (bool, optional (default=False)) – If true, the image will expand to fill the axes
+
dpi (int, optional (default=300)) – The Dots (pixel) Per Inch of the image.
expand (bool, optional (default=False)) – If true, the image will expand to fill the axes
in which it is embedded. Use expand = True if the
boundary of the enclosing axes is the desired crop boundary.
Use expand = False if the image should be scaled in-place
@@ -216,8 +216,8 @@
insert_imageZoomed out 2x with scale=0.5. Note that the enclosing axes is
square, and that the inserted axes is a landscape rectangle that
matches the shape of the source file.
->>> import matplotlib.pyplot as plt
->>> from mpl_template import insert_image
+>>> import matplotlib.pyplot as plt
+>>> from mpl_template import insert_image
>>> file = "img/polar_bar_demo.png"
>>> fig, ax = plt.subplots(figsize=(3, 3))
>>> img_ax = insert_image(ax, file, scale=0.5)
@@ -229,8 +229,8 @@ insert_image
Zoomed in 2x with scale=2. Note that the use of the expand
kwarg causes the zoomed image to fill the enclosing square axes object.
->>> import matplotlib.pyplot as plt
->>> from mpl_template import insert_image
+>>> import matplotlib.pyplot as plt
+>>> from mpl_template import insert_image
>>> file = "img/polar_bar_demo.png"
>>> fig, ax = plt.subplots(figsize=(3, 3))
>>> img_ax = insert_image(ax, file, scale=2, expand=True)
diff --git a/docs/genindex.html b/docs/genindex.html
index 70b0607..429cc89 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -5,15 +5,15 @@
- Index — mpl-template 0.6.0 documentation
-
+ Index — mpl-template<br /><span style="font-size:.7rem">v0.7.0</span> 0.7.0 documentation
+
-
+
-
+
@@ -31,7 +31,7 @@
- mpl-template
+ mpl-template
v0.7.0