1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/************************************************************************
*
* Copyright (C) 2009-2025 IRCAD France
* Copyright (C) 2012-2020 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <core/progress/observer.hpp>
#include <io/__/service/writer.hpp>
#include <filesystem>
namespace sight::data
{
class image;
} // namespace sight::data
namespace sight::module::io::vtk
{
/**
* @brief VTK Image Writer
*
* Service writing a VTK Image using the fwVtkIO lib.
*
* @section Signals Signals
* - \b monitor_created(SPTR(core::progress::monitor)): emitted to display a progress bar while the image is written,
* it should be connected to a progress bar
*
* @section XML XML Configuration
*
* @code{.xml}
<service type="sight::module::io::vtk::image_writer">
<in key="data" uid="..." />
<file>...</file>
</service>
@endcode
* @subsection Input Input
* - \b data [sight::data::image]: image to save.
* @subsection Configuration Configuration
* - \b file (optional): path of the file to save, if it is not defined, 'open_location_dialog()' should be called to
* define the path.
*/
class image_writer : public sight::io::service::writer
{
public:
/**
* @brief Constructor. Do nothing.
*/
image_writer() noexcept;
~image_writer() noexcept override = default;
SIGHT_DECLARE_SERVICE(image_writer, sight::io::service::writer);
/**
* @brief Configure the image path.
*
* This method is used to find
* the file path using a file selector.
*/
void open_location_dialog() override;
/**
* @brief Save a VTK image.
* @param[in] _img_file std::filesystem::path.
* @param[in] _image std::shared_ptr< data::image >.
* @param[in] _sig_monitor_created signal emitted when the image is saved.
* @return bool.
*
* This method is used to save an image using the file path.
* Returns \b true if the image saving is a success and \b false if it fails
*/
static bool save_image(
const std::filesystem::path& _img_file,
const CSPTR(data::image) & _image,
SPTR(core::progress::observer) _progress
);
protected:
sight::io::service::path_type_t get_path_type() const override;
/**
* @brief Starting method.
*
* This method is used to initialize the service.
*/
void starting() override;
/**
* @brief Stopping method.
*
* The stopping method is empty for this service.
*/
void stopping() override;
/**
* @brief Configuring method.
*
* The configuring method only calls the configuring method from the base class
*/
void configuring() override;
/**
* @brief Updating method.
*
* This method is used to update the service.
* The image is read.
*/
void updating() override;
/**
* @brief Info method.
*
* This method is used to give
* informations about the service.
*/
void info(std::ostream& _sstream) override;
private:
/**
* @brief Image path.
*/
std::filesystem::path m_fs_img_path;
};
} // namespace sight::module::io::vtk
|
