autogalaxy.plot.YTicks

class YTicks

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.

• suffix ([<class 'str'>]) – A suffix applied to every tick label (e.g. for the suffix kpc 0.0 becomes 0.0kpc).

Methods

labels_with_suffix_from	The labels used for the y and x ticks can be append with a suffix.
set	Set the y ticks of a figure using the shape of an input Array2D object and input units.
tick_values_from	Calculate the ticks used for the yticks or xticks from input values of the minimum and maximum coordinate values of the y and x axis.
tick_values_in_units_from	Calculate the labels used for the yticks or xticks from input values of the minimum and maximum coordinate values of the y and x axis.

Attributes

config_dict
config_folder

set(array, min_value, max_value, units)

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

Parameters

• array (Optional[Array2D]) – The 2D array of data which is plotted.

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

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

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