The file syntax for IPF-files (iMOD Point File) is very straightforward and stored in ASCII-format. In this way this type of file can be easily edited and/or created outside iMOD with any other type of (commercial) software package. The syntax of the file is twofold and depends on whether the IPF file need to be associated with additional files like time series, 1D and 3D Boreholes and CPT information (see for more detail 9.7.2.1 and beyond).
1. IPF file that is configured such that is cannot be used with additional, associated, files;
2. IPF file that is configured such that it can be used with additional, associated, files.
The first type of IPF file is very easy and simple. The syntax is equal to any regular comma-separated file.
Variable |
Description |
NLABELS |
Specify for each column the label names. |
DATABLOCK |
For NLABELS, specify individual entries per column. Entries with empty spaces need to be bracketed by single quotes. |
An example of such an IPF file as a comma-separated file is given below:
X,Y,Z,"City of Holland"
100.0,435.0,-32.3,Amsterdam
553.0,143.0,-7.3,"Den Bosch"
Note: It is not allowed to have “/” symbols in the IPF files. iMOD cannot read these character properly.
For such an IPF file it is not necessary to define the number of columns or row to be read in, iMOD will distinguish these itself.
Another IPF format, for which it more desired to explicitly define the number of attributes and entries is given below, as an advantage it allows to attach additional data to the IPF file:
Variable |
Description |
NRECORDS |
Number of records |
NFIELDS |
Number of fields |
FIELDNAME\(_i\) |
Name of the field number i, data is stored in column number i in the DATABLOCK. Repeat this item for NFIELDS on a separate line. |
INDEXCOLUMN,EXTENT |
Number of the index column, to be used for assess an extra file. Use INDEXCOLUMN=0, to indicate that there are no extra files associated. If INDEXCOLUMN \(>\)0, the EXTENT (e.g. TXT), will be added to the names in the INDEXCOLUMN to form the actual filename to be read. The maximum length for the EXTENT is 10 characters. It is not necessary to choose the extension *.TXT for these type of files, moreover, any extension can be chosen as long as the right EXTENT is given in the IPF-file that should call these additional files. |
DATABLOCK |
For NRECORDS each record (line) will contain data for each field. It is not sustained to leave data out, whenever no data is known for that particular field. For each data entry the maximum is 50 characters! |
Example of an IPF-file without a reference to an additional file associated to it (INDEXCOLUMN=0,EXTENT=TXT):
2
4
X
Y
Z
"City of Holland"
0,TXT
100.0,435.0,-32.3,Amsterdam
553.0,143.0,-7.3,"Den Bosch"
The different data for each field should be delimited by a single (or more) space(s), or a comma. Do not use tabs as delimiters! Entries that contain spaces should be encapsulated by quotes, e.g. City of Holland should be entered as ‘City of Holland’.
Associated Files
Associated files can contain different types of data that are processed differently by iMOD. The syntax of each of those type of files is similar each time and described as follows:
Variable |
Description |
NRECORDS |
Number of records |
NFIELDS,ITYPE |
Number of fields and the type of this file.
|
FIELDNAME\(_i\), NODATA\(_i\) |
Name of the field number i, data is stored in column number i in the DATABLOCK. Missing data per field is determined by their corresponding NoDataValue. Repeat this item for NFIELDS. |
DATABLOCK |
For NRECORDS each record (line) will contain data for each field. It is not sustained to leave data out, whenever no data is known for that particular field use the corresponding Field NoDataValue. |
In the next subsections each of those type of files will explained in more detail.
Timevariant information of timeseries can be stored in *.TXT files and their location and other spatial attributes (e.g. depth of the screen, surfacelevel) or non-dimensional information (e.g. id, name) can be stored in the IPF-file. The syntax of the *.TXT file is as follows:
4
3,1
DATE,-9999.0
MEASUREMENT,-9999.0
PREDICTION,-9999.0
19940114 5.70 5.70
19940128 5.73 5.71
19940214 4.95 5.10
19940228 5.01 5.15
Note: It is compulsory to use the first column to enter the date, expressed by a [yyyymmdd] notation or alternatively [yyyymmddhhmmss].
Boreholes can be stored in *.TXT files and their location and other spatial attributes (e.g. surfacelevel) or non-dimensional information (e.g. id, name) can be stored in the IPF-file. The syntax of these *.TXT files is equal to the syntax of the TimeVariant information, however, ITYPE=2.
It is compulsory to use the first column to enter the vertical coordinate, expressed by meter+MSL (mean-sea-level). Use comma’s and/or space(s) as delimiters. Moreover, any other column can be used for colouring the interval i and i+1. In the example below, the Lithology=S will be used to colour the interval between 3.90 and -3.10 m+MSL. The colours that will be used are defined in iMOD or can be read by iMOD from a *.DLF-file.
6
4,2
"Z-COORDINATE,M+MSL",-9999.99
"LITHOLOGY",-9999.99
"SANDCLASS NEN5104",-9999.99
"DISTORTION",-9999.99
3.90,S,NONE,NONE
-3.10,S,NONE,SPARSE
-11.10,S,ZFC,NONE
-23.10,C,NONE,NONE
-26.10,S,ZFC,NONE
-38.10,-,-,-
Cone Penetration Test(or borelog) information can be stored in *.TXT files and their location and other spatial attributes (e.g. surfacelevel) or non-dimensional information (e.g. id, name) can be stored in the IPF-file. The syntax of these *.TXT files is equal to the syntax of the TimeVariant information, however, ITYPE=3. It is compulsory to use the first column to enter the vertical coordinate, expressed by meter+MSL (mean-sea-level). Use comma’s and/or space(s) as delimiters.
6
8,3
"M,LENGTH",-9999.99
"MPA,CONUSRESISTANCE",-9999.99
"MPA,RESISTANCE",-9999.99
0.32,0.721,-9999.99
0.30,0.760,-9999.99
0.28,0.783,0.048
0.26,0.828,0.061
0.24,0.865,0.066
0.22,0.893,0.073
0.20,0.838,0.073
0.16,0.930,0.070
In the example above, the fields that contain values equal to the Field NoDataValue will not be drawn and are excluded in the graph.
3D Boreholes information (dx,dy,z) can be stored in *.TXT files and their origin location and other spatial attributes (e.g. surfacelevel) or non-dimensional information (e.g. id, name) can be stored in the IPF-file. It is compulsory to use the first three columns to enter the offset in x and y direction and the vertical coordinate, expressed by meter+MSL. Use comma’s and/or space(s) as delimiters. Moreover, any other column can be used for colouring the interval i and i+1. In the example below, the Lithology=S will be used to colour the interval between (x,y,z) 5.0,5.0,-1.0 and (x,y,z) 7.5,5.0,-2.5. The colours that will be used are defined in iMOD or can be read by iMOD from a *.DLF-file.
9
4,4
"OFFSET X",-9999.99
"OFFSET Y",-9999.99
"Z-COORDINATE,M+MSL",-9999.99
"PERF_TREATMENT_TYPE",-9999.99
0.0,0.0,0.0,CEMENT
5.0,5.0,-1.0,CEMENT_PLUG
7.5,5.0,-2.5,PERFORATION
12.1,6.0,-4.5,PERFORATION
3.1,2.0,-12.3,"ACID TREATMENT"
-2.1,-3.1,-32.3,"MULTI-STAGE FRACTURE"
-21.1,-43.1,-12.3,"PACKING DEVICE"
-2.1,-5.6,-4.3,"PACKING DEVICE"
-5.1,3.6,-7.3,-
Note: It is possible with this type of boreholes to change azimuth and angle throughout the borehole, in this manner the borehole can move in any direction through the subsoil and even move up- and downwards.