Moved y-axis range checking logic to D3SpectrumDisplayDiv, and also added a explanatory message when setYRange(...) call, from terminal widget, isnt fully obeyed.

In response to issue #33.

Author: wcjohns

InterSpec/D3SpectrumDisplayDiv.h

@@ -4,6 +4,7 @@
 #include "InterSpec_config.h"
 
 #include <map>
+#include <tuple>
 #include <chrono>
 #include <memory>
 #include <vector>
@@ -324,7 +325,13 @@ class D3SpectrumDisplayDiv : public Wt::WContainerWidget
 
   void setYAxisMinimum( const double minimum );
   void setYAxisMaximum( const double maximum );
-  void setYAxisRange( const double minimum, const double maximum );
+  
+  /** Set the y-axis range.
+   
+   Returns the actual set y-range, and if this is different than the requested range, a message as to why it couldnt be set
+   (e.x., a value less than or equal to 0 was requested for a log axis).
+   */
+  std::tuple<double,double,Wt::WString> setYAxisRange( double minimum, double maximum );
 
   //peakLabel should be of type SpectrumChart::PeakLabels, but I didnt want
   //  to include the SpectrumChart header for just this

InterSpec/InterSpec.h

@@ -27,19 +27,20 @@
 
 #include <set>
 #include <deque>
+#include <tuple>
 #include <memory>
 #include <vector>
 
 #include <Wt/Dbo/Dbo>
 #include <Wt/WContainerWidget>
 
-//#include "SpecUtils/SpecFile.h"
-//Without including InterSpecUser.h here, we get some wierd issues with the
-//  DB optomistic versioning...
+//Without including InterSpecUser.h here, we get some weird issues with the
+//  DB optimistic versioning...
 #include "InterSpec/InterSpecUser.h"
 
 class PeakDef;
 class PopupDiv;
+class SpecMeas;
 class AuxWindow;
 class GoogleMap;
 class PeakModel;
@@ -591,10 +592,10 @@ class InterSpec : public Wt::WContainerWidget
 
   /** Sets the Y-axis range.
    
-   Returns true if successful, or false if the request couldnt be fully honored
+   Returns set range, and empty string if successful, or otherwise a message explaining why the request couldnt be fully honored
    (e.g., a negative lower counts was specified, but its currently log-scale)
    */
-  bool setYAxisRange( double lower_counts, double upper_counts );
+  std::tuple<double,double,Wt::WString> setYAxisRange( double lower_counts, double upper_counts );
 
   /** When displaying the spectrum in log-y, sets the lower y-axis value to show, if there are channels with zero counts. */
   bool setLogYAxisMin( const double lower_value );

InterSpec/InterSpecUser.h

@@ -78,7 +78,7 @@ namespace Wt
     //  to avoid "Stale object" exceptions when the same user has multiple
     //  sessions of the app open.  A related issue not dealt with is that
     //  one session will overwrite whats saved in another one, and stuff wont be
-    //  propogated between them
+    //  propagated between them
     template<>
     struct dbo_traits<UserOption> : public dbo_default_traits
     {

InterSpec_resources/app_text/D3SpectrumDisplayDiv.xml

@@ -41,4 +41,10 @@
   <message id="d3sdd-recalFromTo">Recalibrate data from {1} to {2} keV</message>
   <message id="d3sdd-sumFromTo">{1} to {2} keV</message>
   <message id="d3sdd-comptonPeakAngle">{1}° Compton Peak</message>
-</messages>
+
+<message id="d3sdd-yaxis-lower-upper-equal">Lower and upper counts equal.</message>
+<message id="d3sdd-yaxis-no-spectrum">No spectrum displayed.</message>
+<message id="d3sdd-yaxis-upper-counts-below-zero">Upper range equal or below zero.</message>
+<message id="d3sdd-yaxis-lower-counts-below-zero">Lower range equal or below zero.</message>
+<message id="d3sdd-yaxis-below-min-non-zero">Upper range less than minimum displayed, non-zero value.</message>
+</messages>

src/D3SpectrumDisplayDiv.cpp

@@ -996,19 +996,97 @@ void D3SpectrumDisplayDiv::setXAxisRange( const double minimum, const double max
 }//void setXAxisRange( const double minimum, const double maximum );
 
 
-void D3SpectrumDisplayDiv::setYAxisRange( const double minimum,
-                                       const double maximum )
+std::tuple<double,double,Wt::WString> D3SpectrumDisplayDiv::setYAxisRange( double lower_counts,
+                                       double upper_counts )
 {
-  const string minimumStr = SpecUtils::printCompact(minimum, 8);
-  const string maximumStr = SpecUtils::printCompact(maximum, 8);
-  m_yAxisMinimum = minimum;
-  m_yAxisMaximum = maximum;
+  if( upper_counts < lower_counts )
+    std::swap( lower_counts, upper_counts );
+  
+  if( upper_counts == lower_counts )
+    return {m_yAxisMinimum, m_yAxisMaximum, WString::tr("d3sdd-yaxis-lower-upper-equal")};
+  
+  WString errmsg;
+  const bool isLogY = yAxisIsLog();
+  if( isLogY )
+  {
+    const auto hist = m_foreground;
+    if( !hist || !hist->gamma_counts() || (hist->gamma_counts()->size() < 2) )
+      return {m_yAxisMinimum, m_yAxisMaximum, WString::tr("d3sdd-yaxis-no-spectrum")};
+    
+    const shared_ptr<const vector<float>> &channels = hist->gamma_counts();
+    assert( channels );
+    
+    // Lets check the y-range - ignoring we may be showing multiple channels per display-bin,
+    // to see if the requested range is reasonable
+    double xmin, xmax, ymin, ymax;
+    visibleRange( xmin, xmax, ymin, ymax );
+    
+    const size_t lower_channel = hist->find_gamma_channel(xmin);
+    const size_t upper_channel = hist->find_gamma_channel(xmax);
+    float min_nonzero_value = std::numeric_limits<float>::max();
+    float max_value = -std::numeric_limits<float>::max();
+    
+    for( size_t channel = lower_channel; channel <= upper_channel; ++channel )
+    {
+      if( channel < channels->size() )
+      {
+        const float val = (*channels)[channel];
+        max_value = std::max( max_value, val );
+        if( val > 0.0f )
+          min_nonzero_value = std::min( min_nonzero_value, val );
+      }//if( channel < channels->size() )
+    }//for( loop over visible channels )
+    
+    if( (max_value <= 0.0f) || IsInf(max_value) || IsNan(max_value) )
+      max_value = 1.0f;
+    
+    if( (min_nonzero_value == std::numeric_limits<float>::max())
+       || IsInf(min_nonzero_value)
+       || IsNan(min_nonzero_value) )
+    {
+      min_nonzero_value = 0.1f*max_value;
+    }
+    
+    if( upper_counts <= 0.0f )
+    {
+      errmsg = WString::tr("d3sdd-yaxis-upper-counts-below-zero");
+      upper_counts = (max_value > 0.0f) ? 2.0f*max_value : 1.0f;
+    }
+    
+    if( upper_counts <= min_nonzero_value )
+    {
+      errmsg = WString::tr("d3sdd-yaxis-below-min-non-zero");
+      upper_counts = 2.0f*min_nonzero_value;
+    }
+    
+    if( (lower_counts <= 0.0) || (lower_counts > max_value) )
+    {
+      errmsg = WString::tr("d3sdd-yaxis-lower-counts-below-zero");
+      lower_counts = min_nonzero_value;
+    }
+  }//if( isLogY && (lower_counts <= 0.0f) )
+  
+  
+  if( isLogY )
+  {
+    const double prevMinLogY = logYAxisMin();
+    if( lower_counts < prevMinLogY )
+      setLogYAxisMin( lower_counts );
+  }//if( isLogY )
+  
+  
+  const string minimumStr = SpecUtils::printCompact(lower_counts, 8);
+  const string maximumStr = SpecUtils::printCompact(upper_counts, 8);
+  m_yAxisMinimum = lower_counts;
+  m_yAxisMaximum = upper_counts;
 
   string js = m_jsgraph + ".setYAxisRange(" + minimumStr + "," + maximumStr + ");";
   if( isRendered() )
     doJavaScript( js );
   else
     m_pendingJs.push_back( js );
+  
+  return {m_yAxisMinimum, m_yAxisMaximum, errmsg};
 }//void setYAxisRange( const double minimum, const double maximum );
 
 

src/InterSpec.cpp

@@ -12237,83 +12237,9 @@ void InterSpec::setDisplayedEnergyRange( float lowerEnergy, float upperEnergy )
 }//void setDisplayedEnergyRange()
 
 
-bool InterSpec::setYAxisRange( double lower_counts, double upper_counts )
+tuple<double,double,Wt::WString> InterSpec::setYAxisRange( double lower_counts, double upper_counts )
 {
-  bool success = true;
-  if( upper_counts < lower_counts )
-    std::swap( lower_counts, upper_counts );
-  
-  if( upper_counts == lower_counts )
-    return false;
-  
-  const bool isLogY = m_spectrum->yAxisIsLog();
-  if( isLogY )
-  {
-    const auto hist = displayedHistogram(SpecUtils::SpectrumType::Foreground);
-    if( !hist || !hist->gamma_counts() || (hist->gamma_counts()->size() < 2) )
-      return false;
-    
-    const shared_ptr<const vector<float>> &channels = hist->gamma_counts();
-    assert( channels );
-    
-    // Lets check the y-range - ignoring we may be showing multiple channels per display-bin,
-    // to see if the requested range is reasonable
-    double xmin, xmax, ymin, ymax;
-    m_spectrum->visibleRange( xmin, xmax, ymin, ymax );
-    
-    const size_t lower_channel = hist->find_gamma_channel(xmin);
-    const size_t upper_channel = hist->find_gamma_channel(xmax);
-    float min_nonzero_value = std::numeric_limits<float>::max();
-    float max_value = -std::numeric_limits<float>::max();
-    
-    for( size_t channel = lower_channel; channel <= upper_channel; ++channel )
-    {
-      if( channel < channels->size() )
-      {
-        const float val = (*channels)[channel];
-        max_value = std::max( max_value, val );
-        if( val > 0.0f )
-          min_nonzero_value = std::min( min_nonzero_value, val );
-      }//if( channel < channels->size() )
-    }//for( loop over visible channels )
-    
-    if( (max_value <= 0.0f) || IsInf(max_value) || IsNan(max_value) )
-      max_value = 1.0f;
-    
-    if( (min_nonzero_value == std::numeric_limits<float>::max())
-       || IsInf(min_nonzero_value)
-       || IsNan(min_nonzero_value) )
-    {
-      min_nonzero_value = 0.1f*max_value;
-    }
-    
-    if( upper_counts <= 0.0f )
-    {
-      success = false;
-      upper_counts = (max_value > 0.0f) ? 2.0f*max_value : 1.0f;
-    }
-    
-    if( upper_counts <= min_nonzero_value )
-    {
-      success = false;
-      upper_counts = 2.0f*min_nonzero_value;
-    }
-    
-    if( (lower_counts <= 0.0) || (lower_counts > max_value) )
-      lower_counts = min_nonzero_value;
-  }//if( isLogY && (lower_counts <= 0.0f) )
-  
-  
-  if( isLogY )
-  {
-    const double prevMinLogY = m_spectrum->logYAxisMin();
-    if( lower_counts < prevMinLogY )
-      m_spectrum->setLogYAxisMin( lower_counts );
-  }//if( isLogY )
-  
-  m_spectrum->setYAxisRange( lower_counts, upper_counts );
-  
-  return success;
+  return m_spectrum->setYAxisRange( lower_counts, upper_counts );
 }//bool setYAxisRange(...)
 
 

src/TerminalModel.cpp

@@ -34,6 +34,7 @@
 #include "InterSpec_config.h"
 
 #include <regex>
+#include <tuple>
 #include <vector>
 #include <memory>
 #include <stdio.h>
@@ -1914,12 +1915,14 @@ std::string TerminalModel::setYRange( const std::string& arguments )
     //  throw mup::ParserError( "Invalid arguments for function (setYRange). Lower and upper bound"
     //                           " must not have difference less than or equal to 0.01." );
 
-    const bool success = m_viewer->setYAxisRange(lower, upper);
+    const std::tuple<double,double,Wt::WString> result = m_viewer->setYAxisRange(lower, upper);
 
-    if( success )
-      os << "Now setting count range to [" << lower << ", " << upper << "] counts.";
+    if( std::get<2>(result).empty() )
+      os << "Setting y-range to [" << lower << ", " << upper << "].";
     else
-      os << "Setting to count range [" << lower << ", " << upper << "] not fully be fulfilled.";
+      os << "Setting y-range to [" << lower << ", " << upper << "] not fully be fulfilled; set to ["
+         << std::get<0>(result) << ", " << std::get<1>(result) << "]: "
+         << std::get<2>(result).toUTF8();
   } catch ( const mup::ParserError& e ) {
     os << "Error code " << e.GetCode() << ": " << e.GetMsg();