OverlapStatistics.h

#ifndef OverlapStatistics_h
#define OverlapStatistics_h
 
/* SPDX-License-Identifier: CC0-1.0 */
#include "Cube.h"
#include "FileName.h"
#include "MultivariateStatistics.h"
#include "Projection.h"
 
namespace Isis {
  class PvlObject;
  
  class OverlapStatistics {
    public:
      OverlapStatistics(Isis::Cube &x, Isis::Cube &y,
                        QString progressMsg = "Gathering Overlap Statistics",
                        double sampPercent = 100.0);
      OverlapStatistics(const PvlObject &inStats);
 
      bool HasOverlap(int band) const {
        return (p_stats[band-1].ValidPixels() > 0);
      };
 
      bool HasOverlap() const;
 
      Isis::FileName FileNameX() const {
        return p_xFile;
      };
 
      Isis::FileName FileNameY() const {
        return p_yFile;
      };
 
      Isis::MultivariateStatistics GetMStats(int band) const {
        return p_stats[band-1];
      };
 
      int Lines() const {
        return p_lineRange;
      };
 
      int Samples() const {
        return p_sampRange;
      };
 
      int Bands() const {
        return p_bands;
      };
 
      double SampPercent() const {
        return p_sampPercent;
      };
 
      int StartSampleX() const {
        return p_minSampX;
      };
 
      int EndSampleX() const {
        return p_maxSampX;
      };
 
      int StartLineX() const {
        return p_minLineX;
      };
 
      int EndLineX() const {
        return p_maxLineX;
      };
 
      int StartSampleY() const {
        return p_minSampY;
      };
 
      int EndSampleY() const {
        return p_maxSampY;
      };
 
      int StartLineY() const {
        return p_minLineY;
      };
 
      int EndLineY() const {
        return p_maxLineY;
      };
 
      void SetMincount(unsigned int mincnt) {
        p_mincnt = mincnt;
      };
 
      int MinCount() const {
        return p_mincnt;
      }
 
      bool IsValid(unsigned int band) const {
        return GetMStats(band).ValidPixels() > p_mincnt;
      };
 
      PvlObject toPvl(QString name = "OverlapStatistics") const;
 
 
    private:
 
      void fromPvl(const PvlObject &inStats);
      void init();
 
      int p_bands;               
      double p_sampPercent;      
      Isis::FileName p_xFile;    
      Isis::FileName p_yFile;    
      int p_sampRange;           
      int p_lineRange;           
      int p_minSampX;            
      int p_maxSampX;            
      int p_minSampY;            
      int p_maxSampY;            
      int p_minLineX;            
      int p_maxLineX;            
      int p_minLineY;            
      int p_maxLineY;            
      int p_mincnt;              
 
      std::vector<Isis::MultivariateStatistics> p_stats;
  };
  std::ostream &operator<<(std::ostream &os, Isis::OverlapStatistics &stats);
};
 
#endif