Skip to content

Commit 8ed2c9f

Browse files
conradhauptconradhaupt
committed
Revert namespace renaming of PlotStyle parameters
1 parent 7c3ca90 commit 8ed2c9f

File tree

4 files changed

+36
-34
lines changed

4 files changed

+36
-34
lines changed

‎qiskit_experiments/library/characterization/analysis/cr_hamiltonian_analysis.py‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,11 @@ def _default_options(cls):
6464
default_options.plotter.set_options(
6565
subplots=(3, 1),
6666
style=PlotStyle(
67-
figsize=(8, 10),
68-
legend_loc="lower right",
69-
text_box_rel_pos=(0.28, -0.10),
67+
{
68+
"figsize": (8, 10),
69+
"legend_loc": "lower right",
70+
"textbox_rel_pos": (0.28, -0.10),
71+
}
7072
),
7173
)
7274
default_options.plotter.set_figure_options(

‎qiskit_experiments/visualization/drawers/mpl_drawer.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ def initialize_canvas(self):
9292
if isinstance(label, list):
9393
# Y label can be given as a list for each sub axis
9494
label = label[i]
95-
sub_ax.set_ylabel(label, fontsize=self.style["axis.label_size"])
95+
sub_ax.set_ylabel(label, fontsize=self.style["axis_label_size"])
9696
if i != n_rows - 1:
9797
# remove x axis except for most-bottom plot
9898
sub_ax.set_xticklabels([])
@@ -103,18 +103,18 @@ def initialize_canvas(self):
103103
if isinstance(label, list):
104104
# X label can be given as a list for each sub axis
105105
label = label[j]
106-
sub_ax.set_xlabel(label, fontsize=self.style["axis.label_size"])
106+
sub_ax.set_xlabel(label, fontsize=self.style["axis_label_size"])
107107
if j == 0 or i == n_rows - 1:
108108
# Set label size for outer axes where labels are drawn
109-
sub_ax.tick_params(labelsize=self.style["tick.label_size"])
109+
sub_ax.tick_params(labelsize=self.style["tick_label_size"])
110110
sub_ax.grid()
111111

112112
# Remove original axis frames
113113
axis.axis("off")
114114
else:
115-
axis.set_xlabel(self.figure_options.xlabel, fontsize=self.style["axis.label_size"])
116-
axis.set_ylabel(self.figure_options.ylabel, fontsize=self.style["axis.label_size"])
117-
axis.tick_params(labelsize=self.style["tick.label_size"])
115+
axis.set_xlabel(self.figure_options.xlabel, fontsize=self.style["axis_label_size"])
116+
axis.set_ylabel(self.figure_options.ylabel, fontsize=self.style["axis_label_size"])
117+
axis.tick_params(labelsize=self.style["tick_label_size"])
118118
axis.grid()
119119

120120
self._axis = axis
@@ -130,7 +130,7 @@ def format_canvas(self):
130130
for sub_ax in all_axes:
131131
_, labels = sub_ax.get_legend_handles_labels()
132132
if len(labels) > 1:
133-
sub_ax.legend(loc=self.style["legend.loc"])
133+
sub_ax.legend(loc=self.style["legend_loc"])
134134

135135
# Format x and y axis
136136
for ax_type in ("x", "y"):
@@ -216,7 +216,7 @@ def format_canvas(self):
216216
if self.figure_options.figure_title is not None:
217217
self._axis.set_title(
218218
label=self.figure_options.figure_title,
219-
fontsize=self.style["axis.label_size"],
219+
fontsize=self.style["axis_label_size"],
220220
)
221221

222222
def _get_axis(self, index: Optional[int] = None) -> Axes:
@@ -427,14 +427,14 @@ def draw_text_box(
427427
bbox_props.update(**options)
428428

429429
if rel_pos is None:
430-
rel_pos = self.style["textbox.rel_pos"]
430+
rel_pos = self.style["textbox_rel_pos"]
431431

432432
text_box_handler = self._axis.text(
433433
*rel_pos,
434434
s=description,
435435
ha="center",
436436
va="top",
437-
size=self.style["textbox.text_size"],
437+
size=self.style["textbox_text_size"],
438438
transform=self._axis.transAxes,
439439
zorder=1000, # Very large zorder to draw over other graphics.
440440
)

‎qiskit_experiments/visualization/style.py‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,26 @@ class PlotStyle(dict):
2020
This style class is used by :class:`BasePlotter` and :class:`BaseDrawer`. The default style for
2121
Qiskit Experiments is defined in :meth:`default_style`. Style parameters are stored as dictionary
2222
entries, grouped by graphics or figure component. For example, style parameters relating to textboxes
23-
have the prefix ``textbox.``. For default style parameter names and their values, see the
23+
have the prefix ``textbox_``. For default style parameter names and their values, see the
2424
:meth:`default_style` method.
2525
2626
Example:
2727
.. code-block:: python
2828
# Create custom style
2929
custom_style = PlotStyle(
3030
{
31-
"legend.loc": "upper right",
32-
"textbox.rel_pos": (1, 1),
33-
"textbox.text_size": 14,
31+
"legend_loc": "upper right",
32+
"textbox_rel_pos": (1, 1),
33+
"textbox_text_size": 14,
3434
}
3535
)
3636
3737
# Create full style, using PEP448 to combine with default style.
3838
full_style = PlotStyle.merge(PlotStyle.default_style(), custom_style)
3939
4040
# Query style parameters
41-
full_style["legend.loc"] # Returns "upper right"
42-
full_style["axis.label_size"] # Returns the value provided in ``PlotStyle.default_style()``
41+
full_style["legend_loc"] # Returns "upper right"
42+
full_style["axis_label_size"] # Returns the value provided in ``PlotStyle.default_style()``
4343
"""
4444

4545
@classmethod
@@ -48,12 +48,12 @@ def default_style(cls) -> "PlotStyle":
4848
4949
Style Parameters:
5050
figsize (Tuple[int,int]): The size of the figure ``(width, height)``, in inches.
51-
legend.loc (str): The location of the legend.
52-
tick.label_size (int): The font size for tick labels.
53-
axis.label_size (int): The font size for axis labels.
54-
textbox.rel_pos (Tuple[float,float]): The relative position ``(horizontal, vertical)`` of
51+
legend_loc (str): The location of the legend.
52+
tick_label_size (int): The font size for tick labels.
53+
axis_label_size (int): The font size for axis labels.
54+
textbox_rel_pos (Tuple[float,float]): The relative position ``(horizontal, vertical)`` of
5555
textboxes, as a percentage of the canvas dimensions.
56-
textbox.text_size (int): The font size for textboxes.
56+
textbox_text_size (int): The font size for textboxes.
5757
5858
Returns:
5959
PlotStyle: The default plot style used by Qiskit Experiments.
@@ -62,15 +62,15 @@ def default_style(cls) -> "PlotStyle":
6262
# size of figure (width, height)
6363
"figsize": (8, 5), # Tuple[int, int]
6464
# legend location (vertical, horizontal)
65-
"legend.loc": "center right", # str
65+
"legend_loc": "center right", # str
6666
# size of tick label
67-
"tick.label_size": 14, # int
67+
"tick_label_size": 14, # int
6868
# size of axis label
69-
"axis.label_size": 16, # int
69+
"axis_label_size": 16, # int
7070
# relative position of a textbox
71-
"textbox.rel_pos": (0.6, 0.95), # Tuple[float, float]
71+
"textbox_rel_pos": (0.6, 0.95), # Tuple[float, float]
7272
# size of textbox text
73-
"textbox.text_size": 14, # int
73+
"textbox_text_size": 14, # int
7474
}
7575
return cls(**style)
7676

‎test/visualization/test_style.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,11 @@ def test_default_only_contains_expected_fields(self):
6262
default = PlotStyle.default_style()
6363
expected_not_none_fields = [
6464
"figsize",
65-
"legend.loc",
66-
"tick.label_size",
67-
"axis.label_size",
68-
"textbox.rel_pos",
69-
"textbox.text_size",
65+
"legend_loc",
66+
"tick_label_size",
67+
"axis_label_size",
68+
"textbox_rel_pos",
69+
"textbox_text_size",
7070
]
7171
for field in expected_not_none_fields:
7272
self.assertIsNotNone(default.get(field, None))

0 commit comments

Comments
 (0)