My Project
Public Member Functions | Public Attributes | List of all members
animationTools.BKAnimation Class Reference

Public Member Functions

def __init__ (self, single_plots, frame_interval=10, movement_per_frame=10, n_frames=10, fps=10, sleep_amount=1, max_lim_change=0.1)
 
def init_live_plot (self, positions, figure_shape, titles, show_plot=True, suptitle="")
 START: INITIALIZE ##. More...
 
def init_subplots (self)
 
def init_specified_subplot (self, single_plot)
 
def init_line_plot (self, single_line, ax_number)
 
def init_spring_plot (self, single_line, ax_number)
 
def init_bar_plot (self, single_line, ax_number)
 
def init_lims (self, single_plot)
 
def init_labels (self, single_plot)
 
def update_subplots (self, update_lims=False)
 END: INITIALIZE ##. More...
 
def update_specified_subplot (self, single_plot)
 
def update_live_x_values (self, single_line, plot_type)
 
def update_live_y_values (self, single_line, plot_type)
 
def update_live_x_lim (self, single_plot)
 
def update_live_y_lim (self, single_plot)
 
def update_upper_springs (self, ax_number, index_first_spring, block_line_index=0)
 
def update_suptitle (self, suptitle)
 
def check_lims (self, ax_number, axis_checked, reduce_extra_lim_amount=3)
 
def change_xy_lim (self, ax_number, lim_min_add, lim_max_add)
 END: UPDATE ##. More...
 
def change_x_lim (self, ax_number, x_lim_min_add, x_lim_max_add)
 
def change_y_lim (self, ax_number, y_lim_min_add, y_lim_max_add)
 
def shift_xy_indexes (self, ax_number, line_number, shift_amount, only_shift_first=False)
 
def shift_x_indexes (self, ax_number, line_number, shift_amount, only_shift_first=False)
 
def shift_y_indexes (self, ax_number, line_number, shift_amount, only_shift_first=False)
 
def change_x (self, ax_number, line_number, get_axis="x")
 
def change_y (self, ax_number, line_number, get_axis="y")
 
def get_last_plotted_x_value (self, ax_number, line_number)
 END: HELP FUNCTIONS ##. More...
 
def get_last_plotted_y_value (self, ax_number, line_number)
 
def get_frame_interval (self)
 
def set_frame_interval (self, new_value)
 
def get_movement_per_frame (self)
 
def set_movement_per_frame (self, new_value)
 
def get_n_frames (self)
 
def set_n_frames (self, new_value)
 
def get_fps (self)
 
def set_fps (self, new_value)
 
def get_sleep_amount (selfSinglePlot)
 
def set_sleep_amount (self, new_value)
 

Public Attributes

 single_plots
 
 frame_interval
 
 movement_per_frame
 
 n_frames
 
 fps
 
 sleep_amount
 
 max_lim_change
 
 fig
 
 axs
 

Detailed Description

Definition at line 6 of file animationTools.py.

Constructor & Destructor Documentation

◆ __init__()

def animationTools.BKAnimation.__init__ (   self,
  single_plots,
  frame_interval = 10,
  movement_per_frame = 10,
  n_frames = 10,
  fps = 10,
  sleep_amount = 1,
  max_lim_change = 0.1 
)

Definition at line 16 of file animationTools.py.

Member Function Documentation

◆ change_x()

def animationTools.BKAnimation.change_x (   self,
  ax_number,
  line_number,
  get_axis = "x" 
)

Definition at line 334 of file animationTools.py.

Here is the call graph for this function:

◆ change_x_lim()

def animationTools.BKAnimation.change_x_lim (   self,
  ax_number,
  x_lim_min_add,
  x_lim_max_add 
)

Definition at line 290 of file animationTools.py.

Here is the call graph for this function:

◆ change_xy_lim()

def animationTools.BKAnimation.change_xy_lim (   self,
  ax_number,
  lim_min_add,
  lim_max_add 
)

END: UPDATE ##.

START: HELP FUNCTIONS ##

Definition at line 281 of file animationTools.py.

Here is the call graph for this function:

◆ change_y()

def animationTools.BKAnimation.change_y (   self,
  ax_number,
  line_number,
  get_axis = "y" 
)

Definition at line 347 of file animationTools.py.

Here is the call graph for this function:

◆ change_y_lim()

def animationTools.BKAnimation.change_y_lim (   self,
  ax_number,
  y_lim_min_add,
  y_lim_max_add 
)

Definition at line 298 of file animationTools.py.

Here is the call graph for this function:

◆ check_lims()

def animationTools.BKAnimation.check_lims (   self,
  ax_number,
  axis_checked,
  reduce_extra_lim_amount = 3 
)

Definition at line 234 of file animationTools.py.

Here is the call graph for this function:

◆ get_fps()

def animationTools.BKAnimation.get_fps (   self)

Definition at line 420 of file animationTools.py.

Here is the call graph for this function:

◆ get_frame_interval()

def animationTools.BKAnimation.get_frame_interval (   self)

Definition at line 387 of file animationTools.py.

Here is the call graph for this function:

◆ get_last_plotted_x_value()

def animationTools.BKAnimation.get_last_plotted_x_value (   self,
  ax_number,
  line_number 
)

END: HELP FUNCTIONS ##.

START: GETTERS AND SETTERS ##

Definition at line 361 of file animationTools.py.

Here is the call graph for this function:

◆ get_last_plotted_y_value()

def animationTools.BKAnimation.get_last_plotted_y_value (   self,
  ax_number,
  line_number 
)

Definition at line 375 of file animationTools.py.

Here is the call graph for this function:

◆ get_movement_per_frame()

def animationTools.BKAnimation.get_movement_per_frame (   self)

Definition at line 398 of file animationTools.py.

Here is the call graph for this function:

◆ get_n_frames()

def animationTools.BKAnimation.get_n_frames (   self)

Definition at line 409 of file animationTools.py.

Here is the call graph for this function:

◆ get_sleep_amount()

def animationTools.BKAnimation.get_sleep_amount (   selfSinglePlot)

Definition at line 431 of file animationTools.py.

Here is the call graph for this function:

◆ init_bar_plot()

def animationTools.BKAnimation.init_bar_plot (   self,
  single_line,
  ax_number 
)

Definition at line 102 of file animationTools.py.

Here is the call graph for this function:

◆ init_labels()

def animationTools.BKAnimation.init_labels (   self,
  single_plot 
)

Definition at line 115 of file animationTools.py.

Here is the call graph for this function:

◆ init_lims()

def animationTools.BKAnimation.init_lims (   self,
  single_plot 
)

Definition at line 108 of file animationTools.py.

Here is the call graph for this function:

◆ init_line_plot()

def animationTools.BKAnimation.init_line_plot (   self,
  single_line,
  ax_number 
)

Definition at line 75 of file animationTools.py.

Here is the call graph for this function:

◆ init_live_plot()

def animationTools.BKAnimation.init_live_plot (   self,
  positions,
  figure_shape,
  titles,
  show_plot = True,
  suptitle = "" 
)

START: INITIALIZE ##.

Definition at line 35 of file animationTools.py.

◆ init_specified_subplot()

def animationTools.BKAnimation.init_specified_subplot (   self,
  single_plot 
)

Definition at line 61 of file animationTools.py.

Here is the call graph for this function:

◆ init_spring_plot()

def animationTools.BKAnimation.init_spring_plot (   self,
  single_line,
  ax_number 
)

Definition at line 87 of file animationTools.py.

Here is the call graph for this function:

◆ init_subplots()

def animationTools.BKAnimation.init_subplots (   self)

Definition at line 49 of file animationTools.py.

Here is the call graph for this function:

◆ set_fps()

def animationTools.BKAnimation.set_fps (   self,
  new_value 
)

Definition at line 426 of file animationTools.py.

Here is the call graph for this function:

◆ set_frame_interval()

def animationTools.BKAnimation.set_frame_interval (   self,
  new_value 
)

Definition at line 393 of file animationTools.py.

Here is the call graph for this function:

◆ set_movement_per_frame()

def animationTools.BKAnimation.set_movement_per_frame (   self,
  new_value 
)

Definition at line 404 of file animationTools.py.

Here is the call graph for this function:

◆ set_n_frames()

def animationTools.BKAnimation.set_n_frames (   self,
  new_value 
)

Definition at line 415 of file animationTools.py.

Here is the call graph for this function:

◆ set_sleep_amount()

def animationTools.BKAnimation.set_sleep_amount (   self,
  new_value 
)

Definition at line 437 of file animationTools.py.

◆ shift_x_indexes()

def animationTools.BKAnimation.shift_x_indexes (   self,
  ax_number,
  line_number,
  shift_amount,
  only_shift_first = False 
)

Definition at line 317 of file animationTools.py.

Here is the call graph for this function:

◆ shift_xy_indexes()

def animationTools.BKAnimation.shift_xy_indexes (   self,
  ax_number,
  line_number,
  shift_amount,
  only_shift_first = False 
)

Definition at line 307 of file animationTools.py.

Here is the call graph for this function:

◆ shift_y_indexes()

def animationTools.BKAnimation.shift_y_indexes (   self,
  ax_number,
  line_number,
  shift_amount,
  only_shift_first = False 
)

Definition at line 326 of file animationTools.py.

Here is the call graph for this function:

◆ update_live_x_lim()

def animationTools.BKAnimation.update_live_x_lim (   self,
  single_plot 
)

Definition at line 186 of file animationTools.py.

Here is the call graph for this function:

◆ update_live_x_values()

def animationTools.BKAnimation.update_live_x_values (   self,
  single_line,
  plot_type 
)

Definition at line 147 of file animationTools.py.

Here is the call graph for this function:

◆ update_live_y_lim()

def animationTools.BKAnimation.update_live_y_lim (   self,
  single_plot 
)

Definition at line 196 of file animationTools.py.

Here is the call graph for this function:

◆ update_live_y_values()

def animationTools.BKAnimation.update_live_y_values (   self,
  single_line,
  plot_type 
)

Definition at line 169 of file animationTools.py.

Here is the call graph for this function:

◆ update_specified_subplot()

def animationTools.BKAnimation.update_specified_subplot (   self,
  single_plot 
)

Definition at line 137 of file animationTools.py.

Here is the call graph for this function:

◆ update_subplots()

def animationTools.BKAnimation.update_subplots (   self,
  update_lims = False 
)

END: INITIALIZE ##.

START: UPDATE ##

Definition at line 126 of file animationTools.py.

Here is the call graph for this function:

◆ update_suptitle()

def animationTools.BKAnimation.update_suptitle (   self,
  suptitle 
)

Definition at line 226 of file animationTools.py.

Here is the call graph for this function:

◆ update_upper_springs()

def animationTools.BKAnimation.update_upper_springs (   self,
  ax_number,
  index_first_spring,
  block_line_index = 0 
)

Definition at line 208 of file animationTools.py.

Here is the call graph for this function:

Member Data Documentation

◆ axs

animationTools.BKAnimation.axs

Definition at line 38 of file animationTools.py.

◆ fig

animationTools.BKAnimation.fig

Definition at line 37 of file animationTools.py.

◆ fps

animationTools.BKAnimation.fps

Definition at line 22 of file animationTools.py.

◆ frame_interval

animationTools.BKAnimation.frame_interval

Definition at line 19 of file animationTools.py.

◆ max_lim_change

animationTools.BKAnimation.max_lim_change

Definition at line 24 of file animationTools.py.

◆ movement_per_frame

animationTools.BKAnimation.movement_per_frame

Definition at line 20 of file animationTools.py.

◆ n_frames

animationTools.BKAnimation.n_frames

Definition at line 21 of file animationTools.py.

◆ single_plots

animationTools.BKAnimation.single_plots

Definition at line 17 of file animationTools.py.

◆ sleep_amount

animationTools.BKAnimation.sleep_amount

Definition at line 23 of file animationTools.py.


The documentation for this class was generated from the following file: