表格线识别通用库文档
载入中...
搜索中...
未找到
Public 成员函数 | Public 属性 | 所有成员列表
cm::FileManger< T, HASH > 模板类 参考

文件管理器类 更多...

#include <inout.hpp>

Public 成员函数

 FileManger (const std::string &output_root_path="", const std::string &output_file_prefix="")
 文件管理类构造函数
 
FileManger< T, HASH > & SetDirectionName (T dir, const std::string &name)
 设置指定输出文件夹的名称
 
FileManger< T, HASH > & SetDirectionNames (const std::unordered_map< T, std::string, HASH > &names_table)
 批量设置指定输出文件夹的名称
 
FileManger< T, HASH > & OutputImage (T dir, const cv::Mat &image, const std::vector< int > &image_params={}, const std::string &image_name_suffix="", ImageType type=IMT_JPG)
 输出指定类型图片文件到指定文件夹
 
FileManger< T, HASH > & OutputTextFile (T dir, const std::string &text, const std::string &file_name_suffix="", FileType type=FT_TXT)
 输出指定类型文本文件到指定文件夹
 

Public 属性

std::string output_file_prefix
 输出文件名前缀
 

详细描述

template<typename T, typename HASH = EnumHash<T>>
class cm::FileManger< T, HASH >

文件管理器类

该类用于根据需求管理文件（包括文本文件和图片文件）的输出，实现自动将文件输出到指定文件夹。通过设置少量参数控制不同类型文件的输出，避免冗余代码。

模板参数
T不同文件夹枚举类型
HASH枚举哈希仿函数（类型），默认使用 EnumHash
作者
dreamy-xay
日期
2024-03-01

在文件 inout.hpp 第 39 行定义.

构造及析构函数说明

◆ FileManger()

template<typename T , typename HASH >
cm::FileManger< T, HASH >::FileManger ( const std::string & output_root_path = "",
const std::string & output_file_prefix = "" )
inline

文件管理类构造函数

根据给定输出文件的根路径和输出文件名前缀构造一个文件管理器对象。

参数
output_root_path输出根路径 默认为 ""
output_file_prefix输出文件名前缀 默认为 ""
作者
dreamy-xay
日期
2023-12-29

在文件 inout.hpp 第 73 行定义.

成员函数说明

◆ OutputImage()

template<typename T , typename HASH >
FileManger< T, HASH > & cm::FileManger< T, HASH >::OutputImage ( T dir,
const cv::Mat & image,
const std::vector< int > & image_params = {},
const std::string & image_name_suffix = "",
ImageType type = IMT_JPG )
inline

输出指定类型图片文件到指定文件夹

将给定的图片数据输出到指定的文件夹中，并根据指定的参数信息保存为指定类型的图片文件。

参数
dir输出文件夹枚举值
image图片数据
image_params输出图片数据所包含的参数信息（具体可以查看 cv::imwrite 函数） 默认为 {}
image_name_suffix输出图片名的后缀 默认为 ""
type输出图片的类型 默认为 cm::IMT_JPG
返回
类自身引用，方便链式调用
注解
image_params 参数指定保存图像时的压缩格式和压缩质量。可以传入一个 std::vector<int> 类型的参数，其中包含两个元素：压缩格式和压缩质量。例如，可以使用 {cv::IMWRITE_JPEG_QUALITY, 90} 来指定 JPEG 格式的压缩质量为 90。压缩格式可以是 IMWRITE_JPEG_QUALITY、IMWRITE_PNG_COMPRESSION 等。
作者
dreamy-xay
日期
2023-12-29

在文件 inout.hpp 第 154 行定义.

函数调用图:

◆ OutputTextFile()

template<typename T , typename HASH >
FileManger< T, HASH > & cm::FileManger< T, HASH >::OutputTextFile ( T dir,
const std::string & text,
const std::string & file_name_suffix = "",
FileType type = FT_TXT )
inline

输出指定类型文本文件到指定文件夹

将给定的文本数据输出到指定的文件夹中，并根据指定的参数信息保存为指定类型的文本文件。

参数
dir输出文件夹枚举值
text文本内容
file_name_suffix输出文件名的后缀 默认为 ""
type输出文件的类型 默认为 cm::FT_TXT
返回
类自身引用，方便链式调用
作者
dreamy-xay
日期
2023-12-29

在文件 inout.hpp 第 176 行定义.

函数调用图:

◆ SetDirectionName()

template<typename T , typename HASH >
FileManger< T, HASH > & cm::FileManger< T, HASH >::SetDirectionName ( T dir,
const std::string & name )
inline

设置指定输出文件夹的名称

使用给定的名称设置指定输出文件夹的名称，并在输出根路径下创建该文件夹。

参数
dir输出文件夹枚举值
name输出文件夹名称
返回
类自身引用，方便链式调用
注意
如果无法成功创建指定的输出文件夹，则抛出文件夹创建失败异常。
作者
dreamy-xay
日期
2023-12-29

在文件 inout.hpp 第 105 行定义.

函数调用图:

◆ SetDirectionNames()

template<typename T , typename HASH >
FileManger< T, HASH > & cm::FileManger< T, HASH >::SetDirectionNames ( const std::unordered_map< T, std::string, HASH > & names_table)
inline

批量设置指定输出文件夹的名称

遍历整张表，对于 每一项，使用给定的名称设置指定输出文件夹的名称，并在输出根路径下创建该文件夹。

参数
names_table输出文件夹枚举值对应输出文件夹名称所构成的表
返回
类自身引用，方便链式调用
作者
dreamy-xay
日期
2023-12-29

在文件 inout.hpp 第 128 行定义.

函数调用图:

类成员变量说明

◆ output_file_prefix

template<typename T , typename HASH = EnumHash<T>>
std::string cm::FileManger< T, HASH >::output_file_prefix

输出文件名前缀

在文件 inout.hpp 第 49 行定义.

该类的文档由以下文件生成: