Ticket #7962 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Document and Simplify CombineMulti

Reported by: Owen Arnold Owned by: Owen Arnold
Priority: major Milestone: Release 3.0
Component: Reflectometry Keywords:
Cc: Blocked By:
Blocking: #7982 Tester: Gesner Passos

Description

At the end of the last iteration CombineMulti.py was moved to API v2 and put under system test. This script should now be simplified, refactored and documented. This is a necessary step to extracting a working Stitch1D algorithm that could work for uniformly and non-uniformly rebinned data.

Change History

comment:1 Changed 7 years ago by Owen Arnold

  • Status changed from new to inprogress

comment:2 Changed 7 years ago by Owen Arnold

  • Milestone changed from Backlog to Release 3.0

comment:3 Changed 7 years ago by Owen Arnold

refs #7962. Provide documentation for functions.

Start cleanup. Add new method which wraps original combine2 method, so that workspaces rather than workspace keys can be dealt with.

Changeset: a762dc8ef61d3bdcd324e14b43d7bb28ef944590

comment:4 Changed 7 years ago by Owen Arnold

refs #7962. Remove magic naming strings from combine2.

These magic strings make the code completely unreadable, so I'm refactoring them out.

Changeset: af46c3b88d7ff4019eec064e94d9a3d867cba9b8

comment:5 Changed 7 years ago by Owen Arnold

refs #7962. Refactor combine2 method.

Is now more pythonic. Utilise MatrixWorkspace algebra where possible. Explicitly indicate that masking is occurring in the latter MultiplyRange calls. Add Documentation for key pieces.

Changeset: ab1d24ac6205437be2a0a3d7a984b235db8a3950

comment:6 Changed 7 years ago by Owen Arnold

refs #7962. Simplify the script as much as possible.

Changeset: d559655209ba30464f4471436bb811074dc7a647

comment:7 Changed 7 years ago by Owen Arnold

refs #7962. Do not modify input workspaces as part of this script.

Changeset: 4669c94e1d93141ed6091a108eba9182b365362f

comment:8 Changed 7 years ago by Owen Arnold

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

Tester: Please do not attempt to verify until at least 20th September, as a run of the system tests will be required to check that the changes have not broken anything.

Aside from running the system tests, a code review should be applied to these changes.

comment:9 Changed 7 years ago by Owen Arnold

  • Blocking 7982 added

comment:10 Changed 7 years ago by Gesner Passos

  • Status changed from verify to verifying
  • Tester set to Gesner Passos

comment:11 Changed 7 years ago by Gesner Passos

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/7962_combine_multi'

comment:12 Changed 7 years ago by Gesner Passos

It definitely improved the readability of the code and made it much more easier to understand and to follow. It also simplified the code.

comment:13 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 8807

Note: See TracTickets for help on using tickets.