XarrayImage
===========

.. currentmodule:: PlasmaCalcs.plotting.images

.. autoclass:: XarrayImage
   :members:
   :show-inheritance:
   :inherited-members:

   
   
   .. rubric:: Methods

   .. autosummary::

   
   
     
       ~XarrayImage.__call__
     
     
       ~XarrayImage.__getitem__
     
     
       ~XarrayImage.__init_subclass__
     
     
       ~XarrayImage.__iter__
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

   
   
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
       ~XarrayImage.add_child
     
     
       ~XarrayImage.display
     
     
       ~XarrayImage.enumerate_flat
     
     
       ~XarrayImage.flat
     
     
       ~XarrayImage.flat_branches_until
     
     
       ~XarrayImage.get_animator
     
     
       ~XarrayImage.get_data_at_frame
     
     
       ~XarrayImage.get_nframes
     
     
       ~XarrayImage.get_nframes_here
     
     
       ~XarrayImage.help
     
     
       ~XarrayImage.html
     
     
       ~XarrayImage.infer_xyt_dims
     
     
       ~XarrayImage.init_plot
     
     
       ~XarrayImage.init_plots
     
     
       ~XarrayImage.make_child
     
     
       ~XarrayImage.make_children
     
     
       ~XarrayImage.plot_title
     
     
       ~XarrayImage.save
     
     
       ~XarrayImage.scatter_max
     
     
       ~XarrayImage.scatter_min
     
     
       ~XarrayImage.scatter_where
     
     
       ~XarrayImage.set_parent
     
     
       ~XarrayImage.update_to_frame
     

   
   
     
     
     
     
     
       ~XarrayImage._array_is_not_2D
     
     
       ~XarrayImage._get_frames
     
     
       ~XarrayImage._get_plot_dims_attr_value
     
     
       ~XarrayImage._has_valid_plot_dims
     
     
       ~XarrayImage._init_plot_checks
     
     
       ~XarrayImage._on_added_child
     
     
       ~XarrayImage._on_added_descendant
     
     
       ~XarrayImage._on_adding_ancestor
     
     
       ~XarrayImage._on_setting_parent
     
     
       ~XarrayImage._repr_html_
     
     
       ~XarrayImage._set_plot_dims_attr_value
     
     
       ~XarrayImage._shorthand_repr
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     

   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~XarrayImage.DEFAULT_TREE_SHORTHAND
      ~XarrayImage.DEFAULT_TREE_SHOW_DEPTH
      ~XarrayImage.DEFAULT_TREE_SHOW_MAX_DEPTH
      ~XarrayImage.ani
      ~XarrayImage.ax
      ~XarrayImage.cbar
      ~XarrayImage.depth
      ~XarrayImage.fig
      ~XarrayImage.frame
      ~XarrayImage.frames
      ~XarrayImage.height
      ~XarrayImage.im
      ~XarrayImage.parent
      ~XarrayImage.parent_ref
      ~XarrayImage.plot_dims_attrs
      ~XarrayImage.plotted
      ~XarrayImage.plotted_data
      ~XarrayImage.size
      ~XarrayImage.t_plot_dim
      ~XarrayImage.x_plot_dim
      ~XarrayImage.xy_plot_dims
      ~XarrayImage.xyt_plot_dims
      ~XarrayImage.y_plot_dim