chiark / gitweb /
document options
[chiark-utils.git] / scripts / gnucap2gnuplot
1 #!/usr/bin/perl
2 # This is gnucap2gnuplot, which is Copyright 2004 Ian Jackson.
3 # It's a script to postprocess the output from gnucap and then run gnuplot.
4 #
5 # gnucap2gnuplot and its documentation are free software; you can
6 # redistribute them and/or modify them under the terms of the GNU
7 # General Public License as published by the Free Software Foundation;
8 # either version 2, or (at your option) any later version.
9
10 # gnucap2gnuplot and its documentation are distributed in the hope that
11 # they will be useful, but WITHOUT ANY WARRANTY; without even the
12 # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
13 # PURPOSE.  See the GNU General Public License for more details.
14
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18
19 # usage:
20 #    gnucap2gnuplot [<options>] input-file
21 #
22 # Input file should be a .cir file (will be put through gnucap)
23 #  or an output file from gnucap.
24 #
25 # Produces various output files:
26 #  <input-file>.gnuplots.sh                     run this to display results
27 #  <input-file>,<Kind><N>.gnuplot-cmd           gnuplot script for displaying:
28 #  <input-file>,<Kind><N>-<M>.gnuplot-data      gnuplot-format input data
29 #  <input-file>,gnuplot-fifo                    working fifo for .gnuplots.sh
30 # where
31 #  <Kind> is Freq or Time (according to the type of analysis)
32 #  <N>    is the count, starting at 0, of which report this is from gnucap
33 #  <M>    is the individual column of Y data
34 #
35 # Options
36 #   -g          do run gnucap     ) default is run gnucap
37 #   -G          don't run gnucap  )  if input file ends in .cir
38 #   -o<prefix>  use <prefix> instead of <input-file> in output filenames
39 # If the input file is `-' then you may not specify -g and must use -o.
40 #
41 # Limitations
42 #
43 #  Only Freq (.AC) and Time (.TRAN) plots have been tested.  If
44 #   other types go wrong they can probably be fixed by adding code for
45 #   them to startplot().
46 #
47 #  Displaying voltages and currents on the same .TRAN graph won't work
48 #   well because they currently have to have the same Y scale.  This
49 #   could be fixed by assigning carefully to $mmm in startplot().
50 #
51 #  It's a bit clumsy.
52 #
53 #  There's no easy way to mess with the gnuplot settings.
54
55 sub fail ($) { die "gnucap2gnuplot: $_[0]\n"; }
56
57 while ($ARGV[0] =~ m/^\-./) {
58     if (m/^\-\-$/) {
59         last;
60     } elsif (m/^\-g$/) {
61         $rungnucap= 1;
62     } elsif (m/^\-G$/) {
63         $rungnucap= 0;
64     } elsif (m/^\-o(.+)$/) {
65         $ofb= $1;
66     } else {
67         fail("unknown option $_\n");
68     }
69 }
70
71 if (@ARGV) {
72     @ARGV==1 or fail("one input file only please");
73     $if= shift @ARGV;
74     $ofb= $if unless defined $ofb;
75     $rungnucap= $if =~ m/\.cir$/i unless defined $rungnucap;
76     open STDIN, $rungnucap ? "gnucap -b $if |" : "< $if"
77         or fail("open $if: $!");
78 } else {
79     fail("cannot run gnucap on stdin, run it yourself") if $rungnucap;
80     fail("you must specify -o... when running from stdin") unless defined $ofb;
81 }
82
83 %facttimes= qw(f 1e-15
84                p 1e-12
85                n 1e-9
86                u 1e-6
87                m 1e-3
88                K 1e3
89                Meg 1e6
90                G 1e9
91                T 1e12);
92
93 $sof= "$ofb.gnuplots.sh";
94 open A, "> $sof" or die $!;
95 system 'chmod','+x',"$sof"; $? and die $?;
96 print A <<END
97 #!/bin/sh
98 set -e
99 fi=$ofb,gnuplot-fifo
100 rm -f \$fi
101 mkfifo -m 600 \$fi
102 END
103     or die $!;
104 sub startplot () {
105     open S, "> $ofb,$cplot.gnuplot-cmd" or die $!;
106     print S <<END
107 set data style linespoints
108 set y2tics autofreq
109 set title '$cplot'
110 END
111         or die $!;
112     $mmm[0]= 'x';
113     for ($yn=1; $yn<=$#columns; $yn++) {
114         $mmm[$yn]= 'y';
115     }
116     undef %min;
117     undef %max;
118     if ($kind eq 'Freq') {
119         for ($yn=1; $yn<=$#columns; $yn++) {
120             die unless $columns[$yn] =~ m/.*([MP])\(\d+\)$/;
121             $mmm[$yn]= 'y2' if $1 eq 'P';
122         }
123         print S "set logscale xy\n" or die $!;
124     }
125     for ($yn=1; $yn<=$#columns; $yn++) {
126         open "O$yn", "> $ofb,$cplot-$yn.gnuplot-data" or die $!;
127     }
128 }
129 sub endplot () {
130     return unless defined $kind;
131     foreach $mmm (keys %min) {
132         print S "set ${mmm}range [$min{$mmm}:$max{$mmm}]\n" or die $!;
133     }
134     $sep= "plot ";
135     for ($yn=1; $yn<=$#columns; $yn++) {
136         close "O$yn" or die $!;
137         $mmm[$yn] =~ m/^y2?$/ or die "$mmm[$yn]";
138         $axes= $mmm[$yn]; $axes =~ s/^y$/y1/;
139         $yoff= 1-$yn;
140         print S "$sep\\\n".
141             " '$ofb,$cplot-$yn.gnuplot-data'".
142                 " axes x1$axes title '$columns[$yn]'"
143             or die $!;
144         $sep= ',';
145     }
146     print S "\n\npause -1\n" or die $!;
147     close S or die $!;
148     print A "  gnuplot $ofb,$cplot.gnuplot-cmd <\$fi &\n" or die $!;
149     $kind= undef;
150 }
151
152 while (<STDIN>) {
153     s/\s+$//;
154     if (m/^\#(\w+)/) {
155         endplot();
156         $kind= $1;
157         @columns= split /\s+/;
158         $cplot= $kind.($counter{$kind}++);
159         startplot();
160         next;
161     } elsif (!defined $kind) {
162         next;
163     } elsif (s/^\s+//) {
164         @numbers= split /\s+/;
165         die unless @numbers == @columns;
166         for ($yn=0; $yn<=$#columns; $yn++) {
167             $_= $numbers[$yn];
168             if (m/^(\-?\d+\.\d*)([A-Za-z]+)$/) {
169                 die "factor $2" unless exists $facttimes{$2};
170                 $_= $1*$facttimes{$2};
171                 $numbers[$yn]= $_;
172             }
173             $mmm= $mmm[$yn];
174             $min{$mmm}= $_ unless exists($min{$mmm}) && $min{$mmm} <= $_;
175             $max{$mmm}= $_ unless exists($max{$mmm}) && $max{$mmm} >= $_;
176             if ($yn) {
177                 printf {"O$yn"} "%s %s\n", $numbers[0], $_
178                     or die $!;
179             }
180         }
181     } else {
182         die "$_ ?";
183     }
184 }
185 die "no plots" unless defined $kind;
186 endplot();
187 print A <<END
188 exec 3>\$fi
189 printf 'hit return to quit: '
190 read
191 exec 3>&-
192 END
193     or die $!;
194 close A or die $!;
195 $?=0; close STDIN; $? and fail("gnucap failed (code $?)");
196 $sof= "./$sof" unless $sof =~ m,/,;
197 print ": generated ; $sof\n" or die $!;
198
199 # $Id: gnucap2gnuplot,v 1.2 2004-03-23 23:03:06 ianmdlvl Exp $