<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) R.F. Boisvert, C. De Boor (código da biblioteca FORTRAN CMLIB)
 * Copyright (C) B. Pincon (interface Scilab)
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
          xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
          xml:id="splin3d" xml:lang="pt">
    <refnamediv>
        <refname>splin3d</refname>
        <refpurpose>interpolação spline em grides 3d</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>
            tl = splin3d(x, y, z, v)
            tl = splin3d(x, y, z, v, order)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>x,y,z</term>
                <listitem>
                    <para> vetores linhas estritamente crescentes (cada um com pelo
                        menos três componentes) definindo o grid de interpolação 3d
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>v</term>
                <listitem>
                    <para> uma hipermatriz nx x ny x nz (nx, ny, nz sendo de
                        comprimentos de <literal>x</literal>, <literal>y</literal> e
                        <literal>z</literal>, respectivamente)
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>order</term>
                <listitem>
                    <para>(opcional) um vetor 1x3 [kx,ky,kz] dada a ordem do tensor
                        spline em cada direção (o padrão é [4,4,4], i.e. spline tricúbico)
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>tl</term>
                <listitem>
                    <para>um tlist do tipo splin3d definindo o spline</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            Esta função computa um spline tensor 3d <emphasis>s</emphasis> que
            interpola os pontos <emphasis>(xi,yj,zk,vijk)</emphasis>, i.e., temos
            <emphasis>s(xi,yj,zk)=vijk</emphasis> para todo
            <emphasis>i=1,..,nx</emphasis>, <emphasis>j=1,..,ny</emphasis> e
            <emphasis>k=1,..,nz</emphasis>. O spline resultante <emphasis>s</emphasis>
            é definido por <literal>tl</literal> que consiste em uma representação
            B-tensor-spline de <emphasis>s</emphasis>. A avaliação de s em alguns
            pontos deve ser feita pela função <link linkend="interp3d">interp3d</link>
            (para computar s e suas derivadas primeiras) ou pela função
            <link linkend="bsplin3val">bsplin3val</link> (para computar uma derivada
            arbitrária de s) . Vários tipos de splines podem ser computados
            selecionando a ordem dos splines em cada direção
            <literal>order=[kx,ky,kz]</literal>.
        </para>
        <para>
            Observação : Esta função funciona sob as condições
            <table align="center"  style="float:center">
                <tr><td>nx, ny, nz ≥ 3</td></tr>
                <tr><td>2 ≤ kx &lt; nx</td></tr>
                <tr><td>2 ≤ ky &lt; ny</td></tr>
                <tr><td>2 ≤ kz &lt; nz</td></tr>
            </table>
        </para>
        <para>
            Há erro quando estas condições não são respeitadas.
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
// exemplo 1
// =============================================================================

func =  "v=cos(2*%pi*x).*sin(2*%pi*y).*cos(2*%pi*z)";
deff("v=f(x,y,z)",func);
n = 10;  // n x n x n  pontos de interpolação
x = linspace(0,1,n); y=x; z=x; // grid de interpolação
[X,Y,Z] = ndgrid(x,y,z);
V = f(X,Y,Z);
tl = splin3d(x,y,z,V,[5 5 5]);
m = 10000;
// computando um erro aproximado
xp = grand(m,1,"def"); yp = grand(m,1,"def"); zp = grand(m,1,"def");
vp_exact = f(xp,yp,zp);
vp_interp = interp3d(xp,yp,zp, tl);
er = max(abs(vp_exact - vp_interp))
// tente agora com n=20 e veja o erro
     ]]></programlisting>
        <para/>
        <programlisting role="example"><![CDATA[
// exemplo 2 (veja a página de ajuda de linear_interpn que contém o
//            mesmo exemplo com interpolação trilinear)
// =============================================================================

exec("SCI/modules/interpolation/demos/interp_demo.sci", -1);
func =  "v=(x-0.5).^2 + (y-0.5).^3 + (z-0.5).^2";
deff("v=f(x,y,z)",func);
n = 5;
x = linspace(0,1,n); y=x; z=x;
[X,Y,Z] = ndgrid(x,y,z);
V = f(X,Y,Z);
tl = splin3d(x,y,z,V);
// computando e exibindo o spline interpolante 3d em algumas fatias
m = 41;
dir = ["z="  "z="  "z="  "x="  "y="];
val = [ 0.1   0.5   0.9   0.5   0.5];
ebox = [0 1 0 1 0 1];
[XF, YF, ZF, VF] = ([], [], [], []);
for i = 1:length(val)
    [Xm,Xp,Ym,Yp,Zm,Zp] = slice_parallelepiped(dir(i), val(i), ebox, m, m, m);
    Vm = interp3d(Xm,Ym,Zm, tl);
    [xf,yf,zf,vf] = nf3dq(Xm,Ym,Zm,Vm,1);
    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf]; VF = [VF vf];
    Vp = interp3d(Xp,Yp,Zp, tl);
    [xf,yf,zf,vf] = nf3dq(Xp,Yp,Zp,Vp,1);
    XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf]; VF = [VF vf];
end

clf
[nb_col, vmin, vmax] = (128, min(VF), max(VF));
color = dsearch(VF,linspace(vmin,vmax,nb_col+1));
gcf().color_map = jet(nb_col);
gca().hiddencolor = gca().background;
colorbar(vmin,vmax)
plot3d(XF, YF, list(ZF,color), flag=[-1 6 4])
title("interpolação por spline 3d da função "+func, "fontsize",3)
     ]]></programlisting>
        <scilab:image localized="true">
            exec("SCI/modules/interpolation/demos/interp_demo.sci", -1);
            func =  "v=(x-0.5).^2 + (y-0.5).^3 + (z-0.5).^2";
            deff("v=f(x,y,z)",func);
            n = 5;
            x = linspace(0,1,n); y=x; z=x;
            [X,Y,Z] = ndgrid(x,y,z);
            V = f(X,Y,Z);
            tl = splin3d(x,y,z,V);
            // computando e exibindo o spline interpolante 3d em algumas fatias
            m = 41;
            dir = ["z="  "z="  "z="  "x="  "y="];
            val = [ 0.1   0.5   0.9   0.5   0.5];
            ebox = [0 1 0 1 0 1];
            XF=[]; YF=[]; ZF=[]; VF=[];
            for i = 1:length(val)
               [Xm,Xp,Ym,Yp,Zm,Zp] = slice_parallelepiped(dir(i), val(i), ebox, m, m, m);
               Vm = interp3d(Xm,Ym,Zm, tl);
               [xf,yf,zf,vf] = nf3dq(Xm,Ym,Zm,Vm,1);
               XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf]; VF = [VF vf];
               Vp = interp3d(Xp,Yp,Zp, tl);
               [xf,yf,zf,vf] = nf3dq(Xp,Yp,Zp,Vp,1);
               XF = [XF xf]; YF = [YF yf]; ZF = [ZF zf]; VF = [VF vf];
            end
            nb_col = 128;
            vmin = min(VF); vmax = max(VF);
            color = dsearch(VF,linspace(vmin,vmax,nb_col+1));
            gcf().color_map = jet(nb_col);
            clf();
            gca().hiddencolor = gca().background;
            colorbar(vmin,vmax)
            plot3d(XF, YF, list(ZF,color), flag=[-1 6 4])
            xtitle("interpolação por spline 3d da função "+func)
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="linear_interpn">linear_interpn</link>
            </member>
            <member>
                <link linkend="interp3d">interp3d</link>
            </member>
            <member>
                <link linkend="bsplin3val">bsplin3val</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
