Printing#
- print_map_2d(experiment, return_map: bool = False, xlabel=None, legend_pos=None, title_pos=None, angle=0, reverse: bool = False, update: bool = False, textual: list[str] | None = None, textual_size: int = 16, title: str | None = None, bbox_inches='tight', saveas: str | None = None, show: bool = True, legend: bool = True, dpi: int = 250, title_size: int = 16, figsize=(6.4, 6.4), pad_inches=None, mask: str | None = None)[source]#
Prints a 2D map of experiment instances.
- Parameters:
experiment (Experiment) – Experiment object containing data for the map.
return_map (bool, default=False) – If True, return fig, ax instead of displaying the map.
xlabel (str, optional) – Label for the x-axis.
legend_pos (tuple, optional) – Position of the legend on the plot.
title_pos (tuple, optional) – Position of the title on the plot.
angle (float, default=0) – Angle to rotate the map.
reverse (bool, default=False) – If True, reverse the map orientation.
update (bool, default=False) – If True, export updated point coordinates.
textual (list of str, optional) – Labels for specific points on the map.
textual_size (int, default=16) – Font size for textual labels.
title (str, optional) – Title of the plot.
bbox_inches (str, default='tight') – Bounding box setting for saving the plot.
saveas (str, optional) – File path to save the image.
show (bool, default=True) – If True, display the map.
legend (bool, default=True) – Display the legend if True.
dpi (int, default=250) – Resolution of the saved image.
title_size (int, default=16) – Font size for the plot title.
figsize (tuple, default=(6.4, 6.4)) – Size of the figure in inches.
pad_inches (float, optional) – Padding for saving the plot.
mask (str, optional) – Mask to apply to the plot background.
- Returns:
fig, ax – If return_map is True, returns the figure and axis objects.
- Return type:
matplotlib Figure and Axes
- print_map_2d_colored_by_feature(experiment, return_map=False, feature_id=None, column_id='value', xlabel=None, legend_pos=None, title_pos=None, rounding: int = 1, upper_limit: float = inf, lower_limit: float = -inf, ticks=None, textual: list[str] | None = None, scale='default', title=None, bbox_inches='tight', saveas=None, show: bool = True, normalizing_func=None, xticklabels=None, cmap=None, marker_func=None, feature_labelsize: int = 14, dpi: int = 250, title_size: int = 16, ticks_pos=None, omit: list | None = None, textual_size: int = 16, figsize=(6.4, 6.4), strech=None, colors=None, pad_inches=None, mask: str | None = None)[source]#
Prints map of instances on a 2d plane.
- Parameters:
experiment (Experiment) – Experiment object.
return_map (bool) – If True then return: fig, ax
feature_id – Id of the feature to be used for coloring.
column_id – Column of the feature to be used for coloring.
xlabel – Pyplot param.
legend_pos – Pyplot param.
title_pos – Pyplot param.
rounding (int) – Rounding of the feature values.
upper_limit (float) – Upper limit of the feature values.
lower_limit (float) – Lower limit of the feature values.
ticks – Pyplot param.
textual (list[str]) – Print thext over the points with names from the list.
scale – Pyplot param.
textual_size – Size of the ‘textual’ text.
title (str) – Pyplot param.
bbox_inches – Pyplot param.
saveas – Name of file in which the image will be stored.
show (bool) – If true show the map on screen.
normalizing_func – Normalizing function.
xticklabels – xticklabels.
cmap – Pyplot param.
marker_func – Pyplot param.
tex (bool) – If True save image in tex format.
feature_labelsize (int) – Size of the feature labels.
legend – Pyplot param.
dpi (int) – Quality of the image.
title_size (int) – Size of the title.
ticks_pos – Pyplot param.
omit (list) – List of the points to be omitted.
figsize – Size of the figure.
strech – Pyplot param.
colors – Pyplot param.
pad_inches – Pyplot param.
mask (str) – Name of the mask to be put on top of the image.
- print_map_2d_colored_by_features(experiment, feature_ids: list | None = None, xlabel=None, legend_pos=None, title_pos=None, rounding=1, upper_limit=inf, ticks=None, textual=None, title=None, bbox_inches=None, saveas=None, show=True, ms=20, normalizing_func=None, xticklabels=None, cmap=None, marker_func=None, feature_labelsize: int = 14, dpi: int = 250, column_id: str = 'value', title_size: int = 16, ticks_pos=None, textual_size: int = 16, figsize=(6.4, 6.4)) None[source]#
Prints map of instances on a 2d plane.
- Parameters:
experiment (Experiment) – Experiment object.
return_map (bool) – If True then return: fig, ax
feature_ids (list) – Ids of the feature to be used for coloring.
column_id – Column of the feature to be used for coloring.
xlabel – Pyplot param.
legend_pos – Pyplot param.
title_pos – Pyplot param.
rounding (int) – Rounding of the feature values.
upper_limit (float) – Upper limit of the feature values.
lower_limit (float) – Lower limit of the feature values.
ticks – Pyplot param.
textual (list[str]) – Print thext over the points with names from the list.
scale – Pyplot param.
textual_size – Size of the ‘textual’ text.
title (str) – Pyplot param.
bbox_inches – Pyplot param.
saveas – Name of file in which the image will be stored.
show (bool) – If true show the map on screen.
normalizing_func – Normalizing function.
xticklabels – xticklabels.
cmap – Pyplot param.
marker_func – Pyplot param.
tex (bool) – If True save image in tex format.
feature_labelsize (int) – Size of the feature labels.
legend – Pyplot param.
dpi (int) – Quality of the image.
title_size (int) – Size of the title.
ticks_pos – Pyplot param.
omit (list) – List of the points to be omitted.
figsize – Size of the figure.
strech – Pyplot param.
colors – Pyplot param.
pad_inches – Pyplot param.
mask (str) – Name of the mask to be put on top of the image.