Skip to content

Commit 78ebf33

Browse files
committed
Add information about the supported file formats
1 parent d173ab9 commit 78ebf33

2 files changed

Lines changed: 24 additions & 8 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Surface reconstruction library and CLI for particle data from SPH simulations, w
1515
- [Basic usage](#basic-usage)
1616
- [Sequences of files](#sequences-of-files)
1717
- [Input file formats](#input-file-formats)
18-
- [Ply](#ply)
18+
- [VTK](#vtk)
19+
- [PLY](#ply)
20+
- [XYZ](#xyz)
1921
- [License](#license)
2022

2123
# The `splashsurf` CLI
@@ -154,11 +156,17 @@ With these parameters, a scene with 13353401 particles is reconstructed in nearl
154156

155157
## Input file formats
156158

157-
*TODO: Document more details about the expected format of supported file extensions*
159+
### VTK
158160

159-
### Ply
161+
Files with the "`.vtk`" are loaded using [`vtkio`](https://crates.io/crates/vtkio). The VTK file is loaded as a big endian binary file and has to contain an "Unstructured Grid" with either `f32` or `f64` vertex coordinates. Any other data or attributes are ignored. Only the first "Unstructured Grid" is loaded, other entities are ignored.
160162

161-
The ply format expects an element definition 'vertex', with element properties of 'x,y,z'
163+
### PLY
164+
165+
Files with the "`.ply`" extension are loaded using [`ply-rs`](https://crates.io/crates/ply-rs). The PLY file has to contain an element called "`vertex`" with the properties `x`, `y` and `z` of type `f32`/["`Property::Float`"](https://docs.rs/ply-rs/0.1.3/ply_rs/ply/enum.Property.html#variant.Float). Any other properties or elements are ignored.
166+
167+
### XYZ
168+
169+
Files with the "`.xyz`" extension are interpreted as raw bytes of `f32` values in native endianness of the system. Three consecutive `f32`s represent a (x,y,z) coordinate triplet of a fluid particle.
162170

163171
# License
164172

splashsurf/README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ Surface reconstruction library and CLI for particle data from SPH simulations, w
1515
- [Basic usage](#basic-usage)
1616
- [Sequences of files](#sequences-of-files)
1717
- [Input file formats](#input-file-formats)
18-
- [Ply](#ply)
18+
- [VTK](#vtk)
19+
- [PLY](#ply)
20+
- [XYZ](#xyz)
1921
- [License](#license)
2022

2123
# The `splashsurf` CLI
@@ -154,11 +156,17 @@ With these parameters, a scene with 13353401 particles is reconstructed in nearl
154156

155157
## Input file formats
156158

157-
*TODO: Document more details about the expected format of supported file extensions*
159+
### VTK
158160

159-
### Ply
161+
Files with the "`.vtk`" are loaded using [`vtkio`](https://crates.io/crates/vtkio). The VTK file is loaded as a big endian binary file and has to contain an "Unstructured Grid" with either `f32` or `f64` vertex coordinates. Any other data or attributes are ignored. Only the first "Unstructured Grid" is loaded, other entities are ignored.
160162

161-
The ply format expects an element definition 'vertex', with element properties of 'x,y,z'
163+
### PLY
164+
165+
Files with the "`.ply`" extension are loaded using [`ply-rs`](https://crates.io/crates/ply-rs). The PLY file has to contain an element called "`vertex`" with the properties `x`, `y` and `z` of type `f32`/["`Property::Float`"](https://docs.rs/ply-rs/0.1.3/ply_rs/ply/enum.Property.html#variant.Float). Any other properties or elements are ignored.
166+
167+
### XYZ
168+
169+
Files with the "`.xyz`" extension are interpreted as raw bytes of `f32` values in native endianness of the system. Three consecutive `f32`s represent a (x,y,z) coordinate triplet of a fluid particle.
162170

163171
# License
164172

0 commit comments

Comments
 (0)