Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper Class Reference

Public Member Functions

 __init__ (self, analysis_folder, analysis_prefix)
 
 analysis_save (self, iplot, data)
 
 load_analysis (self, iplot)
 
 get_list_analysis_id (self)
 
 make_plot (self, iplot, plot_func)
 
 render_all (self, plot_func)
 
 render_gif (self, glob_str_plot, gif_filename, save_animation=False, fps=15, bitrate=1800)
 

Public Attributes

 analysis_prefix
 
 npy_data_filename
 
 glob_str_data
 

Detailed Description

Definition at line 432 of file StandardPlotHelper.py.

Constructor & Destructor Documentation

◆ __init__()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.__init__ (   self,
  analysis_folder,
  analysis_prefix 
)

Definition at line 433 of file StandardPlotHelper.py.

Member Function Documentation

◆ analysis_save()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.analysis_save (   self,
  iplot,
  data 
)
Save the analysis data npy file

Definition at line 444 of file StandardPlotHelper.py.

◆ get_list_analysis_id()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.get_list_analysis_id (   self)

Definition at line 458 of file StandardPlotHelper.py.

◆ load_analysis()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.load_analysis (   self,
  iplot 
)
Load the analysis data from the json and npy files

Definition at line 452 of file StandardPlotHelper.py.

+ Here is the call graph for this function:

◆ make_plot()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.make_plot (   self,
  iplot,
  plot_func 
)

Definition at line 461 of file StandardPlotHelper.py.

◆ render_all()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.render_all (   self,
  plot_func 
)

Definition at line 466 of file StandardPlotHelper.py.

◆ render_gif()

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.render_gif (   self,
  glob_str_plot,
  gif_filename,
  save_animation = False,
  fps = 15,
  bitrate = 1800 
)

Definition at line 470 of file StandardPlotHelper.py.

Member Data Documentation

◆ analysis_prefix

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.analysis_prefix

Definition at line 440 of file StandardPlotHelper.py.

◆ glob_str_data

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.glob_str_data

Definition at line 442 of file StandardPlotHelper.py.

◆ npy_data_filename

shamrock.utils.analysis.StandardPlotHelper.AnalysisHelper.npy_data_filename

Definition at line 441 of file StandardPlotHelper.py.


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