TFE function added

14 files changed, 94 insertions, 1 deletions

diff --git a/help/en_US/master_help.xml b/help/en_US/master_help.xml
index 928bf3f..9ff7294 100644
--- a/help/en_US/master_help.xml
+++ b/help/en_US/master_help.xml
@@ -221,6 +221,7 @@
 <!ENTITY a74b148e7e471bd9f170cd4dc3087d2c9 SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/tf2sos.xml">
 <!ENTITY a243b79cdb976d4f432450ea744ca236c SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/tf2zp.xml">
 <!ENTITY a9187ccad1c55b5cd1a5a900b17f2104b SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/tf2zpk.xml">
+<!ENTITY a62d4009c826ca50e7466327e7eaa3dde SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/tfe.xml">
 <!ENTITY a805a0ed4cae04e01f29ecf5f82345622 SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/transpose.xml">
 <!ENTITY a6e3552f90470c430b16dca28da599068 SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/trial_iirlp2mb.xml">
 <!ENTITY aff0a00518280d05c9d58a7de46b1b160 SYSTEM "/home/abhinav/Documents/IITB/Repos/FOSSEE-Signal-Processing-Toolbox/help/en_US/triang.xml">
@@ -485,6 +486,7 @@
 &a74b148e7e471bd9f170cd4dc3087d2c9;
 &a243b79cdb976d4f432450ea744ca236c;
 &a9187ccad1c55b5cd1a5a900b17f2104b;
+&a62d4009c826ca50e7466327e7eaa3dde;
 &a805a0ed4cae04e01f29ecf5f82345622;
 &a6e3552f90470c430b16dca28da599068;
 &aff0a00518280d05c9d58a7de46b1b160;
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
index a84edbe..f80938d 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
index f9a9626..78a675f 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
index 8255fa1..11f7b63 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
index 80cb637..a921a9b 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
index 8970d6a..a8a67ce 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA
@@ -1,2 +1,2 @@
 JavaSearch 1.0
-TMAP bs=2048 rt=1 fl=-1 id1=2513 id2=1
+TMAP bs=2048 rt=1 fl=-1 id1=2516 id2=1
diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
index ed7ae27..8273b39 100644
--- a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
+++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP
diff --git a/help/en_US/scilab_en_US_help/jhelpmap.jhm b/help/en_US/scilab_en_US_help/jhelpmap.jhm
index b4c824f..88502e4 100644
--- a/help/en_US/scilab_en_US_help/jhelpmap.jhm
+++ b/help/en_US/scilab_en_US_help/jhelpmap.jhm
@@ -223,6 +223,7 @@
 <mapID target="tf2sos" url="tf2sos.html"/>
 <mapID target="tf2zp" url="tf2zp.html"/>
 <mapID target="tf2zpk" url="tf2zpk.html"/>
+<mapID target="tfe" url="tfe.html"/>
 <mapID target="transpose" url="transpose.html"/>
 <mapID target="trial_iirlp2mb" url="trial_iirlp2mb.html"/>
 <mapID target="triang" url="triang.html"/>
diff --git a/help/en_US/scilab_en_US_help/jhelptoc.xml b/help/en_US/scilab_en_US_help/jhelptoc.xml
index 5d9607e..56617b9 100644
--- a/help/en_US/scilab_en_US_help/jhelptoc.xml
+++ b/help/en_US/scilab_en_US_help/jhelptoc.xml
@@ -223,6 +223,7 @@
 <tocitem target="tf2sos" text="tf2sos"/>
 <tocitem target="tf2zp" text="tf2zp"/>
 <tocitem target="tf2zpk" text="tf2zpk"/>
+<tocitem target="tfe" text="tfe"/>
 <tocitem target="transpose" text="transpose"/>
 <tocitem target="trial_iirlp2mb" text="trial_iirlp2mb"/>
 <tocitem target="triang" text="triang"/>
diff --git a/help/en_US/tfe.xml b/help/en_US/tfe.xml
new file mode 100644
index 0000000..0e5e35b
--- /dev/null
+++ b/help/en_US/tfe.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from tfe.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="tfe" xml:lang="en"
+          xmlns="http://docbook.org/ns/docbook"
+          xmlns:xlink="http://www.w3.org/1999/xlink"
+          xmlns:svg="http://www.w3.org/2000/svg"
+          xmlns:ns3="http://www.w3.org/1999/xhtml"
+          xmlns:mml="http://www.w3.org/1998/Math/MathML"
+          xmlns:scilab="http://www.scilab.org"
+          xmlns:db="http://docbook.org/ns/docbook">
+
+  <refnamediv>
+    <refname>tfe</refname>
+    <refpurpose>Estimate transfer function of system with input "x" and output "y". Use the Welch (1967) periodogram/FFT method.</refpurpose>
+  </refnamediv>
+
+
+<refsynopsisdiv>
+   <title>Calling Sequence</title>
+   <synopsis>
+   [Pxx,freq] = tfe(x,y,Nfft,Fs,window,overlap,range,plot_type,detrend)
+   </synopsis>
+</refsynopsisdiv>
+
+<refsection>
+   <title>Parameters</title>
+   <variablelist>
+   <varlistentry><term>x:</term>
+      <listitem><para> [non-empty vector] system-input time-series data</para></listitem></varlistentry>
+   <varlistentry><term>y:</term>
+      <listitem><para> [non-empty vector] system-output time-series data</para></listitem></varlistentry>
+   <varlistentry><term>win:</term>
+      <listitem><para>[real vector] of window-function values between 0 and 1; the data segment has the same length as the window. Default window shape is Hamming. [integer scalar] length of each data segment.  The default value is window=sqrt(length(x)) rounded up to the nearest integer power of 2; see 'sloppy' argument.</para></listitem></varlistentry>
+   <varlistentry><term>overlap:</term>
+      <listitem><para>[real scalar] segment overlap expressed as a multiple of window or segment length.   0 &lt;= overlap &lt; 1, The default is overlap=0.5 .</para></listitem></varlistentry>
+   <varlistentry><term>Nfft:</term>
+      <listitem><para>[integer scalar] Length of FFT.  The default is the length of the "window" vector or has the same value as the scalar "window" argument.  If Nfft is larger than the segment length, "seg_len", the data segment is padded with "Nfft-seg_len" zeros.  The default is no padding. Nfft values smaller than the length of the data segment (or window) are ignored silently.</para></listitem></varlistentry>
+   <varlistentry><term>Fs:</term>
+      <listitem><para>[real scalar] sampling frequency (Hertz); default=1.0</para></listitem></varlistentry>
+   <varlistentry><term>range:</term>
+      <listitem><para>'half',  'onesided' : frequency range of the spectrum is zero up to but not including Fs/2.  Power from negative frequencies is added to the positive side of the spectrum, but not at zero or Nyquist (Fs/2) frequencies.  This keeps power equal in time and spectral domains.  See reference [2]. 'whole', 'twosided' : frequency range of the spectrum is-Fs/2 to Fs/2, with negative frequenciesstored in "wrap around" order after the positivefrequencies; e.g. frequencies for a 10-point 'twosided'spectrum are 0 0.1 0.2 0.3 0.4 0.5 -0.4 -0.3 -0.2 -0.1 'shift', 'centerdc' : same as 'whole' but with the first half of the spectrum swapped with second half to put the zero-frequency value in the middle. (See "help fftshift". If data (x and y) are real, the default range is 'half', otherwise default range is 'whole'.</para></listitem></varlistentry>
+   <varlistentry><term>plot_type:</term>
+      <listitem><para> 'plot', 'semilogx', 'semilogy', 'loglog', 'squared' or 'db': specifies the type of plot.  The default is 'plot', which means linear-linear axes. 'squared' is the same as 'plot'. 'dB' plots "10*log10(psd)".  This argument is ignored and a spectrum is not plotted if the caller requires a returned value.</para></listitem></varlistentry>
+   <varlistentry><term>detrends:</term>
+      <listitem><para>'no-strip', 'none' -- do NOT remove mean value from the data'short', 'mean' -- remove the mean value of each segment from each segment of the data. 'linear',-- remove linear trend from each segment of the data.'long-mean'-- remove the mean value from the data before splitting it into segments. This is the default.</para></listitem></varlistentry>
+   </variablelist>
+</refsection>
+
+<refsection>
+   <title>Description</title>
+   <para>
+Estimate transfer function of system with input "x" and output "y". Use the Welch (1967) periodogram/FFT method.
+</para>
+</refsection>
+</refentry>
diff --git a/jar/scilab_en_US_help.jar b/jar/scilab_en_US_help.jar
index f6622b8..611be4e 100644
--- a/jar/scilab_en_US_help.jar
+++ b/jar/scilab_en_US_help.jar
diff --git a/macros/lib b/macros/lib
index 4ca8135..574edf5 100644
--- a/macros/lib
+++ b/macros/lib
diff --git a/macros/names b/macros/names
index b437c07..6639534 100644
--- a/macros/names
+++ b/macros/names
@@ -227,6 +227,7 @@ synthesis
 tf2sos
 tf2zp
 tf2zpk
+tfe
 transpose
 trial_iirlp2mb
 triang
diff --git a/macros/tfe.sci b/macros/tfe.sci
new file mode 100644
index 0000000..5acc391
--- /dev/null
+++ b/macros/tfe.sci
@@ -0,0 +1,27 @@
+function [Pxx,freqs] = tfe(x,y,Nfft,Fs,win,overlap,ran,plot_type,detrends)
+//Estimate transfer function of system with input "x" and output "y". Use the Welch (1967) periodogram/FFT method.
+//Calling Sequence
+// [Pxx,freq] = tfe(x,y,Nfft,Fs,window,overlap,range,plot_type,detrend)
+//Parameters 
+//x: [non-empty vector] system-input time-series data
+//y: [non-empty vector] system-output time-series data
+//win:[real vector] of window-function values between 0 and 1; the data segment has the same length as the window. Default window shape is Hamming. [integer scalar] length of each data segment.  The default value is window=sqrt(length(x)) rounded up to the nearest integer power of 2; see 'sloppy' argument.
+//overlap:[real scalar] segment overlap expressed as a multiple of window or segment length.   0 <= overlap < 1, The default is overlap=0.5 .
+//Nfft:[integer scalar] Length of FFT.  The default is the length of the "window" vector or has the same value as the scalar "window" argument.  If Nfft is larger than the segment length, "seg_len", the data segment is padded with "Nfft-seg_len" zeros.  The default is no padding. Nfft values smaller than the length of the data segment (or window) are ignored silently.
+//Fs:[real scalar] sampling frequency (Hertz); default=1.0 
+//range:'half',  'onesided' : frequency range of the spectrum is zero up to but not including Fs/2.  Power from negative frequencies is added to the positive side of the spectrum, but not at zero or Nyquist (Fs/2) frequencies.  This keeps power equal in time and spectral domains.  See reference [2]. 'whole', 'twosided' : frequency range of the spectrum is-Fs/2 to Fs/2, with negative frequenciesstored in "wrap around" order after the positivefrequencies; e.g. frequencies for a 10-point 'twosided'spectrum are 0 0.1 0.2 0.3 0.4 0.5 -0.4 -0.3 -0.2 -0.1 'shift', 'centerdc' : same as 'whole' but with the first half of the spectrum swapped with second half to put the zero-frequency value in the middle. (See "help fftshift". If data (x and y) are real, the default range is 'half', otherwise default range is 'whole'.
+//plot_type: 'plot', 'semilogx', 'semilogy', 'loglog', 'squared' or 'db': specifies the type of plot.  The default is 'plot', which means linear-linear axes. 'squared' is the same as 'plot'. 'dB' plots "10*log10(psd)".  This argument is ignored and a spectrum is not plotted if the caller requires a returned value.
+//detrends:'no-strip', 'none' -- do NOT remove mean value from the data'short', 'mean' -- remove the mean value of each segment from each segment of the data. 'linear',-- remove linear trend from each segment of the data.'long-mean'-- remove the mean value from the data before splitting it into segments. This is the default.
+//Description
+//Estimate transfer function of system with input "x" and output "y". Use the Welch (1967) periodogram/FFT method.
+	funcprot(0);
+	rhs= argn(2);
+	lhs= argn(1);
+	if(rhs < 10 | rhs > 10)
+		error("Wrong number of input arguments");
+	end
+	select(rhs)
+	case 10 then
+		[Pxx,freqs] = callOctave("tfe",x,y,Nfft,Fs,win,overlap,ran,plot_type,detrends);
+	end
+endfunction
\ No newline at end of file