class EndpointFrame:
"""
Object to be passed into notebook panel for the Endpoint tab
"""
def __init__(self, parent, group_data, time_series, regression,
control_chart):
"""
:param parent: notebook panel in main view
:type parent: Panel
:param group_data: dvh, table_data, and stats_data
:type group_data: dict
:param time_series: Time Series object in notebook
:type time_series: TimeSeriesFrame
:param regression: Regression frame object in notebook
:type regression: RegressionFrame
:param control_chart: Control Chart frame object in notebook
:type control_chart: ControlChartFrame
"""
self.parent = parent
self.group_data = group_data
self.time_series = time_series
self.regression = regression
self.control_chart = control_chart
self.group_data = group_data
self.initial_columns = ['MRN', 'Tx Site', 'ROI Name', 'Volume (cc)']
self.widths = [150, 150, 250, 100]
self.button = {
'add': wx.Button(self.parent, wx.ID_ANY, "Add Endpoint"),
'del': wx.Button(self.parent, wx.ID_ANY, "Delete Endpoint"),
'exp': wx.Button(self.parent, wx.ID_ANY, 'Export')
}
self.table = {
key: wx.ListCtrl(self.parent,
wx.ID_ANY,
style=wx.BORDER_SUNKEN | wx.LC_HRULES
| wx.LC_REPORT | wx.LC_VRULES)
for key in [1, 2]
}
for table in self.table.values():
table.SetMinSize(get_window_size(0.623, 0.28))
self.data_table = {key: DataTable(self.table[key]) for key in [1, 2]}
self.endpoint_defs = DataTable(None,
columns=[
'label', 'output_type',
'input_type', 'input_value',
'units_in', 'units_out'
])
for key in [1, 2]:
if self.group_data[key]['dvh']:
self.group_data[key]['dvh'].endpoints[
'data'] = self.data_table[key].data
self.group_data[key]['dvh'].endpoints[
'defs'] = self.endpoint_defs.data
self.__do_bind()
self.__set_properties()
self.__do_layout()
self.disable_buttons()
def __do_bind(self):
self.parent.Bind(wx.EVT_BUTTON,
self.add_ep_button_click,
id=self.button['add'].GetId())
self.parent.Bind(wx.EVT_BUTTON,
self.del_ep_button_click,
id=self.button['del'].GetId())
self.parent.Bind(wx.EVT_BUTTON,
self.on_export_csv,
id=self.button['exp'].GetId())
def __set_properties(self):
for table in self.table.values():
for i, column in enumerate(self.initial_columns):
table.AppendColumn(column,
format=wx.LIST_FORMAT_LEFT,
width=self.widths[i])
def __do_layout(self):
sizer_wrapper = wx.BoxSizer(wx.VERTICAL)
vbox = wx.BoxSizer(wx.VERTICAL)
hbox = wx.BoxSizer(wx.HORIZONTAL)
for key in list(self.button):
hbox.Add(self.button[key], 0, wx.ALL, 5)
vbox.Add(hbox, 0, wx.ALL | wx.EXPAND, 5)
for grp in [1, 2]:
vbox.Add(
wx.StaticText(self.parent, wx.ID_ANY, "Query Group %s:" % grp),
0, wx.EXPAND | wx.BOTTOM, 5)
vbox.Add(self.table[grp], 1, wx.EXPAND, 0)
vbox.Add((10, 10), 0, 0, 0)
sizer_wrapper.Add(vbox, 1, wx.ALL | wx.EXPAND, 20)
self.layout = sizer_wrapper
def calculate_endpoints(self):
columns = {key: [c for c in self.initial_columns] for key in [1, 2]}
if self.data_table[1].data:
current_labels = [
key for key in list(self.data_table[1].data)
if key not in columns
]
else:
current_labels = []
eps = {
grp: {
'MRN': group_data['dvh'].mrn,
'Tx Site': group_data['dvh'].get_plan_values('tx_site'),
'ROI Name': group_data['dvh'].roi_name,
'Volume (cc)': group_data['dvh'].volume
}
for grp, group_data in self.group_data.items() if group_data['dvh']
}
ep_defs = self.endpoint_defs.data
for group, ep in eps.items():
if ep_defs:
for i, ep_name in enumerate(ep_defs['label']):
if ep_name not in columns[group]:
columns[group].append(ep_name)
if ep_name in current_labels:
ep[ep_name] = deepcopy(
self.data_table[group].data[ep_name])
else:
endpoint_input = ep_defs['input_type'][i]
endpoint_output = ep_defs['output_type'][i]
x = float(ep_defs['input_value'][i])
if endpoint_input == 'relative':
x /= 100.
dvh = self.group_data[group]['dvh']
if 'V' in ep_name:
ep[ep_name] = dvh.get_volume_of_dose(
x,
volume_scale=endpoint_output,
dose_scale=endpoint_input)
else:
ep[ep_name] = dvh.get_dose_to_volume(
x,
dose_scale=endpoint_output,
volume_scale=endpoint_input)
for group, ep in eps.items():
self.data_table[group].set_data(ep, columns[group])
self.data_table[group].set_column_width(0, 150)
self.data_table[group].set_column_width(1, 150)
self.data_table[group].set_column_width(2, 200)
def add_ep_button_click(self, evt):
# TODO: Track down duplicate table refreshes/calculations
dlg = AddEndpointDialog()
res = dlg.ShowModal()
if res == wx.ID_OK and dlg.is_endpoint_valid:
self.endpoint_defs.append_row(dlg.endpoint_row)
self.calculate_endpoints()
self.enable_buttons()
self.update_endpoints_in_dvh()
dlg.Destroy()
self.update_endpoints_and_radbio_in_group_data()
self.regression.update_combo_box_choices()
self.control_chart.update_combo_box_y_choices()
self.time_series.update_y_axis_options()
def del_ep_button_click(self, evt):
dlg = DelEndpointDialog(self.data_table[1].columns)
res = dlg.ShowModal()
if res == wx.ID_OK:
for value in dlg.selected_values:
for data_table in self.data_table.values():
if data_table.columns and value in data_table.columns:
data_table.delete_column(value)
endpoint_def_row = self.endpoint_defs.data['label'].index(
value)
self.update_endpoints_in_dvh()
self.endpoint_defs.delete_row(endpoint_def_row)
self.update_endpoints_and_radbio_in_group_data()
self.time_series.update_y_axis_options()
dlg.Destroy()
for group in self.group_data.values():
if group['stats_data']:
group['stats_data'].update_endpoints_and_radbio()
self.regression.update_combo_box_choices()
self.control_chart.update_combo_box_y_choices()
for data_table in self.data_table.values():
if data_table.column_count == 3:
self.button['del'].Disable()
self.button['exp'].Disable()
def update_dvh(self, group_data):
self.group_data = group_data
self.update_endpoints_in_dvh()
def update_endpoints_and_radbio_in_group_data(self):
for grp, data in self.group_data.items():
if data['stats_data']:
data['stats_data'].update_endpoints_and_radbio()
if grp == 2:
sync_variables_in_stats_data_objects(
self.group_data[1]['stats_data'],
self.group_data[2]['stats_data'])
def update_endpoints_in_dvh(self):
for group in [1, 2]:
if self.group_data[group]['dvh']:
self.group_data[group]['dvh'].endpoints[
'data'] = self.data_table[group].data
self.group_data[group]['dvh'].endpoints[
'defs'] = self.endpoint_defs.data
def clear_data(self):
for data_table in self.data_table.values():
data_table.delete_all_rows()
self.endpoint_defs.delete_all_rows(
force_delete_data=True) # no attached layout, force delete
for data_table in self.data_table.values():
if data_table.data:
for column in list(data_table.data):
if column not in self.initial_columns:
data_table.delete_column(column)
def enable_buttons(self):
for key in list(self.button):
self.button[key].Enable()
def disable_buttons(self):
for key in list(self.button):
self.button[key].Disable()
def enable_initial_buttons(self):
self.button['add'].Enable()
def get_csv(self, selection=None):
uid = {
1: {
'title': 'Study Instance UID',
'data': self.group_data[1]['dvh'].uid
}
}
csv = self.data_table[1].get_csv(extra_column_data=uid)
if self.group_data[2]['dvh']:
uid = {
1: {
'title': 'Study Instance UID',
'data': self.group_data[2]['dvh'].uid
}
}
csv = 'Group 1\n%s\n\nGroup 2\n%s' % (
csv, self.data_table[2].get_csv(extra_column_data=uid))
return csv
def on_export_csv(self, evt):
save_data_to_file(self.parent, "Export Endpoints to CSV",
self.get_csv())
def get_save_data(self):
return {
'data_table_1': self.data_table[1].get_save_data(),
'data_table_2': self.data_table[2].get_save_data(),
'endpoint_defs': self.endpoint_defs.get_save_data()
}
def load_save_data(self, save_data):
self.data_table[1].load_save_data(save_data['data_table_1'],
ignore_layout=True)
self.data_table[2].load_save_data(save_data['data_table_2'],
ignore_layout=True)
self.endpoint_defs.load_save_data(save_data['endpoint_defs'],
ignore_layout=True)
self.calculate_endpoints()
@property
def has_data(self):
if self.endpoint_defs.data and self.endpoint_defs.data['label']:
return True
return False
class DVHAMainFrame(wx.Frame):
def __init__(self, *args, **kwds):
kwds["style"] = kwds.get("style", 0) | wx.DEFAULT_FRAME_STYLE
wx.Frame.__init__(self, *args, **kwds)
self.layout_set = False
self.sizer_dvhs = wx.BoxSizer(wx.VERTICAL)
set_msw_background_color(
self) # If windows, change the background color
self.options = Options()
# Initial DVH object and data
self.dvh = None
self.data = {key: None for key in ['Plans', 'Beams', 'Rxs']}
self.stats_data = None
self.save_data = {}
self.toolbar_keys = [
'Open', 'Close', 'Save', 'Export', 'Import', 'Database', 'ROI Map',
'Settings'
]
self.toolbar_ids = {
key: i + 1000
for i, key in enumerate(self.toolbar_keys)
}
# sql_columns.py contains dictionaries of all queryable variables along with their
# SQL columns and tables. Numerical categories include their units as well.
self.categorical_columns = sql_columns.categorical
self.numerical_columns = sql_columns.numerical
# Keep track of currently selected row in the query tables
self.selected_index_categorical = None
self.selected_index_numerical = None
# Load ROI Map now and pass to other objects for continuity
# TODO: Need a method to address multiple users editing roi_map at the same time
self.roi_map = DatabaseROIs()
self.__add_menubar()
self.__add_tool_bar()
self.__add_layout_objects()
self.__bind_layout_objects()
self.__set_properties()
self.__set_tooltips()
self.__add_notebook_frames()
self.__do_layout()
self.disable_query_buttons('categorical')
self.disable_query_buttons('numerical')
self.button_query_execute.Disable()
self.__disable_notebook_tabs()
columns = {
'categorical': ['category_1', 'category_2', 'Filter Type'],
'numerical': ['category', 'min', 'max', 'Filter Type']
}
self.data_table_categorical = DataTable(self.table_categorical,
columns=columns['categorical'])
self.data_table_numerical = DataTable(self.table_numerical,
columns=columns['numerical'])
if not echo_sql_db():
self.__disable_add_filter_buttons()
def __add_tool_bar(self):
self.frame_toolbar = wx.ToolBar(self,
-1,
style=wx.TB_HORIZONTAL | wx.TB_TEXT)
self.SetToolBar(self.frame_toolbar)
description = {
'Open': "Open previously queried data",
'Close': "Clear queried data",
'Save': "Save queried data",
# 'Print': "Print a report",
'Export': "Export data to CSV",
'Import': "DICOM import wizard",
'Settings': "User Settings",
'Database': "Database Administrator Tools",
'ROI Map': "Define ROI name aliases"
}
for key in self.toolbar_keys:
bitmap = wx.Bitmap(ICONS[key], wx.BITMAP_TYPE_ANY)
if is_windows() or is_linux():
bitmap = scale_bitmap(bitmap, 30, 30)
self.frame_toolbar.AddTool(self.toolbar_ids[key], key, bitmap,
wx.NullBitmap, wx.ITEM_NORMAL,
description[key], "")
if key in {'Close', 'Export', 'ROI Map'}:
self.frame_toolbar.AddSeparator()
self.Bind(wx.EVT_TOOL, self.on_save, id=self.toolbar_ids['Save'])
self.Bind(wx.EVT_TOOL, self.on_open, id=self.toolbar_ids['Open'])
self.Bind(wx.EVT_TOOL, self.on_export, id=self.toolbar_ids['Export'])
self.Bind(wx.EVT_TOOL,
self.on_toolbar_database,
id=self.toolbar_ids['Database'])
self.Bind(wx.EVT_TOOL,
self.on_toolbar_settings,
id=self.toolbar_ids['Settings'])
self.Bind(wx.EVT_TOOL,
self.on_toolbar_roi_map,
id=self.toolbar_ids['ROI Map'])
self.Bind(wx.EVT_TOOL, self.on_close, id=self.toolbar_ids['Close'])
self.Bind(wx.EVT_TOOL,
self.on_toolbar_import,
id=self.toolbar_ids['Import'])
def __add_menubar(self):
self.frame_menubar = wx.MenuBar()
file_menu = wx.Menu()
# file_menu.Append(wx.ID_NEW, '&New')
menu_open = file_menu.Append(wx.ID_OPEN, '&Open\tCtrl+O')
menu_save = file_menu.Append(wx.ID_ANY, '&Save\tCtrl+S')
menu_close = file_menu.Append(wx.ID_ANY, '&Close')
export_plot = wx.Menu()
export_dvhs = export_plot.Append(wx.ID_ANY, 'DVHs')
export_time_series = export_plot.Append(wx.ID_ANY, 'Time Series')
export_regression = export_plot.Append(wx.ID_ANY, 'Regression')
export_control_chart = export_plot.Append(wx.ID_ANY, 'Control Chart')
export = wx.Menu()
export_csv = export.Append(wx.ID_ANY, 'Data to csv\tCtrl+E')
export.AppendSubMenu(export_plot, 'Plot to html')
file_menu.AppendSeparator()
qmi = file_menu.Append(wx.ID_ANY, '&Quit\tCtrl+Q')
self.data_menu = wx.Menu()
self.data_views = {
key: None
for key in ['DVHs', 'Plans', 'Rxs', 'Beams']
}
self.data_menu.AppendSubMenu(export, '&Export')
self.data_menu_items = {
'DVHs': self.data_menu.Append(wx.ID_ANY, 'Show DVHs\tCtrl+1'),
'Plans': self.data_menu.Append(wx.ID_ANY, 'Show Plans\tCtrl+2'),
'Rxs': self.data_menu.Append(wx.ID_ANY, 'Show Rxs\tCtrl+3'),
'Beams': self.data_menu.Append(wx.ID_ANY, 'Show Beams\tCtrl+4')
}
settings_menu = wx.Menu()
menu_pref = settings_menu.Append(wx.ID_PREFERENCES)
menu_sql = settings_menu.Append(wx.ID_ANY,
'&Database Connection\tCtrl+D')
menu_user_settings = settings_menu.Append(wx.ID_ANY,
'&User Settings\tCtrl+,')
help_menu = wx.Menu()
menu_about = help_menu.Append(wx.ID_ANY, '&About')
self.Bind(wx.EVT_MENU, self.on_quit, qmi)
self.Bind(wx.EVT_MENU, self.on_open, menu_open)
self.Bind(wx.EVT_MENU, self.on_close, menu_close)
self.Bind(wx.EVT_MENU, self.on_export, export_csv)
self.Bind(wx.EVT_MENU, self.on_save, menu_save)
self.Bind(wx.EVT_MENU, self.on_pref, menu_pref)
self.Bind(wx.EVT_MENU, self.on_pref, menu_user_settings)
self.Bind(wx.EVT_MENU, self.on_about, menu_about)
self.Bind(wx.EVT_MENU, self.on_sql, menu_sql)
self.Bind(wx.EVT_MENU, self.on_save_plot_dvhs, export_dvhs)
self.Bind(wx.EVT_MENU, self.on_save_plot_time_series,
export_time_series)
self.Bind(wx.EVT_MENU, self.on_save_plot_regression, export_regression)
self.Bind(wx.EVT_MENU, self.on_save_plot_control_chart,
export_control_chart)
self.Bind(wx.EVT_MENU, self.on_view_dvhs, self.data_menu_items['DVHs'])
self.Bind(wx.EVT_MENU, self.on_view_plans,
self.data_menu_items['Plans'])
self.Bind(wx.EVT_MENU, self.on_view_rxs, self.data_menu_items['Rxs'])
self.Bind(wx.EVT_MENU, self.on_view_beams,
self.data_menu_items['Beams'])
self.frame_menubar.Append(file_menu, '&File')
self.frame_menubar.Append(self.data_menu, '&Data')
self.frame_menubar.Append(settings_menu, '&Settings')
self.frame_menubar.Append(help_menu, '&Help')
self.SetMenuBar(self.frame_menubar)
def __add_layout_objects(self):
self.button_categorical = {
'add': wx.Button(self, wx.ID_ANY, "Add Filter"),
'del': wx.Button(self, wx.ID_ANY, "Delete Selected"),
'edit': wx.Button(self, wx.ID_ANY, "Edit Selected")
}
self.button_numerical = {
'add': wx.Button(self, wx.ID_ANY, "Add Filter"),
'del': wx.Button(self, wx.ID_ANY, "Delete Selected"),
'edit': wx.Button(self, wx.ID_ANY, "Edit Selected")
}
self.table_categorical = wx.ListCtrl(self,
wx.ID_ANY,
style=wx.BORDER_SUNKEN
| wx.LC_REPORT)
self.table_numerical = wx.ListCtrl(self,
wx.ID_ANY,
style=wx.BORDER_SUNKEN
| wx.LC_REPORT)
self.button_query_execute = wx.Button(self, wx.ID_ANY,
"Query and Retrieve")
self.notebook_main_view = wx.Notebook(self, wx.ID_ANY)
self.tab_keys = [
'Welcome', 'DVHs', 'Endpoints', 'Rad Bio', 'Time Series',
'Regression', 'Control Chart'
]
self.notebook_tab = {
key: wx.Panel(self.notebook_main_view, wx.ID_ANY)
for key in self.tab_keys
}
self.text_summary = wx.StaticText(self,
wx.ID_ANY,
"",
style=wx.ALIGN_LEFT)
def __bind_layout_objects(self):
self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.on_item_select_categorical,
self.table_categorical)
self.Bind(wx.EVT_BUTTON,
self.add_row_categorical,
id=self.button_categorical['add'].GetId())
self.Bind(wx.EVT_BUTTON,
self.del_row_categorical,
id=self.button_categorical['del'].GetId())
self.Bind(wx.EVT_BUTTON,
self.edit_row_categorical,
id=self.button_categorical['edit'].GetId())
self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.doubleclick_categorical,
self.table_categorical)
self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.on_item_select_numerical,
self.table_numerical)
self.Bind(wx.EVT_BUTTON,
self.add_row_numerical,
id=self.button_numerical['add'].GetId())
self.Bind(wx.EVT_BUTTON,
self.del_row_numerical,
id=self.button_numerical['del'].GetId())
self.Bind(wx.EVT_BUTTON,
self.edit_row_numerical,
id=self.button_numerical['edit'].GetId())
self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.doubleclick_numerical,
self.table_numerical)
self.Bind(wx.EVT_BUTTON,
self.exec_query_button,
id=self.button_query_execute.GetId())
self.Bind(wx.EVT_SIZE, self.on_resize)
def __set_properties(self):
self.SetTitle("DVH Analytics")
self.frame_toolbar.Realize()
self.table_categorical.AppendColumn("Category1",
format=wx.LIST_FORMAT_LEFT,
width=180)
self.table_categorical.AppendColumn("Category2",
format=wx.LIST_FORMAT_LEFT,
width=150)
self.table_categorical.AppendColumn("Filter Type",
format=wx.LIST_FORMAT_LEFT,
width=80)
self.table_numerical.AppendColumn("Category",
format=wx.LIST_FORMAT_LEFT,
width=150)
self.table_numerical.AppendColumn("Min",
format=wx.LIST_FORMAT_LEFT,
width=90)
self.table_numerical.AppendColumn("Max",
format=wx.LIST_FORMAT_LEFT,
width=90)
self.table_numerical.AppendColumn("Filter Type",
format=wx.LIST_FORMAT_LEFT,
width=80)
def __set_tooltips(self):
self.button_categorical['add'].SetToolTip(
"Add a categorical data filter.")
self.button_categorical['del'].SetToolTip(
"Delete the currently selected category filter.")
self.button_categorical['edit'].SetToolTip(
"Edit the currently selected category filter.")
self.button_numerical['add'].SetToolTip("Add a numerical data filter.")
self.button_numerical['del'].SetToolTip(
"Delete the currently selected numerical data filter.")
self.button_numerical['edit'].SetToolTip(
"Edit the currently selected data filter.")
self.button_query_execute.SetToolTip(
"Query the database with the filters entered below. At least one "
"filter must be added.")
def __add_notebook_frames(self):
self.plot = PlotStatDVH(self.notebook_tab['DVHs'], self.dvh,
self.options)
self.time_series = TimeSeriesFrame(self.notebook_tab['Time Series'],
self.dvh, self.data, self.options)
self.regression = RegressionFrame(self.notebook_tab['Regression'],
self.stats_data, self.options)
self.control_chart = ControlChartFrame(
self.notebook_tab['Control Chart'], self.dvh, self.stats_data,
self.options)
self.radbio = RadBioFrame(self.notebook_tab['Rad Bio'], self.dvh,
self.time_series, self.regression,
self.control_chart)
self.endpoint = EndpointFrame(self.notebook_tab['Endpoints'], self.dvh,
self.time_series, self.regression,
self.control_chart)
def __do_layout(self):
sizer_summary = wx.StaticBoxSizer(
wx.StaticBox(self, wx.ID_ANY, "Summary"), wx.HORIZONTAL)
sizer_query_numerical = wx.StaticBoxSizer(
wx.StaticBox(self, wx.ID_ANY, "Query by Numerical Data"),
wx.VERTICAL)
sizer_query_categorical = wx.StaticBoxSizer(
wx.StaticBox(self, wx.ID_ANY, "Query by Categorical Data"),
wx.VERTICAL)
sizer_categorical_buttons = wx.BoxSizer(wx.HORIZONTAL)
sizer_numerical_buttons = wx.BoxSizer(wx.HORIZONTAL)
for key in ['add', 'del', 'edit']:
sizer_categorical_buttons.Add(self.button_categorical[key], 0,
wx.ALL, 5)
sizer_numerical_buttons.Add(self.button_numerical[key], 0, wx.ALL,
5)
sizer_query_categorical.Add(sizer_categorical_buttons, 0,
wx.ALL | wx.EXPAND, 5)
sizer_query_categorical.Add(self.table_categorical, 1,
wx.ALL | wx.EXPAND, 10)
sizer_query_numerical.Add(sizer_numerical_buttons, 0,
wx.ALL | wx.EXPAND, 5)
sizer_query_numerical.Add(self.table_numerical, 1, wx.ALL | wx.EXPAND,
10)
sizer_summary.Add(self.text_summary)
panel_left = wx.BoxSizer(wx.VERTICAL)
panel_left.Add(sizer_query_categorical, 0,
wx.EXPAND | wx.LEFT | wx.RIGHT | wx.SHAPED | wx.TOP, 5)
panel_left.Add(sizer_query_numerical, 0,
wx.BOTTOM | wx.EXPAND | wx.LEFT | wx.RIGHT | wx.SHAPED,
5)
panel_left.Add(self.button_query_execute, 0,
wx.ALIGN_CENTER | wx.LEFT | wx.RIGHT, 15)
panel_left.Add(sizer_summary, 1, wx.ALL | wx.EXPAND, 5)
bitmap_logo = wx.StaticBitmap(self.notebook_tab['Welcome'], wx.ID_ANY,
wx.Bitmap(LOGO_PATH, wx.BITMAP_TYPE_ANY))
text_welcome = wx.StaticText(
self.notebook_tab['Welcome'],
wx.ID_ANY,
"\n\nWelcome to DVH Analytics.\nIf you already have a database built, design "
"a query with the filters to the left.\n\n\n\nDVH Analytics is a software "
"application to help radiation oncology departments build an in-house database "
"of treatment planning data for the purpose of historical comparisons and "
"statistical analysis. This code is still in development. Please contact the "
"developer if you are interested in testing or collaborating.\n\nThe application "
"builds a SQL database of DVHs and various planning parameters from DICOM files "
"(i.e., Plan, Structure, Dose). Since the data is extracted directly from DICOM "
"files, we intend to accommodate an array of treatment planning system vendors.",
style=wx.ALIGN_CENTER)
text_welcome_size = get_window_size(0.417, 0.476)
text_welcome.SetMinSize(text_welcome_size)
text_welcome.Wrap(text_welcome_size[1])
sizer_welcome = wx.BoxSizer(wx.VERTICAL)
sizer_welcome.Add(bitmap_logo, 0,
wx.ALIGN_CENTER | wx.LEFT | wx.RIGHT | wx.TOP, 100)
sizer_welcome.Add(text_welcome, 0, wx.ALIGN_CENTER | wx.ALL, 25)
self.notebook_tab['Welcome'].SetSizer(sizer_welcome)
self.sizer_dvhs.Add(self.plot.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['DVHs'].SetSizer(self.sizer_dvhs)
sizer_endpoint = wx.BoxSizer(wx.VERTICAL)
sizer_endpoint.Add(self.endpoint.layout, 0, wx.ALL, 25)
self.notebook_tab['Endpoints'].SetSizer(sizer_endpoint)
sizer_rad_bio = wx.BoxSizer(wx.VERTICAL)
sizer_rad_bio.Add(self.radbio.layout, 0, wx.ALL, 25)
self.notebook_tab['Rad Bio'].SetSizer(sizer_rad_bio)
sizer_time_series = wx.BoxSizer(wx.VERTICAL)
sizer_time_series.Add(self.time_series.layout, 1, wx.EXPAND | wx.ALL,
25)
self.notebook_tab['Time Series'].SetSizer(sizer_time_series)
sizer_regression = wx.BoxSizer(wx.VERTICAL)
sizer_regression.Add(self.regression.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Regression'].SetSizer(sizer_regression)
sizer_control_chart = wx.BoxSizer(wx.VERTICAL)
sizer_control_chart.Add(self.control_chart.layout, 1,
wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Control Chart'].SetSizer(sizer_control_chart)
for key in self.tab_keys:
self.notebook_main_view.AddPage(self.notebook_tab[key], key)
sizer_main = wx.BoxSizer(wx.VERTICAL)
sizer_main_wrapper = wx.BoxSizer(wx.HORIZONTAL)
hbox_main = wx.BoxSizer(wx.HORIZONTAL)
hbox_main.Add(panel_left, 0, wx.BOTTOM | wx.EXPAND | wx.LEFT | wx.TOP,
5)
hbox_main.Add(self.notebook_main_view, 1,
wx.BOTTOM | wx.EXPAND | wx.RIGHT | wx.TOP, 5)
sizer_main_wrapper.Add(hbox_main, 1, wx.EXPAND, 0)
sizer_main.Add(sizer_main_wrapper, 1, wx.EXPAND, 0)
self.SetSizer(sizer_main)
self.Layout()
self.SetSize(get_window_size(0.833, 0.857))
self.Center()
def __enable_notebook_tabs(self):
for key in self.tab_keys:
if key in {'Regression', 'Control Chart'}:
self.notebook_tab[key].Enable(self.dvh.count > 1)
else:
self.notebook_tab[key].Enable()
self.__enable_initial_buttons_in_tabs()
def __disable_notebook_tabs(self):
for key in self.tab_keys:
if key != 'Welcome':
self.notebook_tab[key].Disable()
def __enable_initial_buttons_in_tabs(self):
self.endpoint.enable_initial_buttons()
self.radbio.enable_initial_buttons()
self.time_series.enable_initial_buttons()
def __disable_add_filter_buttons(self):
self.button_categorical['add'].Disable()
self.button_numerical['add'].Disable()
def __enable_add_filter_buttons(self):
self.button_categorical['add'].Enable()
self.button_numerical['add'].Enable()
def enable_query_buttons(self, query_type):
for key in ['del', 'edit']:
{
'categorical': self.button_categorical[key],
'numerical': self.button_numerical[key]
}[query_type].Enable()
def disable_query_buttons(self, query_type):
for key in ['del', 'edit']:
{
'categorical': self.button_categorical[key],
'numerical': self.button_numerical[key]
}[query_type].Disable()
def update_all_query_buttons(self):
tables = {
'numerical': self.data_table_numerical,
'categorical': self.data_table_categorical
}
for key, table in tables.items():
if table.data is not None:
[self.disable_query_buttons,
self.enable_query_buttons][table.row_count > 0](key)
else:
self.disable_query_buttons(key)
if self.data_table_numerical.row_count + self.data_table_categorical.row_count > 0:
self.button_query_execute.Enable()
else:
self.button_query_execute.Disable()
# --------------------------------------------------------------------------------------------------------------
# Menu bar event functions
# --------------------------------------------------------------------------------------------------------------
def on_save(self, evt):
if self.save_data:
dlg = wx.FileDialog(self,
"Save your downloaded data to file",
"",
wildcard='*.dvha',
style=wx.FD_SAVE)
dlg.SetDirectory(DATA_DIR)
if dlg.ShowModal() == wx.ID_OK:
self.save_data_obj()
save_object_to_file(self.save_data, dlg.GetPath())
dlg.Destroy()
else:
wx.MessageBox(
'There is no data to save. Please query/open some data first.',
'Save Error', wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
def on_open(self, evt):
dlg = wx.FileDialog(self,
"Open saved data",
"",
wildcard='*.dvha',
style=wx.FD_FILE_MUST_EXIST | wx.FD_OPEN)
if dlg.ShowModal() == wx.ID_OK:
self.close()
self.load_data_obj(dlg.GetPath())
dlg.Destroy()
def save_data_obj(self):
self.save_data['dvh'] = self.dvh
self.save_data['main_data'] = self.data
self.save_data['time_stamp'] = datetime.now()
self.save_data['version'] = self.options.VERSION
# data_table_categorical and data_table_numerical saved after query to ensure these data reflect
# the rest of the saved data
self.save_data['endpoint'] = self.endpoint.get_save_data()
self.save_data['time_series'] = self.time_series.get_save_data()
self.save_data['radbio'] = self.radbio.get_save_data()
self.save_data['regression'] = self.regression.get_save_data()
def load_data_obj(self, abs_file_path):
self.save_data = load_object_from_file(abs_file_path)
self.dvh = self.save_data['dvh']
self.data = self.save_data['main_data']
# .load_save_data loses column widths?
self.data_table_categorical.data = deepcopy(
self.save_data['main_categorical']['data'])
self.data_table_numerical.data = deepcopy(
self.save_data['main_numerical']['data'])
self.data_table_categorical.set_data_in_layout()
self.data_table_numerical.set_data_in_layout()
self.update_all_query_buttons()
self.exec_query(load_saved_dvh_data=True)
self.endpoint.load_save_data(self.save_data['endpoint'])
if self.endpoint.has_data:
self.endpoint.enable_buttons()
self.radbio.load_save_data(self.save_data['radbio'])
self.endpoint.update_endpoints_in_dvh()
self.time_series.update_y_axis_options()
self.time_series.load_save_data(self.save_data['time_series'])
self.time_series.update_plot()
if self.dvh.count > 1:
self.regression.stats_data.update_endpoints_and_radbio()
self.regression.update_combo_box_choices()
self.regression.load_save_data(self.save_data['regression'])
self.control_chart.update_combo_box_y_choices()
def on_toolbar_settings(self, evt):
self.on_pref()
def on_toolbar_import(self, evt):
self.check_db_then_call(ImportDicomFrame, self.roi_map, self.options)
def on_toolbar_database(self, evt):
self.check_db_then_call(DatabaseEditorFrame, self.roi_map)
def on_toolbar_roi_map(self, evt):
self.check_db_then_call(ROIMapFrame, self.roi_map)
def check_db_then_call(self, func, *parameters):
if not echo_sql_db():
self.on_sql()
if echo_sql_db():
func(*parameters)
else:
wx.MessageBox(
'Connection to SQL database could not be established.',
'Connection Error', wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
# --------------------------------------------------------------------------------------------------------------
# Query event functions
# --------------------------------------------------------------------------------------------------------------
def on_item_select_categorical(self, evt):
self.selected_index_categorical = self.table_categorical.GetFirstSelected(
)
def on_item_select_numerical(self, evt):
self.selected_index_numerical = self.table_numerical.GetFirstSelected()
def add_row_categorical(self, evt):
query_dlg(self, 'categorical')
self.button_query_execute.Enable()
self.update_all_query_buttons()
def add_row_numerical(self, evt):
query_dlg(self, 'numerical')
self.update_all_query_buttons()
def edit_row_categorical(self, *args):
if self.selected_index_categorical is not None:
query_dlg(self, 'categorical', set_values=True)
def edit_row_numerical(self, *args):
if self.selected_index_numerical is not None:
query_dlg(self, 'numerical', set_values=True)
def doubleclick_categorical(self, evt):
self.selected_index_categorical = self.table_categorical.GetFirstSelected(
)
self.edit_row_categorical()
def doubleclick_numerical(self, evt):
self.selected_index_numerical = self.table_numerical.GetFirstSelected()
self.edit_row_numerical()
def del_row_categorical(self, evt):
self.data_table_categorical.delete_row(self.selected_index_categorical)
self.selected_index_categorical = None
self.update_all_query_buttons()
def del_row_numerical(self, evt):
self.data_table_numerical.delete_row(self.selected_index_numerical)
self.selected_index_numerical = None
self.update_all_query_buttons()
def exec_query_button(self, evt):
# TODO: Thread this process
self.exec_query()
def exec_query(self, load_saved_dvh_data=False):
wait = wx.BusyCursor()
# self.dvh = None
self.plot.clear_plot()
self.endpoint.clear_data()
self.time_series.clear_data()
self.time_series.initialize_y_axis_options()
self.regression.clear()
self.control_chart.clear_data()
self.control_chart.initialize_y_axis_options()
self.radbio.clear_data()
if not load_saved_dvh_data:
uids, dvh_str = self.get_query()
self.dvh = DVH(dvh_condition=dvh_str, uid=uids)
if self.dvh.count:
self.endpoint.update_dvh(self.dvh)
self.text_summary.SetLabelText(self.dvh.get_summary())
self.plot.update_plot(self.dvh)
del wait
self.notebook_main_view.SetSelection(1)
self.update_data(load_saved_dvh_data=load_saved_dvh_data)
self.time_series.update_data(self.dvh, self.data)
if self.dvh.count > 1:
self.control_chart.update_data(self.dvh, self.stats_data)
self.radbio.update_dvh_data(self.dvh)
self.__enable_notebook_tabs()
self.save_data[
'main_categorical'] = self.data_table_categorical.get_save_data(
)
self.save_data[
'main_numerical'] = self.data_table_numerical.get_save_data()
else:
del wait
wx.MessageBox(
'No DVHs returned. Please modify query or import more data.',
'Query Error', wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
self.dvh = None
def get_query(self):
# Used to accumulate lists of query strings for each table
# Will assume each item in list is complete query for that SQL column
queries = {'Plans': [], 'Rxs': [], 'Beams': [], 'DVHs': []}
# Used to group queries by variable, will combine all queries of same variable with an OR operator
# e.g., queries_by_sql_column['Plans'][key] = list of strings, where key is sql column
queries_by_sql_column = {
'Plans': {},
'Rxs': {},
'Beams': {},
'DVHs': {}
}
# Categorical filter
if self.data_table_categorical.row_count:
for i, category in enumerate(
self.data_table_categorical.data['category_1']):
table = self.categorical_columns[category]['table']
col = self.categorical_columns[category]['var_name']
value = self.data_table_categorical.data['category_2'][i]
if col not in queries_by_sql_column[table]:
queries_by_sql_column[table][col] = []
operator = ['=', '!='][{
'Include': 0,
'Exclude': 1
}[self.data_table_categorical.data['Filter Type'][i]]]
queries_by_sql_column[table][col].append(
"%s %s '%s'" % (col, operator, value))
# Range filter
if self.data_table_numerical.row_count:
for i, category in enumerate(
self.data_table_numerical.data['category']):
table = self.numerical_columns[category]['table']
col = self.numerical_columns[category]['var_name']
value_low = self.data_table_numerical.data['min'][i]
value_high = self.data_table_numerical.data['max'][i]
if 'date' in col:
value_low = "'%s'::date" % value_low
value_high = "'%s'::date" % value_high
if col not in queries_by_sql_column[table]:
queries_by_sql_column[table][col] = []
operator = ['BETWEEN', 'NOT BETWEEN'][{
'Include': 0,
'Exclude': 1
}[self.data_table_numerical.data['Filter Type'][i]]]
queries_by_sql_column[table][col].append(
"%s %s %s AND %s" % (col, operator, value_low, value_high))
for table in queries:
for col in queries_by_sql_column[table]:
queries[table].append(
"(%s)" % ' OR '.join(queries_by_sql_column[table][col]))
queries[table] = ' AND '.join(queries[table])
uids = get_study_instance_uids(plans=queries['Plans'],
rxs=queries['Rxs'],
beams=queries['Beams'])['common']
return uids, queries['DVHs']
def update_data(self, load_saved_dvh_data=False):
wait = wx.BusyCursor()
tables = ['Plans', 'Rxs', 'Beams']
if hasattr(self.dvh, 'study_instance_uid'):
if not load_saved_dvh_data:
condition_str = "study_instance_uid in ('%s')" % "','".join(
self.dvh.study_instance_uid)
self.data = {
key: QuerySQL(key, condition_str)
for key in tables
}
else:
self.data = {key: None for key in tables}
del wait
if hasattr(self.dvh, 'study_instance_uid'):
wait = wx.BusyCursor()
self.stats_data = StatsData(self.dvh, self.data)
self.regression.stats_data = self.stats_data
self.control_chart.stats_data = self.stats_data
try:
self.regression.update_combo_box_choices()
except ValueError:
# TODO: Print error in GUI
pass
self.control_chart.update_combo_box_y_choices()
del wait
# --------------------------------------------------------------------------------------------------------------
# Menu bar event functions
# --------------------------------------------------------------------------------------------------------------
def on_quit(self, evt):
self.Close()
def on_close(self, evt):
if self.dvh:
dlg = wx.MessageDialog(self,
"Clear all data and plots?",
caption='Close',
style=wx.YES | wx.NO | wx.NO_DEFAULT
| wx.CENTER | wx.ICON_EXCLAMATION)
dlg.Center()
res = dlg.ShowModal()
if res == wx.ID_YES:
self.close()
dlg.Destroy()
def close(self):
self.dvh = None
self.data_table_categorical.delete_all_rows()
self.data_table_numerical.delete_all_rows()
self.plot.clear_plot()
self.endpoint.clear_data()
self.radbio.clear_data()
self.time_series.clear_data()
self.notebook_main_view.SetSelection(0)
self.text_summary.SetLabelText("")
self.__disable_notebook_tabs()
self.disable_query_buttons('categorical')
self.disable_query_buttons('numerical')
self.button_query_execute.Disable()
self.time_series.initialize_y_axis_options()
self.regression.clear()
self.control_chart.initialize_y_axis_options()
self.control_chart.plot.clear_plot()
def on_export(self, evt):
if self.dvh is not None:
ExportCSVDialog(self)
else:
wx.MessageBox(
'There is no data to export! Please query some data first.',
'Export Error', wx.OK | wx.ICON_WARNING)
def on_about(self, evt):
About()
def on_pref(self, *args):
UserSettings(self.options)
def on_sql(self, *args):
SQLSettingsDialog()
[self.__disable_add_filter_buttons,
self.__enable_add_filter_buttons][echo_sql_db()]()
def on_save_plot_dvhs(self, evt):
save_data_to_file(self,
'Save DVHs plot',
self.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_time_series(self, evt):
save_data_to_file(self,
'Save Time Series plot',
self.time_series.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_regression(self, evt):
save_data_to_file(self,
'Save Regression plot',
self.regression.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_control_chart(self, evt):
save_data_to_file(self,
'Save Control Chart plot',
self.control_chart.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_view_dvhs(self, evt):
self.view_table_data('DVHs')
def on_view_plans(self, evt):
self.view_table_data('Plans')
def on_view_rxs(self, evt):
self.view_table_data('Rxs')
def on_view_beams(self, evt):
self.view_table_data('Beams')
def view_table_data(self, key):
if key == 'DVHs':
data = self.dvh
else:
data = self.data[key]
if data:
if self.get_menu_item_status(key) == 'Show':
self.data_views[key] = QueriedDataFrame(
data, key, self.data_menu,
self.data_menu_items[key].GetId())
else:
self.data_views[key].on_close()
self.data_views[key] = None
else:
dlg = wx.MessageDialog(self, 'Please query/open some data first.',
'ERROR!', wx.ICON_ERROR | wx.OK_DEFAULT)
dlg.ShowModal()
dlg.Destroy()
def get_menu_item_status(self, key):
show_hide = [
'Hide', 'Show'
]['Show' in self.data_menu.GetLabel(self.data_menu_items[key].GetId())]
return show_hide
def redraw_plots(self):
if self.dvh:
self.plot.redraw_plot()
self.time_series.plot.redraw_plot()
self.regression.plot.redraw_plot()
self.control_chart.plot.redraw_plot()
def on_resize(self, *evt):
try:
self.Refresh()
self.Layout()
wx.CallAfter(self.redraw_plots)
except RuntimeError:
pass
class DVHAMainFrame(wx.Frame):
def __init__(self, *args, **kwds):
kwds["style"] = kwds.get("style", 0) | wx.DEFAULT_FRAME_STYLE
wx.Frame.__init__(self, *args, **kwds)
self.layout_set = False
self.sizer_dvhs = wx.BoxSizer(wx.VERTICAL)
set_msw_background_color(self) # If windows, change the background color
self.options = Options()
# Initial DVH object and data
self.save_data = {}
self.group_data = {1: {'dvh': None,
'data': {key: None for key in ['Plans', 'Beams', 'Rxs']},
'stats_data': None},
2: {'dvh': None,
'data': {key: None for key in ['Plans', 'Beams', 'Rxs']},
'stats_data': None}}
self.toolbar_keys = ['Open', 'Close', 'Save', 'Export', 'Import', 'Database', 'ROI Map', 'Settings']
self.toolbar_ids = {key: i + 1000 for i, key in enumerate(self.toolbar_keys)}
# sql_columns.py contains dictionaries of all queryable variables along with their
# SQL columns and tables. Numerical categories include their units as well.
self.categorical_columns = sql_columns.categorical
self.numerical_columns = sql_columns.numerical
# Keep track of currently selected row in the query tables
self.selected_index_categorical = None
self.selected_index_numerical = None
# Load ROI Map now and pass to other objects for continuity
# TODO: Need a method to address multiple users editing roi_map at the same time
self.roi_map = DatabaseROIs()
self.query_filters = None
self.reset_query_filters()
self.__add_menubar()
self.__add_tool_bar()
self.__add_layout_objects()
self.__bind_layout_objects()
columns = {'categorical': ['category_1', 'category_2', 'Filter Type'],
'numerical': ['category', 'min', 'max', 'Filter Type']}
self.data_table_categorical = DataTable(self.table_categorical, columns=columns['categorical'])
self.data_table_numerical = DataTable(self.table_numerical, columns=columns['numerical'])
self.__set_properties()
self.__set_tooltips()
self.__add_notebook_frames()
self.__do_layout()
self.disable_query_buttons('categorical')
self.disable_query_buttons('numerical')
self.button_query_execute.Disable()
self.__disable_notebook_tabs()
self.Bind(wx.EVT_CLOSE, self.on_quit)
self.tool_bar_windows = {key: None for key in ['import', 'database', 'roi_map']}
wx.CallAfter(self.__catch_failed_sql_connection_on_app_launch)
self.__do_subscribe()
def __add_tool_bar(self):
self.frame_toolbar = wx.ToolBar(self, -1, style=wx.TB_HORIZONTAL | wx.TB_TEXT)
self.SetToolBar(self.frame_toolbar)
description = {'Open': "Open previously queried data",
'Close': "Clear queried data",
'Save': "Save queried data",
# 'Print': "Print a report",
'Export': "Export data to CSV",
'Import': "DICOM import wizard",
'Settings': "User Settings",
'Database': "Database Administrator Tools",
'ROI Map': "Define ROI name aliases"}
for key in self.toolbar_keys:
bitmap = wx.Bitmap(ICONS[key], wx.BITMAP_TYPE_ANY)
if is_windows() or is_linux():
bitmap = scale_bitmap(bitmap, 30, 30)
self.frame_toolbar.AddTool(self.toolbar_ids[key], key, bitmap,
wx.NullBitmap, wx.ITEM_NORMAL, description[key], "")
if key in {'Close', 'Export', 'ROI Map'}:
self.frame_toolbar.AddSeparator()
self.Bind(wx.EVT_TOOL, self.on_save, id=self.toolbar_ids['Save'])
self.Bind(wx.EVT_TOOL, self.on_open, id=self.toolbar_ids['Open'])
self.Bind(wx.EVT_TOOL, self.on_export, id=self.toolbar_ids['Export'])
self.Bind(wx.EVT_TOOL, self.on_toolbar_database, id=self.toolbar_ids['Database'])
self.Bind(wx.EVT_TOOL, self.on_toolbar_settings, id=self.toolbar_ids['Settings'])
self.Bind(wx.EVT_TOOL, self.on_toolbar_roi_map, id=self.toolbar_ids['ROI Map'])
self.Bind(wx.EVT_TOOL, self.on_close, id=self.toolbar_ids['Close'])
self.Bind(wx.EVT_TOOL, self.on_toolbar_import, id=self.toolbar_ids['Import'])
def __add_menubar(self):
self.frame_menubar = wx.MenuBar()
file_menu = wx.Menu()
# file_menu.Append(wx.ID_NEW, '&New')
menu_open = file_menu.Append(wx.ID_OPEN, '&Open\tCtrl+O')
menu_import = file_menu.Append(wx.ID_OPEN, '&Import DICOM\tCtrl+I')
menu_save = file_menu.Append(wx.ID_ANY, '&Save\tCtrl+S')
menu_close = file_menu.Append(wx.ID_ANY, '&Close')
load_model = wx.Menu()
load_model_mvr = load_model.Append(wx.ID_ANY, 'Multi-Variable Regression')
load_model_ml = load_model.Append(wx.ID_ANY, 'Machine Learning')
export_plot = wx.Menu()
export_dvhs = export_plot.Append(wx.ID_ANY, 'DVHs')
export_time_series = export_plot.Append(wx.ID_ANY, 'Time Series')
export_correlation = export_plot.Append(wx.ID_ANY, 'Correlation')
export_regression = export_plot.Append(wx.ID_ANY, 'Regression')
export_control_chart = export_plot.Append(wx.ID_ANY, 'Control Chart')
export = wx.Menu()
export_csv = export.Append(wx.ID_ANY, 'Data to csv\tCtrl+E')
export.AppendSubMenu(export_plot, 'Plot to html')
file_menu.AppendSeparator()
qmi = file_menu.Append(wx.ID_ANY, '&Quit\tCtrl+Q')
self.data_menu = wx.Menu()
self.data_views = {key: None for key in ['DVHs', 'Plans', 'Rxs', 'Beams']}
menu_db_admin = self.data_menu.Append(wx.ID_ANY, 'Database Administrator')
self.data_menu.AppendSubMenu(load_model, 'Load &Model')
self.data_menu.AppendSubMenu(export, '&Export')
self.data_menu_items = {'DVHs': self.data_menu.Append(wx.ID_ANY, 'Show DVHs\tCtrl+1'),
'Plans': self.data_menu.Append(wx.ID_ANY, 'Show Plans\tCtrl+2'),
'Rxs': self.data_menu.Append(wx.ID_ANY, 'Show Rxs\tCtrl+3'),
'Beams': self.data_menu.Append(wx.ID_ANY, 'Show Beams\tCtrl+4'),
'StatsData1': self.data_menu.Append(wx.ID_ANY, 'Show Stats Data: Group 1\tCtrl+5'),
'StatsData2': self.data_menu.Append(wx.ID_ANY, 'Show Stats Data: Group 2\tCtrl+6')}
settings_menu = wx.Menu()
menu_pref = settings_menu.Append(wx.ID_PREFERENCES)
menu_sql = settings_menu.Append(wx.ID_ANY, '&Database Connection\tCtrl+D')
menu_roi_map = settings_menu.Append(wx.ID_ANY, '&ROI Map\tCtrl+R')
help_menu = wx.Menu()
menu_github = help_menu.Append(wx.ID_ANY, 'GitHub Page')
menu_report_issue = help_menu.Append(wx.ID_ANY, 'Report an Issue')
menu_about = help_menu.Append(wx.ID_ANY, '&About')
self.Bind(wx.EVT_MENU, self.on_quit, qmi)
self.Bind(wx.EVT_MENU, self.on_open, menu_open)
self.Bind(wx.EVT_MENU, self.on_toolbar_import, menu_import)
self.Bind(wx.EVT_MENU, self.on_load_mvr_model, load_model_mvr)
self.Bind(wx.EVT_MENU, self.on_load_ml_model, load_model_ml)
self.Bind(wx.EVT_MENU, self.on_close, menu_close)
self.Bind(wx.EVT_MENU, self.on_export, export_csv)
self.Bind(wx.EVT_MENU, self.on_save, menu_save)
self.Bind(wx.EVT_MENU, self.on_pref, menu_pref)
self.Bind(wx.EVT_MENU, self.on_githubpage, menu_github)
self.Bind(wx.EVT_MENU, self.on_report_issue, menu_report_issue)
self.Bind(wx.EVT_MENU, self.on_about, menu_about)
self.Bind(wx.EVT_MENU, self.on_sql, menu_sql)
self.Bind(wx.EVT_MENU, self.on_toolbar_roi_map, menu_roi_map)
if is_mac():
menu_user_settings = settings_menu.Append(wx.ID_ANY, '&Preferences\tCtrl+,')
self.Bind(wx.EVT_MENU, self.on_pref, menu_user_settings)
self.Bind(wx.EVT_MENU, self.on_save_plot_dvhs, export_dvhs)
self.Bind(wx.EVT_MENU, self.on_save_plot_time_series, export_time_series)
self.Bind(wx.EVT_MENU, self.on_save_plot_correlation, export_correlation)
self.Bind(wx.EVT_MENU, self.on_save_plot_regression, export_regression)
self.Bind(wx.EVT_MENU, self.on_save_plot_control_chart, export_control_chart)
self.Bind(wx.EVT_MENU, self.on_toolbar_database, menu_db_admin)
self.Bind(wx.EVT_MENU, self.on_view_dvhs, self.data_menu_items['DVHs'])
self.Bind(wx.EVT_MENU, self.on_view_plans, self.data_menu_items['Plans'])
self.Bind(wx.EVT_MENU, self.on_view_rxs, self.data_menu_items['Rxs'])
self.Bind(wx.EVT_MENU, self.on_view_beams, self.data_menu_items['Beams'])
self.Bind(wx.EVT_MENU, self.on_view_stats_data_1, self.data_menu_items['StatsData1'])
self.Bind(wx.EVT_MENU, self.on_view_stats_data_2, self.data_menu_items['StatsData2'])
self.frame_menubar.Append(file_menu, '&File')
self.frame_menubar.Append(self.data_menu, '&Data')
self.frame_menubar.Append(settings_menu, '&Settings')
self.frame_menubar.Append(help_menu, '&Help')
self.SetMenuBar(self.frame_menubar)
def __add_layout_objects(self):
self.button_categorical = {'add': wx.Button(self, wx.ID_ANY, "Add Filter"),
'del': wx.Button(self, wx.ID_ANY, "Delete Selected"),
'edit': wx.Button(self, wx.ID_ANY, "Edit Selected")}
self.button_numerical = {'add': wx.Button(self, wx.ID_ANY, "Add Filter"),
'del': wx.Button(self, wx.ID_ANY, "Delete Selected"),
'edit': wx.Button(self, wx.ID_ANY, "Edit Selected")}
self.table_categorical = wx.ListCtrl(self, wx.ID_ANY, style=wx.BORDER_SUNKEN | wx.LC_REPORT)
self.table_numerical = wx.ListCtrl(self, wx.ID_ANY, style=wx.BORDER_SUNKEN | wx.LC_REPORT)
self.radio_button_query_group = wx.RadioBox(self, wx.ID_ANY, 'Query Group', choices=['1', '2'])
self.button_query_execute = wx.Button(self, wx.ID_ANY, "Query and Retrieve Group 1")
self.notebook_main_view = wx.Notebook(self, wx.ID_ANY)
self.tab_keys = ['Welcome', 'DVHs', 'Endpoints', 'Rad Bio', 'Time Series',
'Correlation', 'Regression', 'Control Chart']
self.notebook_tab = {key: wx.Panel(self.notebook_main_view, wx.ID_ANY) for key in self.tab_keys}
self.text_summary = wx.StaticText(self, wx.ID_ANY, "", style=wx.ALIGN_LEFT)
def __bind_layout_objects(self):
self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.on_item_select_categorical, self.table_categorical)
self.Bind(wx.EVT_BUTTON, self.add_row_categorical, id=self.button_categorical['add'].GetId())
self.Bind(wx.EVT_BUTTON, self.del_row_categorical, id=self.button_categorical['del'].GetId())
self.Bind(wx.EVT_BUTTON, self.edit_row_categorical, id=self.button_categorical['edit'].GetId())
self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.doubleclick_categorical, self.table_categorical)
self.Bind(wx.EVT_LIST_ITEM_SELECTED, self.on_item_select_numerical, self.table_numerical)
self.Bind(wx.EVT_BUTTON, self.add_row_numerical, id=self.button_numerical['add'].GetId())
self.Bind(wx.EVT_BUTTON, self.del_row_numerical, id=self.button_numerical['del'].GetId())
self.Bind(wx.EVT_BUTTON, self.edit_row_numerical, id=self.button_numerical['edit'].GetId())
self.Bind(wx.EVT_LIST_ITEM_ACTIVATED, self.doubleclick_numerical, self.table_numerical)
self.Bind(wx.EVT_RADIOBOX, self.on_group_select, id=self.radio_button_query_group.GetId())
self.Bind(wx.EVT_BUTTON, self.exec_query_button, id=self.button_query_execute.GetId())
self.Bind(wx.EVT_SIZE, self.on_resize)
def __set_properties(self):
self.SetTitle("DVH Analytics")
self.frame_toolbar.Realize()
widths = [180, 150, 80]
self.table_categorical.AppendColumn("Category1", format=wx.LIST_FORMAT_LEFT, width=widths[0])
self.table_categorical.AppendColumn("Category2", format=wx.LIST_FORMAT_LEFT, width=widths[1])
self.table_categorical.AppendColumn("Filter Type", format=wx.LIST_FORMAT_LEFT, width=widths[2])
self.data_table_categorical.widths = widths
widths = [150, 90, 90, 80]
self.table_numerical.AppendColumn("Category", format=wx.LIST_FORMAT_LEFT, width=widths[0])
self.table_numerical.AppendColumn("Min", format=wx.LIST_FORMAT_LEFT, width=widths[1])
self.table_numerical.AppendColumn("Max", format=wx.LIST_FORMAT_LEFT, width=widths[2])
self.table_numerical.AppendColumn("Filter Type", format=wx.LIST_FORMAT_LEFT, width=widths[3])
self.data_table_numerical.widths = widths
def __set_tooltips(self):
self.button_categorical['add'].SetToolTip("Add a categorical data filter.")
self.button_categorical['del'].SetToolTip("Delete the currently selected category filter.")
self.button_categorical['edit'].SetToolTip("Edit the currently selected category filter.")
self.button_numerical['add'].SetToolTip("Add a numerical data filter.")
self.button_numerical['del'].SetToolTip("Delete the currently selected numerical data filter.")
self.button_numerical['edit'].SetToolTip("Edit the currently selected data filter.")
self.button_query_execute.SetToolTip("Query the database with the filters entered above. At least one "
"filter must be added.")
def __add_notebook_frames(self):
self.plot = PlotStatDVH(self.notebook_tab['DVHs'], self.group_data, self.options)
self.time_series = TimeSeriesFrame(self.notebook_tab['Time Series'], self.group_data, self.options)
self.correlation = CorrelationFrame(self.notebook_tab['Correlation'], self.group_data, self.options)
self.regression = RegressionFrame(self.notebook_tab['Regression'], self.group_data, self.options)
self.control_chart = ControlChartFrame(self.notebook_tab['Control Chart'], self.group_data, self.options)
self.radbio = RadBioFrame(self.notebook_tab['Rad Bio'], self.group_data, self.time_series, self.regression,
self.control_chart)
self.endpoint = EndpointFrame(self.notebook_tab['Endpoints'], self.group_data, self.time_series, self.regression,
self.control_chart)
def __do_layout(self):
sizer_summary = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Summary"), wx.HORIZONTAL)
sizer_query_numerical = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Query by Numerical Data"),
wx.VERTICAL)
sizer_query_categorical = wx.StaticBoxSizer(wx.StaticBox(self, wx.ID_ANY, "Query by Categorical Data"),
wx.VERTICAL)
sizer_categorical_buttons = wx.BoxSizer(wx.HORIZONTAL)
sizer_numerical_buttons = wx.BoxSizer(wx.HORIZONTAL)
sizer_query_exec_buttons = wx.BoxSizer(wx.HORIZONTAL)
for key in ['add', 'del', 'edit']:
sizer_categorical_buttons.Add(self.button_categorical[key], 0, wx.ALL, 5)
sizer_numerical_buttons.Add(self.button_numerical[key], 0, wx.ALL, 5)
sizer_query_categorical.Add(sizer_categorical_buttons, 0, wx.ALL | wx.EXPAND, 5)
sizer_query_categorical.Add(self.table_categorical, 1, wx.ALL | wx.EXPAND, 10)
sizer_query_numerical.Add(sizer_numerical_buttons, 0, wx.ALL | wx.EXPAND, 5)
sizer_query_numerical.Add(self.table_numerical, 1, wx.TOP | wx.LEFT | wx.RIGHT | wx.EXPAND, 10)
sizer_summary.Add(self.text_summary)
panel_left = wx.BoxSizer(wx.VERTICAL)
panel_left.Add(sizer_query_categorical, 0, wx.EXPAND | wx.LEFT | wx.RIGHT | wx.SHAPED | wx.TOP, 5)
panel_left.Add(sizer_query_numerical, 0, wx.BOTTOM | wx.EXPAND | wx.LEFT | wx.RIGHT | wx.SHAPED, 5)
sizer_query_exec_buttons.Add(self.radio_button_query_group, 0, 0, 0)
sizer_query_exec_buttons.Add(self.button_query_execute, 1, wx.EXPAND | wx.LEFT | wx.RIGHT | wx.ALIGN_CENTER, 10)
panel_left.Add(sizer_query_exec_buttons, 0, wx.EXPAND | wx.ALIGN_CENTER | wx.RIGHT | wx.LEFT, 5)
panel_left.Add(sizer_summary, 1, wx.ALL | wx.EXPAND, 5)
bitmap_logo = wx.StaticBitmap(self.notebook_tab['Welcome'], wx.ID_ANY,
wx.Bitmap(LOGO_PATH, wx.BITMAP_TYPE_ANY))
text_welcome = wx.StaticText(self.notebook_tab['Welcome'], wx.ID_ANY,
"\n\nWelcome to DVH Analytics.\nIf you already have a database built, design "
"a query with the filters to the left.\n\n\n\nDVH Analytics is a software "
"application to help radiation oncology departments build an in-house database "
"of treatment planning data for the purpose of historical comparisons and "
"statistical analysis. This code is still in development. Please contact the "
"developer if you are interested in testing or collaborating.\n\nThe application "
"builds a SQL database of DVHs and various planning parameters from DICOM files "
"(i.e., Plan, Structure, Dose). Since the data is extracted directly from DICOM "
"files, we intend to accommodate an array of treatment planning system vendors.",
style=wx.ALIGN_CENTER)
text_welcome_size = get_window_size(0.417, 0.476)
text_welcome.SetMinSize(text_welcome_size)
text_welcome.Wrap(text_welcome_size[1])
sizer_welcome = wx.BoxSizer(wx.VERTICAL)
sizer_welcome.Add(bitmap_logo, 0, wx.ALIGN_CENTER | wx.LEFT | wx.RIGHT | wx.TOP, 100)
sizer_welcome.Add(text_welcome, 0, wx.ALIGN_CENTER | wx.ALL, 25)
self.notebook_tab['Welcome'].SetSizer(sizer_welcome)
self.sizer_dvhs.Add(self.plot.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['DVHs'].SetSizer(self.sizer_dvhs)
sizer_endpoint = wx.BoxSizer(wx.VERTICAL)
sizer_endpoint.Add(self.endpoint.layout, 0, wx.ALL, 25)
self.notebook_tab['Endpoints'].SetSizer(sizer_endpoint)
sizer_rad_bio = wx.BoxSizer(wx.VERTICAL)
sizer_rad_bio.Add(self.radbio.layout, 0, wx.ALL, 25)
self.notebook_tab['Rad Bio'].SetSizer(sizer_rad_bio)
sizer_time_series = wx.BoxSizer(wx.VERTICAL)
sizer_time_series.Add(self.time_series.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Time Series'].SetSizer(sizer_time_series)
sizer_correlation = wx.BoxSizer(wx.VERTICAL)
sizer_correlation.Add(self.correlation.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Correlation'].SetSizer(sizer_correlation)
sizer_regression = wx.BoxSizer(wx.VERTICAL)
sizer_regression.Add(self.regression.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Regression'].SetSizer(sizer_regression)
sizer_control_chart = wx.BoxSizer(wx.VERTICAL)
sizer_control_chart.Add(self.control_chart.layout, 1, wx.EXPAND | wx.ALL, 25)
self.notebook_tab['Control Chart'].SetSizer(sizer_control_chart)
for key in self.tab_keys:
self.notebook_main_view.AddPage(self.notebook_tab[key], key)
sizer_main = wx.BoxSizer(wx.VERTICAL)
sizer_main_wrapper = wx.BoxSizer(wx.HORIZONTAL)
hbox_main = wx.BoxSizer(wx.HORIZONTAL)
hbox_main.Add(panel_left, 0, wx.BOTTOM | wx.EXPAND | wx.LEFT | wx.TOP, 5)
hbox_main.Add(self.notebook_main_view, 1, wx.BOTTOM | wx.EXPAND | wx.RIGHT | wx.TOP, 5)
sizer_main_wrapper.Add(hbox_main, 1, wx.EXPAND, 0)
sizer_main.Add(sizer_main_wrapper, 1, wx.EXPAND, 0)
self.SetSizer(sizer_main)
self.Layout()
self.SetSize(get_window_size(0.833, 0.857))
self.Center()
def __enable_notebook_tabs(self):
for key in self.tab_keys:
self.notebook_tab[key].Enable()
self.__enable_initial_buttons_in_tabs()
def __disable_notebook_tabs(self):
for key in self.tab_keys:
if key != 'Welcome':
self.notebook_tab[key].Disable()
def __enable_initial_buttons_in_tabs(self):
self.endpoint.enable_initial_buttons()
self.radbio.enable_initial_buttons()
self.time_series.enable_initial_buttons()
def __disable_add_filter_buttons(self):
self.button_categorical['add'].Disable()
self.button_numerical['add'].Disable()
def __enable_add_filter_buttons(self):
self.button_categorical['add'].Enable()
self.button_numerical['add'].Enable()
def enable_query_buttons(self, query_type):
for key in ['del', 'edit']:
{'categorical': self.button_categorical[key],
'numerical': self.button_numerical[key]}[query_type].Enable()
def disable_query_buttons(self, query_type):
for key in ['del', 'edit']:
{'categorical': self.button_categorical[key],
'numerical': self.button_numerical[key]}[query_type].Disable()
def update_all_query_buttons(self):
tables = {'numerical': self.data_table_numerical, 'categorical': self.data_table_categorical}
for key, table in tables.items():
if table.data is not None:
[self.disable_query_buttons, self.enable_query_buttons][table.row_count > 0](key)
else:
self.disable_query_buttons(key)
if self.data_table_numerical.row_count + self.data_table_categorical.row_count > 0:
self.button_query_execute.Enable()
else:
self.button_query_execute.Disable()
# Force user to populate group 1 first
if self.selected_group == 2 and self.group_data[1]['dvh'] is None:
self.button_query_execute.Disable()
def __catch_failed_sql_connection_on_app_launch(self):
if self.options.DB_TYPE == 'pgsql':
if not echo_sql_db():
wx.MessageBox('Invalid credentials!', 'Echo SQL Database', wx.OK | wx.ICON_WARNING)
self.on_sql()
else: # if using sqlite
initialize_db()
def __do_subscribe(self):
pub.subscribe(self.raise_error_dialog, "import_status_raise_error")
def raise_error_dialog(self, msg):
MemoryErrorDialog(self, msg)
# --------------------------------------------------------------------------------------------------------------
# Menu bar event functions
# --------------------------------------------------------------------------------------------------------------
def on_save(self, evt):
if self.save_data:
dlg = wx.FileDialog(self, "Save your session data to file", "", wildcard='*.dvha',
style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT)
dlg.SetDirectory(DATA_DIR)
if dlg.ShowModal() == wx.ID_OK:
self.save_data_obj()
save_object_to_file(self.save_data, dlg.GetPath())
dlg.Destroy()
else:
wx.MessageBox('There is no data to save. Please query/open some data first.', 'Save Error',
wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
def on_open(self, evt):
dlg = wx.FileDialog(self, "Open saved data", "", wildcard='*.dvha',
style=wx.FD_FILE_MUST_EXIST | wx.FD_OPEN)
if dlg.ShowModal() == wx.ID_OK:
self.close()
self.load_data_obj(dlg.GetPath())
dlg.Destroy()
def on_load_mvr_model(self, *evt):
with wx.FileDialog(self, "Load a multi-variable linear regression model", "", wildcard='*.mvr',
style=wx.FD_FILE_MUST_EXIST | wx.FD_OPEN) as dlg:
dlg.SetDirectory(MODELS_DIR)
if dlg.ShowModal() == wx.ID_OK:
model_file_path = dlg.GetPath()
dlg.Destroy()
LoadMultiVarModelFrame(model_file_path, self.group_data, self.selected_group, self.options)
def on_load_ml_model(self, *evt):
if self.group_data[self.selected_group]['stats_data']:
MachineLearningModelViewer(self, self.group_data, self.selected_group, self.options)
else:
wx.MessageBox('No data as been queried for Group %s.' % self.selected_group, 'Error',
wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
@property
def selected_group(self):
return self.radio_button_query_group.GetSelection() + 1
def save_data_obj(self):
self.save_data['group_data'] = self.group_data
self.save_data['query_filters'] = self.query_filters
self.save_data['time_stamp'] = datetime.now()
self.save_data['version'] = DefaultOptions().VERSION
# data_table_categorical and data_table_numerical saved after query to ensure these data reflect
# the rest of the saved data
self.save_data['endpoint'] = self.endpoint.get_save_data()
self.save_data['time_series'] = self.time_series.get_save_data()
self.save_data['radbio'] = self.radbio.get_save_data()
self.save_data['regression'] = self.regression.get_save_data()
self.save_data['control_chart'] = self.control_chart.get_save_data()
def load_data_obj(self, abs_file_path):
self.save_data = load_object_from_file(abs_file_path)
self.group_data = self.save_data['group_data']
# .load_save_data loses column widths?
self.radio_button_query_group.SetSelection(0)
self.data_table_categorical.load_save_data(self.save_data['main_categorical_1'])
self.data_table_numerical.load_save_data(self.save_data['main_numerical_1'])
self.control_chart.load_save_data(self.save_data['control_chart'])
self.radio_button_query_group.SetSelection(0)
self.exec_query(load_saved_dvh_data=True, group=1)
if 'main_categorical_2' in self.save_data.keys():
self.radio_button_query_group.SetSelection(1)
self.on_group_select()
self.data_table_categorical.load_save_data(self.save_data['main_categorical_2'])
self.data_table_numerical.load_save_data(self.save_data['main_numerical_2'])
self.update_all_query_buttons()
self.exec_query(load_saved_dvh_data=True, group=2)
self.update_all_query_buttons()
self.endpoint.load_save_data(self.save_data['endpoint'])
if self.endpoint.has_data:
self.endpoint.enable_buttons()
self.radbio.load_save_data(self.save_data['radbio'])
self.endpoint.update_endpoints_in_dvh()
self.group_data[1]['stats_data'].update_endpoints_and_radbio()
if self.group_data[2]['stats_data']:
self.group_data[2]['stats_data'].update_endpoints_and_radbio()
self.time_series.load_save_data(self.save_data['time_series'])
self.time_series.update_plot()
self.regression.update_combo_box_choices()
self.regression.load_save_data(self.save_data['regression'])
self.control_chart.update_combo_box_y_choices()
def on_toolbar_settings(self, evt):
self.on_pref()
def on_toolbar_import(self, evt):
self.check_db_then_call(ImportDicomFrame, 'import', self.roi_map, self.options)
def on_toolbar_database(self, evt):
self.check_db_then_call(DatabaseEditorFrame, 'database', self.roi_map, self.options)
def on_toolbar_roi_map(self, evt):
self.check_db_then_call(ROIMapFrame, 'roi_map', self.roi_map)
def check_db_then_call(self, func, window_type, *parameters):
if not echo_sql_db():
self.on_sql()
if echo_sql_db():
if self.tool_bar_windows[window_type]:
self.tool_bar_windows[window_type].Raise()
else:
self.tool_bar_windows[window_type] = func(*parameters)
else:
wx.MessageBox('Connection to SQL database could not be established.', 'Connection Error',
wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
# --------------------------------------------------------------------------------------------------------------
# Query event functions
# --------------------------------------------------------------------------------------------------------------
def on_item_select_categorical(self, evt):
self.selected_index_categorical = self.table_categorical.GetFirstSelected()
def on_item_select_numerical(self, evt):
self.selected_index_numerical = self.table_numerical.GetFirstSelected()
def add_row_categorical(self, evt):
query_dlg(self, 'categorical')
self.button_query_execute.Enable()
self.update_all_query_buttons()
def add_row_numerical(self, evt):
query_dlg(self, 'numerical')
self.update_all_query_buttons()
def edit_row_categorical(self, *args):
if self.selected_index_categorical is not None:
query_dlg(self, 'categorical', set_values=True)
def edit_row_numerical(self, *args):
if self.selected_index_numerical is not None:
query_dlg(self, 'numerical', set_values=True)
def doubleclick_categorical(self, evt):
self.selected_index_categorical = self.table_categorical.GetFirstSelected()
self.edit_row_categorical()
def doubleclick_numerical(self, evt):
self.selected_index_numerical = self.table_numerical.GetFirstSelected()
self.edit_row_numerical()
def del_row_categorical(self, evt):
self.data_table_categorical.delete_row(self.selected_index_categorical)
self.selected_index_categorical = None
self.update_all_query_buttons()
def del_row_numerical(self, evt):
self.data_table_numerical.delete_row(self.selected_index_numerical)
self.selected_index_numerical = None
self.update_all_query_buttons()
def exec_query_button(self, evt):
self.exec_query()
def exec_query(self, load_saved_dvh_data=False, group=None):
wx.BeginBusyCursor()
if group is not None:
self.radio_button_query_group.SetSelection(group - 1)
group = self.selected_group
# TODO: retain group 1 endpoint defs after query of group 2
self.endpoint.clear_data()
if group == 1:
self.plot.clear_plot()
self.time_series.clear_data()
self.regression.clear(self.group_data)
self.control_chart.clear_data()
self.radbio.clear_data()
if not load_saved_dvh_data:
try:
uids, dvh_str = self.get_query()
self.group_data[group]['dvh'] = \
DVH(dvh_condition=dvh_str, uid=uids, dvh_bin_width=self.options.dvh_bin_width)
except MemoryError:
msg = "Querying memory error. Try querying less data. At least %s DVHs returned.\n"\
"NOTE: Threshold of this error is dependent on your computer." % self.group_data[group]['dvh'].count
MemoryErrorDialog(self, msg)
self.close()
return
count = self.group_data[group]['dvh'].count
if count > 1:
try:
self.endpoint.update_dvh(self.group_data)
self.set_summary_text(group)
self.plot.update_plot(self.group_data[1]['dvh'], dvh_2=self.group_data[2]['dvh'])
wx.EndBusyCursor()
self.update_data(load_saved_dvh_data=load_saved_dvh_data, group_2_only=bool(group-1))
if group == 1:
self.notebook_main_view.SetSelection(1)
self.__enable_notebook_tabs()
self.save_data['main_categorical_%s' % group] = self.data_table_categorical.get_save_data()
self.save_data['main_numerical_%s' % group] = self.data_table_numerical.get_save_data()
if group == 2:
self.regression.group = 2
self.control_chart.group = 2
self.update_stats_data_plots()
except PlottingMemoryError as e:
wx.EndBusyCursor()
self.on_plotting_memory_error(str(e))
else:
wx.EndBusyCursor()
msg = "%s DVHs returned. Please modify query or import more data." % ['Less than 2', 'No'][count == 0]
wx.MessageBox(msg, 'Query Error', wx.OK | wx.OK_DEFAULT | wx.ICON_WARNING)
self.group_data[group]['dvh'] = None
def get_query(self):
# Used to accumulate lists of query strings for each table
# Will assume each item in list is complete query for that SQL column
queries = {'Plans': [], 'Rxs': [], 'Beams': [], 'DVHs': []}
# Used to group queries by variable, will combine all queries of same variable with an OR operator
# e.g., queries_by_sql_column['Plans'][key] = list of strings, where key is sql column
queries_by_sql_column = {'Plans': {}, 'Rxs': {}, 'Beams': {}, 'DVHs': {}}
# Categorical filter
if self.data_table_categorical.row_count:
for i, category in enumerate(self.data_table_categorical.data['category_1']):
table = self.categorical_columns[category]['table']
col = self.categorical_columns[category]['var_name']
value = self.data_table_categorical.data['category_2'][i]
if col not in queries_by_sql_column[table]:
queries_by_sql_column[table][col] = []
operator = ['=', '!='][{'Include': 0, 'Exclude': 1}[self.data_table_categorical.data['Filter Type'][i]]]
queries_by_sql_column[table][col].append("%s %s '%s'" % (col, operator, value))
# Range filter
if self.data_table_numerical.row_count:
for i, category in enumerate(self.data_table_numerical.data['category']):
table = self.numerical_columns[category]['table']
col = self.numerical_columns[category]['var_name']
value_low = self.data_table_numerical.data['min'][i]
value_high = self.data_table_numerical.data['max'][i]
if 'date' in col:
value_low = "'%s'" % value_low
value_high = "'%s'" % value_high
if self.options.DB_TYPE == 'pgsql':
value_low = value_low + '::date'
value_high = value_high + '::date'
if col not in queries_by_sql_column[table]:
queries_by_sql_column[table][col] = []
operator = ['BETWEEN', 'NOT BETWEEN'][
{'Include': 0, 'Exclude': 1}[self.data_table_numerical.data['Filter Type'][i]]]
queries_by_sql_column[table][col].append("%s %s %s AND %s" % (col, operator, value_low, value_high))
for table in queries:
for col in queries_by_sql_column[table]:
queries[table].append("(%s)" % ' OR '.join(queries_by_sql_column[table][col]))
queries[table] = ' AND '.join(queries[table])
uids = get_study_instance_uids(plans=queries['Plans'], rxs=queries['Rxs'], beams=queries['Beams'])['common']
return uids, queries['DVHs']
def update_data(self, load_saved_dvh_data=False, group_2_only=False):
wx.BeginBusyCursor()
tables = ['Plans', 'Rxs', 'Beams']
for grp, grp_data in self.group_data.items():
if not(grp == 1 and group_2_only) or grp == 2:
if hasattr(grp_data['dvh'], 'study_instance_uid'):
if not load_saved_dvh_data:
condition_str = "study_instance_uid in ('%s')" % "','".join(
grp_data['dvh'].study_instance_uid)
grp_data['data'] = {key: QuerySQL(key, condition_str) for key in tables}
grp_data['stats_data'] = StatsData(grp_data['dvh'], grp_data['data'], group=grp)
else:
grp_data['data'] = {key: None for key in tables}
grp_data['stats_data'] = None
if self.group_data[2]['stats_data']:
sync_variables_in_stats_data_objects(self.group_data[1]['stats_data'],
self.group_data[2]['stats_data'])
self.time_series.update_data(self.group_data)
self.control_chart.update_data(self.group_data)
self.correlation.set_data(self.group_data)
self.regression.update_combo_box_choices()
self.radbio.update_dvh_data(self.group_data)
wx.EndBusyCursor()
# --------------------------------------------------------------------------------------------------------------
# Menu bar event functions
# --------------------------------------------------------------------------------------------------------------
def close_windows(self):
for view in self.data_views.values():
if hasattr(view, 'Destroy'):
try:
view.Destroy()
except RuntimeError:
pass
for window in self.tool_bar_windows.values():
if window and hasattr(window, 'Destroy'):
window.Destroy()
self.regression.close_mvr_frames()
def on_quit(self, evt):
self.close_windows()
self.Destroy()
def on_close(self, *evt):
if self.group_data[1]['dvh']:
dlg = wx.MessageDialog(self, "Clear all data and plots?", caption='Close',
style=wx.YES | wx.NO | wx.NO_DEFAULT | wx.CENTER | wx.ICON_EXCLAMATION)
dlg.Center()
res = dlg.ShowModal()
if res == wx.ID_YES:
self.close()
self.radio_button_query_group.SetSelection(0)
dlg.Destroy()
def close(self):
self.group_data = {1: {'dvh': None,
'data': {key: None for key in ['Plans', 'Beams', 'Rxs']},
'stats_data': None},
2: {'dvh': None,
'data': {key: None for key in ['Plans', 'Beams', 'Rxs']},
'stats_data': None}}
self.data_table_categorical.delete_all_rows()
self.data_table_numerical.delete_all_rows()
self.plot.clear_plot()
self.endpoint.clear_data()
self.radbio.clear_data()
self.time_series.clear_data()
self.notebook_main_view.SetSelection(0)
self.text_summary.SetLabelText("")
self.__disable_notebook_tabs()
self.disable_query_buttons('categorical')
self.disable_query_buttons('numerical')
self.button_query_execute.Disable()
self.time_series.initialize_y_axis_options()
self.regression.clear(self.group_data)
self.control_chart.initialize_y_axis_options()
self.control_chart.plot.clear_plot()
self.control_chart.group = 1
self.close_windows()
self.reset_query_filters()
def on_export(self, evt):
if self.group_data[1]['dvh'] is not None:
ExportCSVDialog(self)
else:
wx.MessageBox('There is no data to export! Please query some data first.', 'Export Error',
wx.OK | wx.ICON_WARNING)
@staticmethod
def on_githubpage(evt):
webbrowser.open_new_tab("http://dvhanalytics.com/")
@staticmethod
def on_report_issue(evt):
webbrowser.open_new_tab("https://github.com/cutright/DVH-Analytics/issues")
@staticmethod
def on_about(evt):
About()
def on_pref(self, *args):
UserSettings(self.options)
def on_sql(self, *args):
SQLSettingsDialog(self.options)
[self.__disable_add_filter_buttons, self.__enable_add_filter_buttons][echo_sql_db()]()
def on_save_plot_dvhs(self, evt):
save_data_to_file(self, 'Save DVHs plot', self.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_time_series(self, evt):
save_data_to_file(self, 'Save Time Series plot', self.time_series.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_correlation(self, evt):
save_data_to_file(self, 'Save Correlation plot', self.correlation.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_regression(self, evt):
save_data_to_file(self, 'Save Regression plot', self.regression.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_save_plot_control_chart(self, evt):
save_data_to_file(self, 'Save Control Chart plot', self.control_chart.plot.html_str,
wildcard="HTML files (*.html)|*.html")
def on_view_dvhs(self, evt):
self.view_table_data('DVHs')
def on_view_plans(self, evt):
self.view_table_data('Plans')
def on_view_rxs(self, evt):
self.view_table_data('Rxs')
def on_view_beams(self, evt):
self.view_table_data('Beams')
def on_view_stats_data_1(self, evt):
self.view_table_data('StatsData1')
def on_view_stats_data_2(self, evt):
self.view_table_data('StatsData2')
def view_table_data(self, key):
if key == 'DVHs':
data = {grp: self.group_data[grp]['dvh'] for grp in [1, 2]}
elif 'StatsData' in key:
data = {grp: self.group_data[grp]['stats_data'] for grp in [1, 2]}
else:
data = {grp: self.group_data[grp]['data'][key] for grp in [1, 2]}
if data[1]:
if self.get_menu_item_status(key) == 'Show':
if 'StatsData' in key:
group = int(key[-1])
if group == 1 or data[2] is not None:
self.data_views[key] = StatsDataEditor(self.group_data, group, self.data_menu,
self.data_menu_items[key].GetId(), self.time_series,
self.regression, self.control_chart)
else:
self.no_queried_data_dlg()
else:
if key == 'DVHs':
columns = [c for c in data[1].keys]
elif key == 'Rxs':
columns = ['plan_name', 'fx_dose', 'rx_percent', 'fxs', 'rx_dose', 'fx_grp_number',
'fx_grp_count',
'fx_grp_name', 'normalization_method', 'normalization_object']
else:
columns = [obj['var_name'] for obj in sql_column_info.values() if obj['table'] == key]
for starter_column in ['study_instance_uid', 'mrn']:
if starter_column in columns:
columns.pop(columns.index(starter_column))
columns.insert(0, starter_column)
self.data_views[key] = QueriedDataFrame(data, columns, key,
self.data_menu, self.data_menu_items[key].GetId())
else:
self.data_views[key].on_close()
self.data_views[key] = None
else:
self.no_queried_data_dlg()
def no_queried_data_dlg(self):
dlg = wx.MessageDialog(self, 'Please query/open some data first.', 'ERROR!', wx.ICON_ERROR | wx.OK_DEFAULT)
dlg.ShowModal()
dlg.Destroy()
def get_menu_item_status(self, key):
show_hide = ['Hide', 'Show']['Show' in self.data_menu.GetLabel(self.data_menu_items[key].GetId())]
return show_hide
def redraw_plots(self):
if self.group_data[1]['dvh']:
self.plot.redraw_plot()
self.time_series.plot.redraw_plot()
self.correlation.plot.redraw_plot()
self.regression.plot.redraw_plot()
self.control_chart.plot.redraw_plot()
def update_stats_data_plots(self):
if self.group_data[1]['dvh']:
self.time_series.update_plot()
self.time_series.update_y_axis_options()
self.regression.update_plot()
self.control_chart.update_plot()
def on_resize(self, *evt):
try:
self.Refresh()
self.Layout()
wx.CallAfter(self.redraw_plots)
except RuntimeError:
pass
def on_plotting_memory_error(self, plot_type):
plot_type = [' (Plot type: %s)' % plot_type, ''][plot_type is None]
msg = "Plotting memory error%s. Try querying less data. At least %s DVHs returned.\n" \
"NOTE: Threshold of this error is dependent on your computer." % (plot_type, self.group_data[1]['dvh'].count)
MemoryErrorDialog(self, msg)
self.close()
def reset_query_filters(self):
self.query_filters = {key: None for key in [1, 2]}
def on_group_select(self, *evt):
group = self.selected_group
other = 3 - group
self.button_query_execute.SetLabelText('Query and Retrieve Group %s' % group)
self.query_filters[other] = {'main_categorical': self.data_table_categorical.get_save_data(),
'main_numerical': self.data_table_numerical.get_save_data()}
if self.query_filters[group] is not None:
self.data_table_categorical.load_save_data(self.query_filters[group]['main_categorical'])
self.data_table_numerical.load_save_data(self.query_filters[group]['main_numerical'])
else:
self.data_table_categorical.delete_all_rows()
self.data_table_numerical.delete_all_rows()
self.update_all_query_buttons()
self.set_summary_text(group)
if self.group_data[2]['stats_data']:
self.regression.group = group
self.regression.update_plot()
self.control_chart.group = group
self.control_chart.update_plot()
def set_summary_text(self, group):
if self.group_data[group]['dvh']:
text = self.group_data[group]['dvh'].get_summary()
else:
text = ''
self.text_summary.SetLabelText(text)
class EndpointFrame:
"""
Object to be passed into notebook panel for the Endpoint tab
"""
def __init__(self, parent, dvh, time_series, regression, control_chart):
"""
:param parent: notebook panel in main view
:type parent: Panel
:param dvh: dvh data object
:type dvh: DVH
:param time_series: Time Series object in notebook
:type time_series: TimeSeriesFrame
:param regression: Regression frame object in notebook
:type regression: RegressionFrame
:param control_chart: Control Chart frame object in notebook
:type control_chart: ControlChartFrame
"""
self.parent = parent
self.dvh = dvh
self.time_series = time_series
self.regression = regression
self.control_chart = control_chart
self.initial_columns = ['MRN', 'Tx Site', 'ROI Name', 'Volume (cc)']
self.widths = [150, 150, 250, 100]
self.button = {'add': wx.Button(self.parent, wx.ID_ANY, "Add Endpoint"),
'del': wx.Button(self.parent, wx.ID_ANY, "Delete Endpoint"),
'exp': wx.Button(self.parent, wx.ID_ANY, 'Export')}
self.table = wx.ListCtrl(self.parent, wx.ID_ANY,
style=wx.BORDER_SUNKEN | wx.LC_HRULES | wx.LC_REPORT | wx.LC_VRULES)
self.table.SetMinSize(get_window_size(0.623, 0.762))
self.data_table = DataTable(self.table)
self.endpoint_defs = DataTable(None, columns=['label', 'output_type', 'input_type',
'input_value', 'units_in', 'units_out'])
if dvh:
self.dvh.endpoints['data'] = self.data_table.data
self.dvh.endpoints['defs'] = self.endpoint_defs.data
self.__do_bind()
self.__set_properties()
self.__do_layout()
self.disable_buttons()
def __do_bind(self):
self.parent.Bind(wx.EVT_BUTTON, self.add_ep_button_click, id=self.button['add'].GetId())
self.parent.Bind(wx.EVT_BUTTON, self.del_ep_button_click, id=self.button['del'].GetId())
self.parent.Bind(wx.EVT_BUTTON, self.on_export_csv, id=self.button['exp'].GetId())
def __set_properties(self):
for i, column in enumerate(self.initial_columns):
self.table.AppendColumn(column, format=wx.LIST_FORMAT_LEFT, width=self.widths[i])
def __do_layout(self):
sizer_wrapper = wx.BoxSizer(wx.VERTICAL)
vbox = wx.BoxSizer(wx.VERTICAL)
hbox = wx.BoxSizer(wx.HORIZONTAL)
for key in list(self.button):
hbox.Add(self.button[key], 0, wx.ALL, 5)
vbox.Add(hbox, 0, wx.ALL | wx.EXPAND, 5)
vbox.Add(self.table, 1, wx.EXPAND, 0)
sizer_wrapper.Add(vbox, 1, wx.ALL | wx.EXPAND, 20)
self.layout = sizer_wrapper
def calculate_endpoints(self):
columns = [c for c in self.initial_columns]
if self.data_table.data:
current_labels = [key for key in list(self.data_table.data) if key not in columns]
else:
current_labels = []
ep = {'MRN': self.dvh.mrn,
'Tx Site': self.dvh.get_plan_values('tx_site'),
'ROI Name': self.dvh.roi_name,
'Volume (cc)': self.dvh.volume}
ep_defs = self.endpoint_defs.data
if ep_defs:
for i, ep_name in enumerate(ep_defs['label']):
if ep_name not in columns:
columns.append(ep_name)
if ep_name in current_labels:
ep[ep_name] = deepcopy(self.data_table.data[ep_name])
else:
endpoint_input = ep_defs['input_type'][i]
endpoint_output = ep_defs['output_type'][i]
x = float(ep_defs['input_value'][i])
if endpoint_input == 'relative':
x /= 100.
if 'V' in ep_name:
ep[ep_name] = self.dvh.get_volume_of_dose(x, volume_scale=endpoint_output,
dose_scale=endpoint_input)
else:
ep[ep_name] = self.dvh.get_dose_to_volume(x, dose_scale=endpoint_output,
volume_scale=endpoint_input)
self.data_table.set_data(ep, columns)
self.data_table.set_column_width(0, 150)
self.data_table.set_column_width(1, 150)
self.data_table.set_column_width(2, 200)
def add_ep_button_click(self, evt):
dlg = AddEndpointDialog()
res = dlg.ShowModal()
if res == wx.ID_OK and dlg.is_endpoint_valid:
self.endpoint_defs.append_row(dlg.endpoint_row)
self.calculate_endpoints()
self.enable_buttons()
self.update_endpoints_in_dvh()
self.time_series.update_y_axis_options()
dlg.Destroy()
self.regression.stats_data.update_endpoints_and_radbio()
self.regression.update_combo_box_choices()
self.control_chart.update_combo_box_y_choices()
def del_ep_button_click(self, evt):
dlg = DelEndpointDialog(self.data_table.columns)
res = dlg.ShowModal()
if res == wx.ID_OK:
for value in dlg.selected_values:
self.data_table.delete_column(value)
endpoint_def_row = self.endpoint_defs.data['label'].index(value)
self.update_endpoints_in_dvh()
self.endpoint_defs.delete_row(endpoint_def_row)
self.time_series.update_y_axis_options()
dlg.Destroy()
self.regression.stats_data.update_endpoints_and_radbio()
self.regression.update_combo_box_choices()
self.control_chart.update_combo_box_y_choices()
if self.data_table.column_count == 3:
self.button['del'].Disable()
self.button['exp'].Disable()
def update_dvh(self, dvh):
self.dvh = dvh
self.update_endpoints_in_dvh()
def update_endpoints_in_dvh(self):
if self.dvh:
self.dvh.endpoints['data'] = self.data_table.data
self.dvh.endpoints['defs'] = self.endpoint_defs.data
def clear_data(self):
self.data_table.delete_all_rows()
self.endpoint_defs.delete_all_rows(force_delete_data=True) # no attached layout, force delete
if self.data_table.data:
for column in list(self.data_table.data):
if column not in self.initial_columns:
self.data_table.delete_column(column)
def enable_buttons(self):
for key in list(self.button):
self.button[key].Enable()
def disable_buttons(self):
for key in list(self.button):
self.button[key].Disable()
def enable_initial_buttons(self):
self.button['add'].Enable()
def get_csv(self, selection=None):
uid = {1: {'title': 'Study Instance UID',
'data': self.dvh.uid}}
return self.data_table.get_csv(extra_column_data=uid)
def on_export_csv(self, evt):
save_data_to_file(self.parent, "Export Endpoints to CSV", self.get_csv())
def get_save_data(self):
return deepcopy({'data_table': self.data_table.get_save_data(),
'endpoint_defs': self.endpoint_defs.get_save_data()})
def load_save_data(self, save_data):
self.data_table.load_save_data(save_data['data_table'], ignore_layout=True)
self.endpoint_defs.load_save_data(save_data['endpoint_defs'], ignore_layout=True)
self.calculate_endpoints()
@property
def has_data(self):
if self.endpoint_defs.data and self.endpoint_defs.data['label']:
return True
return False