gisansexplorer package

Submodules

gisansexplorer.GUI module

class gisansexplorer.GUI.MyFrame

Bases: PyQt5.QtWidgets.QFrame, gisansexplorer.utils.Frozen

[summary]

Parameters
  • qtw ([type]) – [description]

  • Frozen ([type]) – [description]

addExperimentInfo()

[summary]

addFileTreeAndList(botSplitter)

[summary]

Parameters

botSplitter ([type]) – [description]

addFunctionalityButtons()

[summary]

addPanels()

[summary]

build_ascii_header()

[summary]

Returns

[description]

Return type

[type]

color_outdated()

[summary]

Returns

[description]

Return type

[type]

static color_validate(table_item, value_a, value_b)

[summary]

Parameters
  • table_item ([type]) – [description]

  • value_a ([type]) – [description]

  • value_b ([type]) – [description]

Returns

[description]

Return type

[type]

compute_Q()

[summary]

Returns

[description]

Return type

[type]

doStuff(datFilePath)

[summary]

Parameters

datFilePath ([type]) – [description]

initFrame()

[summary]

on_cell_changed()

[summary]

on_click_loglinear()

[summary]

on_click_open_file()
on_click_save_ascii()

[summary]

on_click_save_png()

[summary]

Returns

[description]

Return type

[type]

on_click_update()

[summary]

on_file_double_clicked()

[summary]

on_file_selection_changed()

[summary]

on_graph_updated()

[summary]

on_progress_emited(value)

[summary]

Parameters

value ([type]) – [description]

on_subtract_checkbox_changed()

[summary]

openFileNameDialog()

[summary]

Returns

[description]

Return type

[type]

parse_dat(file)

[summary]

Parameters

file ([type]) – [description]

Returns

[description]

Return type

[type]

parse_intensity_map(inputd)

[summary]

Parameters

inputd ([type]) – [description]

Returns

[description]

Return type

[type]

parse_sensitivity_map(sens)

[summary]

Parameters

sens ([type]) – [description]

Returns

[description]

Return type

[type]

parse_yaml(fp)

[summary]

Parameters

fp ([type]) – [description]

Returns

[description]

Return type

[type]

read_dat_file(datFilePath=None)

[summary]

Parameters

datFilePath ([type], optional) – [description], by default None

Returns

[description]

Return type

[type]

read_intensity_file()

[summary]

Returns

[description]

Return type

[type]

read_sensitivity_file()

[summary]

Returns

[description]

Return type

[type]

read_yaml_file()

[summary]

Returns

[description]

Return type

[type]

safe_parse(parse_func, file_path)

[summary]

Parameters
  • parse_func ([type]) – [description]

  • file_path ([type]) – [description]

Returns

[description]

Return type

[type]

safe_parse_numpy(parse_func, file_path, dtype='i', delimiter=' ')

[summary]

Parameters
  • parse_func ([type]) – [description]

  • file_path ([type]) – [description]

  • dtype (str, optional) – [description], by default ‘i’

  • delimiter (str, optional) – [description], by default ‘ ‘

Returns

[description]

Return type

[type]

saveFileNameDialog()

[summary]

Returns

[description]

Return type

[type]

save_gisans_map_filepath(inputd)

[summary]

Parameters

inputd ([type]) – [description]

Raises

NotImplementedError – [description]

subtract_intensities_from_selected_files()

[summary]

Returns

[description]

Return type

[type]

Raises

ValueError – [description]

sum_intensities_from_selected_files()

[summary]

Returns

[description]

Return type

[type]

update_from_info_table()

[summary]

Returns

[description]

Return type

[type]

update_from_selection_list()

[summary]

update_gui()

[summary]

Returns

[description]

Return type

[type]

Raises

Exception – [description]

update_multi_experiment_values()

[summary]

Returns

[description]

Return type

[type]

update_single_experiment_values(experiment)

[summary]

Parameters

experiment ([type]) – [description]

Returns

[description]

Return type

[type]

update_table()

[summary]

Returns

[description]

Return type

[type]

class gisansexplorer.GUI.MyTabs

Bases: PyQt5.QtWidgets.QTabWidget, gisansexplorer.utils.Frozen

Collection of tabs hosting gisans data frames

tabButton_add

Adds a new tab

Type

QToolButton

tabButton_rmv

Removes the current tab

Type

QToolButton

frameList

List of gisans frames

Type

List

last_num

index of last tab created

Type

int

addTab()

Adds a new tab

initCornerButton()

Adds and creates connections for the add/rmv tab buttons

removeTab()

Removes the current tab

gisansexplorer.experiment_data_handling module

class gisansexplorer.experiment_data_handling.Experiment(instrument=<gisansexplorer.experiment_data_handling.Instrument object>)

Bases: gisansexplorer.utils.Frozen

cos_alpha_f(pixel_j)
property cos_alpha_i
sin_2theta_f(pixel_i)
sin_alpha_f(pixel_j)
property sin_alpha_i
property two_pi_over_lambda
class gisansexplorer.experiment_data_handling.FileReadingThread(myframe)

Bases: PyQt5.QtCore.QThread

progress_signal
run(self)
class gisansexplorer.experiment_data_handling.Instrument(name, pixel_size_mm=None, sample_detector_distance_mm=None, data_root_dir='/')

Bases: gisansexplorer.utils.Frozen

class gisansexplorer.experiment_data_handling.Settings

Bases: gisansexplorer.utils.Frozen

basename()
datFilePath()
gisans_cut_filepath(y_or_z='z')
gisans_map_filepath()
gzFilePaths()
sensFilePath()
yamlFilePaths()

gisansexplorer.main_app module

class gisansexplorer.main_app.App

Bases: PyQt5.QtWidgets.QMainWindow, gisansexplorer.utils.Frozen

addTab()
closeEvent(self, QCloseEvent)
gisansexplorer.main_app.icon_file()

gisansexplorer.plotting module

class gisansexplorer.plotting.AreaSelector(ax, line_select_callback)

Bases: gisansexplorer.utils.Frozen

class gisansexplorer.plotting.MyGraphView(graph_title, parent=None)

Bases: PyQt5.QtWidgets.QWidget

build_cbar()
build_norm(**kwargs)
define_axes()
define_layout()
finishedUpdating
init_canvas_connections()
init_data_and_parameters()
init_xyzLabel()
line_select_callback(eclick, erelease)
on_mouse_click(event)
on_mouse_move(event)
on_mouse_wheel(event)
save(**kwargs)
save_figures(filePath)
save_gisans_map(filePath=None)
save_gisans_surface(filePath=None)
save_qy_integration(filePath=None)
save_qz_integration(filePath=None)
show_figures()
take_care_of_negative_values()
test_show()
update_area_selector(**kwargs)
update_ax(**kwargs)
update_axes(**kwargs)
update_cax()
update_data(**kwargs)
update_graph(**kwargs)
update_xax()
update_yax()
update_zoom_ax()
class gisansexplorer.plotting.PlotData

Bases: gisansexplorer.utils.Frozen

class gisansexplorer.plotting.PlotStyle

Bases: object

classmethod apply_style(ax)
axisLabelFontSize = 30.0
borderWidth = 3
figSize = (12, 9)
fontSize = 20
lineWidth = 4.0
majorTickLength = 20
minorTickLength = 6.0
titleFontSize = 10.0
gisansexplorer.plotting.create_gisans_figure(data, cnorm, draw_surface_plot=False)
gisansexplorer.plotting.create_qy_integration_figure(data)
gisansexplorer.plotting.create_qz_integration_figure(data)

gisansexplorer.utils module

class gisansexplorer.utils.FloatValidator(*args, **kwargs)

Bases: PyQt5.QtGui.QValidator

fixup(self, str) → str
validate(self, str, int) → Tuple[QValidator.State, str, int]
class gisansexplorer.utils.Frozen

Bases: object

gisansexplorer.utils.enable_high_dpi_scaling()
gisansexplorer.utils.format_float(value)

Modified form of the ‘g’ format specifier.

gisansexplorer.utils.handle_exception(e)
gisansexplorer.utils.is_file(path)
class gisansexplorer.utils.mySciSpinBox(*args, **kwargs)

Bases: PyQt5.QtWidgets.QDoubleSpinBox

fixup(self, str) → str
stepBy(self, int)
textFromValue(self, float) → str
validate(self, str, int) → Tuple[QValidator.State, str, int]
valueFromText(self, str) → float
gisansexplorer.utils.profile_dec(fnc)

A decorator that uses cProfile to profile a function

gisansexplorer.utils.profile_function_with_arguments(*args, **kwargs)
gisansexplorer.utils.valid_float_string(string)

Module contents

gisansexplorer.entry_point()