Allow default loading of more than one Instrument Parameter File

[Owen Arnold]

Instrument Parameter Files shipped with Mantid, with the name InstrumentName_Parameters.xml, that live in the instrument directory are automatically loaded when mantid loads data for a specific instrument.

So e.g. if we have in the instrument folder:

HRPD_Instrument_1.xml HRPD_Instrument_2.xml HRPD_Instrument_3.xml HRPD_Parameters.xml

Then when any of the HRPD_Instrument_#.xml are loaded HRPD_Parameters.xml are then subsequenctly loaded.

Expand this so that if the instrument folder contains the files:

HRPD_Instrument_1.xml HRPD_Instrument_2.xml HRPD_Instrument_3.xml HRPD_Parameters.xml HRPD_Parameters_2.xml

then for this example HRPD_Parameters.xml is loaded after HRPD_Instrument_1.xml and HRPD_Instrument_3.xml are loaded and HRPD_Parameters_2.xml is loaded after HRPD_Instrument_2.xml.

Hence if a parameter file with a matching name exist than it takes precedence to the 'default' parameter file (which in the above example is HRPD_Parameters.xml)

Once implemented update IDF wiki accordingly

[Nick Draper]

Moved at the end of release 2.2

[Nick Draper]

Moved to milestone 2.4

[Karl Palmen]

A discussion of this at the 2012 Mantid Workshop suggested one parameter file might be sufficient.

[Anders Markvardsen]

Changed the ticket description according to suggestion at workshop

[Karl Palmen]

I believe that 'Instrument' in the filenames in the description needs to be 'Definition', else the change requested would have no effect in practice.

[Karl Palmen]

Implemented change to Parameter File Selection re #5635

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

Changeset: 6d454d295b769a7735b50e031617c27d268301be

[Karl Palmen]

Unit Test for Loading Instrument with Parameter File re #5635

This one tests an IDF file not in the instrument folder with something extra added to its name uses the default parameter file in the instrument folder, because no parameter file has this extra part in its name.

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

Changeset: 2b00027847b4d5e7b32f854372b4172bfa77c72a

[Karl Palmen]

Add further tests for Parameter File Selection re #5635 re #6281

Changeset: aa0d02c305752c02dbae97f629e2a1107321012c

[Karl Palmen]

Add 2 more unit tests and remove duplicate code re #5635 re #6281

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

Changeset: b3918a6583751723e83056373db828c06079b0de

[Karl Palmen]

Added One More Test re #5635 re #6281

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

Changeset: 97a44fcf130819bb487dafe3448de21fc24626e3

[Karl Palmen]

The original unit test did not check whether the parameter from the parameter file was successfully loaded, so would crash if the correct parameter file were not loaded. I modified this to make this check and if the parameter were not loaded it would give an informative message instead of attempting the other tests on the parameter.

This modification was included in all such tests.

[Karl Palmen]

Added test IDF file re #5635 re #6281

Changeset: 150dcec1577da8f7906ce9a24d04368c568251c9

[Karl Palmen]

I suggest this ticket be tested alongside #6281, because testing of the latter would entail a variation of testing this ticket.

Select an IDF file that uses a separate parameter file. Create a copy of that parameter file that has an effect you can observe when you load empty instrument with the IDF file (e.g. when you open the fit parameters window).

Create a copy of the IDF file with some extra characters after the "Definition" part of its name. Name the parameter file you created the same except for "Parameters" instead of definition. LoadEmptyInstrument with the new IDF file and check for the change that should occur with the new parameter file.

Create another copy of the IDF file with different characters after the "Definition" part and LoadEmpty instrument with it and check that the change does not occur and it is identical with the effect of LoadEmptyInstrument of the original IDF file.

Do this test with all the files in the instrument directory of your installation and again with all the files in some other folder.

[Karl Palmen]

Implemented change to Parameter File Selection re #5635

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

Changeset: 444c270c08d8748ab1b5037d0c4de3bca762a580

[Karl Palmen]

Unit Test for Loading Instrument with Parameter File re #5635

This one tests an IDF file not in the instrument folder with something extra added to its name uses the default parameter file in the instrument folder, because no parameter file has this extra part in its name.

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

Changeset: 0e705dbd41f07bcef1ae32ab802065488b68ea36

[Karl Palmen]

Add further tests for Parameter File Selection re #5635 re #6281

Changeset: 4e0adae4426c4dea7aa161cec351708ff2f4fe5d

[Karl Palmen]

Add 2 more unit tests and remove duplicate code re #5635 re #6281

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

Changeset: 48b96e3b3ace374281326bc2d3c62640c9092743

[Karl Palmen]

Added One More Test re #5635 re #6281

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

Changeset: 4467a586c0b7872d86f8efbfc6518f68d5d03069

[Karl Palmen]

Added test IDF file re #5635 re #6281

Changeset: 3439c55d60b326eb22c79f6a64a23dacb4dc12cc

[Nick Draper]

tested with altered files and

s=mtd["snap"]
print s
snap
i=s.getInstrument()
print i
<mantid.geometry._geometry.Instrument object at 0x0000000009675C18>
print i.getParameterNames()
set('centre-finder-step-size','default-incident-monitor-spectrum','default-transmission-monitor-spectrum','high-angle-detector-name','high-angle-detector-num-columns','high-angle-detector-num-rows','high-angle-detector-short-name','low-angle-detector-name','low-angle-detector-num-columns','low-angle-detector-num-rows','low-angle-detector-short-name')
print i.getStringParameter("low-angle-detector-name")
['outside directory  matching']

[Nick Draper]

and

s=mtd["snap"]
i=s.getInstrument()
print i.getStringParameter("low-angle-detector-name")
['outside directory not matching']

[Nick Draper]

and

s=mtd["snap"]
i=s.getInstrument()
print i.getStringParameter("low-angle-detector-name")
['rear-detector']

[Stuart Campbell]

This ticket has been transferred to github issue ​6481