SBF - Revision history

Daniel at 14:04, 21 May 2022

2022-05-21T14:04:10Z

← Older revision		Revision as of 16:04, 21 May 2022
Line 9:		Line 9:
	The file structure is always like this:		The file structure is always like this:
	- myfile.sbf (text file with meta-data)		- myfile.sbf (text file with meta-data)
	- myfile.data~~.sbf~~ (binary file)		- myfile.sbf.data (binary file)

	=Specifications=		=Specifications=
Line 29:		Line 29:
	* the 'p' and 's' options for the scalar fields are optional		* the 'p' and 's' options for the scalar fields are optional
	* the 'p' option is simply stored as meta-data and restored when exporting the cloud to SBF		* the 'p' option is simply stored as meta-data and restored when exporting the cloud to SBF
			* all values should be float/decimal

	==Binary file==		==Binary file==
	This section describes the contents of the binary file (.data~~.sbf~~)		This section describes the contents of the binary file (.sbf.data)

	=== Header ===		=== Header ===
Line 70:		Line 71:
	\|style="border-style: solid; border-width: 1px"\| 0		\|style="border-style: solid; border-width: 1px"\| 0
	\|}		\|}

			Notes: with Python, the following snippet can be used to create the header:
			struct.pack('>2BQH3d28x', 42, 42, no_pt, no_sf, offset_x, offset_y, offset_z)

	=== Body ===		=== Body ===

Daniel: /* Ascii file */

2020-02-09T16:26:50Z

Ascii file

← Older revision		Revision as of 18:26, 9 February 2020
Line 21:		Line 21:
	GlobalShift=-462500.000000, -5640400.000000, 0.000000		GlobalShift=-462500.000000, -5640400.000000, 0.000000
	SFCount=10		SFCount=10
	SF1=name of scalar field~~, p=precision~~, s=shift value		SF1=name of scalar field, s=shift value, p=precision
	SF2=name of scalar field~~, p=precision~~, s=shift value		SF2=name of scalar field, s=shift value, p=precision
	...		...
	SF10=name of scalar field~~{, p=precision~~, s=shift value}		SF10=name of scalar field, s=shift value, p=precision

	Notes:		Notes:

Daniel: /* Ascii file */

2020-02-09T16:26:17Z

Ascii file

← Older revision		Revision as of 18:26, 9 February 2020
Line 26:		Line 26:
	SF10=name of scalar field{, p=precision, s=shift value}		SF10=name of scalar field{, p=precision, s=shift value}

	''Notes		Notes:
	* the 'p' and 's' options for the scalar fields are optional		* the 'p' and 's' options for the scalar fields are optional
	* the 'p' option is simply stored as meta-data and restored when exporting the cloud to SBF		* the 'p' option is simply stored as meta-data and restored when exporting the cloud to SBF
	''

	==Binary file==		==Binary file==

Daniel: /* Ascii file */

2020-02-09T16:26:01Z

Ascii file

← Older revision		Revision as of 18:26, 9 February 2020
Line 26:		Line 26:
	SF10=name of scalar field{, p=precision, s=shift value}		SF10=name of scalar field{, p=precision, s=shift value}

	''~~Note that~~ the 'p' and 's' options for the scalar fields are optional.''		''Notes
			* the 'p' and 's' options for the scalar fields are optional
			* the 'p' option is simply stored as meta-data and restored when exporting the cloud to SBF
			''

	==Binary file==		==Binary file==

Daniel: /* Specifications */

2020-02-09T16:18:11Z

Specifications

← Older revision		Revision as of 18:18, 9 February 2020
Line 12:		Line 12:

	=Specifications=		=Specifications=

			==Ascii file==
			This section describes the contents of the text file (.sbf)

			It has the same structure as a Windows INI file:
			[SBF]
			Points=362315
			GlobalShift=-462500.000000, -5640400.000000, 0.000000
			SFCount=10
			SF1=name of scalar field, p=precision, s=shift value
			SF2=name of scalar field, p=precision, s=shift value
			...
			SF10=name of scalar field{, p=precision, s=shift value}

			''Note that the 'p' and 's' options for the scalar fields are optional.''

	==Binary file==		==Binary file==

Daniel at 10:49, 9 February 2020

2020-02-09T10:49:46Z

← Older revision		Revision as of 12:49, 9 February 2020
Line 3:		Line 3:
	The SBF (Simple Binary File) format, is meant to ease the export and external processing of big point clouds.		The SBF (Simple Binary File) format, is meant to ease the export and external processing of big point clouds.

	While the BIN format of CloudCompare can store about anything created or loaded in CloudCompare, it is complex to decode (as it is a serialized stream of what is loaded in the memory - '''the only way to properly open a BIN file is to use QCC_DB_LIB''').		While the BIN format of CloudCompare can store about anything created or loaded in CloudCompare, it is highly complex to decode (as it is a serialized stream of what is loaded in the memory - '''the only way to properly open a BIN file is to use QCC_DB_LIB''').

	Thus, the SBF format has been created to store ~~data~~ in a ~~Binary~~ file with a very simple structure~~, and to store~~ some more meta-data in a text file next to the binary file.		Thus, the SBF format has been created to store 3D points and scalar field values in a binary file with a very simple structure (+ some more meta-data in a text file next to the binary file).

			The file structure is always like this:
			- myfile.sbf (text file with meta-data)
			- myfile.data.sbf (binary file)

	=Specifications=		=Specifications=

	==Binary file==		==Binary file==
			This section describes the contents of the binary file (.data.sbf)

	=== Header ===		=== Header ===
Line 50:		Line 55:

	=== Body ===		=== Body ===
	~~All values are saved with 32bit floating point precision (= 'float').~~

	For each point (1-Np):		For each point (1-Np):
	{\| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"		{\| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"

Daniel: Created page with "=Introduction= The SBF (Simple Binary File) format, is meant to ease the export and external processing of big point clouds. While the BIN format of CloudCompare can store a..."

2020-02-09T10:47:18Z

Created page with "=Introduction= The SBF (Simple Binary File) format, is meant to ease the export and external processing of big point clouds. While the BIN format of CloudCompare can store a..."

New page

=Introduction=

The SBF (Simple Binary File) format, is meant to ease the export and external processing of big point clouds.

While the BIN format of CloudCompare can store about anything created or loaded in CloudCompare, it is complex to decode (as it is a serialized stream of what is loaded in the memory - '''the only way to properly open a BIN file is to use QCC_DB_LIB''').

Thus, the SBF format has been created to store data in a Binary file with a very simple structure, and to store some more meta-data in a text file next to the binary file.

=Specifications=

==Binary file==

=== Header ===

Total length: 64 bytes

{| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!style="border-style: solid; border-width: 1px"| Bytes
!style="border-style: solid; border-width: 1px"| Description
!style="border-style: solid; border-width: 1px"| Value / comment
|-
|style="border-style: solid; border-width: 1px"| 0-1
|style="border-style: solid; border-width: 1px"| SBF header flag
|style="border-style: solid; border-width: 1px"| 42 42
|-
|style="border-style: solid; border-width: 1px"| 2-9
|style="border-style: solid; border-width: 1px"| Point count (Np)
|style="border-style: solid; border-width: 1px"| 8 bytes unsigned integer
|-
|style="border-style: solid; border-width: 1px"| 10-11
|style="border-style: solid; border-width: 1px"| Scalar field count (Ns)
|style="border-style: solid; border-width: 1px"| 2 bytes unsigned integer
|-
|style="border-style: solid; border-width: 1px"| 12-19
|style="border-style: solid; border-width: 1px"| X coordinate shift (should be added to all 32bit coordinates stored in the file)
|style="border-style: solid; border-width: 1px"| 64bit floating point value ('double')
|-
|style="border-style: solid; border-width: 1px"| 20-27
|style="border-style: solid; border-width: 1px"| Y coordinate shift (should be added to all 32bit coordinates stored in the file)
|style="border-style: solid; border-width: 1px"| 64bit floating point value ('double')
|-
|style="border-style: solid; border-width: 1px"| 28-35
|style="border-style: solid; border-width: 1px"| Z coordinate shift (should be added to all 32bit coordinates stored in the file)
|style="border-style: solid; border-width: 1px"| 64bit floating point value ('double')
|-
|style="border-style: solid; border-width: 1px"| 36-63
|style="border-style: solid; border-width: 1px"| Reserved for later
|style="border-style: solid; border-width: 1px"| 0
|}

=== Body ===
All values are saved with 32bit floating point precision (= 'float').

For each point (1-Np):
{| cellpadding="10" style="text-align:center; border-collapse: collapse; border-width: 1px; border-style: solid; border-color: #000"
!style="border-style: solid; border-width: 1px"| Bytes
!style="border-style: solid; border-width: 1px"| Description
!style="border-style: solid; border-width: 1px"| Value / comment
|-
|style="border-style: solid; border-width: 1px"| 0-3
|style="border-style: solid; border-width: 1px"| X coordinate
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|-
|style="border-style: solid; border-width: 1px"| 4-7
|style="border-style: solid; border-width: 1px"| Y coordinate
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|-
|style="border-style: solid; border-width: 1px"| 8-11
|style="border-style: solid; border-width: 1px"| Z coordinate
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|-
|style="border-style: solid; border-width: 1px"| 12-15
|style="border-style: solid; border-width: 1px"| Scalar value (SF #1)
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|-
|style="border-style: solid; border-width: 1px"| 16-19
|style="border-style: solid; border-width: 1px"| Scalar value (SF #2)
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|-
|style="border-style: solid; border-width: 1px"| ...
|style="border-style: solid; border-width: 1px"| ...
|style="border-style: solid; border-width: 1px"|
|-
|style="border-style: solid; border-width: 1px"| 12-15 + k * 4 (k in [0 ; Ns[)
|style="border-style: solid; border-width: 1px"| Scalar value (SF #k)
|style="border-style: solid; border-width: 1px"| 32bit floating point value ('float')
|}