compute_ROI_values.h

Go to the documentation of this file.

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

    SPDX-License-Identifier: Apache-2.0

    See STIR/LICENSE.txt for details
*/
#ifndef __stir_evaluation_compute_ROI_values__H__
#define __stir_evaluation_compute_ROI_values__H__

#include "stir/evaluation/ROIValues.h"
#include "stir/VoxelsOnCartesianGrid.h"

START_NAMESPACE_STIR

template <typename coordT>
class CartesianCoordinate2D;
template <typename coordT>
class CartesianCoordinate3D;
template <typename elemT>
class VectorWithOffset;
template <int num_dimensions, typename elemT>
class DiscretisedDensity;
class Shape3D;


// TODO doc

void compute_ROI_values_per_plane(VectorWithOffset<ROIValues>& values,
                                  const DiscretisedDensity<3, float>& image,
                                  const Shape3D& shape,
                                  const CartesianCoordinate3D<int>& num_samples);

void compute_ROI_values_per_plane(VectorWithOffset<ROIValues>& values,
                                  const DiscretisedDensity<3, float>& image,
                                  const DiscretisedDensity<3, float>& discretised_shape);

ROIValues compute_total_ROI_values(const VectorWithOffset<ROIValues>& values);

ROIValues compute_total_ROI_values(const DiscretisedDensity<3, float>& image,
                                   const Shape3D& shape,
                                   const CartesianCoordinate3D<int>& num_samples);

ROIValues compute_total_ROI_values(const DiscretisedDensity<3, float>& image,
                                   const DiscretisedDensity<3, float>& discretised_shape);

// function that calculate the
void compute_plane_range_ROI_values_per_plane(VectorWithOffset<ROIValues>& values,
                                              const DiscretisedDensity<3, float>& image,
                                              const CartesianCoordinate2D<int>& plane_range,
                                              const Shape3D& shape,
                                              const CartesianCoordinate3D<int>& num_samples);

float compute_CR_hot(ROIValues& val1, ROIValues& val2);
float compute_CR_cold(ROIValues& val1, ROIValues& val2);
float compute_uniformity(ROIValues& val);

VectorWithOffset<float> compute_CR_hot_per_plane(VectorWithOffset<ROIValues>& val1, VectorWithOffset<ROIValues>& val2);

VectorWithOffset<float> compute_CR_cold_per_plane(VectorWithOffset<ROIValues>& val1, VectorWithOffset<ROIValues>& val2);

VectorWithOffset<float> compute_uniformity_per_plane(VectorWithOffset<ROIValues>& val);

// end of doxygen group

END_NAMESPACE_STIR

#endif