ROIValues.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000- 2009, Hammersmith Imanet Ltd
    This file is part of STIR.

    SPDX-License-Identifier: Apache-2.0 AND License-ref-PARAPET-license

    See STIR/LICENSE.txt for details
*/

#ifndef __stir_evaluation_ROIValues__H__
#define __stir_evaluation_ROIValues__H__

#include "stir/common.h"

#include <string>
#include <iostream>
#include <algorithm>

START_NAMESPACE_STIR

class ROIValues
{

public:
  ROIValues() { init(); };

  ROIValues(float roi_volume, float integral, float integral_of_square, float min_value, float max_value)
      : roi_volume(roi_volume),
        integral(integral),
        integral_of_square(integral_of_square),
        min_value(min_value),
        max_value(max_value)
  {
    update();
  };

  ROIValues operator+=(const ROIValues& iv)
  {
    roi_volume += iv.roi_volume;
    integral += iv.integral;
    integral_of_square += iv.integral_of_square;

    min_value = std::min(min_value, iv.min_value);
    max_value = std::max(max_value, iv.max_value);

    update();
    return *this;
  };

  std::string report() const;

  float get_roi_volume() const { return roi_volume; }
  float get_integral() const { return integral; }
  float get_integral_of_square() const { return integral_of_square; }
  float get_mean() const { return mean_value; }
  float get_variance() const { return variance_value; }
  float get_stddev() const { return std_value; }
  float get_CV() const { return std_value / mean_value; }
  float get_min() const { return min_value; }
  float get_max() const { return max_value; }

  // friend ostream &operator <<( ostream &stream, ROIValues val);

private:
  float roi_volume;
  float integral;
  float integral_of_square;

  float mean_value;
  float variance_value;
  float std_value;

  float min_value;
  float max_value;

  void init();
  void update();
};

END_NAMESPACE_STIR

#endif