Refs #10627 Adding custom auto color scaling for multiple workspaces

Code/Mantid/Vates/ParaviewPlugins/ParaViewFilters/ScaleWorkspace/vtkScaleWorkspace.cxx

@@ -88,4 +88,4 @@ void vtkScaleWorkspace::SetZScaling(double zScaling)
     this->Modified();
     m_zScaling = zScaling;
   }
-}
+}
\ No newline at end of file

Code/Mantid/Vates/ParaviewPlugins/ParaViewFilters/SplatterPlot/SplatterPlot.xml

@@ -29,6 +29,28 @@
             The set the viewing limit to the top percentile of the denses boxes.
          </Documentation>
       </DoubleVectorProperty>
+	  <DoubleVectorProperty 
+        name="MinValue"
+		command="GetMinValue"
+        information_only="1">
+        <Documentation>
+          Minimum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	  <DoubleVectorProperty 
+        name="MaxValue"
+		command="GetMaxValue"
+        information_only="1">
+        <Documentation>
+          Maximum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	  <StringVectorProperty
+         name="Instrument"
+         command="GetInstrument"
+         number_of_elements="1"
+         information_only="1">
+       </StringVectorProperty>
     </SourceProxy>
   </ProxyGroup>
   <!-- End SplatterPlot -->

Code/Mantid/Vates/ParaviewPlugins/ParaViewFilters/SplatterPlot/vtkSplatterPlot.cxx

@@ -168,3 +168,66 @@ void vtkSplatterPlot::updateAlgorithmProgress(double progress, const std::string
   this->SetProgress(progress);
   this->SetProgressText(message.c_str());
 }
+
+/**
+ * Gets the minimum value of the data associated with the 
+ * workspace.
+ * @return The minimum value of the workspace data.
+ */
+double vtkSplatterPlot::GetMinValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMinValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0.0;
+  }
+}
+
+/**
+ * Gets the maximum value of the data associated with the 
+ * workspace.
+ * @return The maximum value of the workspace data.
+ */
+double vtkSplatterPlot::GetMaxValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMaxValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0.0;
+  }
+}
+
+/**
+ * Gets the (first) instrument which is associated with the workspace.
+ * @return The name of the instrument.
+ */
+const char* vtkSplatterPlot::GetInstrument()
+{
+  if (NULL == m_presenter)
+  {
+    return "";
+  }
+  try
+  {
+    return m_presenter->getInstrument().c_str();
+  }
+  catch (std::runtime_error &)
+  {
+    return "";
+  }
+}
+

Code/Mantid/Vates/ParaviewPlugins/ParaViewFilters/SplatterPlot/vtkSplatterPlot.h

@@ -23,8 +23,13 @@ public:
   void SetNumberOfPoints(int nPoints);
   void SetTopPercentile(double topPercentile);
   void updateAlgorithmProgress(double progress, const std::string& message);
+  /// Getter for the minimum value of the workspace data
+  double GetMinValue();
+  /// Getter for the maximum value of the workspace data
+  double GetMaxValue();
+  /// Getter for the maximum value of the workspace data
+  const char* GetInstrument();
 protected:
-
   vtkSplatterPlot();
   ~vtkSplatterPlot();
   int RequestInformation(vtkInformation *, vtkInformationVector **, vtkInformationVector *);

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDEWSource/MDEWSource.xml

@@ -56,6 +56,28 @@
         information_only="1"
         si_class="vtkSITimeLabelProperty">
       </StringVectorProperty>
+	         <DoubleVectorProperty 
+        name="MinValue"
+		command="GetMinValue"
+        information_only="1">
+        <Documentation>
+          Minimum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	  <DoubleVectorProperty 
+        name="MaxValue"
+		command="GetMaxValue"
+        information_only="1">
+        <Documentation>
+          Maximum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	 <StringVectorProperty
+         name="Instrument"
+         command="GetInstrument"
+         number_of_elements="1"
+         information_only="1">
+       </StringVectorProperty>
     </SourceProxy>
   </ProxyGroup>
   <!-- End MDEWSource -->

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDEWSource/vtkMDEWSource.cxx

@@ -102,6 +102,69 @@ int vtkMDEWSource::GetSpecialCoordinates()
   }
 }
 
+/**
+ * Gets the minimum value of the data associated with the 
+ * workspace.
+ * @return The minimum value of the workspace data.
+ */
+double vtkMDEWSource::GetMinValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMinValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0;
+  }
+}
+
+/**
+ * Gets the maximum value of the data associated with the 
+ * workspace.
+ * @return The maximum value of the workspace data.
+ */
+double vtkMDEWSource::GetMaxValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMaxValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0;
+  }
+}
+
+/**
+ * Gets the (first) instrument which is associated with the workspace.
+ * @return The name of the instrument.
+ */
+const char* vtkMDEWSource::GetInstrument()
+{
+  if (NULL == m_presenter)
+  {
+    return "";
+  }
+  try
+  {
+    return m_presenter->getInstrument().c_str();
+  }
+  catch (std::runtime_error &)
+  {
+    return "";
+  }
+}
+
+
 int vtkMDEWSource::RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *outputVector)
 {
   if(m_presenter->canReadFile())

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDEWSource/vtkMDEWSource.h

@@ -67,6 +67,12 @@ public:
   const char* GetWorkspaceName();
   /// Getter for the workspace type
   char* GetWorkspaceTypeName();
+  /// Getter for the minimum value of the workspace data
+  double GetMinValue();
+  /// Getter for the maximum value of the workspace data
+  double GetMaxValue();
+  /// Getter for the maximum value of the workspace data
+  const char* GetInstrument();
 
 protected:
   vtkMDEWSource();

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDHWSource/MDHWSource.xml

@@ -50,6 +50,28 @@
         information_only="1"
         si_class="vtkSITimeLabelProperty">
       </StringVectorProperty>
+       <DoubleVectorProperty 
+        name="MinValue"
+		command="GetMinValue"
+        information_only="1">
+        <Documentation>
+          Minimum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	  <DoubleVectorProperty 
+        name="MaxValue"
+		command="GetMaxValue"
+        information_only="1">
+        <Documentation>
+          Maximum value of the data set.
+        </Documentation>
+      </DoubleVectorProperty>
+	  <StringVectorProperty
+         name="Instrument"
+         command="GetInstrument"
+         number_of_elements="1"
+         information_only="1">
+       </StringVectorProperty>
     </SourceProxy>
   </ProxyGroup>
   <!-- End MDHWSource -->

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDHWSource/vtkMDHWSource.cxx

@@ -88,6 +88,68 @@ int vtkMDHWSource::GetSpecialCoordinates()
   }
 }
 
+/**
+ * Gets the minimum value of the data associated with the 
+ * workspace.
+ * @return The minimum value of the workspace data.
+ */
+double vtkMDHWSource::GetMinValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMinValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0.0;
+  }
+}
+
+/**
+ * Gets the maximum value of the data associated with the 
+ * workspace.
+ * @return The maximum value of the workspace data.
+ */
+double vtkMDHWSource::GetMaxValue()
+{
+  if (NULL == m_presenter)
+  {
+    return 0.0;
+  }
+  try
+  {
+    return m_presenter->getMaxValue();
+  }
+  catch (std::runtime_error &)
+  {
+    return 0.0;
+  }
+}
+
+/**
+ * Gets the (first) instrument which is associated with the workspace.
+ * @return The name of the instrument.
+ */
+const char* vtkMDHWSource::GetInstrument()
+{
+  if (NULL == m_presenter)
+  {
+    return "";
+  }
+  try
+  {
+    return m_presenter->getInstrument().c_str();
+  }
+  catch (std::runtime_error &)
+  {
+    return "";
+  }
+}
+
 int vtkMDHWSource::RequestData(vtkInformation *, vtkInformationVector **, vtkInformationVector *outputVector)
 {
   if(m_presenter->canReadFile())
@@ -136,7 +198,7 @@ int vtkMDHWSource::RequestData(vtkInformation *, vtkInformationVector **, vtkInf
     }
     catch (std::invalid_argument &e)
     {
-	  std::string error = e.what();
+    std::string error = e.what();
       vtkDebugMacro(<< "Workspace does not have correct information to "
                     << "plot non-orthogonal axes. " << error);
     }

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/MDHWSource/vtkMDHWSource.h

@@ -65,6 +65,12 @@ public:
   const char* GetWorkspaceName();
   /// Getter for the workspace type
   char* GetWorkspaceTypeName();
+  /// Getter for the minimum value of the workspace data
+  double GetMinValue();
+  /// Getter for the maximum value of the workspace data
+  double GetMaxValue();
+  /// Getter for the maximum value of the workspace data
+  const char* GetInstrument();
 
 protected:
   vtkMDHWSource();

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/PeaksSource/PeaksSource.xml

@@ -45,6 +45,12 @@
           Set the size of the unintegrated peak markers.
         </Documentation>
       </DoubleVectorProperty>
+	  <StringVectorProperty
+         name="Instrument"
+         command="GetInstrument"
+         number_of_elements="1"
+         information_only="1">
+       </StringVectorProperty>
     </SourceProxy>
   </ProxyGroup>
   <!-- End PeaksSource -->

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/PeaksSource/vtkPeaksSource.cxx

@@ -140,6 +140,7 @@ int vtkPeaksSource::RequestInformation(vtkInformation *vtkNotUsed(request),
     Workspace_sptr result = AnalysisDataService::Instance().retrieve(m_wsName);
     m_PeakWS = boost::dynamic_pointer_cast<Mantid::API::IPeaksWorkspace>(result);
     m_wsTypeName = m_PeakWS->id();
+    m_instrument = m_PeakWS->getInstrument()->getName();
   }
   return 1;
 }
@@ -168,3 +169,12 @@ const char* vtkPeaksSource::GetWorkspaceName()
 {
   return m_wsName.c_str();
 }
+
+/**
+ * Gets the (first) instrument which is associated with the workspace.
+ * @return The name of the instrument.
+ */
+const char* vtkPeaksSource::GetInstrument()
+{
+  return m_instrument.c_str();
+}
\ No newline at end of file

Code/Mantid/Vates/ParaviewPlugins/ParaViewSources/PeaksSource/vtkPeaksSource.h

@@ -52,6 +52,8 @@ public:
   const char* GetWorkspaceName();
   /// Getter for the workspace type
   char* GetWorkspaceTypeName();
+  /// Getter for the instrument associated with the workspace
+  const char* GetInstrument();
 
 protected:
   vtkPeaksSource();
@@ -75,6 +77,9 @@ private:
   /// Cached workspace.
   Mantid::API::IPeaksWorkspace_sptr m_PeakWS;
 
+  /// Instrument name.
+  std::string m_instrument;
+
   vtkPeaksSource(const vtkPeaksSource&);
   void operator = (const vtkPeaksSource&);
 };

Code/Mantid/Vates/VatesAPI/CMakeLists.txt

@@ -16,13 +16,14 @@ src/IMDDimensionComparitor.cpp
 src/LoadVTK.cpp
 src/MDEWEventNexusLoadingPresenter.cpp
 src/MDEWRebinningPresenter.cpp
-src/MDEWLoadingPresenter.cpp
 src/MDEWInMemoryLoadingPresenter.cpp
+src/MDEWLoadingPresenter.cpp
 src/MDHWInMemoryLoadingPresenter.cpp
 src/MDHWLoadingPresenter.cpp
 src/MDHWNexusLoadingPresenter.cpp
 src/MedianAndBelowThresholdRange.cpp
 src/MetadataToFieldData.cpp
+src/MetaDataExtractorUtils.cpp
 src/NoThresholdRange.cpp
 src/NullRebinningPresenter.cpp
 src/ProgressAction.cpp
@@ -79,6 +80,7 @@ inc/MantidVatesAPI/MDRebinningPresenter.h
 inc/MantidVatesAPI/MDRebinningView.h
 inc/MantidVatesAPI/MDRebinningViewAdapter.h
 inc/MantidVatesAPI/MedianAndBelowThresholdRange.h
+inc/MantidVatesAPI/MetaDataExtractorUtils.h
 inc/MantidVatesAPI/IgnoreZerosThresholdRange.h
 inc/MantidVatesAPI/IMDDimensionComparitor.h
 inc/MantidVatesAPI/MetadataToFieldData.h

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MDEWInMemoryLoadingPresenter.h

@@ -37,8 +37,10 @@ namespace Mantid
     */
 
     class MDLoadingView;
+    class MetaDataExtractorUtils;
     class WorkspaceProvider;
     class vtkDataSetFactory;
+
     class DLLExport MDEWInMemoryLoadingPresenter : public MDEWLoadingPresenter
     {
     public:
@@ -49,6 +51,10 @@ namespace Mantid
       virtual bool canReadFile() const;
       virtual std::string getWorkspaceTypeName();
       virtual int getSpecialCoordinates();
+      virtual double getMinValue();
+      virtual double getMaxValue();
+
+      
     private:
       /// Repository for accessing workspaces. At this level, does not specify how or where from.
       boost::scoped_ptr<WorkspaceProvider> m_repository;
@@ -56,6 +62,10 @@ namespace Mantid
       const std::string m_wsName;
       std::string m_wsTypeName;
       int m_specialCoords;
+      double m_minValue;
+      double m_maxValue;
+      /// Meta data extractor
+      boost::scoped_ptr<MetaDataExtractorUtils> m_metaDataExtractor;
     };
   }
 }

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MDEWLoadingPresenter.h

@@ -48,6 +48,7 @@ namespace Mantid
       virtual std::string getTimeStepLabel() const;
       virtual void setAxisLabels(vtkDataSet* visualDataSet);
       virtual ~MDEWLoadingPresenter();
+      virtual const std::string& getInstrument();
     protected:
       /*---------------------------------------------------------------------------
       Common/shared operations and members for all MDEW file-type loading.
@@ -66,10 +67,8 @@ namespace Mantid
       size_t m_recursionDepth;
       bool m_loadInMemory;
       bool m_firstLoad;
+      std::string m_instrument;
     };
-
-    
-
   }
 }
 

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MDHWInMemoryLoadingPresenter.h

@@ -37,7 +37,9 @@ namespace Mantid
 
     class MDLoadingView;
     class WorkspaceProvider;
+    class MetaDataExtractorUtils;
     class vtkDataSetFactory;
+    
     class DLLExport MDHWInMemoryLoadingPresenter : public MDHWLoadingPresenter
     {
     public:
@@ -48,6 +50,10 @@ namespace Mantid
       virtual bool canReadFile() const;
       virtual std::string getWorkspaceTypeName();
       virtual int getSpecialCoordinates();
+      virtual double getMinValue();
+      virtual double getMaxValue();
+
+
     private:
       /// Repository for accessing workspaces. At this level, does not specify how or where from.
       boost::scoped_ptr<WorkspaceProvider> m_repository;
@@ -55,6 +61,10 @@ namespace Mantid
       const std::string m_wsName;
       std::string m_wsTypeName;
       int m_specialCoords;
+      double m_minValue;
+      double m_maxValue;
+      /// Meta data extractor
+      boost::scoped_ptr<MetaDataExtractorUtils> m_metaDataExtractor;
     };
   }
 }

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MDHWLoadingPresenter.h

@@ -49,6 +49,8 @@ namespace Mantid
       virtual void setAxisLabels(vtkDataSet* visualDataSet);
       virtual void makeNonOrthogonal(vtkDataSet* visualDataSet);
       virtual ~MDHWLoadingPresenter();
+      virtual const std::string& getInstrument();
+
     protected:
       /*---------------------------------------------------------------------------
       Common/shared operations and members for all MDHW file-type loading.
@@ -68,8 +70,8 @@ namespace Mantid
       double m_time;
       bool m_loadInMemory;
       bool m_firstLoad;
+      std::string m_instrument;
     };
-
   }
 }
 

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MDLoadingPresenter.h

@@ -42,31 +42,54 @@ namespace Mantid
     */
     class DLLExport MDLoadingPresenter
     {
-    public:
-      virtual vtkDataSet* execute(vtkDataSetFactory* factory, ProgressAction& rebinningProgressUpdate, ProgressAction& drawingProgressUpdate) = 0;
-      virtual void executeLoadMetadata() = 0;
-      virtual bool hasTDimensionAvailable() const = 0;
-      virtual std::vector<double> getTimeStepValues() const = 0;
-      virtual std::string getTimeStepLabel() const = 0;
-      virtual void setAxisLabels(vtkDataSet* visualDataSet) = 0;
-      virtual void makeNonOrthogonal(vtkDataSet* visualDataSet)
-      {
-        // This is a no-op function for most loaders.
-        UNUSED_ARG(visualDataSet);
-      }
-      virtual bool canReadFile() const = 0;
-      virtual const std::string& getGeometryXML() const = 0;
-      virtual ~MDLoadingPresenter(){}
-      virtual std::string getWorkspaceTypeName()
-      {
-        return "NotSet";
-      }
-      virtual int getSpecialCoordinates()
-      {
-        return API::None;
-      }
-    };
+      public:
+        virtual vtkDataSet* execute(vtkDataSetFactory* factory, ProgressAction& rebinningProgressUpdate, ProgressAction& drawingProgressUpdate) = 0;
+        virtual void executeLoadMetadata() = 0;
+        virtual bool hasTDimensionAvailable() const = 0;
+        virtual std::vector<double> getTimeStepValues() const = 0;
+        virtual std::string getTimeStepLabel() const = 0;
+        virtual void setAxisLabels(vtkDataSet* visualDataSet) = 0;
+        virtual void makeNonOrthogonal(vtkDataSet* visualDataSet)
+        {
+          // This is a no-op function for most loaders.
+          UNUSED_ARG(visualDataSet);
+        }
+        virtual bool canReadFile() const = 0;
+        virtual const std::string& getGeometryXML() const = 0;
+        virtual ~MDLoadingPresenter(){}
+        virtual std::string getWorkspaceTypeName()
+        {
+          return "NotSet";
+        }
+        virtual int getSpecialCoordinates()
+        {
+          return API::None;
+        }
+
+        /**
+         * Gets the minimum value.
+         * @returns The minimum value of the dataset or 0.0
+         */
+        virtual double getMinValue()
+        {
+          return 0.0;
+        };
 
+        /**
+         * Gets the maximum value.
+         * @returns The maximum value of the dataset or 0.0
+         */
+        virtual double getMaxValue()
+        {
+          return 0.0;	
+        };
+
+        /**
+         * Gets the instrument associated with the dataset.
+         * @returns The instrument associated with the dataset.
+         */
+        virtual const std::string& getInstrument() = 0;
+    };
   }
 }
 

Code/Mantid/Vates/VatesAPI/inc/MantidVatesAPI/MetaDataExtractorUtils.h

+#ifndef MANTID_VATES_METADATAEXTRACTORUTILS_H_
+#define MANTID_VATES_METADATAEXTRACTORUTILS_H_
+
+#include "MantidAPI/IMDWorkspace.h"
+#include "MantidAPI/IMDIterator.h"
+#include "qwt/qwt_double_interval.h"
+#include <string>
+#include <vector>
+
+
+/**
+ * Class with utility methdos to extract meta data information from a IMDWorkspace.
+ *
+ * @date November 21, 2014
+ *
+ * Copyright &copy; 2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
+ *
+ * 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>
+ */
+namespace Mantid
+{
+  namespace VATES
+  {
+
+    class DLLExport MetaDataExtractorUtils
+    {
+      public:
+
+        MetaDataExtractorUtils();
+
+        ~MetaDataExtractorUtils();
+
+        /**
+          * Get the minimum, maximum pair from the workspace
+          * @param workspace A pointer to the workspace
+          * @return A pair of minimum and maximum values.
+          */
+        QwtDoubleInterval getMinAndMax(Mantid::API::IMDWorkspace_sptr workspace);
+
+        /**
+          * Extracts the instrument from the workspace.
+          * @param A pointer to a workspace.
+          * @returns The instrument. 
+          */
+        std::string extractInstrument(Mantid::API::IMDWorkspace_sptr workspace);
+
+      private:
+          /**
+          * Get the range of data values from an MD iterator
+          * @param it Iterator for a general MD workspace.
+          * @retunrs A maximum and minimum pair.
+          */
+        QwtDoubleInterval getRange(Mantid::API::IMDIterator* it);
+    };
+  }
+}
+#endif
\ No newline at end of file