def test_fail_to_add_yerr_for_another_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
self.assertRaises(ValueError,
lambda: mc.add_y_err(ErrorColumn(0, 1, 2)))
def __init__(self, ws):
"""
Initialise the model with the workspace
:param ws: Workspace to be used for providing data
:raises ValueError: if the workspace is not supported
"""
self.supports(ws)
self.ws = ws
self.ws_num_rows = self.ws.rowCount()
self.ws_num_cols = self.ws.columnCount()
self.ws_column_types = self.ws.columnTypes()
self.marked_columns = MarkedColumns()
self._original_column_headers = self.get_column_headers()
def test_add_y_err_duplicate_column(self):
mc = MarkedColumns()
ec = ErrorColumn(2, 4, 0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
ec2 = ErrorColumn(3, 5, 0)
mc.add_y_err(ec2)
self.assertEqual(2, len(mc.as_y_err))
mc.add_y_err(ec2)
self.assertEqual(2, len(mc.as_y_err))
def test_fail_to_add_yerr_for_another_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
self.assertRaises(ValueError, lambda: mc.add_y_err(ErrorColumn(0, 1, 2)))
def test_add_y_err_duplicate_column(self):
mc = MarkedColumns()
ec = ErrorColumn(2, 4, 0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
ec2 = ErrorColumn(3, 5, 0)
mc.add_y_err(ec2)
self.assertEqual(2, len(mc.as_y_err))
mc.add_y_err(ec2)
self.assertEqual(2, len(mc.as_y_err))
def test_add_y_err_duplicate_column_different_reference_col(self):
"""
Test for adding a new YErr column with a _different_ source column but same reference column
-> The new YErr must replace the old one
"""
mc = MarkedColumns()
ec = ErrorColumn(column=2, error_for_column=4, label_index=0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(2, mc.as_y_err[0].column)
self.assertEqual(4, mc.as_y_err[0].error_for_column)
# different source column but contains error for the same column
# adding this one should replace the first one
ec2 = ErrorColumn(column=3, error_for_column=4, label_index=0)
mc.add_y_err(ec2)
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(3, mc.as_y_err[0].column)
self.assertEqual(4, mc.as_y_err[0].error_for_column)
def test_add_already_marked(self):
mc = MarkedColumns()
relevant_funcs = [
ReferenceHolder(mc.add_x, mc.as_x),
ReferenceHolder(mc.add_y, mc.as_y)
]
all_combinations = permutations(relevant_funcs, 2)
for combination in all_combinations:
self.execute_add_already_marked(*combination)
def test_add_y_err(self):
"""
Test adding YErr columns that do not overlap in any way
"""
mc = MarkedColumns()
ec = ErrorColumn(2, 4, 0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
ec = ErrorColumn(3, 5, 0)
mc.add_y_err(ec)
self.assertEqual(2, len(mc.as_y_err))
ec = ErrorColumn(1, 6, 0)
mc.add_y_err(ec)
self.assertEqual(3, len(mc.as_y_err))
def test_add_y_err(self):
"""
Test adding YErr columns that do not overlap in any way
"""
mc = MarkedColumns()
ec = ErrorColumn(2, 4, 0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
ec = ErrorColumn(3, 5, 0)
mc.add_y_err(ec)
self.assertEqual(2, len(mc.as_y_err))
ec = ErrorColumn(1, 6, 0)
mc.add_y_err(ec)
self.assertEqual(3, len(mc.as_y_err))
def test_changing_y_to_none_removes_associated_yerr_columns(self):
"""
Test to check if a first column is marked as Y, a second column YErr is associated with it, but then
the first one is changed to X - the YErr mark should be removed
"""
mc = MarkedColumns()
mc.add_y(4)
ec = ErrorColumn(column=2, error_for_column=4, label_index=0)
mc.add_y_err(ec)
# check that we have both a Y col and an associated YErr
self.assertEqual(1, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(4)
# changing the column to NONE should have removed it from X, Y and YErr
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(0, len(mc.as_y_err))
def test_changing_y_to_none_removes_associated_yerr_columns(self):
"""
Test to check if a first column is marked as Y, a second column YErr is associated with it, but then
the first one is changed to X - the YErr mark should be removed
"""
mc = MarkedColumns()
mc.add_y(4)
ec = ErrorColumn(column=2, error_for_column=4, label_index=0)
mc.add_y_err(ec)
# check that we have both a Y col and an associated YErr
self.assertEqual(1, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(4)
# changing the column to NONE should have removed it from X, Y and YErr
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(0, len(mc.as_y_err))
def test_add_y_err_duplicate_column_different_reference_col(self):
"""
Test for adding a new YErr column with a _different_ source column but same reference column
-> The new YErr must replace the old one
"""
mc = MarkedColumns()
ec = ErrorColumn(column=2, error_for_column=4, label_index=0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(2, mc.as_y_err[0].column)
self.assertEqual(4, mc.as_y_err[0].error_for_column)
# different source column but contains error for the same column
# adding this one should replace the first one
ec2 = ErrorColumn(column=3, error_for_column=4, label_index=0)
mc.add_y_err(ec2)
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(3, mc.as_y_err[0].column)
self.assertEqual(4, mc.as_y_err[0].error_for_column)
def test_add_y(self):
mc = MarkedColumns()
self.execute_add(mc.add_y, mc.as_y)
def test_build_labels_x_y_and_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]')]
mc.add_x(1)
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (2, '[Y0]'), (3, '[Y1]'), (0, '[Y1_YErr]')]
mc.add_y_err(ErrorColumn(0, 3, 2))
self.assertEqual(expected, mc.build_labels())
def test_build_labels_y_and_yerr_change_first(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
# change one of the columns to YErr
mc.add_y_err(ErrorColumn(0, 1, 1))
# note: the first column is being set -> this decreases the label index of all columns to its right by 1
expected = [(1, '[Y0]'), (2, '[Y1]'), (0, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
# change the last Y column to YErr
mc.add_y_err(ErrorColumn(2, 1, 0))
expected = [(1, '[Y0]'), (2, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
def test_add_x(self):
mc = MarkedColumns()
self.execute_add(mc.add_x, mc.as_x)
def test_find_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(4, 1, 1))
expected = {1: 4}
self.assertEqual(expected, mc.find_yerr([1]))
# Replace the Y column, which has an associated YErr. This should remove the YErr as well
mc.add_y_err(ErrorColumn(1, 3, 1))
expected = {3: 1}
self.assertEqual(expected, mc.find_yerr([0, 1, 2, 3]))
mc.add_y_err(ErrorColumn(4, 2, 1))
expected = {2: 4, 3: 1}
self.assertEqual(expected, mc.find_yerr([0, 1, 2, 3]))
def test_remove_column(self):
mc = MarkedColumns()
mc.add_y(4)
mc.add_x(3)
ec = ErrorColumn(column=2, error_for_column=6, label_index=0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_x))
self.assertEqual(1, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(4)
self.assertEqual(0, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(1, len(mc.as_x))
mc.remove(3)
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(2)
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(0, len(mc.as_y_err))
def test_build_labels_y_and_yerr_change_middle(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
# change one of the columns to YErr
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
# change the last Y column to YErr
mc.add_y_err(ErrorColumn(2, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
class TableWorkspaceDisplayModel:
SPECTRUM_PLOT_LEGEND_STRING = '{}-{}'
BIN_PLOT_LEGEND_STRING = '{}-bin-{}'
ALLOWED_WORKSPACE_TYPES = [PeaksWorkspace, TableWorkspace]
@classmethod
def supports(cls, ws):
"""
Checks that the provided workspace is supported by this display.
:param ws: Workspace to be checked for support
:raises ValueError: if the workspace is not supported
"""
if not any(
isinstance(ws, allowed_type)
for allowed_type in cls.ALLOWED_WORKSPACE_TYPES):
raise ValueError(
"The workspace type is not supported: {0}".format(ws))
def __init__(self, ws):
"""
Initialise the model with the workspace
:param ws: Workspace to be used for providing data
:raises ValueError: if the workspace is not supported
"""
self.supports(ws)
self.ws = ws
self.ws_num_rows = self.ws.rowCount()
self.ws_num_cols = self.ws.columnCount()
self.ws_column_types = self.ws.columnTypes()
self.marked_columns = MarkedColumns()
self._original_column_headers = self.get_column_headers()
def _get_v3d_from_str(self, string):
if '[' in string and ']' in string:
string = string[1:-1]
if ',' in string:
return V3D(*[float(x) for x in string.split(',')])
else:
raise ValueError("'{}' is not a valid V3D string.".format(string))
def original_column_headers(self):
return self._original_column_headers[:]
def build_current_labels(self):
return self.marked_columns.build_labels()
def get_name(self):
return self.ws.name()
def get_column_headers(self):
return self.ws.getColumnNames()
def get_column(self, index):
return self.ws.column(index)
def get_number_of_rows(self):
return self.ws_num_rows
def get_number_of_columns(self):
return self.ws_num_cols
def get_column_header(self, index):
return self.get_column_headers()[index]
def is_peaks_workspace(self):
return isinstance(self.ws, PeaksWorkspace)
def set_cell_data(self, row, col, data, is_v3d):
# if the cell contains V3D data, construct a V3D object
# from the string to that it can be properly set
if is_v3d:
data = self._get_v3d_from_str(data)
self.ws.setCell(row, col, data)
def test_build_labels_y_and_yerr_change_first(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
# change one of the columns to YErr
mc.add_y_err(ErrorColumn(0, 1, 1))
# note: the first column is being set -> this decreases the label index of all columns to its right by 1
expected = [(1, '[Y0]'), (2, '[Y1]'), (0, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
# change the last Y column to YErr
mc.add_y_err(ErrorColumn(2, 1, 0))
expected = [(1, '[Y0]'), (2, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
def test_build_labels_x_y(self):
# TODO test this edge case: mark all columns Y, remove one that is not the last one!
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
# note that the max Y label number will decrease as more Y columns are being changed to X
expected = [(0, '[Y0]'), (1, '[Y1]'), (2, '[Y2]'), (3, '[Y3]')]
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]')]
mc.add_x(1)
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (3, '[X1]'), (0, '[Y0]'), (2, '[Y1]')]
mc.add_x(3)
self.assertEqual(expected, mc.build_labels())
def test_find_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(4, 1, 1))
expected = {1: 4}
self.assertEqual(expected, mc.find_yerr([1]))
# Replace the Y column, which has an associated YErr. This should remove the YErr as well
mc.add_y_err(ErrorColumn(1, 3, 1))
expected = {3: 1}
self.assertEqual(expected, mc.find_yerr([0, 1, 2, 3]))
mc.add_y_err(ErrorColumn(4, 2, 1))
expected = {2: 4, 3: 1}
self.assertEqual(expected, mc.find_yerr([0, 1, 2, 3]))
def test_remove_column(self):
mc = MarkedColumns()
mc.add_y(4)
mc.add_x(3)
ec = ErrorColumn(column=2, error_for_column=6, label_index=0)
mc.add_y_err(ec)
self.assertEqual(1, len(mc.as_x))
self.assertEqual(1, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(4)
self.assertEqual(0, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
self.assertEqual(1, len(mc.as_x))
mc.remove(3)
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(1, len(mc.as_y_err))
mc.remove(2)
self.assertEqual(0, len(mc.as_x))
self.assertEqual(0, len(mc.as_y))
self.assertEqual(0, len(mc.as_y_err))
def test_add_y_duplicate_column(self):
mc = MarkedColumns()
self.execute_add_duplicate_column(mc.add_y, mc.as_y)
def test_build_labels_x_y(self):
# TODO test this edge case: mark all columns Y, remove one that is not the last one!
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
# note that the max Y label number will decrease as more Y columns are being changed to X
expected = [(0, '[Y0]'), (1, '[Y1]'), (2, '[Y2]'), (3, '[Y3]')]
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]')]
mc.add_x(1)
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (3, '[X1]'), (0, '[Y0]'), (2, '[Y1]')]
mc.add_x(3)
self.assertEqual(expected, mc.build_labels())
def test_build_labels_y_and_yerr_change_middle(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
# change one of the columns to YErr
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
# change the last Y column to YErr
mc.add_y_err(ErrorColumn(2, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
def test_build_labels_x_y_and_yerr(self):
mc = MarkedColumns()
mc.add_y(0)
mc.add_y(1)
mc.add_y(2)
mc.add_y(3)
mc.add_y_err(ErrorColumn(1, 0, 0))
expected = [(0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]'), (1, '[Y0_YErr]')]
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (0, '[Y0]'), (2, '[Y1]'), (3, '[Y2]')]
mc.add_x(1)
self.assertEqual(expected, mc.build_labels())
expected = [(1, '[X0]'), (2, '[Y0]'), (3, '[Y1]'), (0, '[Y1_YErr]')]
mc.add_y_err(ErrorColumn(0, 3, 2))
self.assertEqual(expected, mc.build_labels())