示例代码
#include <opencv2/core/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);
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;
}
解释
这里我们只讨论XML和YAML文件输入。 您的输出(及其相应的输入)文件可能只有这些扩展中的一个,结构来自此。 它们是您可以序列化的两种数据结构:映射(如STL映射)和元素序列(如STL向量)。 它们之间的区别在于,在地图中,每个元素都有一个唯一的名称,通过您可以访问它。 对于序列,您需要通过它们来查询特定项目。
(1)XML / YAML文件打开和关闭。 在将任何内容写入此类文件之前,您需要打开它并最后将其关闭。 OpenCV中的XML / YAML数据结构是cv :: FileStorage。 要指定此文件绑定到您的硬盘驱动器上的结构,您可以使用其构造函数或open()函数,您使用第二个参数中的任何一个都是一个常量,指定您可以对它们执行的操作类型:WRITE,READ或APPEND。 文件名中指定的扩展名还确定将使用的输出格式。 如果指定* .xml.gz *等扩展名,则可以压缩输出。
当销毁cv :: FileStorage对象时,文件会自动关闭。 但是,您可以使用release函数显式调用此方法:
(2)输入和输出文本和数字。 数据结构使用与STL库相同的<< output运算符。 要输出任何类型的数据结构,我们首先需要指定其名称。 我们只需打印出这个名称就可以做到这一点。 对于基本类型,您可以使用值的打印来执行此操作:
读入是一个简单的寻址(通过[]运算符)和转换操作或通过>>运算符读取:
(3)OpenCV数据结构的输入/输出。 那么这些行为与基本的C ++类型完全一样:
(4)矢量(数组)和关联映射的输入/输出。 正如我之前提到的,我们也可以输出地图和序列(数组,矢量)。 我们再次首先打印变量的名称,然后我们必须指定输出是序列还是映射。
对于序列,在第一个元素之前打印“[”字符,在最后一个元素之后打印“]”字符:
(5)对于Map现在我们使用“{”和“}”分隔符字符:
(6)要从这些中读取,我们使用cv :: FileNode和cv :: FileNodeIterator数据结构。 cv :: FileStorage类的[]运算符返回cv :: FileNode数据类型。 如果节点是顺序的,我们可以使用cv :: FileNodeIterator迭代这些项:
(7)对于Map,您可以再次使用[]运算符来访问给定项目(或者也可以使用>>运算符):
(8)读写您自己的数据结构。
通过在类的内部和外部添加读取和写入函数,可以通过OpenCV I / O XML / YAML接口(就像OpenCV数据结构一样)对此进行序列化。 对于内部部分:
然后,您需要在类外添加以下函数定义:
在这里,您可以观察到,在读取部分中,我们定义了当用户尝试读取不存在的节点时会发生什么。 在这种情况下,我们只返回默认初始化值,但更详细的解决方案是返回例如对象ID的减1值。添加这四个函数后,使用>>运算符进行写操作,使用<<运算符进行读取: