【opencv/core module】(八)File Input and Output using XML and YAML files

说在前面

• opencv版本：4.0.1
• 操作系统：win10
• vs版本：2017
• 官方文档：File Input and Output using XML and YAML files
• 其他说明：自学，记录，demo

SourceCode

• XML/YAML File Open and Close(打开/关闭文件)

  文件访问与c/c++相似，在读写前需要打开文件，使用完成后后关闭文件

  string filename = "I.xml";
  FileStorage fs(filename, FileStorage::WRITE);
  //...
  fs.open(filename, FileStorage::READ);
  

  虽然在FileStory在销毁后文件会自动关闭，但是还是可以自己手动关闭文件，如下

  fs.release();            // explicit close
  

  FileStorage::Mode可选项如下，前4个、中间FORMAT5个、最后俩三种之间可以进行组合，同一类型之间不可以组合。例如WRITE|APPEND就不行，仅表现为WRITE。

type	二进制值	mean
READ	000	读文件，文件必须存在
WRITE	001	写文件，文件不存在则创建，存在则覆盖
APPEND	010	写在文件末，文件不存在则创建
MEMORY	100	flag, read data from source or write data to the internal buffer (which is returned by FileStorage::release)
FORMAT_MASK	111000	格式标志位的掩码
FORMAT_AUTO	000000	自动选择文件格式
FORMAT_XML	001000	xml文件
FORMAT_YAML	010000	yaml文件
FORMAT_JSON	011000	json文件
BASE64	1000000	以BASE64格式写入数据，请使用WRITE_BASE64
WRITE_BASE64	1000001	flag, enable both WRITE and BASE64

• Input and Output of text and numbers(写入/读取文本或数字)

  • 对于写入文本或者数字，我们可以直接使用操作符<<，但是在写入时要加上属性名，便于读取。

  fs << "iterationNr" << 100;
  

  • 读取时通过属性名进行读取

  int itNr;
  fs["iterationNr"] >> itNr;
  //或者
  //itNr = (int) fs["iterationNr"];
  

• Input/Output of OpenCV Data structures(写入/读取opencv数据)

  • 和上面类似

  Mat R = Mat_<uchar >::eye  (3, 3),
  T = Mat_<double>::zeros(3, 1);
  
  fs << "R" << R;                                      // Write cv::Mat
  fs << "T" << T;
  
  fs["R"] >> R;                                      // Read cv::Mat
  fs["T"] >> T;
  

• Input/Output of vectors (arrays) and associative maps(写入/读取数组或者Map)

  • 数组

  fs << "strings" << "[";                          // text - string sequence
  fs << "image1.jpg" << "Awesomeness" << "baboon.jpg";
  fs << "]";                                       // close sequence
  //文件中格式
  //<strings>image1.jpg Awesomeness "../data/baboon.jpg"</strings>
  
  
  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;
  

  • Map

  fs << "Mapping";                              // text - mapping
  fs << "{" << "One" << 1;
  fs <<        "Two" << 2 << "}";
  //文件中格式
  //	<Mapping>
  //	<One>1</One>
  //	<Two>2</Two>
  //	</Mapping>
  
  
  FileNode n = fs["Mapping"];                // Read mappings from a sequence
  cout << "Two  " << (int)(n["Two"]) << "; ";
  cout << "One  " << (int)(n["One"]) << endl << endl;
  

• Read and write your own data structures(写入/读取自定义数据形式)

  • 假定自定义的数据结构如下

  class MyData
  {
  public:
    	MyData() : A(0), X(0), id() {}
  public:   // Data Members
  	int A;
  	double X;
  	string id;
  };
  

  • 成员函数如下

  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"];
  }
  

  • 然后编写外部函数如下

  //这两个函数的格式应该是固定的(用于重载)，FileStorage会调用这俩函数进行读取/写入操作
  //测试删去这俩函数后会出错
  void write(FileStorage& fs, const std::string&, const MyData& x)
  {
  	x.write(fs);
  }
  
  void read(const FileNode& node, MyData& x, const MyData& default_value = MyData())
  {
  	if(node.empty())
  		x = default_value;
  	else
  		x.read(node);
  }
  

  • 完成上面的步骤后我们就可以愉快的写入/读取了

  MyData m(1);
  fs << "MyData" << m;                                // your own data structures
  fs["MyData"] >> m;                                 // Read your own structure_
  

• code

#include <opencv2/core.hpp>
#include <iostream>
#include <string>

using namespace cv;
using namespace std;

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()
{

	string filename = "I.xml";
	{ //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;
			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;
}

Result

---

这篇有点水啊
END-2019.7.1≡(▔﹏▔)≡