Overview | All Modules | Tutorial | User's Guide | Programming Guide |
Module category: IO
Available on all supported platforms.
Name | Type | Description |
FilePath | Browser | File of interest |
Max line length | Integer | length of the max line in the file |
Geometry Type | Choice | Geometry of the input data |
Header | Boolean | Does the file contain an header? (For grids only. Contains the dimensions) |
Header Byte Offset | Integer | Skip X Bytes for header readout |
Header Line Skip | Integer | Skip X lines for header readout |
Dim Pattern | String | Pattern to scan the dimensions from the header |
DimX | Integer | X Dimension (grid only) |
UniDist X | Integer | Uniform distance in X direction (grid only) |
DimY | Integer | Y Dimension (grid only) |
UniDist Y | Integer | Uniform distance in Y direction (grid only) |
DimZ | Integer | Z Dimension (grid only) |
UniDist Z | Integer | Uniform distance in Z direction (grid only) |
Data interleaving | Boolean | Is the data input in an interleaved format? |
Number of Points | Integer | Number of Points (will be calculated for grids) |
Data Byte Offset | Integer | Skip X Bytes for data readout |
Data Line Skip | Integer | Skip X lines for data readout |
Data Format | String | Format to scan the data |
Grid Index Iteration Order | Choice | Iteration order of the index (Structured Grid only) |
Print results to console | Boolean | Print the result in Format: x,y,z(coords) - scalar - x,y,z(value) |
Print debug info to console | Boolean | Print used parameters and their values |
Scale | Float | Scale factor (if factor is 1 it will be ignored) |
Name | Type(s) | Description |
Geometry | Points Uniform Grid Rectilinear Grid Structured Grid | Points or a grid |
ScalarData | Float Float | Scalar data |
VectorData | Vec3 Vec3 | Vector data |
Escape Symbol | Input Type | Example |
%XP | the x-part of the coords of an point | file format: %XP, %YP, %ZP |
%YP | the y-part of the coords of an point | file format: %XP, %YP, %ZP |
%ZP | the z-part of the coords of an point | file format: %XP, %YP, %ZP |
%S | a scalar value (i.e. mass of a star) | file format: point: %XP %YP %ZP value: %S |
%XV | the x-part of a vector Value (i.e. velocity inside a streaming model) | file format: (%XP,%YP,%ZP)|(%XV,%YV,%ZV) |
%XV | the y-part of a vector Value (i.e. velocity inside a streaming model) | file format: (%XP,%YP,%ZP)|(%XV,%YV,%ZV) |
%XV | the z-part of a vector Value (i.e. velocity inside a streaming model) | file format: (%XP,%YP,%ZP)|(%XV,%YV,%ZV) |
%F | a dummy value. Will be ignored | file format: %F. point: %XP, %YP, %ZP |
\ n | a newline, if a reading sequence is expanded to more then one line or data is not interleaved
(see also documentation on interleaved or non-interleaved file formats) | file format: %XP,%YP,%ZP\ n%S |
%% | if your format contains '%' to skip interpreting it | file format: in percent: %F%%, absolut value: %S |
\
n' (see example for non-interleaved data format below)
File example | Format string example | Annotations |
1, 0, 0
3, 0, 0 1, 2, 0 3, 2, 0 1, 0, 2 3, 0, 2 1, 2, 2 3, 2, 2 | %XP, %YP, %ZP | Defines the edges of a cube in interleaved format |
1, 0, 0
14.3 3, 0, 0 67.22 1, 2, 0 7878.0 3, 2, 0 90 | %XP, %YP, %ZP\ n%S | Defines the edges of a rectangle in interleaved format and corresponding scalar values in a new line
Now you could connect a sphere module to the first two ports (points and scalar values) and you get four points with different sizes. |
Note: You cannot apply Byte AND line offset at the same time for the header or the data. You can apply Byte offset for header and line offset for data or revers.
(1,2,3)
(4,5,6) (7,8,9) | That is an interleaved format.
The file format pattern to read that is: (%XP, %YP, %ZP) |
1
4 7 2 5 8 3 6 9 | That are the same vectors in an non-interleaved format
The file format pattern to read that is: (%XP \ n%YP\ n%ZP) |
That is an 2 x 3 x 3 grid in an k, j, i sequence
->iteration sequence z, y, x | The same grid in an i, j, k sequence
->iteration sequence x,y,z |
0, 0, 0
0, 0, 1 0, 0, 2 0, 1, 0 0, 1, 1 0, 1, 2 0, 2, 0 0, 2, 1 0, 2, 2 1, 0, 0 1, 0, 1 1, 0, 2 1, 1, 0 1, 1, 1 1, 1, 2 1, 2, 0 1, 2, 1 1, 2, 2 |
0, 0, 0
1, 0, 0 0, 1, 0 1, 1, 0 0, 2, 0 1, 2, 0 0, 0, 1 1, 0, 1 0, 1, 1 1, 1, 1 0, 2, 1 1, 2, 1 0, 0, 2 1, 0, 2 0, 1, 2 1, 1, 2 0, 2, 2 1, 2, 2 |
Authors: Martin Aumüller, Ruth Lang, Daniela Rainer, Jürgen Schulze-Döbold, Andreas Werner, Peter Wolf, Uwe Wössner |
Copyright © 1993-2022 HLRS, 2004-2014 RRZK, 2005-2014 Visenso |
COVISE Version 2021.12
|