Public Member Functions
	__init__ (self, model, ext_r, nx, ny, ex, ey, center, analysis_folder, analysis_prefix, compute_function=None)

	get_dx_dy (self)

	column_integ_render (self, field_name, field_type, custom_getter=None)

	column_average_render (self, field_name, field_type, min_normalization=1e-9, custom_getter=None)

	slice_render (self, field_name, field_type, do_normalization=True, min_normalization=1e-9, field_transform=None, custom_getter=None)

	get_extent (self)

	compute (self)

	analysis_save (self, iplot, data=None)

	load_analysis (self, iplot)

	get_list_analysis_id (self)

	metadata_to_screen_sink_pos (self, metadata)

	figure_init (self, holywood_mode=False, dpi=200)

	figure_render_sinks (self, metadata, ax, scale_factor, color, linewidth, fill)

	figure_add_time_info (self, text, holywood_mode=False)

	figure_add_colorbar (self, imshow_result, label, holywood_mode=False)

	make_plot (self, iplot, x_unit=None, y_unit=None, time_unit=None, field_unit=None, x_label=None, y_label=None, field_label=None, holywood_mode=False, cmap="magma", cmap_bad_color="black", contour_list=None, add_sinks=True, sink_scale_factor=1, sink_color="green", sink_linewidth=1, sink_fill=False, save_plot=True, **kwargs)

	render_all (self, **kwargs)

	render_gif (self, gif_filename, save_animation=False, fps=15, bitrate=1800)

Public Attributes
	model

	ext_r

	nx

	ny

	ex

	ey

	center

	aspect

	compute_function

	npy_data_filename

	json_data_filename

	glob_str_data

Detailed Description

Definition at line 156 of file StandardPlotHelper.py.

Constructor & Destructor Documentation

◆ init()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.__init__	(	self,
		model,
		ext_r,
		nx,
		ny,
		ex,
		ey,
		center,
		analysis_folder,
		analysis_prefix,
		compute_function = `None`
	)

Definition at line 157 of file StandardPlotHelper.py.

Member Function Documentation

◆ analysis_save()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.analysis_save	(	self,
		iplot,
		data = `None`
	)

Definition at line 290 of file StandardPlotHelper.py.

◆ column_average_render()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.column_average_render	(	self,
		field_name,
		field_type,
		min_normalization = `1e-9`,
		custom_getter = `None`
	)

Definition at line 205 of file StandardPlotHelper.py.

◆ column_integ_render()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.column_integ_render	(	self,
		field_name,
		field_type,
		custom_getter = `None`
	)

Definition at line 190 of file StandardPlotHelper.py.

◆ compute()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.compute ( self )

Definition at line 285 of file StandardPlotHelper.py.

◆ figure_add_colorbar()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.figure_add_colorbar	(	self,
		imshow_result,
		label,
		holywood_mode = `False`
	)

Definition at line 328 of file StandardPlotHelper.py.

◆ figure_add_time_info()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.figure_add_time_info	(	self,
		text,
		holywood_mode = `False`
	)

Definition at line 325 of file StandardPlotHelper.py.

◆ figure_init()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.figure_init	(	self,
		holywood_mode = `False`,
		dpi = `200`
	)

Definition at line 318 of file StandardPlotHelper.py.

◆ figure_render_sinks()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.figure_render_sinks	(	self,
		metadata,
		ax,
		scale_factor,
		color,
		linewidth,
		fill
	)

Definition at line 321 of file StandardPlotHelper.py.

◆ get_dx_dy()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.get_dx_dy ( self )

Definition at line 181 of file StandardPlotHelper.py.

◆ get_extent()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.get_extent ( self )

Definition at line 271 of file StandardPlotHelper.py.

◆ get_list_analysis_id()

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

Definition at line 303 of file StandardPlotHelper.py.

◆ load_analysis()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.load_analysis	(	self,
		iplot
	)

Definition at line 300 of file StandardPlotHelper.py.

◆ make_plot()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.make_plot	(		self,
			iplot,
			x_unit = `None`,
			y_unit = `None`,
			time_unit = `None`,
			field_unit = `None`,
			x_label = `None`,
			y_label = `None`,
			field_label = `None`,
			holywood_mode = `False`,
			cmap = `"magma"`,
			cmap_bad_color = `"black"`,
			contour_list = `None`,
			add_sinks = `True`,
			sink_scale_factor = `1`,
			sink_color = `"green"`,
			sink_linewidth = `1`,
			sink_fill = `False`,
			save_plot = `True`,
		**	kwargs
	)

Definition at line 331 of file StandardPlotHelper.py.

◆ metadata_to_screen_sink_pos()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.metadata_to_screen_sink_pos	(	self,
		metadata
	)

Definition at line 306 of file StandardPlotHelper.py.

◆ render_all()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.render_all	(		self,
		**	kwargs
	)

Definition at line 415 of file StandardPlotHelper.py.

◆ render_gif()

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

Definition at line 419 of file StandardPlotHelper.py.

◆ slice_render()

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.slice_render	(	self,
		field_name,
		field_type,
		do_normalization = `True`,
		min_normalization = `1e-9`,
		field_transform = `None`,
		custom_getter = `None`
	)

Definition at line 232 of file StandardPlotHelper.py.

Member Data Documentation

◆ aspect

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.aspect

Definition at line 177 of file StandardPlotHelper.py.

◆ center

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.center

Definition at line 176 of file StandardPlotHelper.py.

◆ compute_function

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.compute_function

Definition at line 178 of file StandardPlotHelper.py.

◆ ex

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.ex

Definition at line 174 of file StandardPlotHelper.py.

◆ ext_r

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.ext_r

Definition at line 171 of file StandardPlotHelper.py.

◆ ey

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.ey

Definition at line 175 of file StandardPlotHelper.py.

◆ glob_str_data

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.glob_str_data

Definition at line 304 of file StandardPlotHelper.py.

◆ json_data_filename

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.json_data_filename

Definition at line 298 of file StandardPlotHelper.py.

◆ model

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.model

Definition at line 170 of file StandardPlotHelper.py.

◆ npy_data_filename

shamrock.utils.analysis.StandardPlotHelper.StandardPlotHelper.npy_data_filename