autolens.plot.Include2D

class autolens.plot.Include2D(origin=None, mask=None, border=None, grid=None, positions=None, light_profile_centres=None, mass_profile_centres=None, critical_curves=None, caustics=None, multiple_images=None, mapper_source_pixelization_grid: Optional[bool] = None, mapper_source_grid_slim: Optional[bool] = None, mapper_data_pixelization_grid=None)
__init__(origin=None, mask=None, border=None, grid=None, positions=None, light_profile_centres=None, mass_profile_centres=None, critical_curves=None, caustics=None, multiple_images=None, mapper_source_pixelization_grid: Optional[bool] = None, mapper_source_grid_slim: Optional[bool] = None, mapper_data_pixelization_grid=None)

Sets which Visuals2D are included on a figure plotting 2D data that is plotted using a Plotter2D.

The Include object is used to extract the visuals of the plotted 2D data structures so they can be used in plot functions. Only visuals with a True entry in the Include object are extracted and plotted.

If an entry is not input into the class (e.g. it retains its default entry of None) then the bool is loaded from the config/visualize/include.ini config file. This means the default visuals of a project can be specified in a config file.

Parameters:
  • origin (bool) – If True, the origin of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.
  • mask (bool) – if True, the mask of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.
  • border (bool) – If True, the border of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.
  • mapper_data_pixelization_grid (bool) – If True, the pixelization grid in the data plane of a plotted Mapper is included on the figure.
  • mapper_source_pixelization_grid (bool) – If True, the pixelization grid in the source plane of a plotted Mapper is included on the figure.
  • parallel_overscan (bool) – If True, the parallel overscan of a plotted Frame2D is included on the figure.
  • serial_prescan (bool) – If True, the serial prescan of a plotted Frame2D is included on the figure.
  • serial_overscan (bool) – If True, the serial overscan of a plotted Frame2D is included on the figure.

Methods

__init__([origin, mask, border, grid, …]) Sets which Visuals2D are included on a figure plotting 2D data that is plotted using a Plotter2D.
load(value, name)

Attributes

border
caustics
critical_curves
grid
light_profile_centres
mapper_data_pixelization_grid
mapper_source_grid_slim
mapper_source_pixelization_grid
mask
mass_profile_centres
multiple_images
origin
parallel_overscan
positions
section
serial_overscan
serial_prescan