1. 目标
本文会解答以下问题：
- 如何打印和读取文本条目到文件和如何在OpenCV中使用YAML或XML文件？
- 如何对OpenCV中的数据结构做同样的事情？
- 如何为自定义数据结构执行此操作？
- 使用 OpenCV 数据结构，例如cv::FileStorage、cv::FileNode或cv::FileNodeIterator。
2. 源代码
从这里下载samples/cpp/tutorial_code/core/file_input_output/file_input_output.cpp或在 OpenCV 源代码库中找到它。
这是如何实现目标列表中列举的所有内容的示例代码。
#include <opencv2/core.hpp>
#include <iostream>
#include <string>
using namespace cv;
using namespace std;
static void help(char** av)
{
cout << endl
<< av[0] << " shows the usage of the OpenCV serialization functionality." << endl
<< "usage: " << endl
<< av[0] << " outputfile.yml.gz" << endl
<< "The output file may be either XML (xml) or YAML (yml/yaml). You can even compress it by "
<< "specifying this in its extension like xml.gz yaml.gz etc... " << endl
<< "With FileStorage you can serialize objects in OpenCV by using the << and >> operators" << endl
<< "For example: - create a class and have it serialized" << endl
<< " - use it to read and write matrices." << endl;
}
class MyData
{
public:
MyData() : A(0), X(0), id()
{}
explicit MyData(int) : A(97), X(CV_PI), id("mydata1234") // explicit to avoid implicit conversion
{}
void write(FileStorage& fs) const //Write serialization for this class
{
fs << "{" << "A" << A << "X" << X << "id" << id << "}";
}
void read(const FileNode& node) //Read serialization for this class
{
A = (int)node["A"];
X = (double)node["X"];
id = (string)node["id"];
}
public: // Data Members
int A;
double X;
string id;
};
//These write and read functions must be defined for the serialization in FileStorage to work
static void write(FileStorage& fs, const std::string&, const MyData& x)
{
x.write(fs);
}
static void read(const FileNode& node, MyData& x, const MyData& default_value = MyData()){
if(node.empty())
x = default_value;
else
x.read(node);
}
// This function will print our custom class to the console
static ostream& operator<<(ostream& out, const MyData& m)
{
out << "{ id = " << m.id << ", ";
out << "X = " << m.X << ", ";
out << "A = " << m.A << "}";
return out;
}
int main(int ac, char** av)
{
if (ac != 2)
{
help(av);
return 1;
}
string filename = av[1];
{ //write
Mat R = Mat_<uchar>::eye(3, 3),
T = Mat_<double>::zeros(3, 1);
MyData m(1);
FileStorage fs(filename, FileStorage::WRITE);
// or:
// FileStorage fs;
// fs.open(filename, FileStorage::WRITE);
fs << "iterationNr" << 100;
fs << "strings" << "["; // text - string sequence
fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
fs << "]"; // close sequence
fs << "Mapping"; // text - mapping
fs << "{" << "One" << 1;
fs << "Two" << 2 << "}";
fs << "R" << R; // cv::Mat
fs << "T" << T;
fs << "MyData" << m; // your own data structures
fs.release(); // explicit close
cout << "Write Done." << endl;
}
{ //read
cout << endl << "Reading: " << endl;
FileStorage fs;
fs.open(filename, FileStorage::READ);
int itNr;
//fs["iterationNr"] >> itNr;
itNr = (int) fs["iterationNr"];
cout << itNr;
if (!fs.isOpened())
{
cerr << "Failed to open " << filename << endl;
help(av);
return 1;
}
FileNode n = fs["strings"]; // Read string sequence - Get node
if (n.type() != FileNode::SEQ)
{
cerr << "strings is not a sequence! FAIL" << endl;
return 1;
}
FileNodeIterator it = n.begin(), it_end = n.end(); // Go through the node
for (; it != it_end; ++it)
cout << (string)*it << endl;
n = fs["Mapping"]; // Read mappings from a sequence
cout << "Two " << (int)(n["Two"]) << "; ";
cout << "One " << (int)(n["One"]) << endl << endl;
MyData m;
Mat R, T;
fs["R"] >> R; // Read cv::Mat
fs["T"] >> T;
fs["MyData"] >> m; // Read your own structure_
cout << endl
<< "R = " << R << endl;
cout << "T = " << T << endl << endl;
cout << "MyData = " << endl << m << endl << endl;
//Show default behavior for non existing nodes
cout << "Attempt to read NonExisting (should initialize the data structure with its default).";
fs["NonExisting"] >> m;
cout << endl << "NonExisting = " << endl << m << endl;
}
cout << endl
<< "Tip: Open up " << filename << " with a text editor to see the serialized data." << endl;
return 0;
}
3. 代码解释
这里只讨论输入文件是XML和YAML。输出（及其对应的输入）文件可能来自可以序列化的两种数据结构：映射 mappings（如 STL 映射和 Python 字典）和序列 element sequence（如 STL 向量）。这两个的区别在于，在映射mappings中，每个元素都有一个唯一的名称，可以通过名称访问值。对于序列element sequence，需要遍历来查询特定项目。
3.1. XML/YAML 文件打开和关闭。
在将任何内容写入文件之前，需要打开并在完成后关闭。OpenCV 中操作XML/YAML数据结构是cv::FileStorage。要打开磁盘上的指定文件，可以使用它的构造函数或 this 的open() 函数：
FileStorage fs(filename, FileStorage::WRITE);
// or:
// FileStorage fs;
// fs.open(filename, FileStorage::WRITE);
第二个参数中的任何一个都是一个常量，指定可以执行的操作类型：WRITE、READ 或 APPEND。文件名中指定的扩展名也决定了将使用的输出格式。如果指定扩展名*.xml.gz*，表示可以压缩输出。
当cv::FileStorage对象被销毁时，文件会自动关闭。但是，也可以使用release函数显式调用它：
fs.release(); // explicit close
3.2. 文本和数字的输入和输出
在 C++ 中，数据结构使用 STL 库中的 << 输出运算符。在 Python 中，使用cv::FileStorage::write()代替。为了输出任何类型的数据结构，首先需要指定它的名称。这只需简单地将它的名称推送到 C++ 中的流中即可。在 Python 中，write 函数的第一个参数是名称。对于基本类型，可以在后面打印 value ：
// iterationNr 是名称
fs << "iterationNr" << 100;
读入是一个简单的寻址（通过 [] 操作符）和强制转换操作或通过 >> 运算符的读取。在 Python 中，我们使用 getNode() 寻址并使用 real() ：
int itNr;
//fs["iterationNr"] >> itNr;
itNr = (int) fs["iterationNr"];
3.3. OpenCV 数据结构的输入/输出
好吧，它们的行为与基本的 C++ 和 Python 类型完全一样：
Mat R = Mat_<uchar>::eye(3, 3),
T = Mat_<double>::zeros(3, 1);
fs << "R" << R; // cv::Mat
fs << "T" << T;
fs["R"] >> R; // Read cv::Mat
fs["T"] >> T;
3.4. 向量（数组）和关联映射的输入/输出
正如之前提到的，也可以输出映射和序列（数组、向量）。同样，首先打印变量的名称，然后必须指定输出是序列还是映射。
在第一个元素之前，打印“[” 字符，最后一个元素之后打印“]”字符：
// 在第一个元素前打印 [
fs << "strings" << "["; // text - string sequence
fs << "image1.jpg" << "Awesomeness" << "../data/baboon.jpg";
fs << "]"; // close sequence
对于映射，基本是相同的，但是前后使用“{”和“}”分隔符：
fs << "Mapping"; // text - mapping
fs << "{" << "One" << 1;
fs << "Two" << 2 << "}";
要从中读取，使用cv::FileNode和cv::FileNodeIterator数据结构。cv::FileStorage类（或 Python 中的 getNode() 函数）的 [] 运算符返回cv::FileNode数据类型。如果节点是连续的，可以使用cv::FileNodeIterator来遍历项目。在 Python 中，at()函数可用于对序列的元素进行寻址，而size()函数返回序列的长度：
FileNode n = fs["strings"]; // Read string sequence - Get node
if (n.type() != FileNode::SEQ)
{
cerr << "strings is not a sequence! FAIL" << endl;
return 1;
}
FileNodeIterator it = n.begin(), it_end = n.end(); // Go through the node
for (; it != it_end; ++it)
cout << (string)*it << endl;
对于映射，也可以使用 [] 运算符（ Python 中的 at()函数）来访问指定的key（或者也可以使用 >> 运算符）：
n = fs["Mapping"]; // Read mappings from a sequence
cout << "Two " << (int)(n["Two"]) << "; ";
cout << "One " << (int)(n["One"]) << endl << endl;
3.5. 读写自定义数据结构
假设有一个自定义数据结构，例如：
class MyData
{
public:
MyData() : A(0), X(0), id() {}
public: // Data Members
int A;
double X;
string id;
};
在 C++ 中，可以通过 OpenCV I/O XML/YAML 接口（就像 OpenCV 数据结构的情况一样）通过在类内部和外部添加读取和写入函数来序列化。对于内部：
void write(FileStorage& fs) const //Write serialization for this class
{
fs << "{" << "A" << A << "X" << X << "id" << id << "}";
}
void read(const FileNode& node) //Read serialization for this class
{
A = (int)node["A"];
X = (double)node["X"];
id = (string)node["id"];
}
在 C++ 中，您需要在类之外添加以下函数定义：
static void write(FileStorage& fs, const std::string&, const MyData& x)
{
x.write(fs);
}
static void read(const FileNode& node, MyData& x, const MyData& default_value = MyData()){
if(node.empty())
x = default_value;
else
x.read(node);
}
现在可以看到，在读取部分中，我们定义了如果用户尝试读取不存在的节点会发生什么。在这种情况下，只返回默认的初始化值，但是更详细的解决方案是返回例如对象 ID 的减一值。
添加这四个函数后，使用 >> 运算符进行写入，使用 << 运算符进行读取（或为 Python 定义的输入/输出函数）：
MyData m(1);
fs << "MyData" << m; // your own data structures
fs["MyData"] >> m; // Read your own structure_
或者尝试阅读不存在的阅读：
cout << "Attempt to read NonExisting (should initialize the data structure with its default).";
fs["NonExisting"] >> m;
cout << endl << "NonExisting = " << endl << m << endl;
4. 结果
大多数情况下，只是打印出定义的数字。在控制台上，可以看到：
Write Done.
Reading:
100image1.jpg
Awesomeness
baboon.jpg
Two 2; One 1
R = [1, 0, 0;
0, 1, 0;
0, 0, 1]
T = [0; 0; 0]
MyData =
{ id = mydata1234, X = 3.14159, A = 97}
Attempt to read NonExisting (should initialize the data structure with its default).
NonExisting =
{ id = , X = 0, A = 0}
Tip: Open up output.xml with a text editor to see the serialized data.
不过，在输出 xml 文件中看到更有趣的内容：
<?xml version="1.0"?>
<opencv_storage>
<iterationNr>100</iterationNr>
<strings>
image1.jpg Awesomeness baboon.jpg</strings>
<Mapping>
<One>1</One>
<Two>2</Two></Mapping>
<R type_id="opencv-matrix">
<rows>3</rows>
<cols>3</cols>
<dt>u</dt>
<data>
1 0 0 0 1 0 0 0 1</data></R>
<T type_id="opencv-matrix">
<rows>3</rows>
<cols>1</cols>
<dt>d</dt>
<data>
0. 0. 0.</data></T>
<MyData>
<A>97</A>
<X>3.1415926535897931e+000</X>
<id>mydata1234</id></MyData>
</opencv_storage>
或者 YAML 文件：
%YAML:1.0
iterationNr: 100
strings:
- "image1.jpg"
- Awesomeness
- "baboon.jpg"
Mapping:
One: 1
Two: 2
R: !!opencv-matrix
rows: 3
cols: 3
dt: u
data: [ 1, 0, 0, 0, 1, 0, 0, 0, 1 ]
T: !!opencv-matrix
rows: 3
cols: 1
dt: d
data: [ 0., 0., 0. ]
MyData:
A: 97
X: 3.1415926535897931e+000
id: mydata1234
