STIR 6.4.0
ECAT6OutputFileFormat.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_ECAT6OutputFileFormat_H__
22#define __stir_IO_ECAT6OutputFileFormat_H__
23
26// include for namespace macros
28#include <string>
29#include "stir/deprecated.h"
30
31START_NAMESPACE_STIR
32template <int num_dimensions, typename elemT>
33class DiscretisedDensity;
34
35START_NAMESPACE_ECAT
36START_NAMESPACE_ECAT6
37
48class STIR_DEPRECATED ECAT6OutputFileFormat : public RegisteredParsingObject<ECAT6OutputFileFormat,
49 OutputFileFormat<DiscretisedDensity<3, float>>,
50 OutputFileFormat<DiscretisedDensity<3, float>>>
51{
52private:
53 typedef RegisteredParsingObject<ECAT6OutputFileFormat,
54 OutputFileFormat<DiscretisedDensity<3, float>>,
55 OutputFileFormat<DiscretisedDensity<3, float>>>
56 base_type;
57
58public:
60 static const char* const registered_name;
61
62 ECAT6OutputFileFormat(const NumericType& = NumericType::SHORT, const ByteOrder& = ByteOrder::native);
63
65
66 virtual NumericType set_type_of_numbers(const NumericType&, const bool warn = false);
68
69 virtual ByteOrder set_byte_order(const ByteOrder&, const bool warn = false);
70
71public:
72 std::string default_scanner_name;
73
74protected:
75 virtual Succeeded actual_write_to_file(std::string& output_filename, const DiscretisedDensity<3, float>& density) const;
76 virtual void set_defaults();
77 virtual void initialise_keymap();
78 virtual bool post_processing();
79};
80
81END_NAMESPACE_ECAT6
82END_NAMESPACE_ECAT
83END_NAMESPACE_STIR
84
85#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
provides names for some numeric types and methods for finding their properties.
Definition NumericType.h:55
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
virtual ByteOrder set_byte_order(const ByteOrder &, const bool warn=false)
Set byte order to be used for output.
Definition ECAT6OutputFileFormat.cxx:92
virtual Succeeded actual_write_to_file(std::string &output_filename, const DiscretisedDensity< 3, float > &density) const
virtual function called by write_to_file()
Definition ECAT6OutputFileFormat.cxx:106
virtual bool post_processing()
This will be called at the end of the parsing.
Definition ECAT6OutputFileFormat.cxx:60
virtual void initialise_keymap()
Initialise all keywords.
Definition ECAT6OutputFileFormat.cxx:42
virtual void set_defaults()
Set defaults before parsing.
Definition ECAT6OutputFileFormat.cxx:51
static const char *const registered_name
Name which will be used when parsing an OutputFileFormat object.
Definition ECAT6OutputFileFormat.h:60
virtual NumericType set_type_of_numbers(const NumericType &, const bool warn=false)
Set type of numbers to be used for output.
Definition ECAT6OutputFileFormat.cxx:77
This file declares a deprecation macro.
#define STIR_DEPRECATED
Deprecation macro.
Definition deprecated.h:21
Declaration of routines which convert ECAT things into our building blocks and vice versa.