InstrumentWidgetMaskTab.cpp 46.6 KB
Newer Older
1
2
3
4
5
6
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//     NScD Oak Ridge National Laboratory, European Spallation Source
//     & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
Roman Tolchenov's avatar
Roman Tolchenov committed
7
8
9
10
11
12
#include "MantidQtWidgets/InstrumentView/InstrumentWidgetMaskTab.h"
#include "MantidQtWidgets/Common/TSVSerialiser.h"
#include "MantidQtWidgets/InstrumentView/DetXMLFile.h"
#include "MantidQtWidgets/InstrumentView/InstrumentActor.h"
#include "MantidQtWidgets/InstrumentView/InstrumentWidget.h"
#include "MantidQtWidgets/InstrumentView/ProjectionSurface.h"
13
14
15
16
17
18

#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidAPI/IMaskWorkspace.h"
#include "MantidAPI/ITableWorkspace.h"
19
#include "MantidAPI/MatrixWorkspace.h"
20
21
22
23
// #include "MantidDataObjects/TableWorkspace.h"
#include "MantidKernel/Logger.h"
#include "MantidKernel/Strings.h"

Roman Tolchenov's avatar
Roman Tolchenov committed
24
#include "MantidQtWidgets/Common/QtPropertyBrowser/qtpropertymanager.h"
LamarMoore's avatar
LamarMoore committed
25
#include "MantidQtWidgets/Common/QtPropertyBrowser/qttreepropertybrowser.h"
26
27
// Suppress a warning coming out of code that isn't ours
#if defined(__INTEL_COMPILER)
28
#pragma warning disable 1125
29
#elif defined(__GNUC__)
30
31
32
33
#if (__GNUC__ >= 4 && __GNUC_MINOR__ >= 6)
#pragma GCC diagnostic push
#endif
#pragma GCC diagnostic ignored "-Woverloaded-virtual"
34
#endif
Roman Tolchenov's avatar
Roman Tolchenov committed
35
#include "MantidQtWidgets/Common/QtPropertyBrowser/DoubleEditorFactory.h"
LamarMoore's avatar
LamarMoore committed
36
#include "MantidQtWidgets/Common/QtPropertyBrowser/qteditorfactory.h"
37
#if defined(__INTEL_COMPILER)
38
#pragma warning enable 1125
39
#elif defined(__GNUC__)
40
41
42
#if (__GNUC__ >= 4 && __GNUC_MINOR__ >= 6)
#pragma GCC diagnostic pop
#endif
43
44
45
46
#endif

#include <QAction>
#include <QApplication>
47
48
#include <QCheckBox>
#include <QGridLayout>
49
#include <QGroupBox>
50
51
52
53
54
55
#include <QHBoxLayout>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
#include <QRadioButton>
56
#include <QSettings>
57
58
59
60
#include <QTemporaryFile>
#include <QTextEdit>
#include <QToolTip>
#include <QVBoxLayout>
61

Roman Tolchenov's avatar
Roman Tolchenov committed
62
#include "MantidQtWidgets/Common/FileDialogHandler.h"
63
64

#include <algorithm>
LamarMoore's avatar
LamarMoore committed
65
#include <cfloat>
66
#include <fstream>
LamarMoore's avatar
LamarMoore committed
67
#include <numeric>
68

69
70
71
72
73
namespace MantidQt {
namespace MantidWidgets {
InstrumentWidgetMaskTab::InstrumentWidgetMaskTab(InstrumentWidget *instrWidget)
    : InstrumentWidgetTab(instrWidget), m_activity(Select),
      m_hasMaskToApply(false), m_maskBins(false), m_userEditing(true),
Peterson, Peter's avatar
Peterson, Peter committed
74
75
76
      m_groupManager(nullptr), m_stringManager(nullptr),
      m_doubleManager(nullptr), m_browser(nullptr), m_left(nullptr),
      m_top(nullptr), m_right(nullptr), m_bottom(nullptr) {
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208

  // main layout
  QVBoxLayout *layout = new QVBoxLayout(this);

  m_activeTool = new QLabel(this);
  layout->addWidget(m_activeTool);

  // Create the tool buttons

  m_move = new QPushButton();
  m_move->setCheckable(true);
  m_move->setAutoExclusive(true);
  m_move->setIcon(QIcon(":/PickTools/zoom.png"));
  m_move->setToolTip("Move the instrument (Ctrl+Alt+M)");
  m_move->setShortcut(QKeySequence("Ctrl+Alt+M"));

  m_pointer = new QPushButton();
  m_pointer->setCheckable(true);
  m_pointer->setAutoExclusive(true);
  m_pointer->setIcon(QIcon(":/MaskTools/selection-edit.png"));
  m_pointer->setToolTip("Select and edit shapes (Ctrl+Alt+P)");
  m_pointer->setShortcut(QKeySequence("Ctrl+Alt+P"));

  m_ellipse = new QPushButton();
  m_ellipse->setCheckable(true);
  m_ellipse->setAutoExclusive(true);
  m_ellipse->setIcon(QIcon(":/MaskTools/selection-circle.png"));
  m_ellipse->setToolTip("Draw an ellipse (Ctrl+Alt+E)");
  m_ellipse->setShortcut(QKeySequence("Ctrl+Alt+E"));

  m_rectangle = new QPushButton();
  m_rectangle->setCheckable(true);
  m_rectangle->setAutoExclusive(true);
  m_rectangle->setIcon(QIcon(":/MaskTools/selection-box.png"));
  m_rectangle->setToolTip("Draw a rectangle (Ctrl+Alt+R)");
  m_rectangle->setShortcut(QKeySequence("Ctrl+Alt+R"));

  m_ring_ellipse = new QPushButton();
  m_ring_ellipse->setCheckable(true);
  m_ring_ellipse->setAutoExclusive(true);
  m_ring_ellipse->setIcon(QIcon(":/MaskTools/selection-circle-ring.png"));
  m_ring_ellipse->setToolTip("Draw an elliptical ring (Shift+Alt+E)");
  m_ring_ellipse->setShortcut(QKeySequence("Shift+Alt+E"));

  m_ring_rectangle = new QPushButton();
  m_ring_rectangle->setCheckable(true);
  m_ring_rectangle->setAutoExclusive(true);
  m_ring_rectangle->setIcon(QIcon(":/MaskTools/selection-box-ring.png"));
  m_ring_rectangle->setToolTip("Draw a rectangular ring (Shift+Alt+R)");
  m_ring_rectangle->setShortcut(QKeySequence("Shift+Alt+R"));

  m_free_draw = new QPushButton();
  m_free_draw->setCheckable(true);
  m_free_draw->setAutoExclusive(true);
  m_free_draw->setIcon(QIcon(":/MaskTools/brush.png"));
  m_free_draw->setToolTip("Draw an arbitrary shape (Shift+Alt+A)");
  m_free_draw->setShortcut(QKeySequence("Shift+Alt+A"));

  QHBoxLayout *toolBox = new QHBoxLayout();
  toolBox->addWidget(m_move);
  toolBox->addWidget(m_pointer);
  toolBox->addWidget(m_ellipse);
  toolBox->addWidget(m_rectangle);
  toolBox->addWidget(m_ring_ellipse);
  toolBox->addWidget(m_ring_rectangle);
  toolBox->addWidget(m_free_draw);
  toolBox->addStretch();
  toolBox->setSpacing(2);
  toolBox->setMargin(0);

  connect(m_move, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_pointer, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_ellipse, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_rectangle, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_ring_ellipse, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_ring_rectangle, SIGNAL(clicked()), this, SLOT(setActivity()));
  connect(m_free_draw, SIGNAL(clicked()), this, SLOT(setActivity()));
  m_move->setChecked(true);
  QFrame *toolGroup = new QFrame();
  toolGroup->setLayout(toolBox);

  layout->addWidget(toolGroup);

  // create mask/group switch
  m_masking_on = new QRadioButton("Mask");
  m_grouping_on = new QRadioButton("Group");
  m_roi_on = new QRadioButton("ROI");
  m_masking_on->setChecked(true);
  connect(m_masking_on, SIGNAL(clicked()), this, SLOT(toggleMaskGroup()));
  connect(m_grouping_on, SIGNAL(clicked()), this, SLOT(toggleMaskGroup()));
  connect(m_roi_on, SIGNAL(clicked()), this, SLOT(toggleMaskGroup()));
  QHBoxLayout *radioLayout = new QHBoxLayout();
  radioLayout->addWidget(m_masking_on);
  radioLayout->addWidget(m_roi_on);
  radioLayout->addWidget(m_grouping_on);
  radioLayout->setMargin(0);
  QGroupBox *radioGroup = new QGroupBox();
  radioGroup->setStyleSheet("border: none;");
  radioGroup->setLayout(radioLayout);

  layout->addWidget(radioGroup);

  // Create property browser

  /* Create property managers: they create, own properties, get and set values
   */

  m_groupManager = new QtGroupPropertyManager(this);
  m_doubleManager = new QtDoublePropertyManager(this);
  connect(m_doubleManager, SIGNAL(propertyChanged(QtProperty *)), this,
          SLOT(doubleChanged(QtProperty *)));

  /* Create editors and assign them to the managers */

  DoubleEditorFactory *doubleEditorFactory = new DoubleEditorFactory(this);

  m_browser = new QtTreePropertyBrowser();
  m_browser->setFactoryForManager(m_doubleManager, doubleEditorFactory);

  layout->addWidget(m_browser);

  // Algorithm buttons

  m_applyToData = new QPushButton("Apply to Data");
  m_applyToData->setToolTip("Apply current detector and bin masks to the data "
                            "workspace. Cannot be reverted.");
  connect(m_applyToData, SIGNAL(clicked()), this, SLOT(applyMask()));

  m_applyToView = new QPushButton("Apply to View");
  m_applyToView->setToolTip("Apply current mask to the view.");
  connect(m_applyToView, SIGNAL(clicked()), this, SLOT(applyMaskToView()));

209
210
211
212
213
214
  m_saveShapesToTable = new QPushButton("Save Shapes to Table");
  m_saveShapesToTable->setToolTip(
      "Store the current Mask/ROI/Group shapes as a table");
  connect(m_saveShapesToTable, SIGNAL(clicked()), this,
          SLOT(saveShapesToTable()));

215
216
217
218
219
220
221
222
223
  m_clearAll = new QPushButton("Clear All");
  m_clearAll->setToolTip(
      "Clear all masking that have not been applied to the data.");
  connect(m_clearAll, SIGNAL(clicked()), this, SLOT(clearMask()));

  m_save_as_workspace_exclude =
      new QAction("As Detector Mask to workspace", this);
  m_save_as_workspace_exclude->setToolTip(
      "Save current detector mask to mask workspace.");
224
  connect(m_save_as_workspace_exclude, SIGNAL(triggered()), this,
225
226
227
228
229
230
          SLOT(saveMaskToWorkspace()));

  m_save_as_workspace_include =
      new QAction("As Detector ROI to workspace", this);
  m_save_as_workspace_include->setToolTip(
      "Save current detector mask as ROI to mask workspace.");
231
  connect(m_save_as_workspace_include, SIGNAL(triggered()), this,
232
233
234
235
236
          SLOT(saveInvertedMaskToWorkspace()));

  m_save_as_file_exclude = new QAction("As Detector Mask to file", this);
  m_save_as_file_exclude->setToolTip(
      "Save current detector mask to mask file.");
237
  connect(m_save_as_file_exclude, SIGNAL(triggered()), this,
238
239
240
241
          SLOT(saveMaskToFile()));

  m_save_as_file_include = new QAction("As Detector ROI to file", this);
  m_save_as_file_include->setToolTip("Save current mask as ROI to mask file.");
242
  connect(m_save_as_file_include, SIGNAL(triggered()), this,
243
244
245
246
247
248
          SLOT(saveInvertedMaskToFile()));

  m_save_as_cal_file_exclude =
      new QAction("As Detector Mask to cal file", this);
  m_save_as_cal_file_exclude->setToolTip(
      "Save current detector mask to cal file.");
249
  connect(m_save_as_cal_file_exclude, SIGNAL(triggered()), this,
250
251
252
253
254
          SLOT(saveMaskToCalFile()));

  m_save_as_cal_file_include = new QAction("As Detector ROI to cal file", this);
  m_save_as_cal_file_include->setToolTip(
      "Save current detector mask as ROI to cal file.");
255
  connect(m_save_as_cal_file_include, SIGNAL(triggered()), this,
256
257
258
259
260
261
262
263
264
          SLOT(saveInvertedMaskToCalFile()));

  m_save_as_table_xrange_exclude =
      new QAction("As Detector Mask to table", this);
  m_save_as_table_xrange_exclude->setToolTip(
      "Save current detector mask to a table workspace with x-range. "
      "The name of output table workspace is 'MaskBinTable'. "
      "If the output table workspace has alrady exist, then "
      "the newly masked detectors will be added to output workspace.");
265
  connect(m_save_as_table_xrange_exclude, SIGNAL(triggered()), this,
266
267
268
269
270
          SLOT(saveMaskToTable()));

  m_save_group_file_include = new QAction("As include group to file", this);
  m_save_group_file_include->setToolTip(
      "Save current mask as include group to a file.");
271
  connect(m_save_group_file_include, SIGNAL(triggered()), this,
272
273
274
275
276
          SLOT(saveIncludeGroupToFile()));

  m_save_group_file_exclude = new QAction("As exclude group to file", this);
  m_save_group_file_exclude->setToolTip(
      "Save current mask as exclude group to a file.");
277
  connect(m_save_group_file_exclude, SIGNAL(triggered()), this,
278
279
280
281
          SLOT(saveExcludeGroupToFile()));

  m_extract_to_workspace = new QAction("Extract detectors to workspace", this);
  m_extract_to_workspace->setToolTip("Extract detectors to workspace.");
282
  connect(m_extract_to_workspace, SIGNAL(triggered()), this,
283
284
285
286
          SLOT(extractDetsToWorkspace()));

  m_sum_to_workspace = new QAction("Sum detectors to workspace", this);
  m_sum_to_workspace->setToolTip("Sum detectors to workspace.");
287
  connect(m_sum_to_workspace, SIGNAL(triggered()), this,
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
          SLOT(sumDetsToWorkspace()));

  // Save button and its menus
  m_saveButton = new QPushButton("Apply and Save");
  m_saveButton->setToolTip(
      "Save current masking/grouping to a file or a workspace.");

  m_saveMask = new QMenu(this);
  m_saveMask->addAction(m_save_as_workspace_exclude);
  m_saveMask->addAction(m_save_as_file_exclude);
  m_saveMask->addAction(m_save_as_cal_file_exclude);
  m_saveMask->addSeparator();
  m_saveMask->addAction(m_save_as_table_xrange_exclude);
  connect(m_saveMask, SIGNAL(hovered(QAction *)), this,
          SLOT(showSaveMenuTooltip(QAction *)));

  m_saveButton->setMenu(m_saveMask);

  m_saveGroup = new QMenu(this);
  m_saveGroup->addAction(m_extract_to_workspace);
  m_saveGroup->addAction(m_sum_to_workspace);
  m_saveGroup->addSeparator();

  connect(m_saveGroup, SIGNAL(hovered(QAction *)), this,
          SLOT(showSaveMenuTooltip(QAction *)));

  m_saveROI = new QMenu(this);
  m_saveROI->addAction(m_save_as_workspace_include);
  m_saveROI->addAction(m_save_as_file_include);
  m_saveROI->addAction(m_save_as_cal_file_include);
  m_saveROI->addSeparator();
  m_saveROI->addAction(m_extract_to_workspace);
  m_saveROI->addAction(m_sum_to_workspace);

  connect(m_saveROI, SIGNAL(hovered(QAction *)), this,
          SLOT(showSaveMenuTooltip(QAction *)));

  QGroupBox *box = new QGroupBox("View");
  QGridLayout *buttons = new QGridLayout();
  buttons->addWidget(m_applyToView, 0, 0, 1, 2);
328
329
330
  buttons->addWidget(m_saveShapesToTable, 1, 0, 1, 2);
  buttons->addWidget(m_saveButton, 2, 0);
  buttons->addWidget(m_clearAll, 2, 1);
331
332
333
334
335
336
337
338
339

  box->setLayout(buttons);
  layout->addWidget(box);

  box = new QGroupBox("Workspace");
  buttons = new QGridLayout();
  buttons->addWidget(m_applyToData, 0, 0);
  box->setLayout(buttons);
  layout->addWidget(box);
340
341
342

  connect(m_instrWidget, SIGNAL(maskedWorkspaceOverlayed()), this,
          SLOT(enableApplyButtons()));
343
344
345
}

/**
LamarMoore's avatar
LamarMoore committed
346
347
 * Initialize the tab when new projection surface is created.
 */
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
void InstrumentWidgetMaskTab::initSurface() {
  connect(m_instrWidget->getSurface().get(), SIGNAL(shapeCreated()), this,
          SLOT(shapeCreated()));
  connect(m_instrWidget->getSurface().get(), SIGNAL(shapeSelected()), this,
          SLOT(shapeSelected()));
  connect(m_instrWidget->getSurface().get(), SIGNAL(shapesDeselected()), this,
          SLOT(shapesDeselected()));
  connect(m_instrWidget->getSurface().get(), SIGNAL(shapeChanged()), this,
          SLOT(shapeChanged()));
  connect(m_instrWidget->getSurface().get(), SIGNAL(shapesCleared()), this,
          SLOT(shapesCleared()));
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
363
364
365
 * Selects between masking/grouping
 * @param mode The required mode, @see Mode
 */
366
367
368
void InstrumentWidgetMaskTab::setMode(Mode mode) {
  switch (mode) {
  case Mask:
369
    m_masking_on->setChecked(true);
370
371
    break;
  case Group:
372
    m_grouping_on->setChecked(true);
373
374
    break;
  case ROI:
375
    m_roi_on->setChecked(true);
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
    break;
  default:
    throw std::invalid_argument("Invalid Mask tab mode. Use Mask/Group.");
  };
  toggleMaskGroup();
}

void InstrumentWidgetMaskTab::selectTool(Activity tool) {
  switch (tool) {
  case Move:
    m_move->setChecked(true);
    break;
  case Select:
    m_pointer->setChecked(true);
    break;
  case DrawEllipse:
    m_ellipse->setChecked(true);
    break;
  case DrawRectangle:
    m_rectangle->setChecked(true);
    break;
  case DrawEllipticalRing:
    m_ring_ellipse->setChecked(true);
    break;
  case DrawRectangularRing:
    m_ring_rectangle->setChecked(true);
    break;
  case DrawFree:
    m_free_draw->setChecked(true);
    break;
  default:
    throw std::invalid_argument("Invalid tool type.");
  }
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
413
414
 * Set tab's activity based on the currently selected tool button.
 */
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
void InstrumentWidgetMaskTab::setActivity() {
  const QColor borderColor = getShapeBorderColor();
  const QColor fillColor = getShapeFillColor();
  QString whatIsBeingSelected = m_maskBins && getMode() == Mode::Mask
                                    ? "Selecting bins"
                                    : "Selecting detectors";
  if (m_move->isChecked()) {
    m_activity = Move;
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::MoveMode);
    m_activeTool->setText("Tool: Navigation");
  } else if (m_pointer->isChecked()) {
    m_activity = Select;
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Shape editing. " + whatIsBeingSelected);
  } else if (m_ellipse->isChecked()) {
    m_activity = DrawEllipse;
    m_instrWidget->getSurface()->startCreatingShape2D("ellipse", borderColor,
                                                      fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Ellipse. " + whatIsBeingSelected);
  } else if (m_rectangle->isChecked()) {
    m_activity = DrawRectangle;
    m_instrWidget->getSurface()->startCreatingShape2D("rectangle", borderColor,
                                                      fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Rectangle. " + whatIsBeingSelected);
  } else if (m_ring_ellipse->isChecked()) {
    m_activity = DrawEllipticalRing;
    m_instrWidget->getSurface()->startCreatingShape2D("ring ellipse",
                                                      borderColor, fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Elliptical ring. " + whatIsBeingSelected);
  } else if (m_ring_rectangle->isChecked()) {
    m_activity = DrawRectangularRing;
    m_instrWidget->getSurface()->startCreatingShape2D("ring rectangle",
                                                      borderColor, fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Rectangular ring. " + whatIsBeingSelected);
  } else if (m_free_draw->isChecked()) {
    m_activity = DrawFree;
    m_instrWidget->getSurface()->startCreatingFreeShape(borderColor, fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawFreeMode);
    m_activeTool->setText("Tool: Free draw. " + whatIsBeingSelected);
  }
  m_instrWidget->updateInfoText();
}

/**
LamarMoore's avatar
LamarMoore committed
470
471
 * Slot responding on creation of a new masking shape.
 */
472
473
474
475
476
477
478
479
480
481
void InstrumentWidgetMaskTab::shapeCreated() {
  if (!isVisible())
    return;
  if (m_activity != DrawFree) {
    setSelectActivity();
  }
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
482
483
 * Slot responding on selection of a new masking shape.
 */
484
485
486
void InstrumentWidgetMaskTab::shapeSelected() { setProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
487
488
 * Slot responding on deselecting all masking shapes.
 */
489
490
491
void InstrumentWidgetMaskTab::shapesDeselected() { clearProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
492
493
 * Slot responding on a change of a masking shape.
 */
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
void InstrumentWidgetMaskTab::shapeChanged() {
  if (!m_left)
    return; // check that everything is ok
  m_userEditing =
      false; // this prevents resetting shape properties by doubleChanged(...)
  RectF rect = m_instrWidget->getSurface()->getCurrentBoundingRect();
  m_doubleManager->setValue(m_left, rect.x0());
  m_doubleManager->setValue(m_top, rect.y1());
  m_doubleManager->setValue(m_right, rect.x1());
  m_doubleManager->setValue(m_bottom, rect.y0());
  for (QMap<QtProperty *, QString>::iterator it = m_doublePropertyMap.begin();
       it != m_doublePropertyMap.end(); ++it) {
    m_doubleManager->setValue(
        it.key(), m_instrWidget->getSurface()->getCurrentDouble(it.value()));
  }
  for (QMap<QString, QtProperty *>::iterator it = m_pointPropertyMap.begin();
       it != m_pointPropertyMap.end(); ++it) {
    QtProperty *prop = it.value();
    QList<QtProperty *> subs = prop->subProperties();
    if (subs.size() != 2)
      continue;
    QPointF p = m_instrWidget->getSurface()->getCurrentPoint(it.key());
    m_doubleManager->setValue(subs[0], p.x());
    m_doubleManager->setValue(subs[1], p.y());
  }
  m_userEditing = true;
}

/**
LamarMoore's avatar
LamarMoore committed
523
524
 * Slot responding on removing all masking shapes.
 */
525
526
527
void InstrumentWidgetMaskTab::shapesCleared() { enableApplyButtons(); }

/**
LamarMoore's avatar
LamarMoore committed
528
529
 * Removes the mask shapes from the screen.
 */
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
void InstrumentWidgetMaskTab::clearShapes() {
  m_instrWidget->getSurface()->clearMask();
  setSelectActivity();
}

void InstrumentWidgetMaskTab::showEvent(QShowEvent *) {
  setActivity();
  m_instrWidget->setMouseTracking(true);
  enableApplyButtons();
  m_instrWidget->updateInstrumentView(true);
  m_instrWidget->getSurface()->changeBorderColor(getShapeBorderColor());
}

void InstrumentWidgetMaskTab::clearProperties() {
  m_browser->clear();
  m_doublePropertyMap.clear();
  m_pointPropertyMap.clear();
  m_pointComponentsMap.clear();
548
549
550
551
  m_left = nullptr;
  m_top = nullptr;
  m_right = nullptr;
  m_bottom = nullptr;
552
553
554
555
556
557
558
}

void InstrumentWidgetMaskTab::setProperties() {
  clearProperties();
  m_userEditing = false;

  // bounding rect property
559
  QtProperty *boundingRectGroup = m_groupManager->addProperty("Bounding Rect");
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
  m_browser->addProperty(boundingRectGroup);
  m_left = addDoubleProperty("left");
  m_top = addDoubleProperty("top");
  m_right = addDoubleProperty("right");
  m_bottom = addDoubleProperty("bottom");
  boundingRectGroup->addSubProperty(m_left);
  boundingRectGroup->addSubProperty(m_top);
  boundingRectGroup->addSubProperty(m_right);
  boundingRectGroup->addSubProperty(m_bottom);

  // point properties
  QStringList pointProperties =
      m_instrWidget->getSurface()->getCurrentPointNames();
  foreach (QString name, pointProperties) {
    QtProperty *point = m_groupManager->addProperty(name);
    QtProperty *prop_x = addDoubleProperty("x");
    QtProperty *prop_y = addDoubleProperty("y");
    point->addSubProperty(prop_x);
    point->addSubProperty(prop_y);
    m_browser->addProperty(point);
    m_pointComponentsMap[prop_x] = name;
    m_pointComponentsMap[prop_y] = name;
    m_pointPropertyMap[name] = point;
  }

  // double properties
  QStringList doubleProperties =
      m_instrWidget->getSurface()->getCurrentDoubleNames();
  foreach (QString name, doubleProperties) {
    QtProperty *prop = addDoubleProperty(name);
    m_browser->addProperty(prop);
    m_doublePropertyMap[prop] = name;
  }

  shapeChanged();
}

597
598
599
600
601
602
603
/**
 * Save shapes to a table workspace
 */
void InstrumentWidgetMaskTab::saveShapesToTable() const {
  m_instrWidget->getSurface()->saveShapesToTableWorkspace();
}

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
void InstrumentWidgetMaskTab::doubleChanged(QtProperty *prop) {
  if (!m_userEditing)
    return;
  if (prop == m_left || prop == m_top || prop == m_right || prop == m_bottom) {
    QRectF rect(
        QPointF(m_doubleManager->value(m_left), m_doubleManager->value(m_top)),
        QPointF(m_doubleManager->value(m_right),
                m_doubleManager->value(m_bottom)));
    m_instrWidget->getSurface()->setCurrentBoundingRect(RectF(rect));
  } else {
    QString name = m_doublePropertyMap[prop];
    if (!name.isEmpty()) {
      m_instrWidget->getSurface()->setCurrentDouble(
          name, m_doubleManager->value(prop));
    } else {
      name = m_pointComponentsMap[prop];
      if (!name.isEmpty()) {
        QtProperty *point_prop = m_pointPropertyMap[name];
        QList<QtProperty *> subs = point_prop->subProperties();
        if (subs.size() != 2)
          return;
        QPointF p(m_doubleManager->value(subs[0]),
                  m_doubleManager->value(subs[1]));
        m_instrWidget->getSurface()->setCurrentPoint(name, p);
      }
    }
  }
  m_instrWidget->update();
}

/**
LamarMoore's avatar
LamarMoore committed
635
636
637
 * Apply the constructed mask to the data workspace. This operation cannot be
 * reverted.
 */
638
639
640
void InstrumentWidgetMaskTab::applyMask() {
  storeMask();
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
641
  m_instrWidget->getInstrumentActor().applyMaskWorkspace();
642
643
644
645
646
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
647
648
 * Apply the constructed mask to the view only.
 */
649
650
651
652
653
654
void InstrumentWidgetMaskTab::applyMaskToView() {
  storeMask();
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
655
656
 * Remove all masking that has not been applied to the data workspace.
 */
657
658
void InstrumentWidgetMaskTab::clearMask() {
  clearShapes();
659
  m_instrWidget->getInstrumentActor().clearMasks();
660
661
662
663
664
  m_instrWidget->updateInstrumentView();
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
665
666
667
668
669
670
 * Create a MaskWorkspace from the mask defined in this tab.
 * @param invertMask ::  if true, the selected mask will be inverted; if false,
 * the mask will be used as is
 * @param temp :: Set true to create a temporary workspace with a fixed name. If
 * false the name will be unique.
 */
671
Mantid::API::MatrixWorkspace_sptr
672
InstrumentWidgetMaskTab::createMaskWorkspace(bool invertMask, bool temp) const {
673
674
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::MatrixWorkspace_sptr inputWS =
675
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
  Mantid::API::MatrixWorkspace_sptr outputWS;
  const std::string outputWorkspaceName = generateMaskWorkspaceName(temp);

  Mantid::API::IAlgorithm *alg =
      Mantid::API::FrameworkManager::Instance().createAlgorithm("ExtractMask",
                                                                -1);
  alg->setProperty("InputWorkspace", inputWS);
  alg->setPropertyValue("OutputWorkspace", outputWorkspaceName);
  alg->execute();

  outputWS = boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(
      Mantid::API::AnalysisDataService::Instance().retrieve(
          outputWorkspaceName));

  if (invertMask) {
    Mantid::API::IAlgorithm *invertAlg =
        Mantid::API::FrameworkManager::Instance().createAlgorithm(
            "BinaryOperateMasks", -1);
    invertAlg->setPropertyValue("InputWorkspace1", outputWorkspaceName);
    invertAlg->setPropertyValue("OutputWorkspace", outputWorkspaceName);
    invertAlg->setPropertyValue("OperationType", "NOT");
    invertAlg->execute();

    outputWS->setTitle("InvertedMaskWorkspace");
  } else {
    outputWS->setTitle("MaskWorkspace");
  }

  return outputWS;
}

void InstrumentWidgetMaskTab::saveInvertedMaskToWorkspace() {
  saveMaskingToWorkspace(true);
}

void InstrumentWidgetMaskTab::saveMaskToWorkspace() {
  saveMaskingToWorkspace(false);
}

void InstrumentWidgetMaskTab::saveInvertedMaskToFile() {
  saveMaskingToFile(true);
}

void InstrumentWidgetMaskTab::saveMaskToFile() { saveMaskingToFile(false); }

void InstrumentWidgetMaskTab::saveMaskToCalFile() {
  saveMaskingToCalFile(false);
}

void InstrumentWidgetMaskTab::saveInvertedMaskToCalFile() {
  saveMaskingToCalFile(true);
}

void InstrumentWidgetMaskTab::saveMaskToTable() {
  saveMaskingToTableWorkspace(false);
}

/**
LamarMoore's avatar
LamarMoore committed
734
735
 * Extract selected detectors to a new workspace
 */
736
737
void InstrumentWidgetMaskTab::extractDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
738
  std::vector<size_t> dets;
739
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
740
741
  const auto &actor = m_instrWidget->getInstrumentActor();
  DetXMLFile mapFile(actor.getDetIDs(dets));
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
  std::string fname = mapFile();
  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
    Mantid::API::IAlgorithm *alg =
        Mantid::API::FrameworkManager::Instance().createAlgorithm(
            "GroupDetectors");
    alg->setPropertyValue("InputWorkspace", workspaceName);
    alg->setPropertyValue("MapFile", fname);
    alg->setPropertyValue("OutputWorkspace", workspaceName + "_selection");
    alg->execute();
  }
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
757
758
 * Sum selected detectors to a new workspace
 */
759
760
void InstrumentWidgetMaskTab::sumDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
761
  std::vector<size_t> dets;
762
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
763
764
  DetXMLFile mapFile(m_instrWidget->getInstrumentActor().getDetIDs(dets),
                     DetXMLFile::Sum);
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
  std::string fname = mapFile();

  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
    Mantid::API::IAlgorithm *alg =
        Mantid::API::FrameworkManager::Instance().createAlgorithm(
            "GroupDetectors");
    alg->setPropertyValue("InputWorkspace", workspaceName);
    alg->setPropertyValue("MapFile", fname);
    alg->setPropertyValue("OutputWorkspace", workspaceName + "_sum");
    alg->execute();
  }
  QApplication::restoreOverrideCursor();
}

void InstrumentWidgetMaskTab::saveIncludeGroupToFile() {
Ian Bush's avatar
Ian Bush committed
781
782
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
783
  if (!fname.isEmpty()) {
784
    std::vector<size_t> dets;
785
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
786
787
    DetXMLFile mapFile(m_instrWidget->getInstrumentActor().getDetIDs(dets),
                       DetXMLFile::Sum, fname);
788
789
790
791
  }
}

void InstrumentWidgetMaskTab::saveExcludeGroupToFile() {
Ian Bush's avatar
Ian Bush committed
792
793
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
794
  if (!fname.isEmpty()) {
795
    std::vector<size_t> dets;
796
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
797
798
    const auto &actor = m_instrWidget->getInstrumentActor();
    DetXMLFile mapFile(actor.getAllDetIDs(), actor.getDetIDs(dets), fname);
799
800
801
802
803
804
805
806
  }
}

void InstrumentWidgetMaskTab::showSaveMenuTooltip(QAction *action) {
  QToolTip::showText(QCursor::pos(), action->toolTip(), this);
}

/**
LamarMoore's avatar
LamarMoore committed
807
808
809
 * Toggle between different modes
 *
 */
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
void InstrumentWidgetMaskTab::toggleMaskGroup() {
  Mode mode = getMode();

  enableApplyButtons();
  if (mode == Mode::Mask) {
    m_saveButton->setMenu(m_saveMask);
    m_saveButton->setText("Apply and Save");
  } else if (mode == Mode::ROI) {
    m_saveButton->setMenu(m_saveROI);
    m_saveButton->setText("Apply and Save");
  } else {
    m_saveButton->setMenu(m_saveGroup);
    m_saveButton->setText("Save");
  }
  m_instrWidget->getSurface()->changeBorderColor(getShapeBorderColor());
  m_instrWidget->updateInstrumentView();
}

/**
LamarMoore's avatar
LamarMoore committed
829
830
831
832
833
834
 * Save the constructed mask to a workspace with unique name of type
 * "MaskWorkspace_#".
 * The mask is not applied to the data workspace being displayed.
 * @param invertMask ::  if true, the selected mask will be inverted; if false,
 * the mask will be used as is
 */
835
836
837
838
839
840
void InstrumentWidgetMaskTab::saveMaskingToWorkspace(bool invertMask) {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
  // Make sure we have stored the Mask in the helper MaskWorkspace
  storeDetectorMask(invertMask);
  setSelectActivity();
  createMaskWorkspace(false, false);
841
842
843
844
845
846
847
848
849

#if 0
			// TESTCASE
			double minbinvalue = m_instrWidget->getInstrumentActor()->minBinValue();
			double maxbinvalue = m_instrWidget->getInstrumentActor()->maxBinValue();
			std::cout << "Range of X: " << minbinvalue << ", " << maxbinvalue << ".\n";

#endif

850
851
852
853
854
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
855
856
857
858
859
 * Save the constructed mask to a file.
 * The mask is not applied to the data workspace being displayed.
 * @param invertMask ::  if true, the selected mask will be inverted; if false,
 * the mask will be used as is
 */
860
861
862
863
864
865
866
867
868
869
870
871
872
void InstrumentWidgetMaskTab::saveMaskingToFile(bool invertMask) {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));

  // Make sure we have stored the Mask in the helper MaskWorkspace
  storeDetectorMask(invertMask);
  setSelectActivity();
  Mantid::API::MatrixWorkspace_sptr outputWS = createMaskWorkspace(false, true);
  if (outputWS) {
    clearShapes();

    QApplication::restoreOverrideCursor();
    QString fileName = m_instrWidget->getSaveFileName(
        "Select location and name for the mask file",
873
        "XML files (*.xml);;All (*)");
874
875
876
877
878
879
880
881
882
883
884
885
886
    QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));

    if (!fileName.isEmpty()) {

      // Call "SaveMask()"
      Mantid::API::IAlgorithm_sptr alg =
          Mantid::API::AlgorithmManager::Instance().create("SaveMask", -1);
      alg->setProperty(
          "InputWorkspace",
          boost::dynamic_pointer_cast<Mantid::API::Workspace>(outputWS));
      alg->setPropertyValue("OutputFile", fileName.toStdString());
      alg->execute();
    }
887
    Mantid::API::AnalysisDataService::Instance().remove(outputWS->getName());
888
889
890
891
892
893
  }
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
894
895
896
897
898
 * Save the constructed mask to a cal file.
 * The mask is not applied to the data workspace being displayed.
 * @param invertMask ::  if true, the selected mask will be inverted; if false,
 * the mask will be used as is
 */
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
void InstrumentWidgetMaskTab::saveMaskingToCalFile(bool invertMask) {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));

  // Make sure we have stored the Mask in the helper MaskWorkspace
  storeDetectorMask(invertMask);

  setSelectActivity();
  Mantid::API::MatrixWorkspace_sptr outputWS = createMaskWorkspace(false, true);
  if (outputWS) {
    clearShapes();
    QString fileName = m_instrWidget->getSaveFileName(
        "Select location and name for the mask file", "cal files (*.cal)");
    if (!fileName.isEmpty()) {
      Mantid::API::IAlgorithm_sptr alg =
          Mantid::API::AlgorithmManager::Instance().create(
              "MaskWorkspaceToCalFile", -1);
915
      alg->setPropertyValue("InputWorkspace", outputWS->getName());
916
917
918
919
      alg->setPropertyValue("OutputFile", fileName.toStdString());
      alg->setProperty("Invert", false);
      alg->execute();
    }
920
    Mantid::API::AnalysisDataService::Instance().remove(outputWS->getName());
921
922
923
924
925
926
  }
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
927
928
929
930
 * Apply and save the mask to a TableWorkspace with X-range
 * @param invertMask :: if true, the selected mask will be inverted; if false,
 * the mask will be used as is
 */
931
932
933
934
935
936
937
938
939
940
941
942
void InstrumentWidgetMaskTab::saveMaskingToTableWorkspace(bool invertMask) {
  UNUSED_ARG(invertMask);

  // Set override cursor
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));

  // Make sure that we have stored the mask in the helper Mask workspace
  storeDetectorMask();
  setSelectActivity();

  // Apply the view (no workspace) to a buffered mask workspace
  Mantid::API::MatrixWorkspace_sptr inputWS =
943
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
944
945

  // Extract from MaskWorkspace to a TableWorkspace
946
947
  double xmin = m_instrWidget->getInstrumentActor().minBinValue();
  double xmax = m_instrWidget->getInstrumentActor().maxBinValue();
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
  // std::cout << "[DB] Selected x-range: " << xmin << ", " << xmax << ".\n";

  // Always use the same name
  const std::string outputWorkspaceName("MaskBinTable");

  // Check whether it is going to add a line in an existing workspace
  Mantid::API::ITableWorkspace_sptr temptablews;
  bool overwrite = false;
  try {
    temptablews = boost::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
        Mantid::API::AnalysisDataService::Instance().retrieve(
            outputWorkspaceName));
  } catch (Mantid::Kernel::Exception::NotFoundError) {
    std::cout << "TableWorkspace " << outputWorkspaceName
              << " cannot be found in ADS."
              << ".\n";
  }

  if (temptablews)
    overwrite = true;

  std::cout << "[DB] MaskTableWorkspace is found? = " << overwrite << ". "
            << ".\n";

  Mantid::API::IAlgorithm *alg =
      Mantid::API::FrameworkManager::Instance().createAlgorithm(
          "ExtractMaskToTable", -1);
  alg->setProperty("InputWorkspace", inputWS);
  if (overwrite)
    alg->setPropertyValue("MaskTableWorkspace", outputWorkspaceName);
  alg->setPropertyValue("OutputWorkspace", outputWorkspaceName);
  alg->setProperty("Xmin", xmin);
  alg->setProperty("Xmax", xmax);
  alg->execute();

  // Restore the previous state
  enableApplyButtons();
  QApplication::restoreOverrideCursor();

  if (alg->isExecuted()) {
    // Mantid::API::MatrixWorkspace_sptr outputWS
    Mantid::API::ITableWorkspace_sptr outputWS =
        boost::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
            Mantid::API::AnalysisDataService::Instance().retrieve(
                outputWorkspaceName));

    outputWS->setTitle("MaskBinTable");
  } else {
    QMessageBox::critical(this, "MantidPlot - Error",
                          "Algorithm ExtractMaskToTable fails to execute. ");
  }
}

/**
LamarMoore's avatar
LamarMoore committed
1002
1003
1004
 * Generate a unique name for the mask worspace which will be saved in the ADS.
 * It will have a form MaskWorkspace[_#]
 */
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
std::string
InstrumentWidgetMaskTab::generateMaskWorkspaceName(bool temp) const {
  if (temp)
    return "__MaskTab_MaskWorkspace";
  auto wsNames = Mantid::API::AnalysisDataService::Instance().getObjectNames();
  int maxIndex = 0;
  const std::string baseName = "MaskWorkspace";
  for (auto name = wsNames.begin(); name != wsNames.end(); ++name) {
    if (name->find(baseName) == 0) {
      int index = Mantid::Kernel::Strings::endsWithInt(*name);
      if (index > 0 && index > maxIndex)
        maxIndex = index;
      else
        maxIndex = 1;
    }
  }
  if (maxIndex > 0) {
    return baseName + "_" + Mantid::Kernel::Strings::toString(maxIndex + 1);
  }
  return baseName;
}

/**
LamarMoore's avatar
LamarMoore committed
1028
1029
1030
 * Sets the m_hasMaskToApply flag and
 * enables/disables the apply and clear buttons.
 */
1031
void InstrumentWidgetMaskTab::enableApplyButtons() {
1032
  const auto &instrActor = m_instrWidget->getInstrumentActor();
1033
1034
  auto mode = getMode();

1035
  m_maskBins = !instrActor.wholeRange();
1036
  bool hasMaskShapes = m_instrWidget->getSurface()->hasMasks();
1037
1038
  bool hasMaskWorkspace = instrActor.hasMaskWorkspace();
  bool hasBinMask = instrActor.hasBinMask();
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
  bool hasDetectorMask = hasMaskShapes || hasMaskWorkspace;
  bool hasMask = hasDetectorMask || hasBinMask;

  bool enableBinMasking = hasMaskShapes && m_maskBins && mode == Mode::Mask;

  if (m_maskBins && mode == Mode::Mask) {
    m_applyToView->setText("Apply bin mask to View");
  } else {
    m_applyToView->setText("Apply detector mask to View");
  }

  if ((mode == Mode::Mask) || (mode == Mode::ROI)) {
    m_hasMaskToApply = hasMask;
    m_applyToData->setEnabled(hasMask);
    m_applyToView->setEnabled(hasMaskShapes);
  } else {
    m_applyToData->setEnabled(false);
    m_applyToView->setEnabled(false);
  }
1058
  m_saveShapesToTable->setEnabled(hasMaskShapes);
1059
1060
1061
1062
1063
1064
  m_saveButton->setEnabled(hasDetectorMask && (!enableBinMasking));
  m_clearAll->setEnabled(hasMask);
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1065
1066
 * Sets tab activity to Select: select and modify shapes.
 */
1067
1068
1069
1070
1071
1072
void InstrumentWidgetMaskTab::setSelectActivity() {
  m_pointer->setChecked(true);
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1073
1074
 * It tab in masking, ROI or grouping mode?
 */
1075
InstrumentWidgetMaskTab::Mode InstrumentWidgetMaskTab::getMode() const {
1076
  if (m_masking_on->isChecked())
1077
    return Mode::Mask;
1078
  if (m_roi_on->isChecked())
1079
    return Mode::ROI;
1080
  if (m_grouping_on->isChecked())
1081
1082
1083
1084
1085
1086
    return Mode::Group;

  throw std::logic_error("Invalid mode");
}

/**
LamarMoore's avatar
LamarMoore committed
1087
1088
 * Border color.
 */
1089
1090
1091
1092
1093
1094
1095
1096
1097
QColor InstrumentWidgetMaskTab::getShapeBorderColor() const {
  if (getMode() == Mode::Mask)
    return Qt::red;
  if (getMode() == Mode::ROI)
    return Qt::yellow;
  return Qt::blue;
}

/**
LamarMoore's avatar
LamarMoore committed
1098
1099
 * Shape fill color.
 */
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
QColor InstrumentWidgetMaskTab::getShapeFillColor() const {
  return QColor(255, 255, 255, 100);
}

QtProperty *
InstrumentWidgetMaskTab::addDoubleProperty(const QString &name) const {
  QtProperty *prop = m_doubleManager->addProperty(name);
  m_doubleManager->setDecimals(prop, 6);
  return prop;
}

/**
LamarMoore's avatar
LamarMoore committed
1112
1113
 * Store the mask defined by the shape tools to the helper m_maskWorkspace.
 */
1114
1115
1116
1117
1118
1119
1120
void InstrumentWidgetMaskTab::storeDetectorMask(bool isROI) {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
  m_pointer->setChecked(true);
  setActivity();
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::IMaskWorkspace_sptr wsFresh;

1121
1122
  const auto &actor = m_instrWidget->getInstrumentActor();
  std::vector<size_t> dets;
1123
1124
  // get detectors covered by the shapes
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
1125
1126
  if (!dets.empty()) {
    auto wsMask = actor.getMaskWorkspace();
1127
1128
1129
1130
1131
1132
1133
1134
    // have to cast up to the MaskWorkspace to get access to clone()

    std::set<Mantid::detid_t> detList;
    if (isROI) {
      // need to invert the mask before adding the new shape
      // but not if the mask is fresh and empty
      if (wsMask->getNumberMasked() > 0) {
        wsFresh = boost::dynamic_pointer_cast<Mantid::API::IMaskWorkspace>(
1135
1136
            actor.extractCurrentMask());
        actor.invertMaskWorkspace();
1137
1138
      }
    }
Lamar Moore's avatar
Lamar Moore committed
1139
    for (auto det : dets)
1140
      detList.insert(actor.getDetID(det));
1141
1142
1143

    if (!detList.empty()) {
      // try to mask each detector separately and ignore any failure
Lamar Moore's avatar
Lamar Moore committed
1144
      for (auto det : detList) {
1145
1146
        try {
          if (isROI && wsFresh) {
1147
1148
            if (wsMask->isMasked(det))
              wsFresh->setMasked(det);
1149
          } else {
1150
            wsMask->setMasked(det);
1151
1152
1153
1154
1155
1156
          }
        } catch (...) {
        }
      }
      if (isROI) {
        if (wsFresh)
1157
          m_instrWidget->getInstrumentActor().setMaskMatrixWorkspace(
1158
1159
1160
              boost::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(
                  wsFresh));
        // need to invert the mask before displaying
1161
        m_instrWidget->getInstrumentActor().invertMaskWorkspace();
1162
1163
      }
      // update detector colours
1164
      m_instrWidget->getInstrumentActor().updateColors();
1165
1166
1167
1168
1169
1170
1171
1172
1173
      m_instrWidget->updateInstrumentDetectors();
    }
  }
  // remove masking shapes
  clearShapes();
  QApplication::restoreOverrideCursor();
}

void InstrumentWidgetMaskTab::storeBinMask() {
1174
  std::vector<size_t> dets;
1175
1176
1177
  // get detectors covered by the shapes
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
  // mask some bins
1178
  m_instrWidget->getInstrumentActor().addMaskBinsData(dets);
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
  // remove masking shapes
  clearShapes();
  enableApplyButtons();
}

/// Store current shapes as a mask (detector or bin)
void InstrumentWidgetMaskTab::storeMask() {
  if (m_maskBins && getMode() == Mode::Mask) {
    storeBinMask();
  } else {
    storeDetectorMask(getMode() == Mode::ROI);
  }
}

void InstrumentWidgetMaskTab::changedIntegrationRange(double, double) {
  enableApplyButtons();
}
1196

1197
/** Load mask tab state from a Mantid project file
1198
1199
1200
 * @param lines :: lines from the project file to load state from
 */
void InstrumentWidgetMaskTab::loadFromProject(const std::string &lines) {
1201
  API::TSVSerialiser tsv(lines);
1202

1203
1204
  if (!tsv.selectSection("masktab"))
    return;
1205

1206
1207
  std::string tabLines;
  tsv >> tabLines;
1208
  API::TSVSerialiser tab(tabLines);
1209

1210
1211
1212
  std::vector<QPushButton *> buttons{
      m_move,         m_pointer,        m_ellipse,  m_rectangle,
      m_ring_ellipse, m_ring_rectangle, m_free_draw};
1213

1214
1215
1216
1217
1218
1219
  tab.selectLine("ActiveTools");
  for (auto button : buttons) {
    bool value;
    tab >> value;
    button->setChecked(value);
  }
1220

1221
1222
  std::vector<QRadioButton *> typeButtons{m_masking_on, m_grouping_on,
                                          m_roi_on};
1223

1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
  tab.selectLine("ActiveType");
  for (auto type : typeButtons) {
    bool value;
    tab >> value;
    type->setChecked(value);
  }

  if (tab.selectLine("MaskViewWorkspace")) {
    // the view was masked. We should load reapply this from a cached
    // workspace in the project folder
    std::string maskWSName;
    tab >> maskWSName;
    loadMaskViewFromProject(maskWSName);
1237
1238
  }
}
1239

1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
/** Load a mask workspace applied to the instrument actor from the project
 *
 * This is for the case where masks have been applied to the instrument actor
 * but not to the workspace itself or saved to a workspace/table
 *
 * @param name :: name of the file to load from the project folder
 */
void InstrumentWidgetMaskTab::loadMaskViewFromProject(const std::string &name) {
  using namespace Mantid::API;
  using namespace Mantid::Kernel;
1250

1251
1252
1253
  QSettings settings;
  auto workingDir = settings.value("Project/WorkingDirectory", "").toString();
  auto fileName = workingDir.toStdString() + "/" + name;
1254
1255
1256
1257
1258
  auto maskWS = loadMask(fileName);

  if (!maskWS)
    return; // if we couldn't load it then just fail silently

1259
1260
1261
  auto &actor = m_instrWidget->getInstrumentActor();
  actor.setMaskMatrixWorkspace(maskWS);
  actor.updateColors();
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
  m_instrWidget->updateInstrumentDetectors();
  m_instrWidget->updateInstrumentView();
}

/** Load a mask workspace given a file name
 *
 * This will attempt to load a mask workspace using the supplied file name and
 * assume that the instrument is the same one as the actor in the instrument
 * view.
 *
 * @param fileName :: the full path to the mask file on disk
 * @return a pointer to the loaded mask workspace
 */
Mantid::API::MatrixWorkspace_sptr
InstrumentWidgetMaskTab::loadMask(const std::string &fileName) {
  using namespace Mantid::API;

  // build path and input properties etc.
1280
1281
  const auto &actor = m_instrWidget->getInstrumentActor();
  auto workspace = actor.getWorkspace();
1282
1283
  auto instrument = workspace->getInstrument();
  auto instrumentName = instrument->getName();
1284
  auto tempName = "__" + workspace->getName() + "MaskView";
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297

  // load the mask from the project folder
  try {
    auto alg = AlgorithmManager::Instance().create("LoadMask", -1);
    alg->initialize();
    alg->setPropertyValue("Instrument", instrumentName);
    alg->setPropertyValue("InputFile", fileName);
    alg->setPropertyValue("OutputWorkspace", tempName);
    alg->execute();
  } catch (...) {
    // just fail silently, if we can't load the mask then we should
    // give up at this point.
    return nullptr;
1298
  }
1299
1300

  // get the mask workspace and remove from ADS to clean up
1301
1302
1303
  auto &ads = AnalysisDataService::Instance();
  auto maskWS = ads.retrieveWS<MatrixWorkspace>(tempName);
  ads.remove(tempName);
1304
1305

  return maskWS;
1306
1307
}

1308
1309
1310
1311
/** Save the state of the mask tab to a Mantid project file
 * @return a string representing the state of the mask tab
 */
std::string InstrumentWidgetMaskTab::saveToProject() const {
1312
1313
  API::TSVSerialiser tsv;
  API::TSVSerialiser tab;
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331

  std::vector<QPushButton *> buttons{
      m_move,         m_pointer,        m_ellipse,  m_rectangle,
      m_ring_ellipse, m_ring_rectangle, m_free_draw};

  tab.writeLine("ActiveTools");
  for (auto button : buttons) {
    tab << button->isChecked();
  }

  std::vector<QRadioButton *> typeButtons{m_masking_on, m_grouping_on,
                                          m_roi_on};

  tab.writeLine("ActiveType");
  for (auto type : typeButtons) {
    tab << type->isChecked();
  }

1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
  // Save the masks applied to view but not saved to a workspace
  auto wsName =
      m_instrWidget->getWorkspaceName().toStdString() + "MaskView.xml";
  bool success = saveMaskViewToProject(wsName);
  if (success)
    tab.writeLine("MaskViewWorkspace") << wsName;

  tsv.writeSection("masktab", tab.outputLines());
  return tsv.outputLines();
}

/** Save a mask workspace containing masks applied to the instrument view
 *
 * This will save masks which have been applied to the instrument view actor
 * but have not be applied to the workspace or exported to a seperate
 * workspace/table already
 *
 * @param name :: the name to call the workspace in the project folder
 * @return whether a workspace was successfully saved to the project
 */
bool InstrumentWidgetMaskTab::saveMaskViewToProject(
    const std::string &name) const {
1354
1355
  using namespace Mantid::API;
  using namespace Mantid::Kernel;
1356

1357
1358
1359
  QSettings settings;
  auto workingDir = settings.value("Project/WorkingDirectory", "").toString();
  auto fileName = workingDir.toStdString() + "/" + name;
1360

1361
  try {
1362
    // get masked detector workspace from actor
1363
1364
    const auto &actor = m_instrWidget->getInstrumentActor();
    auto outputWS = actor.getMaskMatrixWorkspace();
1365
1366
1367
1368
1369
1370
1371
1372
1373

    if (!outputWS)
      return false; // no mask workspace was found

    // save mask to file inside project folder
    auto alg = AlgorithmManager::Instance().create("SaveMask", -1);
    alg->setProperty("InputWorkspace",
                     boost::dynamic_pointer_cast<Workspace>(outputWS));
    alg->setPropertyValue("OutputFile", fileName);
1374
    alg->setLogging(false);
1375
    alg->execute();
1376
1377
1378
1379

  } catch (...) {
    // just fail silently, if we can't save the mask then we should
    // give up at this point.
1380
    return false;
1381
1382
  }

1383
  return true;
1384
1385
}

LamarMoore's avatar
LamarMoore committed
1386
1387
} // namespace MantidWidgets
} // namespace MantidQt