seidart.visualization.slice25d module

Create a gif for a given plane of a 2.5D model

seidart.visualization.slice25d.slicer(project_file, channel, indslice, num_steps, delay, plane='xz', alpha=0.3, is_single=True)

Create a gif for a given plane of a 2.5D model. The function will create a series of images and then use imagemagick to create a gif.

Parameters:

  • project_file (str) – str: The project file path

  • channel (str) – str: The channel to query

  • indslice (int) – The index along the plane being sliced. This is not corrected for the boundary layer.

  • num_steps (int) – int: The number of time steps between frames

  • plane (str) – str: Specify what plane to slice (default = ‘xz’). The slice is the along the 3rd plane (i.e. y-ind for a ‘xz’ plane). Options are ‘xy’, ‘yz’, and ‘xz’.

  • alpha (float) – float: (OPTIONAL FLOAT [0,1]) Change the transparency of the model plotted in the background; default = 0.3. Zeros is full transparency, 1 is CIA transparency

  • delay (int) – int: The amount of delay between two frames

  • is_single (bool) – bool: If the data is complex

Returns:

None