STIR  6.2.0
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
stir::MultiDynamicDiscretisedDensityOutputFileFormat Class Reference

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

#include "stir/IO/MultiDynamicDiscretisedDensityOutputFileFormat.h"

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

Public Member Functions

 MultiDynamicDiscretisedDensityOutputFileFormat (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 More...
 
- Public Member Functions inherited from stir::RegisteredParsingObject< MultiDynamicDiscretisedDensityOutputFileFormat, OutputFileFormat< DynamicDiscretisedDensity >, OutputFileFormat< DynamicDiscretisedDensity > >
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< DynamicDiscretisedDensity >
 OutputFileFormat (const NumericType &=NumericType::FLOAT, const ByteOrder &=ByteOrder::native)
 
Succeeded write_to_file (std::string &filename, const DynamicDiscretisedDensity &data) const
 Write a single image to file. More...
 
Succeeded write_to_file (const std::string &filename, const DynamicDiscretisedDensity &density) const
 write a single image to file More...
 
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 More...
 
virtual NumericType set_type_of_numbers (const NumericType &, const bool warn=false)
 set type used for outputting numbers More...
 
virtual void set_byte_order_and_type_of_numbers (ByteOrder &, NumericType &, const bool warn=false)
 set byte order and data type used for output More...
 
virtual float set_scale_to_write_data (const float new_scale_to_write_data, const bool warn=false)
 set scale outputting numbers More...
 
- Public Member Functions inherited from stir::ParsingObject
 ParsingObject (const ParsingObject &)
 
ParsingObjectoperator= (const ParsingObject &)
 
void ask_parameters ()
 
bool parse (std::istream &f)
 
bool parse (const char *const filename)
 

Static Public Attributes

static const char *const registered_name = "Multi"
 Name which will be used when parsing an OutputFileFormat object.
 

Protected Member Functions

Succeeded actual_write_to_file (std::string &output_filename, const DynamicDiscretisedDensity &density) const override
 virtual function called by write_to_file() More...
 
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. More...
 
- Protected Member Functions inherited from stir::OutputFileFormat< DynamicDiscretisedDensity >
void set_defaults () override
 sets value for output data type More...
 
void initialise_keymap () override
 sets keys for output data type for parsing More...
 
bool post_processing () override
 Checks if parameters have sensible values after parsing. More...
 
void set_key_values () override
 overloaded member for ParsingObject::set_key_values() More...
 

Protected Attributes

shared_ptr< OutputFileFormat< DiscretisedDensity< 3, float > > > individual_output_type_sptr
 Output type for the individual images.
 
- Protected Attributes inherited from stir::OutputFileFormat< DynamicDiscretisedDensity >
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 More...
 
- Protected Attributes inherited from stir::ParsingObject
KeyParser parser
 

Additional Inherited Members

- Static Public Member Functions inherited from stir::RegisteredParsingObject< MultiDynamicDiscretisedDensityOutputFileFormat, OutputFileFormat< DynamicDiscretisedDensity >, OutputFileFormat< DynamicDiscretisedDensity > >
static OutputFileFormat< DynamicDiscretisedDensity > * read_from_stream (std::istream *)
 Construct a new object (of type Derived) by parsing the istream. More...
 
- Static Public Member Functions inherited from stir::OutputFileFormat< DynamicDiscretisedDensity >
static shared_ptr< OutputFileFormat< DynamicDiscretisedDensity > > default_sptr ()
 A function to return a default output file format.
 
- Static Public Member Functions inherited from stir::RegisteredObject< OutputFileFormat< DynamicDiscretisedDensity > >
static OutputFileFormat< DynamicDiscretisedDensity > * 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. More...
 
static OutputFileFormat< DynamicDiscretisedDensity > * ask_type_and_parameters ()
 ask the user for the type, and then calls read_registered_object(0, type) More...
 
static void list_registered_names (std::ostream &stream)
 List all possible registered names to the stream. More...
 
- Protected Types inherited from stir::RegisteredObject< OutputFileFormat< DynamicDiscretisedDensity > >
typedef OutputFileFormat< DynamicDiscretisedDensity > *(* 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_lessRegistryType
 The type of the registry.
 
- Static Protected Member Functions inherited from stir::RegisteredObject< OutputFileFormat< DynamicDiscretisedDensity > >
static RegistryTyperegistry ()
 Static function returning the registry. More...
 

Detailed Description

Implementation of OutputFileFormat paradigm for the Multi format.

Member Function Documentation

◆ set_byte_order()

ByteOrder stir::MultiDynamicDiscretisedDensityOutputFileFormat::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< DynamicDiscretisedDensity >.

References stir::ByteOrder::is_native_order(), and stir::warning().

◆ actual_write_to_file()

Succeeded stir::MultiDynamicDiscretisedDensityOutputFileFormat::actual_write_to_file ( std::string &  filename,
const DynamicDiscretisedDensity density 
) const
overrideprotectedvirtual

virtual function called by write_to_file()

This function has to be overloaded by the derived class.

The reason we do not simply make write_to_file() virtual is that we have 2 versions of write_to_file. C++ rules are such that overloading the virtual function in a derived class means that the other version gets hidden. Having the non-virtual write_to_file() call the virtual actual_write_to_file() solves this problem.

Implements stir::OutputFileFormat< DynamicDiscretisedDensity >.

References stir::error(), stir::FilePath::get_extension(), and stir::warning().

◆ post_processing()

bool stir::MultiDynamicDiscretisedDensityOutputFileFormat::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 files: