STIR 6.5.0
Public Member Functions | List of all members
stir::SegmentIndices Class Reference
STIR » STIR library » Basic building blocks » Items related to projection data

A very simple class to store segment numbers and any other indices that define a segment. More...

#include "stir/SegmentIndices.h"

Inheritance diagram for stir::SegmentIndices:
Inheritance graph
[legend]

Public Member Functions

 SegmentIndices (const int segment_num=0, const int timing_pos_num=0)
 constructor segment number as arguments
int segment_num () const
 get segment number for const objects
int & segment_num ()
 get reference to segment number
int timing_pos_num () const
 get TOF index for const objects
int & timing_pos_num ()
 get reference to TOF index
bool operator< (const SegmentIndices &other) const
 comparison operator, only useful for sorting
bool operator== (const SegmentIndices &other) const
 test for equality
bool operator!= (const SegmentIndices &other) const

Detailed Description

A very simple class to store segment numbers and any other indices that define a segment.

Constructor & Destructor Documentation

◆ SegmentIndices()

stir::SegmentIndices::SegmentIndices ( const int segment_num = 0,
const int timing_pos_num = 0 )
inlineexplicit

constructor segment number as arguments

References segment_num(), SegmentIndices(), and timing_pos_num().

Referenced by operator<(), operator==(), SegmentIndices(), stir::SinogramIndices::SinogramIndices(), stir::SinogramIndices::SinogramIndices(), stir::SinogramIndices::SinogramIndices(), stir::ViewgramIndices::ViewgramIndices(), and stir::ViewgramIndices::ViewgramIndices().

Member Function Documentation

◆ segment_num()

int stir::SegmentIndices::segment_num ( ) const
inline

get segment number for const objects

Referenced by stir::BackProjectorByBinUsingProjMatrixByBin::actual_back_project(), stir::BackProjectorByBin::back_project(), stir::Bin::Bin(), stir::Bin::Bin(), stir::Bin::Bin(), stir::ProjMatrixByBin::cache_proj_matrix_elems_for_one_bin(), stir::ProjMatrixElemsForOneDenselValue::coordinates_equal(), stir::ProjMatrixElemsForOneDenselValue::coordinates_less(), stir::distributable_computation(), stir::distributable_computation_cache_enabled(), stir::FBP3DRPReconstruction::do_3D_Reconstruction(), stir::LmToProjData::do_post_normalisation(), stir::DataSymmetriesForBins_PET_CartesianGrid::find_basic_bin(), stir::DataSymmetriesForBins_PET_CartesianGrid::find_basic_view_segment_numbers(), stir::DataSymmetriesForBins_PET_CartesianGrid::find_symmetry_operation_from_basic_bin(), stir::DataSymmetriesForBins::find_symmetry_operation_from_basic_view_segment_numbers(), stir::ForwardProjectorByBin::forward_project(), stir::ProjDataInfoCylindricalNoArcCorr::get_all_det_pos_pairs_for_bin(), stir::CListEventCylindricalScannerWithViewTangRingRingEncoding< CListEventECAT966 >::get_bin(), stir::ProjDataInfoCylindricalArcCorr::get_bin(), stir::ProjDataInfoCylindricalNoArcCorr::get_bin(), stir::BinNormalisationSinogramRescaling::get_bin_efficiency(), stir::LmToProjData::get_bin_from_event(), stir::ProjMatrixByBin::get_cached_proj_matrix_elems_for_one_bin(), stir::LmToProjData::get_compression_count(), stir::ProjDataInfoCylindricalNoArcCorr::get_det_pair_for_bin(), stir::Bin::get_empty_copy(), stir::ProjDataInfoCylindrical::get_m(), stir::ProjDataInfoCylindricalNoArcCorr::get_num_det_pos_pairs_for_bin(), stir::ProjDataFromStream::get_offset(), stir::DataSymmetriesForBins::get_related_bins(), stir::DataSymmetriesForBins::get_related_bins(), stir::DataSymmetriesForBins::get_related_bins_factorised(), stir::DataSymmetriesForBins_PET_CartesianGrid::get_related_bins_factorised(), stir::DataSymmetriesForBins_PET_CartesianGrid::get_related_view_segment_numbers(), stir::ProjDataInfo::get_sampling_in_k(), stir::ProjDataInfo::get_sampling_in_m(), stir::ProjDataInfoCylindrical::get_sampling_in_m(), stir::ProjDataInfo::get_sampling_in_s(), stir::ProjDataInfo::get_sampling_in_t(), stir::ProjDataInfoCylindrical::get_sampling_in_t(), stir::get_scale_factors_per_sinogram(), stir::ProjData::get_segment_by_sinogram(), stir::ProjData::get_segment_by_view(), stir::ProjData::get_sinogram(), stir::ProjDataInfoCylindrical::get_tantheta(), stir::ProjData::get_viewgram(), stir::DataSymmetriesForBins_PET_CartesianGrid::num_related_bins(), stir::DataSymmetriesForBins_PET_CartesianGrid::num_related_view_segment_numbers(), stir::ProjMatrixElemsForOneDenselValue::operator<, stir::operator<<(), stir::LmToProjData::process_data(), stir::ScatterSimulation::process_data_for_view_segment_num(), distributed::receive_view_segment_numbers(), stir::ProjDataInfoTests::run_Blocks_DOI_test(), stir::ProjDataInfoTests::run_coordinate_test(), stir::ProjDataInfoTests::run_coordinate_test_for_realistic_scanner(), stir::scale_sinograms(), SegmentIndices(), distributed::send_view_segment_numbers(), stir::Sinogram< elemT >::Sinogram(), stir::SinogramIndices::SinogramIndices(), stir::LmToProjDataBootstrap< LmToProjDataT >::start_new_time_frame(), stir::transform_3d_object(), stir::Viewgram< elemT >::Viewgram(), stir::ViewgramIndices::ViewgramIndices(), and stir::ProjMatrixByBinFromFile::write_to_file().

◆ timing_pos_num()

int stir::SegmentIndices::timing_pos_num ( ) const
inline

get TOF index for const objects

Referenced by stir::BackProjectorByBinUsingProjMatrixByBin::actual_back_project(), stir::BackProjectorByBin::back_project(), stir::Bin::Bin(), stir::DataSymmetriesForBins_PET_CartesianGrid::find_basic_bin(), stir::ProjDataInfoCylindricalNoArcCorr::get_all_det_pos_pairs_for_bin(), stir::CListEventCylindricalScannerWithViewTangRingRingEncoding< Derived >::get_bin(), stir::ProjDataInfoCylindricalNoArcCorr::get_det_pos_pair_for_bin(), stir::Bin::get_empty_copy(), stir::ProjDataInfo::get_k(), stir::ProjDataInfoGenericNoArcCorr::get_LOR(), stir::ProjDataFromStream::get_offset(), stir::TrivialDataSymmetriesForBins::get_related_bins(), stir::ProjDataInfo::get_sampling_in_k(), stir::ProjData::get_segment_by_sinogram(), stir::ProjData::get_segment_by_view(), stir::ProjData::get_sinogram(), stir::ProjData::get_viewgram(), stir::operator<<(), stir::LmToProjData::process_data(), SegmentIndices(), stir::ProjDataInfo::set_tof_mash_factor(), stir::Sinogram< elemT >::Sinogram(), stir::SinogramIndices::SinogramIndices(), stir::Viewgram< elemT >::Viewgram(), and stir::ViewgramIndices::ViewgramIndices().

◆ operator<()

bool stir::SegmentIndices::operator< ( const SegmentIndices & other) const
inline

comparison operator, only useful for sorting

In future, there will be multiple indices, and order will then be based as in (0,1) < (0,-1) < (1,1) ...

References SegmentIndices().

Referenced by stir::SinogramIndices::operator<(), and stir::ViewgramIndices::operator<().

◆ operator==()

bool stir::SegmentIndices::operator== ( const SegmentIndices & other) const
inline

test for equality

References SegmentIndices().

Referenced by stir::SinogramIndices::operator==(), and stir::ViewgramIndices::operator==().

The documentation for this class was generated from the following files:
Generated on for STIR by doxygen 1.18.0