.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "VNL-MAKE-MATRIX 1"
.TH VNL-MAKE-MATRIX 1 2024-02-04 "" vnlog
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
vnl\-make\-matrix \- create a matrix from a one\-point\-per\-record vnlog
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\& $ cat /tmp/dat.vnl
\& # i j x
\& 0 0 1
\& 0 1 2
\& 0 2 3
\& 1 0 4
\& 1 1 5
\& 1 2 6
\& 2 0 7
\& 2 1 8
\& 2 2 9
\& 3 0 10
\& 3 1 11
\& 3 2 12
\&
\& $ </tmp/dat.vnl vnl\-filter \-p i,x | vnl\-make\-matrix \-\-outdir /tmp \-\-prefix test_
\& Writing to \*(Aq/tmp/test_x.matrix\*(Aq
\&
\& $ cat /tmp/test_x.matrix
\& 1 2 3
\& 4 5 6
\& 7 8 9
\& 10 11 12
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Vnlog represents each "data item" as a line of text. This is very often what
one wants, but at times it isn't. One example of this is matrix data: we want
each line to contain a whole row of a matrix. This script exists for
convenience, to bridge this gap.
.PP
The input is an vnlog, coming in on STDIN and/or in files given on the
commandline. This vnlog must have at least two fields: the least-significant
(slowest-changing) index of each point (must be the \fIfirst\fR field), and as many
value fields as desired. These points must be written out in order, and it is
assumed that all entries in the matrix are specified. The output is a set of
(non-vnlog) matrix files in the directory given in the \f(CW\*(C`\-\-outdir\*(C'\fR argument.
These files are named \f(CW\*(C`PREFIX_XXX.matrix\*(C'\fR where \f(CW\*(C`PREFIX\*(C'\fR comes from \-\-prefix
(or empty) and \f(CW\*(C`XXX\*(C'\fR is the field name. These matrices can be loaded into any
analysis tool (numpy for instance), or plotted directly with gnuplot:
.PP
.Vb 3
\& set size ratio \-1
\& plot "/tmp/test_x.matrix" matrix with image
\& pause \-1
.Ve
.SH REPOSITORY
.IX Header "REPOSITORY"
https://github.com/dkogan/vnlog/
.SH AUTHOR
.IX Header "AUTHOR"
Dima Kogan \f(CW\*(C`<dima@secretsauce.net>\*(C'\fR
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2016 California Institute of Technology.
.PP
This library is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or (at your option) any
later version.