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

#include "MantidAPI/AlgorithmManager.h"
#include "MantidAPI/AnalysisDataService.h"
#include "MantidAPI/FrameworkManager.h"
#include "MantidAPI/IMaskWorkspace.h"
#include "MantidAPI/ITableWorkspace.h"
21
#include "MantidAPI/MatrixWorkspace.h"
22
// #include "MantidDataObjects/TableWorkspace.h"
Mathieu Tillet's avatar
Mathieu Tillet committed
23
#include "MantidGeometry/Instrument/ComponentInfo.h"
24
25
26
#include "MantidKernel/Logger.h"
#include "MantidKernel/Strings.h"

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

Samuel Jones's avatar
Samuel Jones committed
48
#include <Poco/Path.h>
49
50
#include <QAction>
#include <QApplication>
51
52
#include <QCheckBox>
#include <QGridLayout>
53
#include <QGroupBox>
54
55
56
57
58
59
#include <QHBoxLayout>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
#include <QRadioButton>
60
#include <QSettings>
61
62
63
64
#include <QTemporaryFile>
#include <QTextEdit>
#include <QToolTip>
#include <QVBoxLayout>
65

Roman Tolchenov's avatar
Roman Tolchenov committed
66
#include "MantidQtWidgets/Common/FileDialogHandler.h"
67
68

#include <algorithm>
LamarMoore's avatar
LamarMoore committed
69
#include <cfloat>
70
#include <fstream>
LamarMoore's avatar
LamarMoore committed
71
#include <numeric>
72

73
74
using Mantid::API::AlgorithmManager;

75
76
77
78
79
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
80
81
82
      m_groupManager(nullptr), m_stringManager(nullptr),
      m_doubleManager(nullptr), m_browser(nullptr), m_left(nullptr),
      m_top(nullptr), m_right(nullptr), m_bottom(nullptr) {
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

  // 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"));

Mathieu Tillet's avatar
Mathieu Tillet committed
134
135
136
  m_sector = new QPushButton();
  m_sector->setCheckable(true);
  m_sector->setAutoExclusive(true);
137
  m_sector->setIcon(QIcon(":/MaskTools/selection-sector.png"));
Mathieu Tillet's avatar
Mathieu Tillet committed
138
139
  m_sector->setToolTip("Draw a circle sector (Shift+Alt+S)");
  m_sector->setShortcut(QKeySequence("Shift+Alt+S"));
Mathieu Tillet's avatar
Mathieu Tillet committed
140

Mathieu Tillet's avatar
Mathieu Tillet committed
141
142
143
144
145
146
147
148
149
150
151
152
  m_pixel = new QPushButton();
  m_pixel->setCheckable(true);
  m_pixel->setAutoExclusive(true);
  m_pixel->setIcon(QIcon(":/PickTools/selection-pointer.png"));
  m_pixel->setToolTip("Select a pixel");

  m_tube = new QPushButton();
  m_tube->setCheckable(true);
  m_tube->setAutoExclusive(true);
  m_tube->setIcon(QIcon(":/PickTools/selection-tube.png"));
  m_tube->setToolTip("Select a tube/bank");

153
154
155
156
157
158
159
  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"));

Mathieu Tillet's avatar
Mathieu Tillet committed
160
161
162
163
164
165
166
167
168
169
170
171
172
  auto *toolBox = new QGridLayout();
  layout->addLayout(toolBox);

  toolBox->addWidget(m_move, 0, 0);
  toolBox->addWidget(m_pointer, 0, 1);
  toolBox->addWidget(m_ellipse, 0, 2);
  toolBox->addWidget(m_rectangle, 0, 3);
  toolBox->addWidget(m_ring_ellipse, 0, 4);
  toolBox->addWidget(m_ring_rectangle, 0, 5);
  toolBox->addWidget(m_sector, 0, 6);
  toolBox->addWidget(m_free_draw, 0, 7);
  toolBox->addWidget(m_pixel, 1, 0);
  toolBox->addWidget(m_tube, 1, 1);
Mathieu Tillet's avatar
Mathieu Tillet committed
173
  toolBox->setColumnStretch(8, 1);
Mathieu Tillet's avatar
Mathieu Tillet committed
174
  toolBox->setSpacing(2);
175
176
177
178
179
180
181

  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()));
Mathieu Tillet's avatar
Mathieu Tillet committed
182
  connect(m_sector, SIGNAL(clicked()), this, SLOT(setActivity()));
Mathieu Tillet's avatar
Mathieu Tillet committed
183
  connect(m_tube, SIGNAL(clicked()), this, SLOT(setActivity()));
184
  connect(m_pixel, SIGNAL(clicked()), this, SLOT(setActivity()));
Mathieu Tillet's avatar
Mathieu Tillet committed
185
  connect(m_free_draw, SIGNAL(clicked()), this, SLOT(setActivity()));
186
187
188
189
190
191
192
193
194
195
  m_move->setChecked(true);

  // 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()));
196
  auto *radioLayout = new QHBoxLayout();
197
198
199
200
  radioLayout->addWidget(m_masking_on);
  radioLayout->addWidget(m_roi_on);
  radioLayout->addWidget(m_grouping_on);
  radioLayout->setMargin(0);
201
  auto *radioGroup = new QGroupBox();
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
  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()));

237
238
239
240
241
242
  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()));

243
244
245
246
247
248
249
250
251
  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.");
252
  connect(m_save_as_workspace_exclude, SIGNAL(triggered()), this,
253
254
255
256
257
258
          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.");
259
  connect(m_save_as_workspace_include, SIGNAL(triggered()), this,
260
261
262
263
264
          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.");
265
  connect(m_save_as_file_exclude, SIGNAL(triggered()), this,
266
267
268
269
          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.");
270
  connect(m_save_as_file_include, SIGNAL(triggered()), this,
271
272
273
274
275
276
          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.");
277
  connect(m_save_as_cal_file_exclude, SIGNAL(triggered()), this,
278
279
280
281
282
          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.");
283
  connect(m_save_as_cal_file_include, SIGNAL(triggered()), this,
284
285
286
287
288
289
290
291
292
          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.");
293
  connect(m_save_as_table_xrange_exclude, SIGNAL(triggered()), this,
294
295
296
297
298
          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.");
299
  connect(m_save_group_file_include, SIGNAL(triggered()), this,
300
301
302
303
304
          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.");
305
  connect(m_save_group_file_exclude, SIGNAL(triggered()), this,
306
307
308
309
          SLOT(saveExcludeGroupToFile()));

  m_extract_to_workspace = new QAction("Extract detectors to workspace", this);
  m_extract_to_workspace->setToolTip("Extract detectors to workspace.");
310
  connect(m_extract_to_workspace, SIGNAL(triggered()), this,
311
312
313
314
          SLOT(extractDetsToWorkspace()));

  m_sum_to_workspace = new QAction("Sum detectors to workspace", this);
  m_sum_to_workspace->setToolTip("Sum detectors to workspace.");
315
  connect(m_sum_to_workspace, SIGNAL(triggered()), this,
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
          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 *)));

353
354
  auto *box = new QGroupBox("View");
  auto *buttons = new QGridLayout();
355
  buttons->addWidget(m_applyToView, 0, 0, 1, 2);
356
357
358
  buttons->addWidget(m_saveShapesToTable, 1, 0, 1, 2);
  buttons->addWidget(m_saveButton, 2, 0);
  buttons->addWidget(m_clearAll, 2, 1);
359
360
361
362
363
364
365
366
367

  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);
368
369
370

  connect(m_instrWidget, SIGNAL(maskedWorkspaceOverlayed()), this,
          SLOT(enableApplyButtons()));
371
372
373
}

/**
LamarMoore's avatar
LamarMoore committed
374
375
 * Initialize the tab when new projection surface is created.
 */
376
void InstrumentWidgetMaskTab::initSurface() {
Mathieu Tillet's avatar
Mathieu Tillet committed
377
  connect(m_instrWidget->getSurface().get(),
378
          SIGNAL(singleComponentPickedForMasking(size_t)), this,
379
          SLOT(singlePixelPicked(size_t)));
380
381
382
383
384
385
386
387
388
389
390
391
392
393
  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
394
395
396
 * Selects between masking/grouping
 * @param mode The required mode, @see Mode
 */
397
398
399
void InstrumentWidgetMaskTab::setMode(Mode mode) {
  switch (mode) {
  case Mask:
400
    m_masking_on->setChecked(true);
401
402
    break;
  case Group:
403
    m_grouping_on->setChecked(true);
404
405
    break;
  case ROI:
406
    m_roi_on->setChecked(true);
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
    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;
Mathieu Tillet's avatar
Mathieu Tillet committed
434
435
436
  case DrawSector:
    m_sector->setChecked(true);
    break;
437
438
439
  case DrawFree:
    m_free_draw->setChecked(true);
    break;
440
441
442
  case Pixel:
    m_pixel->setChecked(true);
    break;
Mathieu Tillet's avatar
Mathieu Tillet committed
443
444
445
  case Tube:
    m_tube->setChecked(true);
    break;
446
447
448
449
450
451
452
  default:
    throw std::invalid_argument("Invalid tool type.");
  }
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
453
454
 * Set tab's activity based on the currently selected tool button.
 */
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
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);
Mathieu Tillet's avatar
Mathieu Tillet committed
499
500
501
502
503
504
505
506
  } else if (m_sector->isChecked()) {
    m_activity = DrawSector;
    m_instrWidget->getSurface()->startCreatingShape2D("sector", borderColor,
                                                      fillColor);
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::DrawRegularMode);
    m_activeTool->setText("Tool: Sector. " + whatIsBeingSelected);

507
508
509
510
511
512
  } 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);
Mathieu Tillet's avatar
Mathieu Tillet committed
513
  } else if (m_pixel->isChecked()) {
514
    m_activity = Pixel;
515
516
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::PickSingleMode);
Mathieu Tillet's avatar
Mathieu Tillet committed
517
518
519
520
521
522
523
    m_activeTool->setText("Tool: Pixel mask. " + whatIsBeingSelected);
  } else if (m_tube->isChecked()) {
    m_activity = Tube;
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::PickTubeMode);
    m_activeTool->setText("Tool: Tube/bank mask. " + whatIsBeingSelected);
  }
524
525
526
  m_instrWidget->updateInfoText();
}

527
528
/**
 * Slot responding on the pick of a single detector pixel for masking.
Mathieu Tillet's avatar
Mathieu Tillet committed
529
 * Can be used either to mask the picked pixel or its parent.
530
 */
Mathieu Tillet's avatar
Mathieu Tillet committed
531
void InstrumentWidgetMaskTab::singlePixelPicked(size_t pickID) {
532
  const auto &actor = m_instrWidget->getInstrumentActor();
Mathieu Tillet's avatar
Mathieu Tillet committed
533
534
535
536
537
538
  const auto &componentInfo = actor.componentInfo();
  if (!componentInfo.isDetector(pickID)) {
    return;
  }

  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
539
  std::vector<size_t> detectorsId{pickID};
Mathieu Tillet's avatar
Mathieu Tillet committed
540
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
541

542
543
  if (m_masking_on->isChecked() || m_roi_on->isChecked()) {
    if (m_tube->isChecked()) {
Mathieu Tillet's avatar
Mathieu Tillet committed
544
545
546
547
      if (!componentInfo.hasParent(pickID)) {
        return;
      }
      auto parent = componentInfo.parent(pickID);
548
      detectorsId = componentInfo.detectorsInSubtree(parent);
Mathieu Tillet's avatar
Mathieu Tillet committed
549
    }
550
    storeDetectorMask(m_roi_on->isChecked(), detectorsId);
551

552
553
554
555
556
557
558
559
560
561
  } else if (m_grouping_on->isChecked()) {
    if (m_pixel->isChecked()) {
      Mantid::detid_t detId = actor.getDetID(pickID);
      m_detectorsToGroup.clear();
      m_detectorsToGroup.append(detId);

    } else if (m_tube->isChecked()) {
      if (!componentInfo.hasParent(pickID)) {
        return;
      }
562
563
564
      const auto parent = componentInfo.parent(pickID);
      const auto dets =
          actor.getDetIDs(componentInfo.detectorsInSubtree(parent));
565
566
567
568
      m_detectorsToGroup.clear();
      for (auto det : dets)
        m_detectorsToGroup.append(det);
    }
Mathieu Tillet's avatar
Mathieu Tillet committed
569
  }
570

Mathieu Tillet's avatar
Mathieu Tillet committed
571
572
573
574
575
  // update detector colours
  m_instrWidget->getInstrumentActor().updateColors();
  m_instrWidget->updateInstrumentDetectors();
  QApplication::restoreOverrideCursor();
  enableApplyButtons();
576
577
}

578
/**
LamarMoore's avatar
LamarMoore committed
579
580
 * Slot responding on creation of a new masking shape.
 */
581
582
583
584
585
586
587
588
589
590
void InstrumentWidgetMaskTab::shapeCreated() {
  if (!isVisible())
    return;
  if (m_activity != DrawFree) {
    setSelectActivity();
  }
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
591
592
 * Slot responding on selection of a new masking shape.
 */
593
594
595
void InstrumentWidgetMaskTab::shapeSelected() { setProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
596
597
 * Slot responding on deselecting all masking shapes.
 */
598
599
600
void InstrumentWidgetMaskTab::shapesDeselected() { clearProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
601
602
 * Slot responding on a change of a masking shape.
 */
603
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
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
632
633
 * Slot responding on removing all masking shapes.
 */
634
635
636
void InstrumentWidgetMaskTab::shapesCleared() { enableApplyButtons(); }

/**
LamarMoore's avatar
LamarMoore committed
637
638
 * Removes the mask shapes from the screen.
 */
639
640
641
642
643
void InstrumentWidgetMaskTab::clearShapes() {
  m_instrWidget->getSurface()->clearMask();
  setSelectActivity();
}

644
void InstrumentWidgetMaskTab::showEvent(QShowEvent * /*unused*/) {
645
646
647
648
649
650
651
652
653
654
655
656
  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();
657
658
659
660
  m_left = nullptr;
  m_top = nullptr;
  m_right = nullptr;
  m_bottom = nullptr;
661
662
663
664
665
666
667
}

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

  // bounding rect property
668
  QtProperty *boundingRectGroup = m_groupManager->addProperty("Bounding Rect");
669
670
671
672
673
674
675
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
  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();
}

706
707
708
709
710
711
712
/**
 * Save shapes to a table workspace
 */
void InstrumentWidgetMaskTab::saveShapesToTable() const {
  m_instrWidget->getSurface()->saveShapesToTableWorkspace();
}

713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
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);
      }
    }
739
740
    // when the user validates the edit of the field, the view is immediatly
    // updated this way
741
    m_instrWidget->updateInstrumentView();
742
743
744
745
746
  }
  m_instrWidget->update();
}

/**
LamarMoore's avatar
LamarMoore committed
747
748
749
 * Apply the constructed mask to the data workspace. This operation cannot be
 * reverted.
 */
750
751
752
void InstrumentWidgetMaskTab::applyMask() {
  storeMask();
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
753
  m_instrWidget->getInstrumentActor().applyMaskWorkspace();
754
755
756
757
758
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
759
760
 * Apply the constructed mask to the view only.
 */
761
762
763
764
765
766
void InstrumentWidgetMaskTab::applyMaskToView() {
  storeMask();
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
767
768
 * Remove all masking that has not been applied to the data workspace.
 */
769
770
void InstrumentWidgetMaskTab::clearMask() {
  clearShapes();
771
  m_instrWidget->getInstrumentActor().clearMasks();
772
773
774
775
776
  m_instrWidget->updateInstrumentView();
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
777
778
779
780
781
782
 * 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.
 */
783
Mantid::API::MatrixWorkspace_sptr
784
InstrumentWidgetMaskTab::createMaskWorkspace(bool invertMask, bool temp) const {
785
786
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::MatrixWorkspace_sptr inputWS =
787
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
788
789
790
  Mantid::API::MatrixWorkspace_sptr outputWS;
  const std::string outputWorkspaceName = generateMaskWorkspaceName(temp);

791
  auto alg = AlgorithmManager::Instance().create("ExtractMask", -1);
792
793
794
795
  alg->setProperty("InputWorkspace", inputWS);
  alg->setPropertyValue("OutputWorkspace", outputWorkspaceName);
  alg->execute();

796
  outputWS = std::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(
797
798
799
800
      Mantid::API::AnalysisDataService::Instance().retrieve(
          outputWorkspaceName));

  if (invertMask) {
Nick Draper's avatar
Nick Draper committed
801
802
    auto invertAlg =
        AlgorithmManager::Instance().create("BinaryOperateMasks", -1);
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
    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
843
844
 * Extract selected detectors to a new workspace
 */
845
846
void InstrumentWidgetMaskTab::extractDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
847
  std::vector<size_t> dets;
848
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
849
  const auto &actor = m_instrWidget->getInstrumentActor();
850
851
852
853
  QList<int> detectorIDs = actor.getDetIDs(dets);
  if (m_pixel->isChecked() || m_tube->isChecked())
    detectorIDs.append(m_detectorsToGroup);
  DetXMLFile mapFile(detectorIDs);
854
855
856
  std::string fname = mapFile();
  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
Nick Draper's avatar
Nick Draper committed
857
    auto alg = AlgorithmManager::Instance().create("GroupDetectors");
858
859
860
861
862
863
864
865
866
    alg->setPropertyValue("InputWorkspace", workspaceName);
    alg->setPropertyValue("MapFile", fname);
    alg->setPropertyValue("OutputWorkspace", workspaceName + "_selection");
    alg->execute();
  }
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
867
868
 * Sum selected detectors to a new workspace
 */
869
870
void InstrumentWidgetMaskTab::sumDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
871
  std::vector<size_t> dets;
872
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
873
874
875
876
  QList<int> detectorIDs = m_instrWidget->getInstrumentActor().getDetIDs(dets);
  if (m_pixel->isChecked() || m_tube->isChecked())
    detectorIDs.append(m_detectorsToGroup);
  DetXMLFile mapFile(detectorIDs, DetXMLFile::Sum);
877
878
879
880
  std::string fname = mapFile();

  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
Nick Draper's avatar
Nick Draper committed
881
    auto alg = AlgorithmManager::Instance().create("GroupDetectors");
882
883
884
885
886
887
888
889
890
    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
891
892
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
893
  if (!fname.isEmpty()) {
894
    std::vector<size_t> dets;
895
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
896
897
    DetXMLFile mapFile(m_instrWidget->getInstrumentActor().getDetIDs(dets),
                       DetXMLFile::Sum, fname);
898
899
900
901
  }
}

void InstrumentWidgetMaskTab::saveExcludeGroupToFile() {
Ian Bush's avatar
Ian Bush committed
902
903
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
904
  if (!fname.isEmpty()) {
905
    std::vector<size_t> dets;
906
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
907
908
    const auto &actor = m_instrWidget->getInstrumentActor();
    DetXMLFile mapFile(actor.getAllDetIDs(), actor.getDetIDs(dets), fname);
909
910
911
912
913
914
915
916
  }
}

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

/**
LamarMoore's avatar
LamarMoore committed
917
918
919
 * Toggle between different modes
 *
 */
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
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
939
940
941
942
943
944
 * 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
 */
945
946
947
948
949
950
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);
951
952
953
954
955
956
957
958
959

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

#endif

960
961
962
963
964
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
965
966
967
968
969
 * 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
 */
970
971
972
973
974
975
976
977
978
979
980
981
982
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",
983
        "XML files (*.xml);;All (*)");
984
985
986
987
988
989
990
991
992
    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",
993
          std::dynamic_pointer_cast<Mantid::API::Workspace>(outputWS));
994
995
996
      alg->setPropertyValue("OutputFile", fileName.toStdString());
      alg->execute();
    }
997
    Mantid::API::AnalysisDataService::Instance().remove(outputWS->getName());
998
999
1000
1001
1002
1003
  }
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
1004
1005
1006
1007
1008
 * 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
 */
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
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);
1025
      alg->setPropertyValue("InputWorkspace", outputWS->getName());
1026
1027
1028
1029
      alg->setPropertyValue("OutputFile", fileName.toStdString());
      alg->setProperty("Invert", false);
      alg->execute();
    }
1030
    Mantid::API::AnalysisDataService::Instance().remove(outputWS->getName());
1031
1032
1033
1034
1035
1036
  }
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
1037
1038
1039
1040
 * 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
 */
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
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 =
1053
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
1054
1055

  // Extract from MaskWorkspace to a TableWorkspace
1056
1057
  double xmin = m_instrWidget->getInstrumentActor().minBinValue();
  double xmax = m_instrWidget->getInstrumentActor().maxBinValue();
1058
1059
1060
1061
1062
1063
1064
1065
1066
  // 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 {
1067
    temptablews = std::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
1068
1069
        Mantid::API::AnalysisDataService::Instance().retrieve(
            outputWorkspaceName));
1070
  } catch (const Mantid::Kernel::Exception::NotFoundError &) {
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
    std::cout << "TableWorkspace " << outputWorkspaceName
              << " cannot be found in ADS."
              << ".\n";
  }

  if (temptablews)
    overwrite = true;

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

Nick Draper's avatar
Nick Draper committed
1082
  auto alg = AlgorithmManager::Instance().create("ExtractMaskToTable", -1);
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
  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 =
1098
        std::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
            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
1110
1111
1112
 * Generate a unique name for the mask worspace which will be saved in the ADS.
 * It will have a form MaskWorkspace[_#]
 */
1113
1114
1115
1116
1117
1118
1119
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";
Tom Titcombe's avatar
Tom Titcombe committed
1120
  for (auto &wsName : wsNames) {
1121
1122
    if (wsName.find(baseName) == 0) {
      int index = Mantid::Kernel::Strings::endsWithInt(wsName);
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
      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
1136
1137
1138
 * Sets the m_hasMaskToApply flag and
 * enables/disables the apply and clear buttons.
 */
1139
void InstrumentWidgetMaskTab::enableApplyButtons() {
1140
  const auto &instrActor = m_instrWidget->getInstrumentActor();
1141
1142
  auto mode = getMode();

1143
  m_maskBins = !instrActor.wholeRange();
1144
  bool hasMaskShapes = m_instrWidget->getSurface()->hasMasks();
1145
1146
  bool hasMaskWorkspace = instrActor.hasMaskWorkspace();
  bool hasBinMask = instrActor.hasBinMask();
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
  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);
  }
1166
  m_saveShapesToTable->setEnabled(hasMaskShapes);
1167
1168
1169
1170
1171
1172
  m_saveButton->setEnabled(hasDetectorMask && (!enableBinMasking));
  m_clearAll->setEnabled(hasMask);
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1173
1174
 * Sets tab activity to Select: select and modify shapes.
 */
1175
1176
1177
1178
1179
1180
void InstrumentWidgetMaskTab::setSelectActivity() {
  m_pointer->setChecked(true);
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1181
1182
 * It tab in masking, ROI or grouping mode?
 */
1183
InstrumentWidgetMaskTab::Mode InstrumentWidgetMaskTab::getMode() const {
1184
  if (m_masking_on->isChecked())
1185
    return Mode::Mask;
1186
  if (m_roi_on->isChecked())
1187
    return Mode::ROI;
1188
  if (m_grouping_on->isChecked())
1189
1190
1191
1192
1193
1194
    return Mode::Group;

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

/**
LamarMoore's avatar
LamarMoore committed
1195
1196
 * Border color.
 */
1197
1198
1199
1200
1201
1202
1203
1204
1205
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
1206
1207
 * Shape fill color.
 */
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
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
1220
1221
 * Store the mask defined by the shape tools to the helper m_maskWorkspace.
 */
1222
1223
void InstrumentWidgetMaskTab::storeDetectorMask(
    bool isROI, const std::vector<size_t> &onClickDets) {
1224
1225
1226
1227
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::IMaskWorkspace_sptr wsFresh;

1228
1229
  const auto &actor = m_instrWidget->getInstrumentActor();
  std::vector<size_t> dets;
1230
1231
1232
1233
1234
1235
  if (onClickDets.size() == 0) {
    // get detectors covered by the shapes
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
    m_pointer->setChecked(true);
    setActivity();
  }
1236
  dets.insert(dets.end(), onClickDets.begin(), onClickDets.end());
1237
1238
  if (!dets.empty()) {
    auto wsMask = actor.getMaskWorkspace();
1239
1240
1241
1242
1243
1244
1245
    // 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) {
1246
        wsFresh = std::dynamic_pointer_cast<Mantid::API::IMaskWorkspace>(
1247
1248
            actor.extractCurrentMask());
        actor.invertMaskWorkspace();
1249
1250
      }
    }
Lamar Moore's avatar
Lamar Moore committed
1251
    for (auto det : dets)
1252
      detList.insert(actor.getDetID(det));
1253
1254
1255

    if (!detList.empty()) {
      // try to mask each detector separately and ignore any failure
Lamar Moore's avatar
Lamar Moore committed
1256
      for (auto det : detList) {
1257
1258
        try {
          if (isROI && wsFresh) {
1259
1260
            if (wsMask->isMasked(det))
              wsFresh->setMasked(det);
1261
          } else {
1262
            wsMask->setMasked(det);
1263
1264
1265
1266
1267
1268
          }
        } catch (...) {
        }
      }
      if (isROI) {
        if (wsFresh)
1269
          m_instrWidget->getInstrumentActor().setMaskMatrixWorkspace(
1270
              std::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(wsFresh));
1271
        // need to invert the mask before displaying
1272
        m_instrWidget->getInstrumentActor().invertMaskWorkspace();
1273
1274
      }
      // update detector colours
1275
      m_instrWidget->getInstrumentActor().updateColors();
1276
1277
1278
      m_instrWidget->updateInstrumentDetectors();
    }
  }
1279
1280
1281
1282
  if (onClickDets.size() == 0) {
    // remove masking shapes
    clearShapes();
  }
1283
1284
1285
1286
  QApplication::restoreOverrideCursor();
}

void InstrumentWidgetMaskTab::storeBinMask() {
1287
  std::vector<size_t> dets;
1288
1289
1290
  // get detectors covered by the shapes
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
  // mask some bins
1291
  m_instrWidget->getInstrumentActor().addMaskBinsData(dets);
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
  // 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);
  }
}

Tom Titcombe's avatar
Tom Titcombe committed
1306
1307
void InstrumentWidgetMaskTab::changedIntegrationRange(double /*unused*/,
                                                      double /*unused*/) {
1308
1309
  enableApplyButtons();
}
1310

1311
/** Load mask tab state from a Mantid project file
1312
1313
1314
 * @param lines :: lines from the project file to load state from
 */
void InstrumentWidgetMaskTab::loadFromProject(const std::string &lines) {
1315
#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
1316
  API::TSVSerialiser tsv(lines);
1317

1318
1319
  if (!tsv.selectSection("masktab"))
    return;
1320

1321
1322
  std::string tabLines;
  tsv >> tabLines;
1323
  API::TSVSerialiser tab(tabLines);
1324

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

1329
1330
1331
1332
1333
1334
  tab.selectLine("ActiveTools");
  for (auto button : buttons) {
    bool value;
    tab >> value;
    button->setChecked(value);
  }
1335

1336
1337