smallconvol.C

Go to the documentation of this file.

/* Gnome gxsm - Gnome X Scanning Microscopy
 * universal STM/AFM/SARLS/SPALEED/... controlling and
 * data analysis software
 * 
 * Gxsm Plugin Name: smallconvol.C
 * ========================================
 * 
 * Copyright (C) 1999 The Free Software Foundation
 *
 * Authors: Percy Zahl <zahl@fkp.uni-hannover.de>
 * additional features: Andreas Klust <klust@fkp.uni-hannover.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

/* Please do not change the Begin/End lines of this comment section!
 * this is a LaTeX style section used for auto generation of the PlugIn Manual 
 * Chapter. Add a complete PlugIn documentation inbetween the Begin/End marks!
 * --------------------------------------------------------------------------------
% BeginPlugInDocuSection
% PlugInDocuCaption: Convolution with 3x3 kernel
% PlugInName: smallconvol
% PlugInAuthor: Percy Zahl
% PlugInAuthorEmail: zahl@users.sf.net
% PlugInMenuPath: Math/Filter 2D/Small Convol

% PlugInDescription
\label{plugin:smallconvol}
This plug-in convolutes the active scan with a 3x3 matrix (kernel).  The
kernel can be changed using \GxsmMenu{Tools/Plugin Details} by calling the
plug-ins configure function (c.f.\ \ref{plugin:listplugins}).

% PlugInUsage
The \GxsmEmph{smallconvol} plug-in can be found in \GxsmMenu{Math/Filter
2D/Small Convol}.  It acts on the active channel and the output is put in
the math channel.

%% OptPlugInKnownBugs
%No known.

% EndPlugInDocuSection
 * -------------------------------------------------------------------------------- 
 */


#include <gtk/gtk.h>
#include "config.h"
#include "gxsm/plugin.h"


static void smallconvol_init( void );
static void smallconvol_about( void );
static void smallconvol_configure( void );
static void smallconvol_cleanup( void );
static gboolean smallconvol_run( Scan *Src, Scan *Dest );

GxsmPlugin smallconvol_pi = {
  NULL,
  NULL,
  0,
  NULL,
  "Smallconvol-M1S-F1D",
  NULL,
  NULL,
  "Percy Zahl",
  "_Math/Filter _2D/",
  N_("Small Convol"),
  N_("Sorry, no help for smallconvol filter!"),
  "no more info",
  NULL,
  NULL,
  smallconvol_init,
  NULL,
  smallconvol_about,
  smallconvol_configure,
  NULL,
  smallconvol_cleanup
};

GxsmMathOneSrcPlugin smallconvol_m1s_pi = {
  smallconvol_run
};

static const char *about_text = N_("Gxsm Smallconvol Plugin\n\n"
                                   "Matrix Convolution PlugIn.");

GxsmPlugin *get_gxsm_plugin_info ( void ){ 
  smallconvol_pi.description = g_strdup_printf(N_("Gxsm MathOneArg smallconvol plugin %s"), VERSION);
  return &smallconvol_pi; 
}

GxsmMathOneSrcPlugin *get_gxsm_math_one_src_plugin_info( void ) { 
  return &smallconvol_m1s_pi; 
}

// Filter Code...

#define SET_SMC_PROGRESS(P) { smallconvol_pi.app->SetProgress((gfloat)(P)); while (gtk_events_pending()) gtk_main_iteration(); }

double kernel[3][3];

static void smallconvol_init(void)
{
  PI_DEBUG (DBG_L2, "Smallconvol Plugin Init");
  // init kernel:
  kernel[0][0] = 1.0;
  kernel[0][1] = 1.0;
  kernel[0][2] = 1.0;
  kernel[1][0] = 1.0;
  kernel[1][1] = 1.0;
  kernel[1][2] = 1.0;
  kernel[2][0] = 1.0;
  kernel[2][1] = 1.0;
  kernel[2][2] = 1.0;
}

static void smallconvol_about(void)
{
  const gchar *authors[] = { smallconvol_pi.authors, NULL};
  gtk_widget_show(gnome_about_new ( smallconvol_pi.name,
                                    VERSION,
                                    N_("(C) 2000 the Free Software Foundation"),
                                    about_text,
                                    authors,
                                    NULL, NULL, NULL
                                    ));
}

static void smallconvol_configure(void)
{
  GtkWidget *dialog;
  GtkWidget *vbox;
  GtkWidget *hbox;
  GtkWidget *info;
  GtkWidget *input;

  dialog = gnome_dialog_new(_("Small Convol Kernel Setup"),
                            GNOME_STOCK_BUTTON_OK,
                            NULL); 
        
  gnome_dialog_set_close(GNOME_DIALOG(dialog), FALSE);
  gnome_dialog_close_hides(GNOME_DIALOG(dialog), FALSE);
  gnome_dialog_set_default(GNOME_DIALOG(dialog), 0);

  vbox = gtk_vbox_new (FALSE, 0);
  gtk_widget_show (vbox);

  gtk_box_pack_start(GTK_BOX(GNOME_DIALOG(dialog)->vbox),
                     vbox, TRUE, TRUE, GNOME_PAD);

  info = gtk_label_new ("3x3 Kernel");
  gtk_widget_show (info);
  gtk_box_pack_start(GTK_BOX(vbox), info, TRUE, TRUE, GNOME_PAD);

  input = smallconvol_pi.app->mygtk_create_input("1", vbox, hbox);
  Gtk_EntryControl ECvar11(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[0][0], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar12(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[0][1], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar13(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[0][2], 
                         -999, 999, ".0f", input);

  input = smallconvol_pi.app->mygtk_create_input("2", vbox, hbox);
  Gtk_EntryControl ECvar21(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[1][0], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar22(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[1][1], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar23(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[1][2], 
                         -999, 999, ".0f", input);

  input = smallconvol_pi.app->mygtk_create_input("3", vbox, hbox);
  Gtk_EntryControl ECvar31(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[2][0], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar32(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[2][1], 
                         -999, 999, ".0f", input);
  input = smallconvol_pi.app->mygtk_add_input(hbox);
  Gtk_EntryControl ECvar33(smallconvol_pi.app->xsm->Unity, "Value out of range !", &kernel[2][2], 
                         -999, 999, ".0f", input);

  gtk_widget_show(dialog);

  gnome_dialog_run_and_close(GNOME_DIALOG(dialog));
}

static void smallconvol_cleanup(void)
{
  PI_DEBUG (DBG_L2, "Smallconvol Plugin Cleanup");
}

// Do 2D Convolution with 3x3 kernel --------------------------------------
static gboolean smallconvol_run(Scan *Src, Scan *Dest)
{
  int line, col;
  ZData *src;

  // new dest size:
  // (the scan size is cropped by one line at each side of the scan
  //  to get rid of border Problems during the convolution)
  Dest->data.s.nx -= 2;
  Dest->data.s.ny -= 2;
  Dest->mem2d->Resize(Dest->data.s.nx, Dest->data.s.ny);

  // compute normalization factors:
  double norm   = 1. / (kernel[0][0] + kernel[0][1] + kernel[0][2] +
                        kernel[1][0] + kernel[1][1] + kernel[1][2] +
                        kernel[2][0] + kernel[2][1] + kernel[2][2]);

  PI_DEBUG (DBG_L2, "Norm of Kernel is " << norm);
  
  // Get help object... for fast access access to surrounding data
  src  = Src->mem2d->data;
  for (line = 0; line < Dest->mem2d->GetNy(); ++line) {
    if(!(line%32)) SET_SMC_PROGRESS( line / Dest->mem2d->GetNy() );
    src->SetPtrTB(1, line+1); // set to x=1 of second line
    for (col = 0; col < Dest->mem2d->GetNx(); ++col) {
      Dest->mem2d->PutDataPkt
        ( norm * 
          ( kernel[0][0] * src->GetThisLT() + // access This-Left-Top
            kernel[1][0] * src->GetThisT() + 
            kernel[2][0] * src->GetThisRT() + 
            
            kernel[0][1] * src->GetThisL() + 
            kernel[1][1] * src->GetThis() + 
            kernel[2][1] * src->GetThisR() + 

            kernel[0][2] * src->GetThisLB() + 
            kernel[1][2] * src->GetThisB() + 
            kernel[2][2] * src->GetThisRB() 
            ), col, line );
      src->IncPtrTB(); // go to next x ...
    }
  }
  SET_SMC_PROGRESS( 0. );
  return MATH_OK;
}

---