org.bytedeco.javacpp

Class opencv_core.FileStorage

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_core.FileStorage

Enclosing class:

opencv_core

public static class opencv_core.FileStorage
extends Pointer

XML/YAML File Storage Class. The class describes an object associated with XML or YAML file. It can be used to store data to such a file or read and decode the data. The storage is organized as a tree of nested sequences (or lists) and mappings. Sequence is a heterogenious array, which elements are accessed by indices or sequentially using an iterator. Mapping is analogue of std::map or C structure, which elements are accessed by names. The most top level structure is a mapping. Leaves of the file storage tree are integers, floating-point numbers and text strings. For example, the following code: \code // open file storage for writing. Type of the file is determined from the extension FileStorage fs("test.yml", FileStorage::WRITE); fs << "test_int" << 5 << "test_real" << 3.1 << "test_string" << "ABCDEFGH"; fs << "test_mat" << Mat::eye(3,3,CV_32F); fs << "test_list" << "[" << 0.0000000000001 << 2 << CV_PI << -3435345 << "2-502 2-029 3egegeg" << "{:" << "month" << 12 << "day" << 31 << "year" << 1969 << "}" << "]"; fs << "test_map" << "{" << "x" << 1 << "y" << 2 << "width" << 100 << "height" << 200 << "lbp" << "[:"; const uchar arr[] = {0, 1, 1, 0, 1, 1, 0, 1}; fs.writeRaw("u", arr, (int)(sizeof(arr)/sizeof(arr[0]))); fs << "]" << "}"; \endcode will produce the following file: \verbatim %YAML:1.0 test_int: 5 test_real: 3.1000000000000001e+00 test_string: ABCDEFGH test_mat: !!opencv-matrix rows: 3 cols: 3 dt: f data: [ 1., 0., 0., 0., 1., 0., 0., 0., 1. ] test_list: - 1.0000000000000000e-13 - 2 - 3.1415926535897931e+00 - -3435345 - "2-502 2-029 3egegeg" - { month:12, day:31, year:1969 } test_map: x: 1 y: 2 width: 100 height: 200 lbp: [ 0, 1, 1, 0, 1, 1, 0, 1 ] \endverbatim and to read the file above, the following code can be used: \code // open file storage for reading. // Type of the file is determined from the content, not the extension FileStorage fs("test.yml", FileStorage::READ); int test_int = (int)fs["test_int"]; double test_real = (double)fs["test_real"]; string test_string = (string)fs["test_string"]; Mat M; fs["test_mat"] >> M; FileNode tl = fs["test_list"]; CV_Assert(tl.type() == FileNode::SEQ && tl.size() == 6); double tl0 = (double)tl[0]; int tl1 = (int)tl[1]; double tl2 = (double)tl[2]; int tl3 = (int)tl[3]; string tl4 = (string)tl[4]; CV_Assert(tl[5].type() == FileNode::MAP && tl[5].size() == 3); int month = (int)tl[5]["month"]; int day = (int)tl[5]["day"]; int year = (int)tl[5]["year"]; FileNode tm = fs["test_map"]; int x = (int)tm["x"]; int y = (int)tm["y"]; int width = (int)tm["width"]; int height = (int)tm["height"]; int lbp_val = 0; FileNodeIterator it = tm["lbp"].begin(); for(int k = 0; k < 8; k++, ++it) lbp_val |= ((int)*it) << k; \endcode

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields

Modifier and Type	Field and Description
static int	APPEND enum cv::FileStorage::
static int	FORMAT_AUTO enum cv::FileStorage::
static int	FORMAT_MASK enum cv::FileStorage::
static int	FORMAT_XML enum cv::FileStorage::
static int	FORMAT_YAML enum cv::FileStorage::
static int	INSIDE_MAP enum cv::FileStorage::
static int	MEMORY enum cv::FileStorage::
static int	NAME_EXPECTED enum cv::FileStorage::
static int	READ enum cv::FileStorage::
static int	UNDEFINED enum cv::FileStorage::
static int	VALUE_EXPECTED enum cv::FileStorage::
static int	WRITE enum cv::FileStorage::

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
opencv_core.FileStorage() the default constructor
opencv_core.FileStorage(BytePointer source, int flags)
opencv_core.FileStorage(BytePointer source, int flags, BytePointer encoding) the full constructor that opens file storage for reading or writing
opencv_core.FileStorage(int size)
opencv_core.FileStorage(opencv_core.CvFileStorage fs) the constructor that takes pointer to the C FileStorage structure
opencv_core.FileStorage(Pointer p)
opencv_core.FileStorage(String source, int flags)
opencv_core.FileStorage(String source, int flags, String encoding)

Method Summary

Methods

Modifier and Type	Method and Description
BytePointer	elname() the currently written element
opencv_core.FileStorage	elname(BytePointer elname)
opencv_core.CvFileStorage	fs() the underlying C FileStorage structure
opencv_core.FileStorage	fs(opencv_core.CvFileStorage fs)
opencv_core.FileNode	get(BytePointer nodename) returns the specified element of the top-level mapping
opencv_core.FileNode	get(String nodename)
static BytePointer	getDefaultObjectName(BytePointer filename) returns the normalized object name for the specified file name
static String	getDefaultObjectName(String filename)
opencv_core.FileNode	getFirstTopLevelNode() returns the first element of the top-level mapping
boolean	isOpened() returns true if the object is associated with currently opened file.
opencv_core.CvFileStorage	multiply() returns pointer to the underlying C FileStorage structure
boolean	open(BytePointer filename, int flags)
boolean	open(BytePointer filename, int flags, BytePointer encoding) opens file storage for reading or writing.
boolean	open(String filename, int flags)
boolean	open(String filename, int flags, String encoding)
opencv_core.FileStorage	position(int position)
void	release() closes the file and releases all the memory buffers
BytePointer	releaseAndGetString() closes the file, releases all the memory buffers and returns the text string
opencv_core.FileNode	root()
opencv_core.FileNode	root(int streamidx) returns the top-level mapping.
int	state() the writer state
opencv_core.FileStorage	state(int state)
BytePointer	structs() the stack of written structures
opencv_core.FileStorage	structs(BytePointer structs)
void	writeObj(BytePointer name, Pointer obj) writes the registered C structure (CvMat, CvMatND, CvSeq).
void	writeObj(String name, Pointer obj)
void	writeRaw(BytePointer fmt, byte[] vec, long len)
void	writeRaw(BytePointer fmt, ByteBuffer vec, long len)
void	writeRaw(BytePointer fmt, BytePointer vec, long len) writes one or more numbers of the specified format to the currently written structure
void	writeRaw(String fmt, byte[] vec, long len)
void	writeRaw(String fmt, ByteBuffer vec, long len)
void	writeRaw(String fmt, BytePointer vec, long len)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

READ

public static final int READ

enum cv::FileStorage::

See Also:

Constant Field Values

WRITE

public static final int WRITE

enum cv::FileStorage::

See Also:

Constant Field Values

APPEND

public static final int APPEND

enum cv::FileStorage::

See Also:

Constant Field Values

MEMORY

public static final int MEMORY

enum cv::FileStorage::

See Also:

Constant Field Values

FORMAT_MASK

public static final int FORMAT_MASK

enum cv::FileStorage::

See Also:

Constant Field Values

FORMAT_AUTO

public static final int FORMAT_AUTO

enum cv::FileStorage::

See Also:

Constant Field Values

FORMAT_XML

public static final int FORMAT_XML

enum cv::FileStorage::

See Also:

Constant Field Values

FORMAT_YAML

public static final int FORMAT_YAML

enum cv::FileStorage::

See Also:

Constant Field Values

UNDEFINED

public static final int UNDEFINED

enum cv::FileStorage::

See Also:

Constant Field Values

VALUE_EXPECTED

public static final int VALUE_EXPECTED

enum cv::FileStorage::

See Also:

Constant Field Values

NAME_EXPECTED

public static final int NAME_EXPECTED

enum cv::FileStorage::

See Also:

Constant Field Values

INSIDE_MAP

public static final int INSIDE_MAP

enum cv::FileStorage::

See Also:

Constant Field Values

Constructor Detail

opencv_core.FileStorage

public opencv_core.FileStorage(Pointer p)

opencv_core.FileStorage

public opencv_core.FileStorage(int size)

opencv_core.FileStorage

public opencv_core.FileStorage()

the default constructor

opencv_core.FileStorage

public opencv_core.FileStorage(BytePointer source,
                       int flags,
                       BytePointer encoding)

the full constructor that opens file storage for reading or writing

opencv_core.FileStorage

public opencv_core.FileStorage(BytePointer source,
                       int flags)

opencv_core.FileStorage

public opencv_core.FileStorage(String source,
                       int flags,
                       String encoding)

opencv_core.FileStorage

public opencv_core.FileStorage(String source,
                       int flags)

opencv_core.FileStorage

public opencv_core.FileStorage(opencv_core.CvFileStorage fs)

the constructor that takes pointer to the C FileStorage structure

Method Detail

position

public opencv_core.FileStorage position(int position)

Overrides:

position in class Pointer

open

public boolean open(BytePointer filename,
           int flags,
           BytePointer encoding)

opens file storage for reading or writing. The previous storage is closed with release()

open

public boolean open(BytePointer filename,
           int flags)

open

public boolean open(String filename,
           int flags,
           String encoding)

open

public boolean open(String filename,
           int flags)

isOpened

public boolean isOpened()

returns true if the object is associated with currently opened file.

release

public void release()

closes the file and releases all the memory buffers

releaseAndGetString

public BytePointer releaseAndGetString()

closes the file, releases all the memory buffers and returns the text string

getFirstTopLevelNode

public opencv_core.FileNode getFirstTopLevelNode()

returns the first element of the top-level mapping

root

public opencv_core.FileNode root(int streamidx)

returns the top-level mapping. YAML supports multiple streams

root

public opencv_core.FileNode root()

get

public opencv_core.FileNode get(BytePointer nodename)

returns the specified element of the top-level mapping

get

public opencv_core.FileNode get(String nodename)

multiply

public opencv_core.CvFileStorage multiply()

returns pointer to the underlying C FileStorage structure

writeRaw

public void writeRaw(BytePointer fmt,
            BytePointer vec,
            long len)

writes one or more numbers of the specified format to the currently written structure

writeRaw

public void writeRaw(String fmt,
            ByteBuffer vec,
            long len)

writeRaw

public void writeRaw(BytePointer fmt,
            byte[] vec,
            long len)

writeRaw

public void writeRaw(String fmt,
            BytePointer vec,
            long len)

writeRaw

public void writeRaw(BytePointer fmt,
            ByteBuffer vec,
            long len)

writeRaw

public void writeRaw(String fmt,
            byte[] vec,
            long len)

writeObj

public void writeObj(BytePointer name,
            Pointer obj)

writes the registered C structure (CvMat, CvMatND, CvSeq). See cvWrite()

writeObj

public void writeObj(String name,
            Pointer obj)

getDefaultObjectName

public static BytePointer getDefaultObjectName(BytePointer filename)

returns the normalized object name for the specified file name

getDefaultObjectName

public static String getDefaultObjectName(String filename)

fs

public opencv_core.CvFileStorage fs()

the underlying C FileStorage structure

fs

public opencv_core.FileStorage fs(opencv_core.CvFileStorage fs)

elname

public BytePointer elname()

the currently written element

elname

public opencv_core.FileStorage elname(BytePointer elname)

structs

public BytePointer structs()

the stack of written structures

structs

public opencv_core.FileStorage structs(BytePointer structs)

state

public int state()

the writer state

state

public opencv_core.FileStorage state(int state)