autogalaxy.plot.XLabel

class XLabel

Bases: AbstractLabel

The settings used to customize the figure’s title and y and x labels.

This object wraps the following Matplotlib methods:

• plt.ylabel: https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.pyplot.ylabel.html

• plt.xlabel: https://matplotlib.org/3.3.2/api/_as_gen/matplotlib.pyplot.xlabel.html

The y and x labels will automatically be set if not specified, using the input units.

Parameters

• units – The units the data is plotted using.

• manual_label – A manual label which overrides the default computed via the units if input.

Methods

label_from	Returns the label of an object, by determining it from the figure units if the label is not manually specified.
set	Set the x labels of the figure, including the fontsize.

Attributes

config_dict
config_folder

set(units, include_brackets=True, auto_label=None)

Set the x labels of the figure, including the fontsize.

The x labels are always the distance scales, thus the labels are either arc-seconds or kpc and depending on the unit_label the figure is plotted in.

Parameters

• units (Units) – The units of the image that is plotted which informs the appropriate x label text.

• include_brackets (bool) – Whether to include brackets around the x label text of the units.