Associate ClusterImage (IMDHistoWorkspace) with a PeaksWorkspace

[Owen Arnold]

IntegratePeaksUsingClusters generates two useful output. An integrated peaks workspace, and a cluster image workspace. Both need to be used in combination at a later time, for example, when viewing the integrated volume in the SliceViewer.

I think that this is a subset of a more general problem, where we want to try to weakly tether an IMDHistoWorkspace to a a PeaksWorkspace.

Solving this is a key component of achieving #9375 now that #9428 is complete.

[Owen Arnold]

Spoke to Martyn about this, and he suggested that storing a boost weak pointer to the IMDHistoWorkspace_sptr would be a suitable strategy. PeaksWorkspace would need an associateImage method. We may well want to allow more than one IMDHistoWorkspace to be associated with a PeaksWorkspace to keep it generic. IPeaksWorkspace should be capable of returning the weak pointers, when requested so that they can attempt to be used. This is the generic part of the design.

For the IntegratePeaksUsingClusters case, we want to use the above, but we also want to add a flag to the IMDHistoWorkspace to indicate that it has been through this particular integration algorithm, or to mark it as a type of ClusterImage some how. That way when we retrieve the WeakPointers we can fetch the correct one containing the cluster ids.

[Owen Arnold]

The generic part should be implemented and reviewed prior to handling the IntegratePeaksUsingClusters specific case.

[Nick Draper]

Moved to Backlog at the code freeze of release 3.2

[Stuart Campbell]

This ticket has been transferred to github issue ​10312