interfile.h File Reference

Declarations of functions which read/write Interfile data. More...

#include "stir/NumericType.h"
#include "stir/Succeeded.h"
#include "stir/ByteOrder.h"
#include "stir/ArrayFwd.h"
#include <iostream>
#include <string>

Go to the source code of this file.

Namespaces
namespace	stir
	Namespace for the STIR library (and some/most of its applications)

Functions
bool	stir::is_interfile_signature (const char *const signature)
	Checks if the signature corresponds to the start of an interfile header.
VoxelsOnCartesianGrid< float > *	stir::read_interfile_image (std::istream &input, const std::string &directory_for_data="")
	This reads the first 3d image in an Interfile header file, given as a stream.
VoxelsOnCartesianGrid< float > *	stir::read_interfile_image (const std::string &filename)
	This reads the first 3d image in an Interfile header file, given as a filename.
DynamicDiscretisedDensity *	stir::read_interfile_dynamic_image (std::istream &input, const std::string &directory_for_data)
	Read dynamic image.
DynamicDiscretisedDensity *	stir::read_interfile_dynamic_image (const std::string &filename)
	Read dynamic image.
ParametricDiscretisedDensity< VoxelsOnCartesianGrid< KineticParameters< 2, float > > > *	stir::read_interfile_parametric_image (std::istream &input, const std::string &directory_for_data)
	Read parametric image.
ParametricDiscretisedDensity< VoxelsOnCartesianGrid< KineticParameters< 2, float > > > *	stir::read_interfile_parametric_image (const std::string &filename)
	Read parametric image.
Succeeded	stir::write_basic_interfile_image_header (const std::string &header_file_name, const std::string &image_file_name, const ExamInfo &exam_info, const IndexRange< 3 > &index_range, const CartesianCoordinate3D< float > &voxel_size, const CartesianCoordinate3D< float > &origin, const NumericType output_type, const ByteOrder byte_order, const VectorWithOffset< float > &scaling_factors, const VectorWithOffset< unsigned long > &file_offsets, const std::vector< std::string > &data_type_descriptions=std::vector< std::string >())
	This outputs an Interfile header for an image.
const VectorWithOffset< unsigned long >	stir::compute_file_offsets (int number_of_time_frames, const NumericType output_type, const Coordinate3D< int > &dim, unsigned long initial_offset=0)
	a utility function that computes the file offsets of subsequent images
template<class elemT>
Succeeded	stir::write_basic_interfile (const std::string &filename, const ArrayType< 3, elemT > &image, const CartesianCoordinate3D< float > &voxel_size, const CartesianCoordinate3D< float > &origin, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
	This outputs an Interfile header and data for a ArrayType<3,elemT> object.
template<class elemT>
Succeeded	stir::write_basic_interfile (const std::string &filename, const ExamInfo &exam_info, const ArrayType< 3, elemT > &image, const CartesianCoordinate3D< float > &voxel_size, const CartesianCoordinate3D< float > &origin, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
	This outputs an Interfile header and data for a ArrayType<3,elemT> object.
template<class elemT>
Succeeded	stir::write_basic_interfile (const std::string &filename, const ArrayType< 3, elemT > &image, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
	This outputs an Interfile header and data for a ArrayType<3,elemT> object, assuming unit voxel sizes.
Succeeded	stir::write_basic_interfile (const std::string &filename, const VoxelsOnCartesianGrid< float > &image, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
	This outputs an Interfile header and data for a VoxelsOnCartesianGrid<float> object.
Succeeded	stir::write_basic_interfile (const std::string &filename, const DiscretisedDensity< 3, float > &image, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
	This outputs an Interfile header and data for a DiscretisedDensity<3,float> object.
Succeeded	stir::write_basic_interfile (const std::string &filename, const ParametricDiscretisedDensity< VoxelsOnCartesianGrid< KineticParameters< 2, float > > > &image, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
Succeeded	stir::write_basic_interfile (const std::string &filename, const DynamicDiscretisedDensity &image, const NumericType output_type=NumericType::FLOAT, const float scale=0, const ByteOrder byte_order=ByteOrder::native)
ProjDataFromStream *	stir::read_interfile_PDFS (std::istream &input, const std::string &directory_for_data="", const std::ios::openmode openmode=std::ios::in)
	This reads the first 3D sinogram from an Interfile header, given as a stream.
ProjDataFromStream *	stir::read_interfile_PDFS (const std::string &filename, const std::ios::openmode open_mode)
	This reads the first 3D sinogram from an Interfile header, given as a filename.
Succeeded	stir::write_basic_interfile_PDFS_header (const std::string &header_filename, const std::string &data_filename, const ProjDataFromStream &pdfs)
	This writes an Interfile header appropriate for the ProjDataFromStream object.
Succeeded	stir::write_basic_interfile_PDFS_header (const std::string &data_filename, const ProjDataFromStream &pdfs)
	This function writes an Interfile header for the pdfs object.

Detailed Description

Declarations of functions which read/write Interfile data.

Author

Kris Thielemans

Sanida Mustafovic

PARAPET project

Richard Brown