/** Checks and retrieves the requested spectrum out of the input workspace
*
* @param inputWorkspace The input workspace
* @returns The unchanged input workspace (so that signature is the same as
*getMonitorWorkspace)
* @throw std::runtime_error If the properties are invalid
*/
MatrixWorkspace_sptr NormaliseToMonitor::getInWSMonitorSpectrum(
const MatrixWorkspace_sptr &inputWorkspace) {
// this is the index of the spectra within the workspace and we need to
// identify it either from DetID or from SpecID
// size_t spectra_num(-1);
// try monitor spectrum. If it is specified, it overrides everything
int monitorSpec = getProperty("MonitorSpectrum");
if (monitorSpec < 0) {
// Get hold of the monitor spectrum through detector ID
int monitorID = getProperty("MonitorID");
if (monitorID < 0) {
throw std::runtime_error(
"Both MonitorSpectrum and MonitorID can not be negative");
}
// set spectra of detector's ID of one selected monitor ID
std::vector<detid_t> detID(1, monitorID);
// got the index of correspondent spectra (should be only one).
auto indexList = inputWorkspace->getIndicesFromDetectorIDs(detID);
if (indexList.empty()) {
throw std::runtime_error(
"Can not find spectra, corresponding to the requested monitor ID");
}
if (indexList.size() > 1 && !m_scanInput) {
throw std::runtime_error("More then one spectrum corresponds to the "
"requested monitor ID. This is unexpected in a "
"non-scanning workspace.");
}
m_workspaceIndexes = indexList;
} else { // monitor spectrum is specified.
if (m_scanInput)
throw std::runtime_error("For a scanning input workspace the monitor ID "
"must be provided. Normalisation can not be "
"performed to a spectrum.");
const SpectraAxis *axis =
dynamic_cast<const SpectraAxis *>(inputWorkspace->getAxis(1));
if (!axis) {
throw std::runtime_error("Cannot retrieve monitor spectrum - spectrum "
"numbers not attached to workspace");
}
auto specs = axis->getSpectraIndexMap();
if (!specs.count(monitorSpec)) {
throw std::runtime_error("Input workspace does not contain spectrum "
"number given for MonitorSpectrum");
}
m_workspaceIndexes = std::vector<size_t>(1, specs[monitorSpec]);
}
return inputWorkspace;
}
void GroupDetectors::exec()
{
// Get the input workspace
const MatrixWorkspace_sptr WS = getProperty("Workspace");
std::vector<size_t> indexList = getProperty("WorkspaceIndexList");
std::vector<specid_t> spectraList = getProperty("SpectraList");
const std::vector<detid_t> detectorList = getProperty("DetectorList");
// Could create a Validator to replace the below
if ( indexList.empty() && spectraList.empty() && detectorList.empty() )
{
g_log.information(name() +
": WorkspaceIndexList, SpectraList, and DetectorList properties are all empty, no grouping done");
return;
}
// Bin boundaries need to be the same, so check if they actually are
if (!API::WorkspaceHelpers::commonBoundaries(WS))
{
g_log.error("Can only group if the histograms have common bin boundaries");
throw std::runtime_error("Can only group if the histograms have common bin boundaries");
}
// If the spectraList property has been set, need to loop over the workspace looking for the
// appropriate spectra number and adding the indices they are linked to the list to be processed
if ( ! spectraList.empty() )
{
WS->getIndicesFromSpectra(spectraList,indexList);
}// End dealing with spectraList
else if ( ! detectorList.empty() )
{
// Dealing with DetectorList
//convert from detectors to workspace indices
WS->getIndicesFromDetectorIDs(detectorList, indexList);
}
if ( indexList.empty() )
{
g_log.warning("Nothing to group");
return;
}
const size_t vectorSize = WS->blocksize();
const specid_t firstIndex = static_cast<specid_t>(indexList[0]);
ISpectrum * firstSpectrum = WS->getSpectrum(firstIndex);
setProperty("ResultIndex",firstIndex);
// loop over the spectra to group
Progress progress(this, 0.0, 1.0, static_cast<int>(indexList.size()-1));
for (size_t i = 0; i < indexList.size()-1; ++i)
{
// The current spectrum
const size_t currentIndex = indexList[i+1];
ISpectrum * spec = WS->getSpectrum(currentIndex);
// Add the current detector to belong to the first spectrum
firstSpectrum->addDetectorIDs(spec->getDetectorIDs());
// Add up all the Y spectra and store the result in the first one
// Need to keep the next 3 lines inside loop for now until ManagedWorkspace mru-list works properly
MantidVec &firstY = WS->dataY(firstIndex);
MantidVec::iterator fYit;
MantidVec::iterator fEit = firstSpectrum->dataE().begin();
MantidVec::iterator Yit = spec->dataY().begin();
MantidVec::iterator Eit = spec->dataE().begin();
for (fYit = firstY.begin(); fYit != firstY.end(); ++fYit, ++fEit, ++Yit, ++Eit)
{
*fYit += *Yit;
// Assume 'normal' (i.e. Gaussian) combination of errors
*fEit = sqrt( (*fEit)*(*fEit) + (*Eit)*(*Eit) );
}
// Now zero the now redundant spectrum and set its spectraNo to indicate this (using -1)
// N.B. Deleting spectra would cause issues for ManagedWorkspace2D, hence the the approach taken here
spec->dataY().assign(vectorSize,0.0);
spec->dataE().assign(vectorSize,0.0);
spec->setSpectrumNo(-1);
spec->clearDetectorIDs();
progress.report();
}
}
