pyspecdata.core.figlist

class pyspecdata.core.figlist(*arg, **kwargs)

basename

A basename that can be changed to generate different sets of figures with different basenames. For example, this is useful if you are looping over different sets of data, and generating the same set of figures for each set of data (which would correspond to a basename).

Type:str

figurelist

A list of the figure names

Type:list

figdict

A dictionary containing the figurelist and the figure numbers or objects that they correspond to. Keys of this dictionary must be elements of figurelist.

Type:dict

propdict

Maintains various properties for each element in figurelist. Keys of this dictionary must be elements of figurelist.

Type:dict

__init__(*arg, **kwargs)

Initialize a figure list, which can be used to generate a series of figures from the command line or prompt. Then the same code (if figlist_var is used) can be included inside a python environment in a latex document.

Parameters:

• black (double) – A fractional number giving how “black” “black” is. Typically 1.0 is actually too dark and makes things hard to see.
• mlab (object) – If you want to use mayavi, this should be the mlab (module?)
• file_name (str) – This is the argument passed to self.show(), and used to construct the file names.

Methods

__init__(*arg, **kwargs)	Initialize a figure list, which can be used to generate a series of figures from the command line or prompt.
adjust_spines(spines)
check_units(testdata, x_index, y_index)
generate_ticks(plotdata, axes, rescale[, …])	generate 3d ticks and grid for mayavi
get_fig_number(name)
get_num_figures()
grid()
header(number_above, input_string)
image(A, **kwargs)	Called as fl.image() where fl is the figlist_var object
label_point(data, axis, value, thislabel[, …])	only works for 1D data: assume you’ve passed a single-point nddata, and label it
marked_text(marker[, input_text, sep])	Creates a named marker where we can place text.
mesh(plotdata[, Z_normalization, …])
next(input_name[, legend, boundaries, …])	Switch to the figure given by input_name, which is used not only as a string-based name for the figure, but also as a default title and as a base name for resulting figure files.
phaseplot_finalize()	Performs plot decorations that are typically desired for a manual phasing plot.
plot(*args, **kwargs)	param linestyle:  the style of the line
pop_marker()	use the plot on the top of the “stack” (see push_marker) as the current plot
push_marker()	save the current plot to a “stack” so we can return to it with “pop_marker”
setprops(**kwargs)
show(*args, **kwargs)
show_prep()
text(mytext)
twinx([autopad, orig, color])
use_autolegend([value])	No argument sets to true if it’s not already set