stir::IOTests< A > Class Template Reference

A simple class to test the OutputFileFormat function. More...

#include "stir/IO/test/test_IO.h"

Inheritance diagram for stir::IOTests< A >:

Public Member Functions
	IOTests (std::istream &in)
void	run_tests () override
	Function (to be overloaded) which does the actual tests. More...
Public Member Functions inherited from stir::RunTests
	RunTests (const double tolerance=1E-4)
	Default constructor.
virtual	~RunTests ()
	Destructor, outputs a diagnostic message.
bool	is_everything_ok () const
	Returns if all checks were fine upto now.
int	main_return_value () const
	Handy return value for a main() function. More...
void	set_tolerance (const double tolerance)
	Set value used in floating point comparisons (see check_* functions)
double	get_tolerance () const
	Get value used in floating point comparisons (see check_* functions)
bool	check (const bool, const std::string &str="")
	Tests if true, str can be used to tell what you are testing. More...
template<class T1 , class T2 >
bool	check_if_less (T1 a, T2 b, const std::string &str="")
	check if a<b
bool	check_if_equal (const std::string &a, const std::string &b, const std::string &str="")
bool	check_if_equal (const double a, const double b, const std::string &str="")
bool	check_if_equal (const short a, const short b, const std::string &str="")
bool	check_if_equal (const unsigned short a, const unsigned short b, const std::string &str="")
bool	check_if_equal (const int a, const int b, const std::string &str="")
bool	check_if_equal (const unsigned int a, const unsigned int b, const std::string &str="")
bool	check_if_equal (const long a, const long b, const std::string &str="")
bool	check_if_equal (const unsigned long a, const unsigned long b, const std::string &str="")
bool	check_if_equal (const Bin &a, const Bin &b, const std::string &str="")
template<class T >
bool	check_if_equal (const DetectionPosition< T > &a, const DetectionPosition< T > &b, const std::string &str="")
template<class T >
bool	check_if_equal (const std::complex< T > a, const std::complex< T > b, const std::string &str="")
	check equality by calling check_if_equal on real and imaginary parts
template<class T >
bool	check_if_equal (const VectorWithOffset< T > &t1, const VectorWithOffset< T > &t2, const std::string &str="")
	check equality by comparing ranges and calling check_if_equal on all elements
template<class T >
bool	check_if_equal (const std::vector< T > &t1, const std::vector< T > &t2, const std::string &str="")
	check equality by comparing size and calling check_if_equal on all elements
bool	check_if_equal (const ProjDataInMemory &t1, const ProjDataInMemory &t2, const std::string &str="")
template<int n>
bool	check_if_equal (const IndexRange< n > &t1, const IndexRange< n > &t2, const std::string &str="")
template<int num_dimensions, class coordT >
bool	check_if_equal (const BasicCoordinate< num_dimensions, coordT > &a, const BasicCoordinate< num_dimensions, coordT > &b, const std::string &str="")
	check equality by comparing norm(a-b) with tolerance
bool	check_if_zero (const double a, const std::string &str="")
bool	check_if_zero (const short a, const std::string &str="")
bool	check_if_zero (const unsigned short a, const std::string &str="")
bool	check_if_zero (const int a, const std::string &str="")
bool	check_if_zero (const unsigned int a, const std::string &str="")
bool	check_if_zero (const long a, const std::string &str="")
bool	check_if_zero (const unsigned long a, const std::string &str="")
template<class T >
bool	check_if_zero (const VectorWithOffset< T > &t, const std::string &str="")
	use check_if_zero on all elements
template<int num_dimensions, class coordT >
bool	check_if_zero (const BasicCoordinate< num_dimensions, coordT > &a, const std::string &str="")
	compare norm with tolerance

Protected Member Functions
void	set_up ()
virtual void	create_image ()=0
virtual void	write_image ()
virtual void	read_image ()
virtual void	check_result ()=0
shared_ptr< VoxelsOnCartesianGrid< float > >	create_single_image ()
void	compare_images (const VoxelsOnCartesianGrid< float > &im_1, const VoxelsOnCartesianGrid< float > &im_2)
void	check_exam_info (const ExamInfo &exm_inf_1, const ExamInfo &exm_inf_2)
Protected Member Functions inherited from stir::RunTests
template<class T >
bool	check_if_equal_generic (const T &a, const T &b, const std::string &str)
	function that is called by some check_if_equal implementations. It just uses operator!=
template<class T >
bool	check_if_zero_generic (T a, const std::string &str)
	function that is called by some check_if_zero implementations. It just uses operator!=

Protected Attributes
std::istream &	_in
shared_ptr< OutputFileFormat< A > >	_output_file_format_sptr
KeyParser	_parser
std::string	_filename
shared_ptr< A >	_image_to_write_sptr
shared_ptr< A >	_image_to_read_sptr
Protected Attributes inherited from stir::RunTests
double	tolerance
	tolerance for comparisons with real values
bool	everything_ok
	variable storing current status

Detailed Description

template<class A>
class stir::IOTests< A >

A simple class to test the OutputFileFormat function.

The class reads input from a stream, whose contents should be as follows:

Test OutputFileFormat Parameters:=
output file format type :=
; here are parameters specific for the file format
End:=

Warning

Overwrites files STIRtmp.* in the current directory

Todo:

Delete STIRtmp.* files, but that's a bit difficult as we don't know which ones are written.

Member Function Documentation

run_tests()

template<class A >

void stir::IOTests< A >::run_tests ( )

overridevirtual

Function (to be overloaded) which does the actual tests.

This function is expected to do a series of calls to check(), check_if_equal() etc.

Implements stir::RunTests.

---

The documentation for this class was generated from the following file:

• /home/sirfuser/devel/STIRdistrib/STIR/src/include/stir/IO/test/test_IO.h