summaryrefslogtreecommitdiffstats
path: root/scilab/modules/cacsd/macros/gainplot.sci
blob: 6a1bd2d88a00837ce61c5f185b0893bb3c863421 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) 2010 - INRIA - Serge Steer
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt

function []=gainplot(varargin)
  rhs=size(varargin)
  if type(varargin($))==10 then
    comments=varargin($);
    rhs=rhs-1;
  else
    comments=[];
  end
  fname="gainplot";//for error messages

  fmax=[];
  if or(typeof(varargin(1))==["state-space" "rational"]) then
    //sys,fmin,fmax [,pas] or sys,frq
    refdim=1 //for error message
    if rhs==1 then
      [frq,repf]=repfreq(varargin(1),1d-3,1d3);
    elseif rhs==2 then //sys,frq
      if size(varargin(2),2)<2 then
        error(msprintf(_("%s: Wrong size for input argument #%d: A row vector with length>%d expected.\n"),..
                       fname,2,1));
      end
      [frq,repf]=repfreq(varargin(1:rhs));
    elseif or(rhs==(3:4)) then //sys,fmin,fmax [,pas]
      [frq,repf]=repfreq(varargin(1:rhs));
    else
      error(msprintf(_("%s: Wrong number of input arguments: %d to %d expected.\n"),fname,1,5))
    end
    [phi,d]=phasemag(repf);
  elseif  type(varargin(1))==1 then
    //frq,db,phi [,comments] or frq, repf [,comments]
    refdim=2
    select rhs
    case 2 then //frq,repf
      frq=varargin(1);
      if size(frq,2)<2 then
        error(msprintf(_("%s: Wrong size for input argument #%d: A row vector with length>%d expected.\n"),..
                       fname,1,1))
      end
      if size(frq,2)<>size(varargin(2),2) then
        error(msprintf(_("%s: Incompatible input arguments #%d and #%d: Same column dimensions expected.\n"),..
                       fname,1,2))
      end

      [phi,d]=phasemag(varargin(2))
    case 3 then  //frq,db,phi
      [frq,d]=varargin(1:rhs-1)
      if size(frq,2)<>size(d,2) then
        error(msprintf(_("%s: Incompatible input arguments #%d and #%d: Same column dimensions expected.\n"),..
                       fname,1,2))
      end
    else
      error(msprintf(_("%s: Wrong number of input arguments: %d to %d expected.\n"),fname,2,4))
    end
  else
    error(msprintf(_("%s: Wrong type for input argument #%d: Linear dynamical system or row vector of floats expected.\n"),fname,1))
  end;

  frq=frq';
  d=d';
  [n,mn]=size(d);
  if and(size(comments,"*")<>[0 mn]) then
    error(msprintf(_("%s: Incompatible input arguments #%d and #%d: Same number of elements expected.\n"),...
                   fname,refdim,rhs+1))
  end

  //
  drawlater()
  axes = gca() ;
  if size(axes.children,"*")==0 then
    axes.data_bounds=[min(frq),min(d);max(frq),max(d)]
    axes.x_label.text=_("Frequency (Hz)")
    axes.y_label.text=_("Magnitude (dB)")

  else
    axes.data_bounds=[min([min(frq),min(d)],axes.data_bounds(1,:));
                      max([max(frq),max(d)],axes.data_bounds(2,:))];
  end
  axes.axes_visible="on";
  axes.log_flags = "lnn" ;
  axes.grid=color("lightgrey")*ones(1,3);

  if size(d,2)>1&size(frq,2)==1 then
    xpolys(frq(:,ones(1,mn)),d,1:mn)
    e=gce();
  else
    xpolys(frq,d,1:mn)
    e=gce();
  end
  for i=1:size(e.children,"*")
    datatipInitStruct(e.children(i),"formatfunction","formatGainplotTip")
  end
  if comments<>[] then
    legend(comments)
  end
  drawnow()
endfunction
function str=formatGainplotTip(curve,pt,index)
//this function is called by the datatips mechanism to format the tip
//string for the magnitude bode curves
  str=msprintf("%.4g"+_("Hz")+"\n%.4g"+_("dB"), pt(1),pt(2))
endfunction