mcstasscript.data.data.McStasPlotOptions
mcstasscript.data.data.McStasPlotOptions¶
- class mcstasscript.data.data.McStasPlotOptions(*args, **kwargs)¶
Class that holds plotting options related to McStas data set
- log¶
To plot on logarithmic or not, standard is linear
- Type
bool, default False
- orders_of_mag¶
If plotting on log scale, restrict max range to orders_of_mag below maximum value
- Type
float, default 300
- colormap¶
Chosen colormap for 2d data, should be available in matplotlib
- Type
string, default jet
- show_colorbar¶
Selects if colorbar should be shown or not
- Type
bool, default True
- cut_max¶
Factor multiplied onto maximum data value to set upper plot limit
- Type
float, default 1
- cut_min¶
Removes given fraction of the plot range from the lower limit
- Type
float, default 0
- x_limit_multiplier¶
Multiplies x axis limits with factor, useful for unit changes
- Type
float, default 1
- y_limit_multiplier¶
Multiplies y axis limits with factor, useful for unit changes
- Type
float, default 1
- custom_ylim_bottom¶
Indicates whether a manual lower limit for y axis has been set
- Type
bool, default False
- custom_ylim_top¶
Indicates whether a manual upper limit for y axis has been set
- Type
bool, default False
- custom_xlim_left¶
Indicates whether a manual lower limit for x axis has been set
- Type
bool, default False
- custom_xlim_right¶
Indicates whether a manual upper limit for x axis has been set
- Type
bool, default False
- set_options(keyword arguments)¶
Can set the class attributes using keyword options
- __init__(*args, **kwargs)¶
Setting default values for plotting preferences
Methods
__init__(*args, **kwargs)Setting default values for plotting preferences
set_options(**kwargs)Set custom values for plotting preferences
- set_options(**kwargs)¶
Set custom values for plotting preferences
- Keyword Arguments
log (bool, default False) – To plot on logarithmic or not, standard is linear
orders_of_mag (float, default 300) – If plotting on log scale, restrict max range to orders_of_mag below maximum value
colormap (string, default jet) – Chosen colormap for 2d data, should be available in matplotlib
show_colorbar (bool, default True) – Selects if colorbar should be shown or not
cut_max (float, default 1) – Factor multiplied onto maximum data value to set upper plot limit
cut_min (float, default 0) – Removes given fraction of the plot range from the lower limit
x_limit_multiplier (float, default 1) – Multiplies x axis limits with factor, useful for unit changes
y_limit_multiplier (float, default 1) – Multiplies y axis limits with factor, useful for unit changes
bottom_lim (float) – Set manual lower limit for y axis
top_lim (float) – Set manual upper limit for y axis
left_lim (float) – Set manual lower limit for x axis
right_lim (float) – Set manual upper limit for x axis