import numpy as np
from typing import List, Optional, Union
from autoarray.plot.abstract_plotters import Plotter
from autoarray.plot.visuals.one_d import Visuals1D
from autoarray.plot.visuals.two_d import Visuals2D
from autoarray.plot.include.one_d import Include1D
from autoarray.plot.include.two_d import Include2D
from autoarray.plot.mat_plot.one_d import MatPlot1D
from autoarray.plot.mat_plot.two_d import MatPlot2D
from autoarray.plot.auto_labels import AutoLabels
from autoarray.structures.arrays.uniform_1d import Array1D
from autoarray.structures.arrays.uniform_2d import Array2D
from autoarray.structures.grids.uniform_1d import Grid1D
from autoarray.structures.grids.uniform_2d import Grid2D
[docs]class Array2DPlotter(Plotter):
def __init__(
self,
array: Array2D,
mat_plot_2d: MatPlot2D = MatPlot2D(),
visuals_2d: Visuals2D = Visuals2D(),
include_2d: Include2D = Include2D(),
):
"""
Plots `Array2D` objects using the matplotlib method `imshow()` and many other matplotlib functions which
customize the plot's appearance.
The `mat_plot_2d` attribute wraps matplotlib function calls to make the figure. By default, the settings
passed to every matplotlib function called are those specified in the `config/visualize/mat_wrap/*.ini` files,
but a user can manually input values into `MatPlot2d` to customize the figure's appearance.
Overlaid on the figure are visuals, contained in the `Visuals2D` object. Attributes may be extracted from
the `Array2D` and plotted via the visuals object, if the corresponding entry is `True` in the `Include2D`
object or the `config/visualize/include.ini` file.
Parameters
----------
array
The 2D array the plotter plot.
mat_plot_2d
Contains objects which wrap the matplotlib function calls that make 2D plots.
visuals_2d
Contains 2D visuals that can be overlaid on 2D plots.
include_2d
Specifies which attributes of the `Array2D` are extracted and plotted as visuals for 2D plots.
"""
super().__init__(
visuals_2d=visuals_2d, include_2d=include_2d, mat_plot_2d=mat_plot_2d
)
self.array = array
def get_visuals_2d(self) -> Visuals2D:
return self.get_2d.via_mask_from(mask=self.array.mask)
[docs]class Grid2DPlotter(Plotter):
def __init__(
self,
grid: Grid2D,
mat_plot_2d: MatPlot2D = MatPlot2D(),
visuals_2d: Visuals2D = Visuals2D(),
include_2d: Include2D = Include2D(),
):
"""
Plots `Grid2D` objects using the matplotlib method `scatter()` and many other matplotlib functions which
customize the plot's appearance.
The `mat_plot_2d` attribute wraps matplotlib function calls to make the figure. By default, the settings
passed to every matplotlib function called are those specified in the `config/visualize/mat_wrap/*.ini` files,
but a user can manually input values into `MatPlot2d` to customize the figure's appearance.
Overlaid on the figure are visuals, contained in the `Visuals2D` object. Attributes may be extracted from
the `Grid2D` and plotted via the visuals object, if the corresponding entry is `True` in the `Include2D`
object or the `config/visualize/include.ini` file.
Parameters
----------
grid
The 2D grid the plotter plot.
mat_plot_2d
Contains objects which wrap the matplotlib function calls that make 2D plots.
visuals_2d
Contains 2D visuals that can be overlaid on 2D plots.
include_2d
Specifies which attributes of the `Grid2D` are extracted and plotted as visuals for 2D plots.
"""
super().__init__(
visuals_2d=visuals_2d, include_2d=include_2d, mat_plot_2d=mat_plot_2d
)
self.grid = grid
def get_visuals_2d(self) -> Visuals2D:
return self.get_2d.via_grid_from(grid=self.grid)
[docs]class YX1DPlotter(Plotter):
def __init__(
self,
y: Union[Array1D, List],
x: Optional[Union[Array1D, Grid1D, List]] = None,
mat_plot_1d: MatPlot1D = MatPlot1D(),
visuals_1d: Visuals1D = Visuals1D(),
include_1d: Include1D = Include1D(),
should_plot_grid: bool = False,
should_plot_zero: bool = False,
plot_axis_type: Optional[str] = None,
plot_yx_dict=None,
auto_labels = AutoLabels(),
):
"""
Plots two 1D objects using the matplotlib method `plot()` (or a similar method) and many other matplotlib
functions which customize the plot's appearance.
The `mat_plot_1d` attribute wraps matplotlib function calls to make the figure. By default, the settings
passed to every matplotlib function called are those specified in the `config/visualize/mat_wrap/*.ini` files,
but a user can manually input values into `MatPlot1d` to customize the figure's appearance.
Overlaid on the figure are visuals, contained in the `Visuals1D` object. Attributes may be extracted from
the `Array1D` and plotted via the visuals object, if the corresponding entry is `True` in the `Include1D`
object or the `config/visualize/include.ini` file.
Parameters
----------
y
The 1D y values the plotter plot.
x
The 1D x values the plotter plot.
mat_plot_1d
Contains objects which wrap the matplotlib function calls that make 1D plots.
visuals_1d
Contains 1D visuals that can be overlaid on 1D plots.
include_1d
Specifies which attributes of the `Array1D` are extracted and plotted as visuals for 1D plots.
"""
if isinstance(y, list):
y = Array1D.no_mask(values=y, pixel_scales=1.0)
if isinstance(x, list):
x = Array1D.no_mask(values=x, pixel_scales=1.0)
super().__init__(
visuals_1d=visuals_1d, include_1d=include_1d, mat_plot_1d=mat_plot_1d
)
self.y = y
self.x = y.grid_radial if x is None else x
self.should_plot_grid = should_plot_grid
self.should_plot_zero = should_plot_zero
self.plot_axis_type = plot_axis_type
self.plot_yx_dict = plot_yx_dict or {}
self.auto_labels = auto_labels
def get_visuals_1d(self) -> Visuals1D:
return self.get_1d.via_array_1d_from(array_1d=self.x)