stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT > Class Template Reference

Implementation of OutputFileFormat paradigm for the Multi format. More...

#include "stir/IO/MultiParametricDiscretisedDensityOutputFileFormat.h"

Inheritance diagram for stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >:

Public Member Functions
	MultiParametricDiscretisedDensityOutputFileFormat (const NumericType &=NumericType::FLOAT, const ByteOrder &=ByteOrder::native)
ByteOrder	set_byte_order (const ByteOrder &, const bool warn=false) override
	set byte order used for output
Public Member Functions inherited from stir::RegisteredParsingObject< MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > >
std::string	get_registered_name () const override
	Returns Derived::registered_name.
std::string	parameter_info () override
	Returns a string with all parameters and their values, in a form suitable for parsing again.
std::string	get_registered_name () const override
	Returns Derived::registered_name.
std::string	parameter_info () override
	Returns a string with all parameters and their values, in a form suitable for parsing again.
Public Member Functions inherited from stir::OutputFileFormat< DataT >
	OutputFileFormat (const NumericType &=NumericType::FLOAT, const ByteOrder &=ByteOrder::native)
Succeeded	write_to_file (std::string &filename, const DataT &data) const
	Write a single image to file.
Succeeded	write_to_file (const std::string &filename, const DataT &density) const
	write a single image to file
NumericType	get_type_of_numbers () const
	get type used for outputting numbers
ByteOrder	get_byte_order ()
	get byte order used for output
float	get_scale_to_write_data () const
	get scale to write the data
virtual NumericType	set_type_of_numbers (const NumericType &, const bool warn=false)
	set type used for outputting numbers
virtual void	set_byte_order_and_type_of_numbers (ByteOrder &, NumericType &, const bool warn=false)
	set byte order and data type used for output
virtual float	set_scale_to_write_data (const float new_scale_to_write_data, const bool warn=false)
	set scale outputting numbers
Public Member Functions inherited from stir::ParsingObject
	ParsingObject (const ParsingObject &)
ParsingObject &	operator= (const ParsingObject &)
bool	parse (std::istream &f)
bool	parse (const char *const filename)
void	ask_parameters ()

Static Public Attributes
static const char *const	registered_name
	Name which will be used when parsing an OutputFileFormat object.

Protected Types
using	DiscretisedDensityType
	Output type for the individual images.
Protected Types inherited from stir::RegisteredObject< OutputFileFormat< DataT > >
typedef OutputFileFormat< DataT > *(*	RootFactory) (std::istream *)
	The type of a root factory is a function, taking an istream* as argument, and returning a Root*.
typedef FactoryRegistry< std::string, RootFactory, interfile_less >	RegistryType
	The type of the registry.

Protected Member Functions
Succeeded	actual_write_to_file (std::string &output_filename, const ParametricDiscretisedDensity< DiscDensityT > &density) const override
void	set_defaults () override
	Set defaults before parsing.
void	initialise_keymap () override
	Initialise all keywords.
bool	post_processing () override
	This will be called at the end of the parsing.
Protected Member Functions inherited from stir::OutputFileFormat< DataT >
virtual Succeeded	actual_write_to_file (std::string &filename, const DataT &density) const =0
	virtual function called by write_to_file()
void	set_defaults () override
	sets value for output data type
void	initialise_keymap () override
	sets keys for output data type for parsing
bool	post_processing () override
	Checks if parameters have sensible values after parsing.
void	set_key_values () override
	overloaded member for ParsingObject::set_key_values()

Protected Attributes
shared_ptr< OutputFileFormat< DiscretisedDensityType > >	individual_output_type_sptr
Protected Attributes inherited from stir::OutputFileFormat< DataT >
NumericType	type_of_numbers
	type used for outputting numbers
ByteOrder	file_byte_order
	byte order used for output
float	scale_to_write_data
	scale to write the data
KeyParser	parser

Additional Inherited Members
Static Public Member Functions inherited from stir::RegisteredParsingObject< MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > >, OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > >
static OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > *	read_from_stream (std::istream *)
	Construct a new object (of type Derived) by parsing the istream.
static OutputFileFormat< ParametricDiscretisedDensity< DiscDensityT > > *	read_from_stream (std::istream *)
	Construct a new object (of type Derived) by parsing the istream.
Static Public Member Functions inherited from stir::OutputFileFormat< DataT >
static shared_ptr< OutputFileFormat< DataT > >	default_sptr ()
	A function to return a default output file format.
Static Public Member Functions inherited from stir::RegisteredObject< OutputFileFormat< DataT > >
static OutputFileFormat< DataT > *	read_registered_object (std::istream *in, const std::string &registered_name)
	Construct a new object (of a type derived from Root, its actual type determined by the registered_name parameter) by parsing the istream.
static OutputFileFormat< DataT > *	ask_type_and_parameters ()
	ask the user for the type, and then calls read_registered_object(0, type)
static void	list_registered_names (std::ostream &stream)
	List all possible registered names to the stream.
Static Protected Member Functions inherited from stir::RegisteredObject< OutputFileFormat< DataT > >
static RegistryType &	registry ()
	Static function returning the registry.

Detailed Description

template<typename DiscDensityT>
class stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >

Implementation of OutputFileFormat paradigm for the Multi format.

Member Typedef Documentation

DiscretisedDensityType

template<typename DiscDensityT>

using stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >::DiscretisedDensityType

protected

Initial value:

 
      typename ParametricDiscretisedDensity<DiscDensityT>::SingleDiscretisedDensityType::hierarchy_base_type

Output type for the individual images.

Member Function Documentation

set_byte_order()

template<typename DiscDensityT>

ByteOrder stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >::set_byte_order ( const ByteOrder & , const bool warn = false )

overridevirtual

set byte order used for output

Returns type actually used. Calls warning() with some text if the requested type is not supported.

Default implementation accepts any byte order.

Reimplemented from stir::OutputFileFormat< DataT >.

set_defaults()

template<typename DiscDensityT>

void stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >::set_defaults ( )

overrideprotectedvirtual

Set defaults before parsing.

Reimplemented from stir::ParsingObject.

initialise_keymap()

template<typename DiscDensityT>

void stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >::initialise_keymap ( )

overrideprotectedvirtual

Initialise all keywords.

Reimplemented from stir::ParsingObject.

post_processing()

template<typename DiscDensityT>

bool stir::MultiParametricDiscretisedDensityOutputFileFormat< DiscDensityT >::post_processing ( )

overrideprotectedvirtual

This will be called at the end of the parsing.

Returns

false if everything OK, true if not

Reimplemented from stir::ParsingObject.

---

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

• /home/kris/devel/STIRdistrib/STIR/src/include/stir/IO/MultiParametricDiscretisedDensityOutputFileFormat.h