Ticket #1810 (closed: fixed)

Opened 10 years ago

Last modified 5 years ago

CreateWorkspace: YUnit does not appear to get set

Reported by: Janik Zikovsky Owned by: Michael Whitty
Priority: minor Milestone: Iteration 26
Component: Mantid Keywords:
Cc: Blocked By:
Blocking: Tester: Russell Taylor

Description

At least when run from MantidPlot, the Y unit does not show up in the workspace property tree or when you plot a spectrum, as the Y axis. Refs #1739

Change History

comment:1 Changed 10 years ago by Janik Zikovsky

  • Priority changed from major to minor

comment:2 Changed 10 years ago by Michael Whitty

I think this is perhaps something to do with there being a blank spectra-detector map created for the Y-Axis. If there's to be something other than spectra number in this position, such as a TextAxis (possibly the most useful from my perspective), then there will need to be some sort of parsing in the part of the algorithm where it currently tries (and fails) to create a YAxis.

comment:3 Changed 10 years ago by Michael Whitty

  • Status changed from new to accepted

comment:4 Changed 10 years ago by Michael Whitty

(In [7312]) Adding YUnitValues parameter to CreateWorkspace algorithm. Can now assign either a numeric or text axis to the created workspace. units do not show in the workspace dock for some reason but will show on "plot bin" of data. refs #1810

comment:5 Changed 10 years ago by Michael Whitty

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

comment:6 Changed 10 years ago by Michael Whitty

  • Status changed from verify to reopened
  • Resolution fixed deleted

noticed that the setting of spectra number doesn't work as I'd thought

comment:7 Changed 10 years ago by Michael Whitty

  • Status changed from reopened to accepted

comment:8 Changed 10 years ago by Michael Whitty

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

(In [8053]) fixes #1810 - CreateWorkspace Y Axis.

comment:9 Changed 10 years ago by Russell Taylor

  • Status changed from verify to verifying
  • Tester set to Russell Taylor

comment:10 Changed 10 years ago by Russell Taylor

  • Status changed from verifying to reopened
  • Resolution fixed deleted

Mantid is a bit confusing in this regard. What's referred to as the "Y Axis" in the workspace dock is the unit of the data point values (e.g. counts). If you like, when viewing a workspace matrix it's an axis coming out the screen towards you. It's also the vertical axis when doing a 'plot spectrum'. The x axis is across the workspace, and down the workspace is another, unspecified axis - the one you're referring to as a Y in this algorithm.

The Mantid 'Y axis' unit is just a string and is set by the setYUnit method on MatrixWorkspace. I don't know what you want in this algorithm, but it should either be changed to set the YUnit string or the name of the property should change.

comment:11 Changed 10 years ago by Michael Whitty

then what is the terminology for the axis that generally contains Spectra Numbers? That's what the algorithm will be setting a unit on, if the user gives values. It can also be "Text" to give a text axis.

I'd rather not go changing the parameter names at this stage, as there's several UI scripts I've built that rely on this stuff.

comment:12 Changed 10 years ago by Nick Draper

  • Milestone changed from Iteration 26 to Iteration 27

Bulk move of tickets to iteration 27, if your ticket is essential for Iteration 26 then move it back.

comment:13 Changed 10 years ago by Michael Whitty

  • Milestone changed from Iteration 27 to Iteration 26

this one is for it 26.

comment:14 Changed 10 years ago by Michael Whitty

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

(In [8165]) fixes #1810 - changing "YAxis"/"YUnit" to "VerticalAxis*" after discussion with Nick to avoid potential confusion with our DataY naming convention. change to script file to work with these changes. I did a search on the Python files in PythonAPI and didn't find any other uses of old parameter names.

comment:15 Changed 10 years ago by Russell Taylor

  • Status changed from verify to verifying

comment:16 Changed 10 years ago by Steve Williams

"VerticalAxis" isn't obvious to me, saying SpectraAxis in the GUI would be the most obvious, although I know we have a class of that name.

About sepctra numbers, if you leave the VerticalAxis blank it defaults to Spectra Number, which is good. But should we have an explict Spectra Number entry as users are aware of, and use, spectra numbers.

comment:17 Changed 10 years ago by Russell Taylor

  • Status changed from verifying to closed

This now does what it says. I expect this algorithm will evolve further in the future.

'VerticalAxis' may not be a great name, but I can't say I can think of a better one. SpectraAxis would not be good because (a) it isn't, necessarily & (b) the concept of spectrum numbers is essentially an ISIS one, for historic reasons.

comment:18 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 2657

Note: See TracTickets for help on using tickets.