DataBlockComposite.h

#ifndef MANTID_DATAHANDLING_DATABLOCK_COMPOSITE_H_
#define MANTID_DATAHANDLING_DATABLOCK_COMPOSITE_H_

#include "MantidDataHandling/DataBlock.h"
#include "MantidDataHandling/DllConfig.h"

namespace Mantid
{
namespace DataHandling
{

/** DataBlockComposite: The DataBlockComposite handles a collection
    of DataBlocks. It represents a set of contiguous spectrum numbers
    which are to be consumed elsewhere.

Copyright © 2016 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source

This file is part of Mantid.

Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

File change history is stored at:
<https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport DataBlockComposite : public DataBlock
{
public:
    int64_t getMinSpectrumID() const override;
    void setMinSpectrumID(int64_t) override;

    int64_t getMaxSpectrumID() const override;
    void setMaxSpectrumID(int64_t) override;

    size_t getNumberOfSpectra() const override;
    size_t getNumberOfChannels() const override;
    int getNumberOfPeriods() const override;

    std::unique_ptr<DataBlockGenerator> getGenerator() const override;

    bool operator==(const DataBlockComposite &other) const;

    // DataBlockComposite only mehtods
    void addDataBlock(DataBlock dataBlock);
    std::vector<DataBlock> getDataBlocks();
    DataBlockComposite operator+(const DataBlockComposite &other);
    void removeSpectra(DataBlockComposite &toRemove);
    void truncate(int64_t specMin, int64_t specMax);
    std::vector<int64_t> getAllSpectrumNumbers();

private:
    std::vector<DataBlock> m_dataBlocks;
};

/**
* Populates a DataBlockComposite with DataBlocks which are extracted from a
* indexable collection (array-type). Note that std::is_array does not
* work on boost::shared_array which is one of the use cases. Hence this
* function could get abused. Monitor spectra get their own data block
* @param dataBlockComposite: the detector block composite which will get
* populated
* @param indexContainer: the container of indices
* @param nArray: the number of array elements
* @param numberOfPeriods: the number of periods
* @param numberOfChannels: the number of channels
* @param monitorSpectra: a collection of monitor spectrum numbers
*/
template <typename T>
void DLLExport
populateDataBlockCompositeWithContainer(DataBlockComposite &dataBlockComposite,
                                        T &indexContainer, int64_t nArray,
                                        int numberOfPeriods,
                                        size_t numberOfChannels,
                                        std::vector<int64_t> monitorSpectra)
{
    auto isMonitor = [&monitorSpectra](int64_t index) {
        return std::find(std::begin(monitorSpectra), std::end(monitorSpectra),
                         index) != std::end(monitorSpectra);
    };

    // Handles the case when an element is a monitor. It needs to crate a data
    // block
    // for potential specturm numbers before the monitor and a data block for
    // the
    // monitor itself
    struct HandleWhenElementIsMonitor {
        void
        operator()(Mantid::DataHandling::DataBlockComposite &dataBlockComposite,
                   int numberOfPeriods, size_t numberOfChannels,
                   int64_t previousValue, int64_t startValue)
        {
            if (previousValue - startValue > 0) {
                auto numberOfSpectra = previousValue
                                       - startValue; /* Should be from [start,
                                                        previousValue -1]*/
                DataBlock dataBlock(numberOfPeriods, numberOfSpectra,
                                    numberOfChannels);
                dataBlock.setMinSpectrumID(startValue);
                dataBlock.setMaxSpectrumID(previousValue - 1);
                dataBlockComposite.addDataBlock(dataBlock);
            }

            // Save out the monitor
            DataBlock dataBlock(numberOfPeriods, 1, numberOfChannels);
            dataBlock.setMinSpectrumID(previousValue);
            dataBlock.setMaxSpectrumID(previousValue);
            dataBlockComposite.addDataBlock(dataBlock);
        }
    };

    // Handles the case when the element made a jump, ie there seems to
    // be a gap between neighbouring spetrum numbers. Then we need to
    // write out this range as a data block.
    struct HandleWhenElementMadeAJump {
        void
        operator()(Mantid::DataHandling::DataBlockComposite &dataBlockComposite,
                   int numberOfPeriods, size_t numberOfChannels,
                   int64_t previousValue, int64_t startValue)
        {
            auto numberOfSpectra = previousValue - startValue + 1;
            DataBlock dataBlock(numberOfPeriods, numberOfSpectra,
                                numberOfChannels);
            dataBlock.setMinSpectrumID(startValue);
            dataBlock.setMaxSpectrumID(previousValue);
            dataBlockComposite.addDataBlock(dataBlock);
        }
    };

    HandleWhenElementIsMonitor handleWhenElementIsMonitor;
    HandleWhenElementMadeAJump handleWhenElementMadeAJump;

    auto startValue = indexContainer[0];
    auto previousValue = startValue;
    for (int64_t arrayIndex = 1; arrayIndex < nArray; ++arrayIndex) {
        // There are two ways to write data out. Either when we have a jump of
        // the indices or there is a monitor. In case of a monitor we also need
        // to clear the data that was potentially before the monitor.

        if (isMonitor(previousValue)) {
            handleWhenElementIsMonitor(dataBlockComposite, numberOfPeriods,
                                       numberOfChannels, previousValue,
                                       startValue);
            startValue = indexContainer[arrayIndex];
        } else if ((indexContainer[arrayIndex] - previousValue) != 1) {
            // We must have completed an interval, we create a DataBlock and add
            // it
            handleWhenElementMadeAJump(dataBlockComposite, numberOfPeriods,
                                       numberOfChannels, previousValue,
                                       startValue);
            startValue = indexContainer[arrayIndex];
        }

        // Set the previous value to the current value;
        previousValue = indexContainer[arrayIndex];
    }

    // The last interval would not have been added.
    if (isMonitor(previousValue)) {
        handleWhenElementIsMonitor(dataBlockComposite, numberOfPeriods,
                                   numberOfChannels, previousValue, startValue);
    } else {
        handleWhenElementMadeAJump(dataBlockComposite, numberOfPeriods,
                                   numberOfChannels, previousValue, startValue);
    }
}
}
}
#endif