autogalaxy.plot.XTicks

class XTicks

Bases: AbstractTicks

The settings used to customize a figure’s y and x ticks using the YTicks and XTicks objects.

This object wraps the following Matplotlib methods:

• plt.yticks: https://matplotlib.org/3.3.1/api/_as_gen/matplotlib.pyplot.yticks.html

• plt.xticks: https://matplotlib.org/3.3.1/api/_as_gen/matplotlib.pyplot.xticks.html

Parameters:

• manual_values (Optional[List[float]]) – Manually override the tick labels to display the labels as the input list of floats.

• manual_units (Optional[str]) – Manually override the units in brackets of the tick label.

• manual_suffix (Optional[str]) – A suffix applied to every tick label (e.g. for the suffix kpc 0.0 becomes 0.0kpc).

Methods

factor_from
labels_from
number_of_ticks_from
set	Set the x ticks of a figure using the shape of an input Array2D object and input units.
tick_maker_from
ticks_and_labels_from
ticks_from
vmax_from	The vmax of a plot, for example the maximum value of the colormap and colorbar.
vmin_from	The vmin of a plot, for example the minimum value of the colormap and colorbar.

Attributes

config_category
config_dict
config_folder
log10_max_value
log10_min_value

set(min_value, max_value, units, pixels=None, xunit=None, use_integers=False, is_for_1d_plot=False, is_log10=False)

Set the x ticks of a figure using the shape of an input Array2D object and input units.

Parameters:

• array – The 2D array of data which is plotted.

• min_value (float) – the minimum value of the xticks that figure is plotted using.

• max_value (float) – the maximum value of the xticks that figure is plotted using.

• units (Units) – The units of the figure.