smooth.C

Go to the documentation of this file.

/* Gnome gxsm - Gnome X Scanning Microscopy
 * universal STM/AFM/SARLS/SPALEED/... controlling and
 * data analysis software
 *
 * plugin_helper reports your answers as
author          =Percy Zahl
email                   =zahl@users.sf.net
pluginname              =smooth
pluginmenuentry         =Smooth
menupath                =Math/Filter 2D/
entryplace              =Filter 2D
shortentryplace =F2D
abouttext               =Gaussian smooth using 2D convolution.
smallhelp               =gaus smooth
longhelp                =Gausian smooth
 * 
 * Gxsm Plugin Name: smooth.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!
 * All "% PlugInXXX" commentary tags are mandatory
 * All "% OptPlugInXXX" tags are optional and can be removed or commented in
 * --------------------------------------------------------------------------------
% BeginPlugInDocuSection
% PlugInDocuCaption: Smooth
% PlugInName: smooth
% PlugInAuthor: Percy Zahl
% PlugInAuthorEmail: zahl@users.sf.net
% PlugInMenuPath: Math/Filter 2D/Smooth

% PlugInDescription
A 2D Gausian smooth is calculated via convolution with a Gaus-Kernel:

\[ K_{ij} = 4*e^{-\frac{i^2+j^2}{r^2}} \]

% PlugInUsage
Call \GxsmMenu{Math/Filter 2D/Smooth}.

% OptPlugInSources
The active channel is used as data source.

% OptPlugInDest
The computation result is placed into an existing math channel, else
into a new created math channel.

% OptPlugInHints
Alternative: Use the Fourier-Filter methods Gaus-Stop/Pass for huge
convolutions, it's faster!

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

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

// Plugin Prototypes
static void smooth_init( void );
static void smooth_about( void );
static void smooth_configure( void );
static void smooth_cleanup( void );

static gboolean smooth_run_radius(Scan *Src, Scan *Dest);
static void smooth_non_interactive( GtkWidget *widget , gpointer pc );

// Define Type of math plugin here, only one line should be commented in!!
#define GXSM_ONE_SRC_PLUGIN__DEF
// #define GXSM_TWO_SRC_PLUGIN__DEF

// Math-Run-Function, use only one of (automatically done :=)
#ifdef GXSM_ONE_SRC_PLUGIN__DEF
// "OneSrc" Prototype
 static gboolean smooth_run( Scan *Src, Scan *Dest );
#else
// "TwoSrc" Prototype
 static gboolean smooth_run( Scan *Src1, Scan *Src2, Scan *Dest );
#endif

// Fill in the GxsmPlugin Description here
GxsmPlugin smooth_pi = {
  NULL,                   // filled in and used by Gxsm, don't touch !
  NULL,                   // filled in and used by Gxsm, don't touch !
  0,                      // filled in and used by Gxsm, don't touch !
  NULL,                   // The Gxsm-App Class Ref.pointer (called "gapp" in Gxsm) is 
                          // filled in here by Gxsm on Plugin load, 
                          // just after init() is called !!!
  // ----------------------------------------------------------------------
  // Plugins Name, CodeStly is like: Name-M1S|M2S-BG|F1D|F2D|ST|TR|Misc
  "smooth-"
#ifdef GXSM_ONE_SRC_PLUGIN__DEF
  "M1S"
#else
  "M2S"
#endif
  "-F2D",
  // Plugin's Category - used to autodecide on Pluginloading or ignoring
  // NULL: load, else
  // example: "+noHARD +STM +AFM"
  // load only, if "+noHARD: no hardware" and Instrument is STM or AFM
  // +/-xxxHARD und (+/-INST or ...)
  NULL,
  // Description, is shown by PluginViewer (Plugin: listplugin, Tools->Plugin Details)
  "Gaus smooth",                   
  // Author(s)
  "Percy Zahl",
  // Menupath to position where it is appendet to
  N_("_Math/Filter _2D/"),
  // Menuentry
  N_("Smooth"),
  // help text shown on menu
  N_("Gaus smooth"),
  // more info...
  "gaus smooth",
  NULL,          // error msg, plugin may put error status msg here later
  NULL,          // Plugin Status, managed by Gxsm, plugin may manipulate it too
  // init-function pointer, can be "NULL", 
  // called if present at plugin load
  smooth_init,  
  // query-function pointer, can be "NULL", 
  // called if present after plugin init to let plugin manage it install itself
  NULL, // query should be "NULL" for Gxsm-Math-Plugin !!!
  // about-function, can be "NULL"
  // can be called by "Plugin Details"
  smooth_about,
  // configure-function, can be "NULL"
  // can be called by "Plugin Details"
  smooth_configure,
  // run-function, can be "NULL", if non-Zero and no query defined, 
  // it is called on menupath->"plugin"
  NULL, // run should be "NULL" for Gxsm-Math-Plugin !!!
  // cleanup-function, can be "NULL"
  // called if present at plugin removeal
  smooth_cleanup
};

// special math Plugin-Strucure, use
// GxsmMathOneSrcPlugin smooth_m1s_pi -> "OneSrcMath"
// GxsmMathTwoSrcPlugin smooth_m2s_pi -> "TwoSrcMath"
#ifdef GXSM_ONE_SRC_PLUGIN__DEF
 GxsmMathOneSrcPlugin smooth_m1s_pi
#else
 GxsmMathTwoSrcPlugin smooth_m2s_pi
#endif
 = {
   // math-function to run, see prototype(s) above!!
   smooth_run
 };

// Text used in Aboutbox, please update!!
static const char *about_text = N_("Gxsm smooth Plugin\n\n"
                                   "Gaus smooth using a 2D convolution.");

// Symbol "get_gxsm_plugin_info" is resolved by dlsym from Gxsm, used to get Plugin's info!! 
// Essential Plugin Function!!
GxsmPlugin *get_gxsm_plugin_info ( void ){ 
  smooth_pi.description = g_strdup_printf(N_("Gxsm MathOneArg smooth plugin %s"), VERSION);
  return &smooth_pi; 
}

// Symbol "get_gxsm_math_one|two_src_plugin_info" is resolved by dlsym from Gxsm, 
// used to find out which Math Type the Plugin is!! 
// Essential Plugin Function!!
#ifdef GXSM_ONE_SRC_PLUGIN__DEF
GxsmMathOneSrcPlugin *get_gxsm_math_one_src_plugin_info( void ) {
  return &smooth_m1s_pi; 
}
#else
GxsmMathTwoSrcPlugin *get_gxsm_math_two_src_plugin_info( void ) { 
  return &smooth_m2s_pi; 
}
#endif

/* Here we go... */
// init-Function
static void smooth_init(void)
{
  PI_DEBUG (DBG_L2, "smooth Plugin Init");

// This is action remote stuff, stolen from the peak finder PI.
  remote_action_cb *ra;
  GtkWidget *dummywidget = gtk_menu_item_new();

  ra = g_new( remote_action_cb, 1);
  ra -> cmd = g_strdup_printf("smooth_PI");
  ra -> RemoteCb = &smooth_non_interactive;
  ra -> widget = dummywidget;
  ra -> data = NULL;
  gapp->RemoteActionList = g_slist_prepend ( gapp->RemoteActionList, ra );
  PI_DEBUG (DBG_L2, "smooth-plugin: Adding new Remote Cmd: smooth_PI");
// remote action stuff
}

static void smooth_non_interactive( GtkWidget *widget , gpointer pc )
{
  PI_DEBUG (DBG_L2, "smooth-plugin: smooth is called from script.");

//  cout << "pc: " << ((gchar**)pc)[1] << endl;
//  cout << "pc: " << ((gchar**)pc)[2] << endl;
//  cout << "pc: " << atof(((gchar**)pc)[2]) << endl;

  gapp->xsm->MathOperation(&smooth_run_radius);
  return;

}

// about-Function
static void smooth_about(void)
{
  const gchar *authors[] = { smooth_pi.authors, NULL};
  gtk_widget_show(gnome_about_new ( smooth_pi.name,
                                    VERSION,
                                    N_("(C) 2000 the Free Software Foundation"),
                                    about_text,
                                    authors,
                                    NULL, NULL, NULL
                                    ));
}

// configure-Function
static void smooth_configure(void)
{
  if(smooth_pi.app)
    smooth_pi.app->message("smooth Plugin Configuration");
}

// cleanup-Function
static void smooth_cleanup(void)
{
        PI_DEBUG (DBG_L2, "smooth Plugin Cleanup");
}

/*
 * special kernels for MemDigiFilter
 * Gausian Smooth Kernel
 */

class MemSmoothKrn : public MemDigiFilter{
public:
        MemSmoothKrn (double xms, double xns, int m, int n):MemDigiFilter (xms, xns, m, n){};
        virtual gboolean CalcKernel (){
                int i,j;
                for (i= -m; i<=m; i++)
                        for (j = -n; j<=n; j++)
                                data->Z (rint (4*exp (-(i*i)/(xms*xms) -(j*j)/(xns*xns))), j+n, i+m); 
                return 0;
        };
};


// run-Function
static gboolean smooth_run(Scan *Src, Scan *Dest)
{
        double r = 5.;    // Get Radius
        gapp->ValueRequest("2D Convol. Filter Size", "Radius", "Smooth kernel size: s = 1+radius",
                           gapp->xsm->Unity, 0., Src->mem2d->GetNx()/10., ".0f", &r);

        int    s = 1+(int)(r + .9); // calc. approx Matrix Radius
        MemSmoothKrn krn(r,r, s,s); // Setup Kernelobject
        krn.Convolve(Src->mem2d, Dest->mem2d); // Do calculation of Kernel and then do convolution
        return MATH_OK;
}


static gboolean smooth_run_radius(Scan *Src, Scan *Dest)
{
        // equals smooth-run except ValueRequest
        double r = 5.0;    // Get Radius

        int    s = 1+(int)(r + .9); // calc. approx Matrix Radius
        MemSmoothKrn krn(r,r, s,s); // Setup Kernelobject
        krn.Convolve(Src->mem2d, Dest->mem2d); // Do calculation of Kernel and then do convolution
        return MATH_OK;
}

---