STIR 6.4.0
InterfileOutputFileFormat.h
Go to the documentation of this file.
1//
2//
3/*
4 Copyright (C) 2002-2007, Hammersmith Imanet Ltd
5 This file is part of STIR.
6
7 SPDX-License-Identifier: Apache-2.0
8
9 See STIR/LICENSE.txt for details
10*/
20
21#ifndef __stir_IO_InterfileOutputFileFormat_H__
22#define __stir_IO_InterfileOutputFileFormat_H__
23
26
27START_NAMESPACE_STIR
28
29template <int num_dimensions, typename elemT>
30class DiscretisedDensity;
31
37class InterfileOutputFileFormat : public RegisteredParsingObject<InterfileOutputFileFormat,
38 OutputFileFormat<DiscretisedDensity<3, float>>,
39 OutputFileFormat<DiscretisedDensity<3, float>>>
40{
41private:
42 typedef RegisteredParsingObject<InterfileOutputFileFormat,
45 base_type;
46
47public:
49 static const char* const registered_name;
50
51 InterfileOutputFileFormat(const NumericType& = NumericType::FLOAT, const ByteOrder& = ByteOrder::native);
52
53 ByteOrder set_byte_order(const ByteOrder&, const bool warn = false) override;
54
55protected:
56 Succeeded actual_write_to_file(std::string& output_filename, const DiscretisedDensity<3, float>& density) const override;
57
58 void set_defaults() override;
59 void initialise_keymap() override;
60 bool post_processing() override;
61};
62
63END_NAMESPACE_STIR
64
65#endif
Declaration of class stir::OutputFileFormat.
Declaration of class stir::RegisteredParsingObject.
This class provides member functions to find out what byte-order your machine is and to swap numbers.
Definition ByteOrder.h:100
@ native
Definition ByteOrder.h:107
This abstract class is the basis for all image representations.
Definition DiscretisedDensity.h:99
Succeeded actual_write_to_file(std::string &output_filename, const DiscretisedDensity< 3, float > &density) const override
virtual function called by write_to_file()
Definition InterfileOutputFileFormat.cxx:66
static const char *const registered_name
Name which will be used when parsing an OutputFileFormat object.
Definition InterfileOutputFileFormat.h:49
ByteOrder set_byte_order(const ByteOrder &, const bool warn=false) override
set byte order used for output
Definition InterfileOutputFileFormat.cxx:59
bool post_processing() override
This will be called at the end of the parsing.
Definition InterfileOutputFileFormat.cxx:50
void set_defaults() override
Set defaults before parsing.
Definition InterfileOutputFileFormat.cxx:36
void initialise_keymap() override
Initialise all keywords.
Definition InterfileOutputFileFormat.cxx:42
provides names for some numeric types and methods for finding their properties.
Definition NumericType.h:55
Base class for classes that create output files.
Definition OutputFileFormat.h:56
Parent class for all leaves in a RegisteredObject hierarchy that do parsing of parameter files.
Definition RegisteredParsingObject.h:78
a class containing an enumeration type that can be used by functions to signal successful operation o...
Definition Succeeded.h:44