Segment.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 PARAPET partners
    Copyright (C) 2000-2012 Hammersmith Imanet Ltd
    Copyright (C) 2023, University College London
    This file is part of STIR.

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

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

#include "stir/ProjDataInfo.h"
#include "stir/SegmentIndices.h"
#include "stir/SinogramIndices.h"
#include "stir/ViewgramIndices.h"
#include "stir/shared_ptr.h"

START_NAMESPACE_STIR
template <typename elemT>
class Sinogram;
template <typename elemT>
class Viewgram;

template <typename elemT>
class Segment
{
#ifdef SWIG
  // need to make typedef public for swig
 public:
#endif
  typedef Segment<elemT> self_type;

public:
  enum StorageOrder
  {
    StorageByView,
    StorageBySino
  };

  virtual ~Segment()
  {}
  inline shared_ptr<const ProjDataInfo> get_proj_data_info_sptr() const;

  virtual StorageOrder get_storage_order() const = 0;
  inline SegmentIndices get_segment_indices() const;
  inline int get_segment_num() const;
  inline int get_timing_pos_num() const;
  virtual int get_min_axial_pos_num() const = 0;
  virtual int get_max_axial_pos_num() const = 0;
  virtual int get_min_view_num() const = 0;
  virtual int get_max_view_num() const = 0;
  virtual int get_min_tangential_pos_num() const = 0;
  virtual int get_max_tangential_pos_num() const = 0;
  virtual int get_num_axial_poss() const = 0;

  virtual int get_num_views() const = 0;
  virtual int get_num_tangential_poss() const = 0;

  virtual Sinogram<elemT> get_sinogram(int axial_pos_num) const = 0;
  virtual Viewgram<elemT> get_viewgram(int view_num) const = 0;

  inline Sinogram<elemT> get_sinogram(const SinogramIndices& s) const;
  inline Viewgram<elemT> get_viewgram(const ViewgramIndices&) const;

  virtual void set_sinogram(const Sinogram<elemT>& s) = 0;
  virtual void set_sinogram(const Sinogram<elemT>& s, int axial_pos_num) = 0;
  virtual void set_viewgram(const Viewgram<elemT>& v) = 0;



  bool has_same_characteristics(self_type const&, std::string& explanation) const;


  bool has_same_characteristics(self_type const&) const;


  virtual bool operator==(const self_type&) const = 0;

  bool operator!=(const self_type&) const;

protected:
  shared_ptr<const ProjDataInfo> proj_data_info_sptr;
  SegmentIndices _indices;

  inline Segment(const shared_ptr<const ProjDataInfo>& proj_data_info_sptr_v, const SegmentIndices&);
};

END_NAMESPACE_STIR

#include "stir/Segment.inl"

#endif