Philippe 02/05/2016: moved all LIBTOOLS files in LIBTOOLS directory
[MNH-git_open_source-lfs.git] / LIBTOOLS / readme / LATEX / lfiz.tex
1 \section{Compression of FM files} 
2
3 A specific compression tool has been developed for FM files.  This
4 tool, called {\tt lfiz}, was first devoted for files that will be
5 explored by the graphic utility {\tt diaprog}. In fact, it is also
6 used for files used during a simulation (initial and coupling files)
7 to reduce the data storage.  Some information of how the compression
8 works is given here, its execution is particularly easy.
9
10 \subsection{{\tt lfiz} tool}
11
12 The \texttt{lfiz} tool works on the binary part (LFI file) of a FM
13 file, synchronous or diachronic.  It is a lossy compression tool.
14 The compressed articles are exclusively the 2-dimensional or
15 3-dimensional \texttt{REAL} fields. When dealing with 3D fields the tool works
16 with each 2D plane on every vertical level. The initial values stored
17 with 64-bit \texttt{REAL} precision are first converted into 32-bit
18 \texttt{REAL} precision and then compressed by mapping the 32-bit
19 real values upon 16-bit integer values (with a possible isolation of
20 extrema values).  The better compression is
21 achieved for fields with small value range.  For fields with missing
22 value (e.g.  2-dimensional fields with land-sea mask), the extremum
23 value is excluded and the compression is done on significant values of
24 the field. The minimum compression ratio is 4 for each 2D or 3D
25 \texttt{REAL} compressed field.
26
27 \subsection{{\tt unlfiz} tool}
28 The \texttt{unlfiz} tool will restore the 64-bit \texttt{REAL} value size to all
29 the compressed LFI articles. However, each previously compressed article
30 will gain no more than a 32-bit \texttt{REAL} precision because of the lossy
31 technique involved above.
32
33
34 \subsection{Usage}
35 The binary part of the FM file is required in the current
36 directory. To compress the file \texttt{myfile.lfi}, you can type:
37
38 \begin{verbatim}
39 lfiz myfile.lfi
40 \end{verbatim}
41
42 \noindent This will produce the compressed file \texttt{myfile.Z.lfi}\\
43
44
45 \noindent In the same way, to uncompress the file \texttt{myfile.Z.lfi}, you can
46 type:
47 \begin{verbatim}
48 unlfiz myfile.Z.lfi
49 \end{verbatim}
50
51 \noindent The output file \texttt{myfile.lfi} is a valid LFI file but the LFI
52 articles previously compressed are 64-bit \texttt{REAL} with no more than 32-bit
53 \texttt{REAL} precision.
54
55
56
57
58 %%% Local Variables: 
59 %%% mode: latex
60 %%% TeX-master: "tools"
61 %%% End: