InstrumentWidgetMaskTab.cpp 53 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"
Mathieu Tillet's avatar
Mathieu Tillet committed
22
#include "MantidGeometry/Instrument/ComponentInfo.h"
23
24
25
#include "MantidKernel/Logger.h"
#include "MantidKernel/Strings.h"

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

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

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

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

72
73
using Mantid::API::AlgorithmManager;

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

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

Mathieu Tillet's avatar
Mathieu Tillet committed
140
141
142
143
144
145
146
147
148
149
150
151
  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");

152
153
154
155
156
157
158
  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
159
160
161
162
163
164
165
166
167
168
169
170
171
  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
172
  toolBox->setColumnStretch(8, 1);
Mathieu Tillet's avatar
Mathieu Tillet committed
173
  toolBox->setSpacing(2);
174
175
176
177
178
179
180

  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
181
  connect(m_sector, SIGNAL(clicked()), this, SLOT(setActivity()));
Mathieu Tillet's avatar
Mathieu Tillet committed
182
  connect(m_tube, SIGNAL(clicked()), this, SLOT(setActivity()));
183
  connect(m_pixel, SIGNAL(clicked()), this, SLOT(setActivity()));
Mathieu Tillet's avatar
Mathieu Tillet committed
184
  connect(m_free_draw, SIGNAL(clicked()), this, SLOT(setActivity()));
185
186
187
188
189
190
191
192
193
194
  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()));
195
  auto *radioLayout = new QHBoxLayout();
196
197
198
199
  radioLayout->addWidget(m_masking_on);
  radioLayout->addWidget(m_roi_on);
  radioLayout->addWidget(m_grouping_on);
  radioLayout->setMargin(0);
200
  auto *radioGroup = new QGroupBox();
201
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
  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

227
  m_applyToData = new QPushButton("Apply to Data (Cannot be reverted)");
228
229
230
231
232
233
234
235
  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()));

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

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

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

  m_sum_to_workspace = new QAction("Sum detectors to workspace", this);
  m_sum_to_workspace->setToolTip("Sum detectors to workspace.");
314
  connect(m_sum_to_workspace, SIGNAL(triggered()), this,
315
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
          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 *)));

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

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

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

372
373
374
375
InstrumentWidgetMaskTab::~InstrumentWidgetMaskTab() {
  m_browser->unsetFactoryForManager(m_doubleManager);
}

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

/**
LamarMoore's avatar
LamarMoore committed
456
457
 * Set tab's activity based on the currently selected tool button.
 */
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
499
500
501
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
502
503
504
505
506
507
508
509
  } 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);

510
511
512
513
514
515
  } 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
516
  } else if (m_pixel->isChecked()) {
517
    m_activity = Pixel;
518
519
    m_instrWidget->getSurface()->setInteractionMode(
        ProjectionSurface::PickSingleMode);
Mathieu Tillet's avatar
Mathieu Tillet committed
520
521
522
523
524
525
526
    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);
  }
527
528
529
  m_instrWidget->updateInfoText();
}

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

541
542
  size_t parent;

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

547
548
  if (m_masking_on->isChecked() || m_roi_on->isChecked()) {
    if (m_tube->isChecked()) {
Mathieu Tillet's avatar
Mathieu Tillet committed
549
550
551
      if (!componentInfo.hasParent(pickID)) {
        return;
      }
552
      parent = componentInfo.parent(pickID);
553
      detectorsId = componentInfo.detectorsInSubtree(parent);
Mathieu Tillet's avatar
Mathieu Tillet committed
554
    }
555
    storeDetectorMask(m_roi_on->isChecked(), detectorsId);
556

557
558
559
560
561
562
563
564
565
  } 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;
      }
566
      parent = componentInfo.parent(pickID);
567
568
      const auto dets =
          actor.getDetIDs(componentInfo.detectorsInSubtree(parent));
569
570
571
572
      m_detectorsToGroup.clear();
      for (auto det : dets)
        m_detectorsToGroup.append(det);
    }
Mathieu Tillet's avatar
Mathieu Tillet committed
573
  }
574

Mathieu Tillet's avatar
Mathieu Tillet committed
575
576
577
578
579
  // update detector colours
  m_instrWidget->getInstrumentActor().updateColors();
  m_instrWidget->updateInstrumentDetectors();
  QApplication::restoreOverrideCursor();
  enableApplyButtons();
580
581
582
583
584
585
586

  if (m_grouping_on->isChecked()) {
    if (m_pixel->isChecked()) {
      m_instrWidget->updateInfoText(
          QString("Pixel %0 picked for grouping").arg(pickID));

    } else if (m_tube->isChecked()) {
Mathieu Tillet's avatar
Mathieu Tillet committed
587
588
589
590
      QString message = QString("Component %0 picked for grouping")
                            .arg(QString::fromStdString(
                                componentInfo.componentID(parent)->getName()));
      m_instrWidget->updateInfoText(message);
591
592
    }
  }
593
594
}

595
/**
LamarMoore's avatar
LamarMoore committed
596
597
 * Slot responding on creation of a new masking shape.
 */
598
599
600
601
602
603
604
605
606
607
void InstrumentWidgetMaskTab::shapeCreated() {
  if (!isVisible())
    return;
  if (m_activity != DrawFree) {
    setSelectActivity();
  }
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
608
609
 * Slot responding on selection of a new masking shape.
 */
610
611
612
void InstrumentWidgetMaskTab::shapeSelected() { setProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
613
614
 * Slot responding on deselecting all masking shapes.
 */
615
616
617
void InstrumentWidgetMaskTab::shapesDeselected() { clearProperties(); }

/**
LamarMoore's avatar
LamarMoore committed
618
619
 * Slot responding on a change of a masking shape.
 */
620
621
622
623
624
625
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();
626
627
628
629
630

  m_doubleManager->setValue(m_left, std::min(rect.x0(), rect.x1()));
  m_doubleManager->setValue(m_top, std::max(rect.y0(), rect.y1()));
  m_doubleManager->setValue(m_right, std::max(rect.x0(), rect.x1()));
  m_doubleManager->setValue(m_bottom, std::min(rect.y0(), rect.y1()));
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
  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
650
651
 * Slot responding on removing all masking shapes.
 */
652
653
654
void InstrumentWidgetMaskTab::shapesCleared() { enableApplyButtons(); }

/**
LamarMoore's avatar
LamarMoore committed
655
656
 * Removes the mask shapes from the screen.
 */
657
658
659
660
661
void InstrumentWidgetMaskTab::clearShapes() {
  m_instrWidget->getSurface()->clearMask();
  setSelectActivity();
}

662
void InstrumentWidgetMaskTab::showEvent(QShowEvent * /*unused*/) {
663
664
665
666
667
668
669
670
671
672
673
674
  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();
675
676
677
678
  m_left = nullptr;
  m_top = nullptr;
  m_right = nullptr;
  m_bottom = nullptr;
679
  m_rotation = nullptr;
680
681
682
683
684
685
686
}

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

  // bounding rect property
687
  QtProperty *boundingRectGroup = m_groupManager->addProperty("Bounding Rect");
688
689
690
691
692
  m_browser->addProperty(boundingRectGroup);
  m_left = addDoubleProperty("left");
  m_top = addDoubleProperty("top");
  m_right = addDoubleProperty("right");
  m_bottom = addDoubleProperty("bottom");
693
  m_rotation = addDoubleProperty("rotation");
694
695
696
697
  boundingRectGroup->addSubProperty(m_left);
  boundingRectGroup->addSubProperty(m_top);
  boundingRectGroup->addSubProperty(m_right);
  boundingRectGroup->addSubProperty(m_bottom);
698
  boundingRectGroup->addSubProperty(m_rotation);
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

  // 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;
  }

724
725
726
  //rotation property
  m_doubleManager->setValue(m_rotation, m_instrWidget->getSurface()->getCurrentBoundingRotation());

727
728
729
  shapeChanged();
}

730
731
732
733
734
735
736
/**
 * Save shapes to a table workspace
 */
void InstrumentWidgetMaskTab::saveShapesToTable() const {
  m_instrWidget->getSurface()->saveShapesToTableWorkspace();
}

737
738
739
void InstrumentWidgetMaskTab::doubleChanged(QtProperty *prop) {
  if (!m_userEditing)
    return;
740

741
  if (prop == m_left || prop == m_top || prop == m_right || prop == m_bottom || prop == m_rotation) {
742
743
744
745
746
747
748
749
750
751
752
    m_userEditing = false;
    double x0 = std::min(m_doubleManager->value(m_left),
                         m_doubleManager->value(m_right));
    double x1 = std::max(m_doubleManager->value(m_left),
                         m_doubleManager->value(m_right));
    double y0 = std::min(m_doubleManager->value(m_top),
                         m_doubleManager->value(m_bottom));
    double y1 = std::max(m_doubleManager->value(m_top),
                         m_doubleManager->value(m_bottom));

    QRectF rect(QPointF(x0, y0), QPointF(x1, y1));
753
    m_instrWidget->getSurface()->setCurrentBoundingRect(RectF(rect));
754
    m_instrWidget->getSurface()->setCurrentBoundingRotation(m_doubleManager->value(m_rotation));
755

756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
  } 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);
      }
    }
  }
774
775
  // when the user validates the field's edit, the view is immediatly updated
  m_instrWidget->updateInstrumentView();
776
777
778
779
  m_instrWidget->update();
}

/**
LamarMoore's avatar
LamarMoore committed
780
781
782
 * Apply the constructed mask to the data workspace. This operation cannot be
 * reverted.
 */
783
784
785
void InstrumentWidgetMaskTab::applyMask() {
  storeMask();
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
786
  m_instrWidget->getInstrumentActor().applyMaskWorkspace();
787
  m_instrWidget->setupColorMap();
788
789
790
791
792
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
793
794
 * Apply the constructed mask to the view only.
 */
795
796
void InstrumentWidgetMaskTab::applyMaskToView() {
  storeMask();
797
  m_instrWidget->setupColorMap();
798
799
800
801
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
802
803
 * Remove all masking that has not been applied to the data workspace.
 */
804
805
void InstrumentWidgetMaskTab::clearMask() {
  clearShapes();
Mathieu Tillet's avatar
Mathieu Tillet committed
806
  m_detectorsToGroup.clear();
807
  m_instrWidget->getInstrumentActor().clearMasks();
Mathieu Tillet's avatar
Mathieu Tillet committed
808
  m_instrWidget->getInstrumentActor().updateColors();
809
  m_instrWidget->setupColorMap();
810
811
812
813
814
  m_instrWidget->updateInstrumentView();
  enableApplyButtons();
}

/**
LamarMoore's avatar
LamarMoore committed
815
816
817
818
819
820
 * 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.
 */
821
Mantid::API::MatrixWorkspace_sptr
822
InstrumentWidgetMaskTab::createMaskWorkspace(bool invertMask, bool temp) const {
823
824
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::MatrixWorkspace_sptr inputWS =
825
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
826
827
828
  Mantid::API::MatrixWorkspace_sptr outputWS;
  const std::string outputWorkspaceName = generateMaskWorkspaceName(temp);

829
  auto alg = AlgorithmManager::Instance().create("ExtractMask", -1);
830
831
832
833
  alg->setProperty("InputWorkspace", inputWS);
  alg->setPropertyValue("OutputWorkspace", outputWorkspaceName);
  alg->execute();

834
  outputWS = std::dynamic_pointer_cast<Mantid::API::MatrixWorkspace>(
835
836
837
838
      Mantid::API::AnalysisDataService::Instance().retrieve(
          outputWorkspaceName));

  if (invertMask) {
Nick Draper's avatar
Nick Draper committed
839
840
    auto invertAlg =
        AlgorithmManager::Instance().create("BinaryOperateMasks", -1);
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
    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
881
882
 * Extract selected detectors to a new workspace
 */
883
884
void InstrumentWidgetMaskTab::extractDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
885
  std::vector<size_t> dets;
886
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
887
  const auto &actor = m_instrWidget->getInstrumentActor();
888
889
890
891
  QList<int> detectorIDs = actor.getDetIDs(dets);
  if (m_pixel->isChecked() || m_tube->isChecked())
    detectorIDs.append(m_detectorsToGroup);
  DetXMLFile mapFile(detectorIDs);
892
893
894
  std::string fname = mapFile();
  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
Nick Draper's avatar
Nick Draper committed
895
    auto alg = AlgorithmManager::Instance().create("GroupDetectors");
896
897
898
899
900
901
902
903
904
    alg->setPropertyValue("InputWorkspace", workspaceName);
    alg->setPropertyValue("MapFile", fname);
    alg->setPropertyValue("OutputWorkspace", workspaceName + "_selection");
    alg->execute();
  }
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
905
906
 * Sum selected detectors to a new workspace
 */
907
908
void InstrumentWidgetMaskTab::sumDetsToWorkspace() {
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
909
  std::vector<size_t> dets;
910
  m_instrWidget->getSurface()->getMaskedDetectors(dets);
911
912
913
914
  QList<int> detectorIDs = m_instrWidget->getInstrumentActor().getDetIDs(dets);
  if (m_pixel->isChecked() || m_tube->isChecked())
    detectorIDs.append(m_detectorsToGroup);
  DetXMLFile mapFile(detectorIDs, DetXMLFile::Sum);
915
916
917
918
  std::string fname = mapFile();

  if (!fname.empty()) {
    std::string workspaceName = m_instrWidget->getWorkspaceName().toStdString();
Nick Draper's avatar
Nick Draper committed
919
    auto alg = AlgorithmManager::Instance().create("GroupDetectors");
920
921
922
923
924
925
926
927
928
    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
929
930
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
931
  if (!fname.isEmpty()) {
932
    std::vector<size_t> dets;
933
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
934
935
    DetXMLFile mapFile(m_instrWidget->getInstrumentActor().getDetIDs(dets),
                       DetXMLFile::Sum, fname);
936
937
938
939
  }
}

void InstrumentWidgetMaskTab::saveExcludeGroupToFile() {
Ian Bush's avatar
Ian Bush committed
940
941
  QString fname = m_instrWidget->getSaveFileName("Save grouping file",
                                                 "XML files (*.xml);;All (*)");
942
  if (!fname.isEmpty()) {
943
    std::vector<size_t> dets;
944
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
945
946
    const auto &actor = m_instrWidget->getInstrumentActor();
    DetXMLFile mapFile(actor.getAllDetIDs(), actor.getDetIDs(dets), fname);
947
948
949
950
951
952
953
954
  }
}

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

/**
LamarMoore's avatar
LamarMoore committed
955
956
957
 * Toggle between different modes
 *
 */
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
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
977
978
979
980
981
982
 * 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
 */
983
984
985
986
987
988
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);
989
990
991
992
993
994
995
996
997

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

#endif

998
999
1000
1001
1002
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

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

/**
LamarMoore's avatar
LamarMoore committed
1042
1043
1044
1045
1046
 * 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
 */
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
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);
1063
      alg->setPropertyValue("InputWorkspace", outputWS->getName());
1064
1065
1066
1067
      alg->setPropertyValue("OutputFile", fileName.toStdString());
      alg->setProperty("Invert", false);
      alg->execute();
    }
1068
    Mantid::API::AnalysisDataService::Instance().remove(outputWS->getName());
1069
1070
1071
1072
1073
1074
  }
  enableApplyButtons();
  QApplication::restoreOverrideCursor();
}

/**
LamarMoore's avatar
LamarMoore committed
1075
1076
1077
1078
 * 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
 */
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
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 =
1091
      m_instrWidget->getInstrumentActor().getMaskMatrixWorkspace();
1092
1093

  // Extract from MaskWorkspace to a TableWorkspace
1094
1095
  double xmin = m_instrWidget->getInstrumentActor().minBinValue();
  double xmax = m_instrWidget->getInstrumentActor().maxBinValue();
1096
1097
1098
1099
1100
1101
1102
1103
1104
  // 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 {
1105
    temptablews = std::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
1106
1107
        Mantid::API::AnalysisDataService::Instance().retrieve(
            outputWorkspaceName));
1108
  } catch (const Mantid::Kernel::Exception::NotFoundError &) {
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
    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
1120
  auto alg = AlgorithmManager::Instance().create("ExtractMaskToTable", -1);
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
  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 =
1136
        std::dynamic_pointer_cast<Mantid::API::ITableWorkspace>(
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
            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
1148
1149
1150
 * Generate a unique name for the mask worspace which will be saved in the ADS.
 * It will have a form MaskWorkspace[_#]
 */
1151
1152
1153
1154
1155
1156
1157
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
1158
  for (auto &wsName : wsNames) {
1159
1160
    if (wsName.find(baseName) == 0) {
      int index = Mantid::Kernel::Strings::endsWithInt(wsName);
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
      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
1174
1175
1176
 * Sets the m_hasMaskToApply flag and
 * enables/disables the apply and clear buttons.
 */
1177
void InstrumentWidgetMaskTab::enableApplyButtons() {
1178
  const auto &instrActor = m_instrWidget->getInstrumentActor();
1179
1180
  auto mode = getMode();

1181
  m_maskBins = !instrActor.wholeRange();
1182
  bool hasMaskShapes = m_instrWidget->getSurface()->hasMasks();
1183
1184
  bool hasMaskWorkspace = instrActor.hasMaskWorkspace();
  bool hasBinMask = instrActor.hasBinMask();
1185
1186
  bool hasDetectorMask = hasMaskShapes || hasMaskWorkspace;
  bool hasMask = hasDetectorMask || hasBinMask;
Mathieu Tillet's avatar
Mathieu Tillet committed
1187
  bool canGroup = (m_detectorsToGroup.size() != 0) && (mode == Mode::Group);
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
  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);
  }
1204
  m_saveShapesToTable->setEnabled(hasMaskShapes);
Mathieu Tillet's avatar
Mathieu Tillet committed
1205
1206
1207
  m_saveButton->setEnabled((hasDetectorMask || canGroup) &&
                           (!enableBinMasking));
  m_clearAll->setEnabled(hasMask || canGroup);
1208
1209
1210
1211
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1212
1213
 * Sets tab activity to Select: select and modify shapes.
 */
1214
1215
1216
1217
1218
1219
void InstrumentWidgetMaskTab::setSelectActivity() {
  m_pointer->setChecked(true);
  setActivity();
}

/**
LamarMoore's avatar
LamarMoore committed
1220
1221
 * It tab in masking, ROI or grouping mode?
 */
1222
InstrumentWidgetMaskTab::Mode InstrumentWidgetMaskTab::getMode() const {
1223
  if (m_masking_on->isChecked())
1224
    return Mode::Mask;
1225
  if (m_roi_on->isChecked())
1226
    return Mode::ROI;
1227
  if (m_grouping_on->isChecked())
1228
1229
1230
1231
1232
1233
    return Mode::Group;

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

/**
LamarMoore's avatar
LamarMoore committed
1234
1235
 * Border color.
 */
1236
1237
1238
1239
1240
1241
1242
1243
1244
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
1245
1246
 * Shape fill color.
 */
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
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
1259
1260
 * Store the mask defined by the shape tools to the helper m_maskWorkspace.
 */
1261
1262
void InstrumentWidgetMaskTab::storeDetectorMask(
    bool isROI, const std::vector<size_t> &onClickDets) {
1263
1264
1265
1266
  QApplication::setOverrideCursor(QCursor(Qt::WaitCursor));
  m_instrWidget->updateInstrumentView(); // to refresh the pick image
  Mantid::API::IMaskWorkspace_sptr wsFresh;

1267
1268
  const auto &actor = m_instrWidget->getInstrumentActor();
  std::vector<size_t> dets;
1269
1270
1271
1272
1273
1274
  if (onClickDets.size() == 0) {
    // get detectors covered by the shapes
    m_instrWidget->getSurface()->getMaskedDetectors(dets);
    m_pointer->setChecked(true);
    setActivity();
  }
1275
  dets.insert(dets.end(), onClickDets.begin(), onClickDets.end());
1276
1277
  if (!dets.empty()) {
    auto wsMask = actor.getMaskWorkspace();
1278
1279
1280
1281
1282
1283
1284
    // 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) {
1285
        wsFresh = std::dynamic_pointer_cast<Mantid::API::IMaskWorkspace>(
1286
1287
            actor.extractCurrentMask());
        actor.invertMaskWorkspace();
1288
1289
      }
    }
Lamar Moore's avatar
Lamar Moore committed
1290
    for (auto det : dets)
1291
      detList.insert(actor.getDetID(det));
1292
1293
1294

    if (!detList.empty()) {
      // try to mask each detector separately and ignore any failure
Lamar Moore's avatar
Lamar Moore committed
1295
      for (auto det : detList) {
1296
1297
        try {
          if (isROI && wsFresh) {
1298
1299
            if (wsMask->isMasked(det))
              wsFresh->setMasked(det);
1300
          } else {
1301
            wsMask->setMasked(det);
1302
1303
1304
1305
1306
1307
          }
        } catch (...) {
        }
      }
      if (isROI) {
        if (wsFresh)
1308
          m_instrWidget->getInstrumentActor().setMaskMatrixWorkspace(