SpecialWorkspace2D.h

#ifndef MANTID_DATAOBJECTS_SPECIALWORKSPACE2D_H_
#define MANTID_DATAOBJECTS_SPECIALWORKSPACE2D_H_
    

#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/SpectraDetectorMap.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/System.h"


namespace Mantid
{
namespace DataObjects
{

  /** An SpecialWorkspace2D is a specialized Workspace2D where
   * the Y value at each pixel will be used for a special meaning.
   * Specifically, by GroupingWorkspace, MaskWorkspace and
   * OffsetsWorkspace.
   *
   * The workspace has a single pixel per detector, and this cannot
   * be changed.
   * 
   */


  class BinaryOperator{
  public:
    enum e {AND, OR, XOR, NOT};
  };

  class DLLExport SpecialWorkspace2D  : public Workspace2D
  {
  public:
    SpecialWorkspace2D();
    SpecialWorkspace2D(Geometry::Instrument_const_sptr inst, const bool includeMonitors=false);
    ~SpecialWorkspace2D();
    
    /** Gets the name of the workspace type
    @return Standard string name  */
    virtual const std::string id() const {return "SpecialWorkspace2D";}


    double getValue(const detid_t detectorID) const;
    double getValue(const detid_t detectorID, const double defaultValue) const;

    void setValue(const detid_t detectorID, const double value, const double error=0.);

    detid_t getDetectorID(const std::size_t workspaceIndex) const;

    void binaryOperation(boost::shared_ptr<const SpecialWorkspace2D>& ws, const unsigned int operatortype);
    void binaryOperation(const unsigned int operatortype);

    void copyFrom(boost::shared_ptr<const SpecialWorkspace2D> sourcews);

  private:
    /// Private copy constructor. NO COPY ALLOWED
    SpecialWorkspace2D(const SpecialWorkspace2D&);
    /// Private copy assignment operator. NO ASSIGNMENT ALLOWED
    SpecialWorkspace2D& operator=(const SpecialWorkspace2D&);
    
    bool isCompatible(boost::shared_ptr<const SpecialWorkspace2D> ws);

    /// Non-const access to the spectra map is disallowed except by this classes constructor.
    Workspace2D::replaceSpectraMap;

  protected:

    virtual void init(const size_t &NVectors, const size_t &XLength, const size_t &YLength);

    /** Vector with all the detector IDs, in the same order as the workspace indices.
     * Therefore, detectorIDs[workspaceIndex] = that detector ID.  */
    std::vector<detid_t> detectorIDs;

    void binaryAND(boost::shared_ptr<const SpecialWorkspace2D> ws);
    void binaryOR(boost::shared_ptr<const SpecialWorkspace2D> ws);
    void binaryXOR(boost::shared_ptr<const SpecialWorkspace2D> ws);
    void binaryNOT();

    /// Map with key = detector ID, and value = workspace index.
    std::map<detid_t,std::size_t> detID_to_WI;
  };


  ///shared pointer to the SpecialWorkspace2D class
  typedef boost::shared_ptr<SpecialWorkspace2D> SpecialWorkspace2D_sptr;

  ///shared pointer to a const SpecialWorkspace2D
  typedef boost::shared_ptr<const SpecialWorkspace2D> SpecialWorkspace2D_const_sptr;

} // namespace Mantid
} // namespace DataObjects

#endif  /* MANTID_DATAOBJECTS_SPECIALWORKSPACE2D_H_ */