Debian Codegraph @

docs/src/dimagehandler.zh_CN.dox

raw
1 /*!
2 @~chinese
3 @file dimagehandler.h
4
5 dimagehandler.h 提供图像处理类 DImageHandler
6
7 @class Dtk::Gui::DImageHandler
8 @brief DImageHandler 提供图像处理,读取、保存、旋转、滤镜等。
9 @details
10 ## 概述
11 提供多种格式图片的读取、保存,允许对部分格式进行旋转。提供多种滤镜、锐化、二值化等图像处理算法。
12 通过 `DImageHandler::setFileName` 设置当前处理的图片文件路径,通过 `DImageHandler::readImage`
13 取得图片数据,通过 `DImageHandler::thumbnail` 取得图片缩略图。设置文件路径将不会立即加载图片,
14 将在需要图片数据时读取,当不需要缓存数据时,可通过 `DImageHandler::clearCache` 清除缓存数据。
15
16 @note 拓展的图片格式依赖 FreeImage 和 LibRaw 公共库,DImageHandler 通过动态加载的方式解析公共库接口。
17 可通过 DImageHandler::supportFormats() 获取当前支持的图片格式类型。
18
19 ## 编译
20 支持拓展的图片格式,编译时会判断环境是否存在依赖包,安装 libfreeimage-dev 及 libraw-dev ,
21 设置编译选项 DTK_DISABLE_EX_IMAGE_FORMAT=OFF 后将开启拓展图片格式支持。
22
23 不同包构建环境默认策略不同,在 **debian** 和 **linglong** 构建环境默认依赖 libfreeimage-dev 及 libraw-dev ,
24 支持拓展图片格式,其它环境需手动安装。
25
26 ## image-handler 工具示例
27 可在程序根目录 ./tools/image-handler 中查看 image-handler 工具项目。
28 image-handler 工具可用于提取图像信息、旋转图像、设置图像滤镜等。
29 ```shell
30 image-handler [options] [file...]
31 ```
32
33 ### image-handler 选项
34 | **选项** | **描述** |
35 |---|---|
36 | -h, --help | 显示工具帮助信息 |
37 | -r, --rotate <degresses> | 根据设置角度旋转图片,旋转角度需为 **90度** 的倍数 |
38 | -o, --output <file> | 保存处理后的文件到指定路径 |
39 | -f <filter> | 为图片设置滤镜,可选图片滤镜包括 old, warm, cool, gray, anticolor, metal |
40 | -l, --list | 列出所有图片的格式 |
41 | -e | 列出所有图片的详细信息,结合 **-l** 使用 |
42
43
44 @fn Dtk::Gui::DImageHandler::DImageHandler(QObject *parent)
45 @brief 构造 DImageHandler 实例,并指定父控件
46 @param[in] parent 作为实例的父控件
47
48 @fn Dtk::Gui::DImageHandler::~DImageHandler()
49 @brief 销毁 DImageHandler 实例
50
51 @fn void Dtk::Gui::DImageHandler::setFileName(const QString &fileName)
52 @brief 设置当前处理的图片文件路径
53 @param[in] fileName 图片文件路径
54
55 @fn QString Dtk::Gui::DImageHandler::fileName() const
56 @brief 返回当前处理的图片文件路径
57 @return 图片文件路径
58
59 @fn QImage Dtk::Gui::DImageHandler::readImage()
60 @brief 从设置的图片文件路径中读取图片
61 @details 从 fileName() 设置的图片文件中读取图片,若读取失败,将返回空图片实例,
62 错误信息通过 lastError() 获取
63 @return 图片实例
64
65 @fn QImage Dtk::Gui::DImageHandler::thumbnail(const QSize &size, Qt::AspectRatioMode mode)
66 @brief 获取当前处理图片指定大小的缩略图,可调整宽高比适配模式
67 @param[in] 缩略图大小
68 @return 缩略图实例
69
70 @fn QString Dtk::Gui::DImageHandler::imageFormat() const
71 @brief 返回当前设置图片文件的格式,若未设置文件路径,返回空字符串
72 @return 图片格式
73
74 @fn QSize Dtk::Gui::DImageHandler::imageSize()
75 @brief 返回当前处理的图片尺寸,若未设置图片文件或加载失败,返回空图片尺寸 (-1, -1)
76 @return 图片大小
77
78 @fn QHash<QString, QString> Dtk::Gui::DImageHandler::findAllMetaData()
79 @brief 查询图片包含的所有元数据,在动态加载 FreeImage 库后有效
80 @return 图片信息表
81
82 @fn void Dtk::Gui::DImageHandler::clearCache()
83 @brief 清空缓存数据,释放缓存的图片和错误信息
84
85 @fn bool Dtk::Gui::DImageHandler::saveImage(const QString &fileName, const QString &format = QString())
86 @brief 保存当前处理的图片至文件,可指定保存的图片格式, 若存在错误,将返回 false ,错误信息通过 lastError() 获取
87 @param[in] fileName 保存的文件路径
88 @param[in] format 指定保存图片格式,默认为空,表示保持原格式
89 @return 是否成功保存图片
90
91 @fn bool Dtk::Gui::DImageHandler::saveImage(const QImage &image, const QString &fileName, const QString &format)
92 @brief 保存图片至文件,可指定保存的图片格式, 若存在错误,将返回 false ,错误信息通过 lastError() 获取
93 @param[in] image 图片实例
94 @param[in] fileName 保存的文件路径
95 @param[in] format 指定保存图片格式,默认为空,表示保持原格式
96 @return 是否成功保存图片
97
98 @fn bool Dtk::Gui::DImageHandler::rotateImage(QImage &image, int angle)
99 @brief 顺时针旋转图片,若存在错误,将返回 false ,错误信息通过 lastError() 获取
100 @param[in,out] image 图片实例
101 @param[in] angle 图片旋转角度,必须以90度为倍数
102 @return 是否成功旋转图片
103
104 @fn bool Dtk::Gui::DImageHandler::rotateImageFile(const QString &fileName, int angle)
105 @brief 顺时针旋转图片文件中的图片
106 @details 读取 fileName 图片文件,顺时针旋转图片 angle 度,并将图片数据写回文件,
107 若存在错误,将返回 false ,错误信息通过 lastError() 获取
108 @param[in] fileName 图片文件路径
109 @param[in] angle 图片旋转角度,必须以90度为倍数
110 @return 是否成功旋转并保存图片文件
111
112 @fn bool Dtk::Gui::DImageHandler::isReadable() const
113 @brief 返回当前设置的图片文件是否可读取,判断基于图片格式,fileName() 为空时返回 false
114 @return 是否可读取
115
116 @fn bool Dtk::Gui::DImageHandler::isWriteable() const
117 @brief 返回当前设置的图片文件是否可写入,判断基于图片格式,fileName() 为空时返回 false
118 @return 是否可写入
119
120 @fn bool Dtk::Gui::DImageHandler::isRotatable() const
121 @brief 返回当前设置的图片文件是否可旋转,判断基于图片格式,fileName() 为空时返回 false
122 @return 是否可旋转
123
124 @fn static QStringList Dtk::Gui::DImageHandler::supportFormats()
125 @brief 返回当前环境下 DImageHandler 可支持的图片格式,可动态加载 FreeImage 库以支持更多图片格式
126 @return 支持的图片格式
127
128 @fn static QString Dtk::Gui::DImageHandler::detectImageFormat(const QString &fileName)
129 @brief 根据文件名称及文件内容检测图片格式
130 @param[in] fileName 图片文件路径
131 @return 图片格式
132
133 @fn QString Dtk::Gui::DImageHandler::lastError() const;
134 @brief 返回最近一次错误的详细信息
135 @return 错误信息
136
137 @fn static QImage Dtk::Gui::DImageHandler::oldColorFilter(const QImage &img)
138 @brief 为图片设置老照片滤镜并返回处理图片实例
139 @param[in] img 待处理的图片实例
140 @return 处理完成的图片实例
141
142 @fn static QImage Dtk::Gui::DImageHandler::warmColorFilter(const QImage &img, int intensity = 30)
143 @brief 为图片设置暖色滤镜并返回处理图片实例
144 @param[in] img 待处理的图片实例
145 @param[in] intensity 滤镜处理强度,取值范围 -255 ~ 255 ,默认30
146 @return 处理完成的图片实例
147
148 @fn static QImage Dtk::Gui::DImageHandler::coolColorFilter(const QImage &img, int intensity = 30)
149 @brief 为图片设置冷色滤镜并返回处理图片实例
150 @param[in] img 待处理的图片实例
151 @param[in] intensity 滤镜处理强度,取值范围 -255 ~ 255 ,默认30
152 @return 处理完成的图片实例
153
154 @fn static QImage Dtk::Gui::DImageHandler::grayScaleColorFilter(const QImage &img)
155 @brief 为图片设置灰色滤镜并返回处理图片实例
156 @param[in] img 待处理的图片实例
157 @return 处理完成的图片实例
158
159 @fn static QImage Dtk::Gui::DImageHandler::antiColorFilter(const QImage &img)
160 @brief 为图片设置反色滤镜并返回处理图片实例
161 @param[in] img 待处理的图片实例
162 @return 处理完成的图片实例
163
164 @fn static QImage Dtk::Gui::DImageHandler::metalColorFilter(const QImage &img)
165 @brief 为图片设置金属风格滤镜并返回处理图片实例
166 @param[in] img 待处理的图片实例
167 @return 处理完成的图片实例
168
169 @fn static QImage Dtk::Gui::DImageHandler::bilateralFilter(const QImage &img, double spatialDecay, double photometricStandardDeviation)
170 @brief 对图片进行双边滤波处理,可保持边界并去除噪点,可用于磨皮等处理
171 @param[in] img 待处理的图片实例
172 @param[in] spatialDecay 空间衰减值,用于双边滤波的空域信息,默认 0.02
173 @param[in] photometricStandardDeviation 光度标准差值,用于双边滤波的值域信息, 默认 10
174 @return 处理完成的图片实例
175
176 @fn static QImage Dtk::Gui::DImageHandler::contourExtraction(const QImage &img)
177 @brief 提取图片轮廓
178 @param[in] img 待处理的图片实例
179 @return 处理完成的图片实例
180
181 @fn static QImage Dtk::Gui::DImageHandler::binaryzation(const QImage &img)
182 @brief 对图片进行二值化处理
183 @param[in] img 待处理的图片实例
184 @return 处理完成的图片实例
185
186 @fn static QImage Dtk::Gui::DImageHandler::grayScale(const QImage &img)
187 @brief 取得灰阶图片
188 @param[in] img 待处理的图片实例
189 @return 处理完成的图片实例
190
191 @fn static QImage Dtk::Gui::DImageHandler::laplaceSharpen(const QImage &img)
192 @brief 拉普拉斯锐化处理
193 @param[in] img 待处理的图片实例
194 @return 处理完成的图片实例
195
196 @fn static QImage Dtk::Gui::DImageHandler::sobelEdgeDetector(const QImage &img)
197 @brief sobel边缘检测处理,用于图片锐化
198 @param[in] img 待处理的图片实例
199 @return 处理完成的图片实例
200
201 @fn static QImage Dtk::Gui::DImageHandler::changeLightAndContrast(const QImage &img, int light = 100, int contrast = 150)
202 @brief 变更图片的亮度和对比度并返回处理图片实例
203 @param[in] img 待处理的图片实例
204 @param[in] light 调整图片亮度,取值范围 0 ~ 300
205 @param[in] constrase 调整图片对比度,取值范围 0 ~ 300
206 @return 处理完成的图片实例
207
208 @fn static QImage Dtk::Gui::DImageHandler::changeBrightness(const QImage &img, int brightness)
209 @brief 调整图片亮度并返回处理图片实例,取值范围 -255 ~ 255
210 @param[in] img 待处理的图片实例
211 @param[in] brightness 图片亮度
212 @return 处理完成的图片实例
213
214 @fn static QImage Dtk::Gui::DImageHandler::changeTransparency(const QImage &img, int transparency)
215 @brief 调整图片透明度并返回处理图片实例,取值范围 0 ~ 255
216 @param[in] img 待处理的图片实例
217 @param[in] transparency 图片透明度
218 @return 处理完成的图片实例
219
220 @fn static QImage Dtk::Gui::DImageHandler::changeStauration(const QImage &img, int saturation)
221 @brief 调整图片饱和度并返回处理图片实例,取值范围 -100 ~ 100
222 @param[in] img 待处理的图片实例
223 @param[in] saturation 图片饱和度
224 @return 处理完成的图片实例
225
226 @fn static QImage Dtk::Gui::DImageHandler::replacePointColor(const QImage &img, QColor oldColor, QColor newColor)
227 @brief 遍历图片所有像素点,替换图片像素点颜色
228 @param[in] img 待处理的图片实例
229 @param[in] oldColor 旧像素颜色
230 @param[in] newColor 新像素颜色
231 @return 处理完成的图片实例
232
233 @fn static QImage Dtk::Gui::DImageHandler::flipHorizontal(const QImage &img)
234 @brief 水平翻转图片
235 @param[in] img 待处理的图片实例
236 @return 处理完成的图片实例
237
238 @fn static QImage Dtk::Gui::DImageHandler::flipVertical(const QImage &img)
239 @brief 垂直翻转图片
240 @param[in] img 待处理的图片
241 @return 处理完成的图片实例
242
243 */