autocti.plot.Include2D#

class autocti.plot.Include2D(origin: Optional[bool] = None, mask: Optional[bool] = None, border: Optional[bool] = None, grid: Optional[bool] = None, mapper_image_plane_mesh_grid: Optional[bool] = None, mapper_source_plane_mesh_grid: Optional[bool] = None, mapper_source_plane_data_grid: Optional[bool] = None, parallel_overscan: Optional[bool] = None, serial_prescan: Optional[bool] = None, serial_overscan: Optional[bool] = None)[source]#

Bases: AbstractInclude

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

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 – If True, the origin of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.

  • mask – if True, the mask of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.

  • border – If True, the border of the plotted data structure (e.g. Array2D, Grid2D) is included on the figure.

  • mapper_image_plane_mesh_grid – If True, the pixelization grid in the data plane of a plotted Mapper is included on the figure.

  • mapper_source_plane_mesh_grid – If True, the pixelization grid in the source plane of a plotted Mapper is included on the figure.

  • parallel_overscan – If True, the parallel overscan of a plotted Frame2D is included on the figure.

  • serial_prescan – If True, the serial prescan of a plotted Frame2D is included on the figure.

  • serial_overscan – If True, the serial overscan of a plotted Frame2D is included on the figure.

Methods

load

Attributes

border

grid

mapper_image_plane_mesh_grid

mapper_source_plane_data_grid

mapper_source_plane_mesh_grid

mask

origin

parallel_overscan

section

serial_overscan

serial_prescan