Ticket #9783 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

EnginXFocus Parameter names

Reported by: Anders Markvardsen Owned by: Karl Palmen
Priority: critical Milestone: Release 3.2
Component: Diffraction Keywords:
Cc: saurabh.kabra@…, joe.kelleher@… Blocked By:
Blocking: #8368 Tester: Anders Markvardsen

Description (last modified by Karl Palmen) (diff)

The input workspace is entered through parameter Run, which is not the default input parameter name for a workspace.

Change the name of the input parameter (http://docs.mantidproject.org/nightly/algorithms/EnginXFocus-v1.html ) Run to InputWorkspace. Also change the order of the parameters so that OutputWorkspace appear as the second paramter.

I.e. change parameter from

{{ Run DetectorPositions Bank OutputWorkspace }}

to

{{ InputWorkspace OutputWorkspace DetectorPositions Bank }}

Note EnginXCalibrateFull and EnginXCalibrate may use this algorithm as a child algorithm

Change History

comment:1 Changed 6 years ago by Anders Markvardsen

  • Cc Kabra removed

comment:2 Changed 6 years ago by Karl Palmen

  • Status changed from new to assigned

comment:3 Changed 6 years ago by Karl Palmen

  • Status changed from assigned to inprogress

comment:4 Changed 6 years ago by Karl Palmen

  • Description modified (diff)
  • Summary changed from EnginXFocus to EnginXFocus Parameter names

comment:5 Changed 6 years ago by Karl Palmen

This algorithm has no unit test in .../code/Mantid/Framework/PythonInterface/test/python/plugins/algorithms.

comment:6 Changed 6 years ago by Karl Palmen

Make the changes specified re #9783

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: ffed16de3ae2c044103ee6fde552a3de6166384e

comment:7 Changed 6 years ago by Anders Markvardsen

  • Blocking 8368 added

comment:8 Changed 6 years ago by Karl Palmen

To test:

Run Mantid execute EnginXFocus as far as the dialog box. Verify that the first property/parameter is InputWorkspace and the next one OutputWorkspace and these are the two mandatory properties/parameters (shown in bold)

You may then run the algorithm.

Check that the documentation has been changed appropriately and makes without error for this algorithm.

You may run a variation of the usage example.

Check that any other python algorithm running this has a child algorithm has be modified appropriately.

comment:9 Changed 6 years ago by Karl Palmen

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:10 Changed 6 years ago by Anders Markvardsen

  • Status changed from verify to verifying
  • Tester set to Anders Markvardsen

comment:11 Changed 6 years ago by Anders Markvardsen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9783_engine_x_focus_properties'

Full changeset: 58f7681f782e5a96e50078c93aa86f54a04d40e7

comment:12 Changed 6 years ago by Anders Markvardsen

Running the updated usage example returned the expected output

comment:13 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10626

Note: See TracTickets for help on using tickets.