crtomo.notebook.steps package

Submodules

crtomo.notebook.steps.base_step module

This is the base step class that all processing steps are derived from.

class crtomo.notebook.steps.base_step.base_step(persistent_directory=None)

Bases: object

apply_next_input()

Actually execute the step based in self.input_new

Returns:

ret_value – True if input was successfully applied, False if not

Return type:

bool

can_run()

Check if all required steps have been finished

create_ipywidget_gui()

find_previous_step(starting_step, search_name)

persistency_load()

Load state of this step from peristency directory

persistency_store()

Store the current state of the widget in the given persistency directory

set_input_new(input_new)

Apply a new set of inputs

TODO: This is the place to check the input_new dictionary for consistency with self.input_skel

transfer_input_new_to_applied()

Make a copy of the self.input_new dict and store in self.input_applied

This is complicated because some objects cannot be easily copied (e.g., io.BytesIO). Therefore, each step must implement this function by itself.

crtomo.notebook.steps.data_import module

class crtomo.notebook.steps.data_import.step_data_import(persistent_directory=None)

Bases: base_step

A simple data importer step. Loads only Syscal .bin files at the moment.

apply_next_input()

Returns True only for a successful application of new input

apply_next_input_from_gui(button)

Generate an input dict from the gui elements and apply those new inputs

can_run()

Check if all required steps have been finished

create_ipywidget_gui()

find_previous_step(starting_step, search_name)

persistency_load()

Load state of this step from peristency directory

persistency_store()

Store the current state of the widget in the given persistency directory

set_input_new(input_new)

Apply a new set of inputs

TODO: This is the place to check the input_new dictionary for consistency with self.input_skel

transfer_input_new_to_applied()

Make a copy of the self.input_new dict and store in self.input_applied

This is complicated because some objects cannot be easily copied (e.g., io.BytesIO). Therefore, each step must implement this function by itself.

crtomo.notebook.steps.fe_mesh module

class crtomo.notebook.steps.fe_mesh.step_fe_mesh(persistent_directory=None)

Bases: base_step

Load, or generate, an FE mesh for CRTomo

apply_next_input()

apply_next_input_from_gui(button)

Generate an input dict from the GUI elements and apply those new inputs

can_run()

Check if all required steps have been finished

create_ipywidget_gui()

find_previous_step(starting_step, search_name)

persistency_load()

Load state of this step from peristency directory

persistency_store()

Store the current state of the widget in the given persistency directory

set_input_new(input_new)

Apply a new set of inputs

TODO: This is the place to check the input_new dictionary for consistency with self.input_skel

transfer_input_new_to_applied()

Make a copy of the self.input_new dict and store in self.input_applied

This is complicated because some objects cannot be easily copied (e.g., io.BytesIO). Therefore, each step must implement this function by itself.

crtomo.notebook.steps.raw_data_visualization module

class crtomo.notebook.steps.raw_data_visualization.step_raw_visualization(persistent_directory=None)

Bases: base_step

apply_next_input()

apply_next_input_from_gui(button)

Generate an input dict from the gui elements and apply those new inputs

can_run()

Check if all required steps have been finished

create_ipywidget_gui()

find_previous_step(starting_step, search_name)

persistency_load()

Load state of this step from peristency directory

persistency_store()

Store the current state of the widget in the given persistency directory

set_input_new(input_new)

Apply a new set of inputs

TODO: This is the place to check the input_new dictionary for consistency with self.input_skel

transfer_input_new_to_applied()

Make a copy of the self.input_new dict and store in self.input_applied

This is complicated because some objects cannot be easily copied (e.g., io.BytesIO). Therefore, each step must implement this function by itself.

Module contents