A class for 2d projection data. More...
#include "stir/Viewgram.h"
Inheritance diagram for stir::Viewgram< elemT >:
Public Member Functions | |
| Viewgram (const shared_ptr< const ProjDataInfo > &proj_data_info_ptr, const ViewgramIndices &ind) | |
| Construct from proj_data_info pointer and indices. Data are set to 0. | |
| Viewgram (const Array< 2, elemT > &p, const shared_ptr< const ProjDataInfo > &proj_data_info_sptr, const ViewgramIndices &ind) | |
| Construct with data set to the array. | |
| Viewgram (const shared_ptr< const ProjDataInfo > &proj_data_info_ptr, const int v_num, const int s_num, const int t_num=0) | |
| Construct from proj_data_info pointer, view and segment number. Data are set to 0. More... | |
| Viewgram (const Array< 2, elemT > &p, const shared_ptr< const ProjDataInfo > &proj_data_info_ptr, const int v_num, const int s_num, const int t_num=0) | |
| Construct with data set to the array. More... | |
| ViewgramIndices | get_viewgram_indices () const |
| Get indices. | |
| int | get_segment_num () const |
| Get segment number. | |
| int | get_view_num () const |
| Get number of views. | |
| int | get_timing_pos_num () const |
| Get timing position index. | |
| int | get_min_axial_pos_num () const |
| Get minimum number of axial positions. | |
| int | get_max_axial_pos_num () const |
| Get maximum number of axial positions. | |
| int | get_num_axial_poss () const |
| Get number of axial positions. | |
| int | get_min_tangential_pos_num () const |
| Get minimum number of axial positions. | |
| int | get_max_tangential_pos_num () const |
| Get maximum number of tangetial positions. | |
| int | get_num_tangential_poss () const |
| Get number of tangential positions. | |
| Viewgram | get_empty_copy (void) const |
| Get an empty viewgram of the same dimensions, segment_num etc. | |
| void | grow (const IndexRange< 2 > &range) override |
| Overloading Array::grow. More... | |
| void | resize (const IndexRange< 2 > &range) override |
| Overloading Array::resize. More... | |
| shared_ptr< const ProjDataInfo > | get_proj_data_info_sptr () const |
| Get shared pointer to proj data info. | |
Equality | |
| bool | has_same_characteristics (self_type const &, std::string &explanation) const |
| Checks if the 2 objects have the proj_data_info, segment_num etc. More... | |
| bool | has_same_characteristics (self_type const &) const |
| Checks if the 2 objects have the proj_data_info, segment_num etc. More... | |
| bool | operator== (const self_type &) const |
| check equality (data has to be identical) More... | |
| bool | operator!= (const self_type &) const |
| negation of operator== | |
 Public Member Functions inherited from stir::Array< 2, elemT > | |
| Array () | |
| Construct an empty Array. | |
| Array (const IndexRange< num_dimensions > &) | |
| Construct an Array of given range of indices, elements are initialised to 0. | |
| Array (const IndexRange< num_dimensions > &range, shared_ptr< elemT[]> data_sptr) | |
| Construct an Array pointing to existing contiguous data. More... | |
| Array (const base_type &t) | |
| Construct an Array from an object of its base_type. | |
| Array (const self &t) | |
| Copy constructor. | |
| Array (Array &&other) noexcept | |
| move constructor More... | |
| Array (Array< num_dimensions, elemT > &&other) noexcept | |
| ~Array () override | |
| virtual destructor, frees up any allocated memory | |
| Array & | operator= (Array other) |
| assignment operator More... | |
| IndexRange< num_dimensions > | get_index_range () const |
| size_t | size_all () const |
| return the total number of elements in this array | |
| virtual void | resize (const IndexRange< num_dimensions > &range) |
| change the array to a new range of indices, new elements are set to 0 More... | |
| virtual void | grow (const IndexRange< num_dimensions > &range) |
| alias for resize() | |
| elemT | sum () const |
| return sum of all elements | |
| elemT | sum_positive () const |
| return sum of all positive elements | |
| elemT | find_max () const |
| return maximum of all the elements | |
| elemT | find_min () const |
| return minimum of all the elements | |
| void | fill (const elemT &n) |
Fill elements with value n. More... | |
| void | apply_lower_threshold (const elemT &l) |
| Sets elements below value to the value. | |
| void | apply_upper_threshold (const elemT &u) |
| Sets elements above value to the value. | |
| bool | is_regular () const |
| checks if the index range is 'regular' More... | |
| bool | get_regular_range (BasicCoordinate< num_dimensions, int > &min, BasicCoordinate< num_dimensions, int > &max) const |
find regular range, returns false if the range is not regular More... | |
| Array< num_dimensions - 1, elemT > & | operator[] (int i) |
| allow array-style access, read/write | |
| const Array< num_dimensions - 1, elemT > & | operator[] (int i) const |
| array access, read-only | |
| elemT & | operator[] (const BasicCoordinate< num_dimensions, int > &c) |
| allow array-style access given a BasicCoordinate to specify the indices, read/write | |
| const elemT & | operator[] (const BasicCoordinate< num_dimensions, int > &c) const |
| array access given a BasicCoordinate to specify the indices, read-only | |
| STIR_DEPRECATED void | axpby (const elemT2 a, const Array &x, const elemT2 b, const Array &y) |
| void | axpby (const elemT2 a, const Array &x, const elemT2 b, const Array &y) |
| void | xapyb (const Array &x, const elemT a, const Array &y, const elemT b) |
| set values of the array to x*a+y*b, where a and b are scalar | |
| void | xapyb (const Array &x, const Array &a, const Array &y, const Array &b) |
| set values of the array to x*a+y*b, where a and b are arrays | |
| void | sapyb (const T &a, const Array &y, const T &b) |
| set values of the array to self*a+y*b where a and b are scalar or arrays | |
| full_iterator | begin_all () |
| start value for iterating through all elements in the array, see full_iterator | |
| const_full_iterator | begin_all () const |
| start value for iterating through all elements in the (const) array, see full_iterator | |
| const_full_iterator | begin_all_const () const |
| start value for iterating through all elements in the array, see full_iterator | |
| full_iterator | end_all () |
| end value for iterating through all elements in the array, see full_iterator | |
| const_full_iterator | end_all () const |
| end value for iterating through all elements in the (const) array, see full_iterator | |
| const_full_iterator | end_all_const () const |
| end value for iterating through all elements in the array, see full_iterator | |
| Array< num_dimensions - 1, elemT > & | at (int i) |
| const Array< num_dimensions - 1, elemT > & | at (int i) const |
| elemT & | at (const BasicCoordinate< num_dimensions, int > &c) |
| const elemT & | at (const BasicCoordinate< num_dimensions, int > &c) const |
| bool | is_contiguous () const |
| return if the array is contiguous in memory | |
| elemT * | get_full_data_ptr () |
| member function for access to the data via a elemT* More... | |
| const elemT * | get_const_full_data_ptr () const |
| member function for access to the data via a const elemT* More... | |
| void | release_full_data_ptr () |
| signal end of access to elemT* More... | |
| void | release_const_full_data_ptr () const |
| signal end of access to const elemT* More... | |
| Public Member Functions inherited from stir::NumericVectorWithOffset< Array< num_dimensions - 1, elemT >, elemT > | |
| NumericVectorWithOffset (const VectorWithOffset< Array< num_dimensions - 1, elemT > > &t) | |
| Constructor from an object of this class' base_type. | |
| NumericVectorWithOffset (const NumericVectorWithOffset &t) | |
| Constructor from an object of this class' base_type. | |
| NumericVectorWithOffset (NumericVectorWithOffset &&other) noexcept | |
| move constructor More... | |
| NumericVectorWithOffset & | operator= (const NumericVectorWithOffset &other) |
| assignment | |
| NumericVectorWithOffset | operator+ (const NumericVectorWithOffset &v) const |
| adding vectors, element by element | |
| NumericVectorWithOffset | operator+ (const elemT &v) const |
return a new vector with elements equal to the sum of the elements in the original and the elemT | |
| NumericVectorWithOffset | operator- (const NumericVectorWithOffset &v) const |
| subtracting vectors, element by element | |
| NumericVectorWithOffset | operator- (const elemT &v) const |
return a new vector with elements equal to the difference of the elements in the original and the elemT | |
| NumericVectorWithOffset | operator* (const NumericVectorWithOffset &v) const |
| multiplying vectors, element by element | |
| NumericVectorWithOffset | operator* (const elemT &v) const |
return a new vector with elements equal to the multiplication of the elements in the original and the elemT | |
| NumericVectorWithOffset | operator/ (const NumericVectorWithOffset &v) const |
| dividing vectors, element by element | |
| NumericVectorWithOffset | operator/ (const elemT &v) const |
return a new vector with elements equal to the division of the elements in the original and the elemT | |
| NumericVectorWithOffset & | operator+= (const NumericVectorWithOffset &v) |
adding elements of v to the current vector More... | |
| NumericVectorWithOffset & | operator+= (const elemT &v) |
adding an elemT to the elements of the current vector | |
| NumericVectorWithOffset & | operator-= (const NumericVectorWithOffset &v) |
subtracting elements of v from the current vector More... | |
| NumericVectorWithOffset & | operator-= (const elemT &v) |
subtracting an elemT from the elements of the current vector | |
| NumericVectorWithOffset & | operator*= (const NumericVectorWithOffset &v) |
multiplying elements of the current vector with elements of v More... | |
| NumericVectorWithOffset & | operator*= (const elemT &v) |
multiplying the elements of the current vector with an elemT | |
| NumericVectorWithOffset & | operator/= (const NumericVectorWithOffset &v) |
dividing all elements of the current vector by elements of v More... | |
| NumericVectorWithOffset & | operator/= (const elemT &v) |
dividing the elements of the current vector by an elemT | |
| STIR_DEPRECATED void | axpby (const elemT2 a, const NumericVectorWithOffset &x, const elemT2 b, const NumericVectorWithOffset &y) |
| void | axpby (const NUMBER2 a, const NumericVectorWithOffset &x, const NUMBER2 b, const NumericVectorWithOffset &y) |
| void | xapyb (const NumericVectorWithOffset &x, const elemT a, const NumericVectorWithOffset &y, const elemT b) |
| set values of the array to x*a+y*b, where a and b are scalar | |
| void | xapyb (const NumericVectorWithOffset &x, const NumericVectorWithOffset &a, const NumericVectorWithOffset &y, const NumericVectorWithOffset &b) |
| set the values of the array to x*a+y*b, where a and b are vectors | |
| void | sapyb (const T2 &a, const NumericVectorWithOffset &y, const T2 &b) |
| set the values of the array to self*a+y*b, where a and b are scalar or vectors | |
| Public Member Functions inherited from stir::VectorWithOffset< Array< num_dimensions - 1, elemT > > | |
| VectorWithOffset () | |
| Default constructor: creates a vector of length 0. | |
| VectorWithOffset (const int hsz) | |
Construct a VectorWithOffset of given length (initialised with T()) | |
| VectorWithOffset (const int min_index, const int max_index) | |
Construct a VectorWithOffset with offset min_index (initialised with T()) | |
| STIR_DEPRECATED | VectorWithOffset (const int hsz, Array< num_dimensions - 1, elemT > *const data_ptr, Array< num_dimensions - 1, elemT > *const end_of_data_ptr) |
| Construct a VectorWithOffset of given length pointing to existing data. More... | |
| STIR_DEPRECATED | VectorWithOffset (const int min_index, const int max_index, Array< num_dimensions - 1, elemT > *const data_ptr, Array< num_dimensions - 1, elemT > *const end_of_data_ptr) |
Construct a VectorWithOffset with offset min_index pointing to existing data. More... | |
| VectorWithOffset (const int hsz, const Array< num_dimensions - 1, elemT > *const data_ptr) | |
| Construct a VectorWithOffset of given length from a bare pointer (copying data) | |
| VectorWithOffset (const int min_index, const int max_index, const Array< num_dimensions - 1, elemT > *const data_ptr) | |
Construct a VectorWithOffset with offset min_index from a bare pointer (copying data) | |
| VectorWithOffset (const int min_index, const int max_index, shared_ptr< Array< num_dimensions - 1, elemT > []> data_sptr) | |
| Construct a VectorWithOffset sharing existing data. More... | |
| VectorWithOffset (const int sz, shared_ptr< Array< num_dimensions - 1, elemT > []> data_sptr) | |
| Construct a VectorWithOffset sharing existing data. More... | |
| VectorWithOffset (const VectorWithOffset &il) | |
| copy constructor | |
| VectorWithOffset (VectorWithOffset &&other) noexcept | |
| move constructor More... | |
| virtual | ~VectorWithOffset () |
| Destructor. | |
| void | recycle () |
| Free all memory and make object as if default-constructed. More... | |
| VectorWithOffset & | operator= (const VectorWithOffset &il) |
| assignment operator with another vector More... | |
| Array< num_dimensions - 1, elemT > & | operator[] (int i) |
| allow array-style access, read/write More... | |
| const Array< num_dimensions - 1, elemT > & | operator[] (int i) const |
| array access, read-only More... | |
| Array< num_dimensions - 1, elemT > & | at (int i) |
| allow array-style access, read/write, but with range checking (throws std::out_of_range) | |
| const Array< num_dimensions - 1, elemT > & | at (int i) const |
| array access, read-only, but with range checking (throws std::out_of_range) | |
| bool | empty () const |
| checks if the vector is empty | |
| void | fill (const Array< num_dimensions - 1, elemT > &n) |
| fill elements with value n | |
| void | apply_lower_threshold (const Array< num_dimensions - 1, elemT > &lower) |
| Sets elements below value to the value. | |
| void | apply_upper_threshold (const Array< num_dimensions - 1, elemT > &upper) |
| Sets elements above value to the value. | |
| int | get_length () const |
| return number of elements in this vector More... | |
| size_t | size () const |
| return number of elements in this vector | |
| int | get_min_index () const |
| get value of first valid index | |
| int | get_max_index () const |
| get value of last valid index | |
| void | set_offset (const int min_index) |
| change value of starting index | |
| void | set_min_index (const int min_index) |
| identical to set_offset() | |
| virtual void | grow (const int min_index, const int max_index) |
grow the range of the vector, new elements are set to T() More... | |
| void | grow (const unsigned int new_size) |
grow the range of the vector from 0 to new_size-1, new elements are set to T() | |
| virtual void | resize (const int min_index, const int max_index) |
change the range of the vector, new elements are set to T() More... | |
| void | resize (const unsigned int new_size) |
change the range of the vector from 0 to new_size-1, new elements are set to T() | |
| void | reserve (const int min_index, const int max_index) |
| make the allocated range at least from min_index to max_index | |
| void | reserve (const unsigned int new_size) |
| make the allocated range at least from 0 to new_size-1 | |
| size_t | capacity () const |
| get allocated size | |
| bool | owns_memory_for_data () const |
| check if this object owns the memory for the data More... | |
| int | get_capacity_min_index () const |
| get min_index within allocated range More... | |
| int | get_capacity_max_index () const |
| get max_index within allocated range More... | |
| bool | operator== (const VectorWithOffset &iv) const |
| bool | operator!= (const VectorWithOffset &iv) const |
| Array< num_dimensions - 1, elemT > * | get_data_ptr () |
| member function for access to the data via a T* More... | |
| const Array< num_dimensions - 1, elemT > * | get_const_data_ptr () const |
| member function for access to the data via a const T* More... | |
| void | release_data_ptr () |
| signal end of access to T* More... | |
| void | release_const_data_ptr () const |
| signal end of access to const T* More... | |
| iterator | begin () |
| use to initialise an iterator to the first element of the vector | |
| const_iterator | begin () const |
| use to initialise an iterator to the first element of the (const) vector | |
| iterator | end () |
| iterator 'past' the last element of the vector | |
| const_iterator | end () const |
| iterator 'past' the last element of the (const) vector | |
| reverse_iterator | rbegin () |
| const_reverse_iterator | rbegin () const |
| reverse_iterator | rend () |
| const_reverse_iterator | rend () const |
| VectorWithOffset & | operator+= (const VectorWithOffset &v) |
adding elements of v to the current vector | |
| VectorWithOffset & | operator-= (const VectorWithOffset &v) |
subtracting elements of v from the current vector | |
| VectorWithOffset & | operator*= (const VectorWithOffset &v) |
multiplying elements of the current vector with elements of v | |
| VectorWithOffset & | operator/= (const VectorWithOffset &v) |
dividing all elements of the current vector by elements of v | |
| VectorWithOffset | operator+ (const VectorWithOffset &v) const |
| adding vectors, element by element | |
| VectorWithOffset | operator- (const VectorWithOffset &v) const |
| subtracting vectors, element by element | |
| VectorWithOffset | operator* (const VectorWithOffset &v) const |
| multiplying vectors, element by element | |
| VectorWithOffset | operator/ (const VectorWithOffset &v) const |
| dividing vectors, element by element | |
Additional Inherited Members | |
| Public Types inherited from stir::Array< 2, elemT > | |
| typedef base_type::value_type | value_type |
typedefs such that we do not need to have typename wherever we use these types defined in the base class | |
| typedef base_type::reference | reference |
| typedef base_type::const_reference | const_reference |
| typedef base_type::difference_type | difference_type |
| typedef base_type::size_type | size_type |
| typedef base_type::iterator | iterator |
| typedef base_type::const_iterator | const_iterator |
| typedef elemT | full_value_type |
| typedef full_value_type * | full_pointer |
| typedef const full_value_type * | const_full_pointer |
| typedef full_value_type & | full_reference |
| typedef const full_value_type & | const_full_reference |
| typedef FullArrayIterator< typename base_type::iterator, typename Array< num_dimensions - 1, elemT >::full_iterator, elemT, full_reference, full_pointer > | full_iterator |
| This defines an iterator type that iterates through all elements. | |
| typedef FullArrayIterator< typename base_type::const_iterator, typename Array< num_dimensions - 1, elemT >::const_full_iterator, elemT, const_full_reference, const_full_pointer > | const_full_iterator |
| As full_iterator, but for const objects. | |
| Public Types inherited from stir::VectorWithOffset< Array< num_dimensions - 1, elemT > > | |
| typedef size_t | size_type |
| typedef Array< num_dimensions - 1, elemT > | value_type |
| typedef value_type & | reference |
| typedef const value_type & | const_reference |
| typedef ptrdiff_t | difference_type |
| typedef Array< num_dimensions - 1, elemT > * | iterator |
| typedef Array< num_dimensions - 1, elemT > const * | const_iterator |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Protected Member Functions inherited from stir::VectorWithOffset< Array< num_dimensions - 1, elemT > > | |
| void | check_state () const |
| Called internally to see if all variables are consistent. More... | |
| void | init (const int min_index, const int max_index, Array< num_dimensions - 1, elemT > *const data_ptr, bool copy_data) |
change vector with new index range and point to data_ptr More... | |
| Protected Attributes inherited from stir::VectorWithOffset< Array< num_dimensions - 1, elemT > > | |
| Array< num_dimensions - 1, elemT > * | num |
| pointer to (*this)[0] (taking get_min_index() into account that is). | |
Detailed Description
template<typename elemT>
class stir::Viewgram< elemT >
A class for 2d projection data.
This represents a subset of the full projection. SegmentIndices and view_num are fixed.
Constructor & Destructor Documentation
◆ Viewgram() [1/2]
template<typename elemT>
|
inline |
Construct from proj_data_info pointer, view and segment number. Data are set to 0.
- Deprecated:
- Use version with ViewgramIndices instead
◆ Viewgram() [2/2]
template<typename elemT>
|
inline |
Construct with data set to the array.
- Deprecated:
- Use version with ViewgramIndices instead
Member Function Documentation
◆ grow()
template<typename elemT >
|
override |
Overloading Array::grow.
This makes sure that the new Array dimensions are the same as those in the ProjDataInfo member.
Referenced by stir::ProjDataInMemory::get_viewgram(), and stir::ProjDataFromStream::get_viewgram().
◆ resize()
template<typename elemT >
|
override |
Overloading Array::resize.
This makes sure that the new Array dimensions are the same as those in the ProjDataInfo member.
◆ has_same_characteristics() [1/2]
template<typename elemT >
| bool stir::Viewgram< elemT >::has_same_characteristics | ( | self_type const & | other, |
| std::string & | explanation | ||
| ) | const |
Checks if the 2 objects have the proj_data_info, segment_num etc.
If they do not have the same characteristics, the string explanation explains why.
◆ has_same_characteristics() [2/2]
template<typename elemT >
| bool stir::Viewgram< elemT >::has_same_characteristics | ( | self_type const & | other | ) | const |
Checks if the 2 objects have the proj_data_info, segment_num etc.
Use this version if you do not need to know why they do not match.
◆ operator==()
template<typename elemT >
| bool stir::Viewgram< elemT >::operator== | ( | const self_type & | that | ) | const |
check equality (data has to be identical)
Uses has_same_characteristics() and Array::operator==.
- Warning
- This function uses
==, which might not be what you need to check whenelemThas data with float or double numbers.
The documentation for this class was generated from the following files:
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/ArcCorrection.h
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/Viewgram.h
- /home/sirfuser/devel/STIRdistrib/STIR/src/buildblock/Viewgram.cxx
- /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/Viewgram.inl
