autolens.plot.XLabel

class autolens.plot.XLabel(**kwargs)
__init__(**kwargs)

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

This object wraps the following Matplotlib methods:

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

__init__(**kwargs) The settings used to customize the figure’s title and y and x labels.
label_from(units) Returns the label of an object, by determining it from the figure units if the label is not manually specified.
set(units, include_brackets, auto_label) Set the x labels of the figure, including the fontsize.

Attributes

config_dict
config_folder
set(units: autoarray.plot.wrap.wrap_base.Units, include_brackets: bool = True, auto_label: Optional[str] = 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 – The units of the image that is plotted which informs the appropriate x label text.
  • include_brackets – Whether to include brackets around the x label text of the units.