spm_scancontrol.h

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: spm_scancontrol.h
 * ========================================
 * 
 * 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.
 */

/* -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 8 c-style: "K&R" -*- */

#ifndef __SPM_SCANCONTROL_H
#define __SPM_SCANCONTROL_H

typedef enum SCAN_DIR { SCAN_DIR_TOPDOWN, SCAN_DIR_TOPDOWN_BOTUP, SCAN_DIR_BOTUP };
typedef enum SCAN_FLAG { SCAN_FLAG_READY, SCAN_FLAG_STOP,  SCAN_FLAG_PAUSE,  SCAN_FLAG_RUN };
typedef enum SCAN_DT_TYPE { SCAN_LINESCAN, SCAN_FRAMECAPTURE };

// Scan Control Class based on AppBase
// -> AppBase provides a GtkWindow and some window handling basics used by Gxsm
class SPM_ScanControl : public AppBase{
public:
        SPM_ScanControl(); // create window and setup it contents, connect buttons, register cb's...
        virtual ~SPM_ScanControl(); // unregister cb's
        
        void update(); // window update (inputs, etc. -- here currently not really necessary)

        int free_scan_lists (); // clean up all old/previous scan lists
        
        int initialize_scan_lists (); /* this scans the current channel list (Channelselector)
                                         and sets up a list of all scans used for data storage.
                                      */
        int initialize_default_pid_src (); // not jet exsistent (plans to split off initialize_scan_lists).
        int initialize_pid_src (); // not jet exsistent.
        int initialize_daq_srcs (); // not jet exsistent.

        int prepare_to_start_scan (SCAN_DT_TYPE st=SCAN_LINESCAN); /* prepare to start a scan:
                                                                      set common scan parameters,
                                                                      signal "scan start event" to hardware,
                                                                      setup basic scan parameters and put to hardware,
                                                                      initialize scan lists,
                                                                      check for invalid parameters -- cancel in case of bad settings (return -1 if fails, 0 if OK)
                                                                   */
                                                                      
        int setup_scan (int ch, const gchar *titleprefix, 
                        const gchar *name, 
                        const gchar *unit, const gchar *label,
                        const gchar *vunit = NULL, const gchar *vlabel = NULL,
                        const gchar *prbsrcs = NULL, int prboutp = 0);
        /* configure a scan -- gets settings from channelselector/configuration */
        void do_scanline (int init=FALSE); // execute a single scan line -- or if "line == -1" a HS 2D Area Capture/Scan
        void run_probe (int ipx, int ipy); // run a local probe
        int do_scan (); // do a full scan, line by line
        int do_hscapture (); // do a full frame capute
        void set_subscan (int ix0=0, int num=0); /* setup for partial/sub scan, 
                                                    current line, start at x = ix0, num points = num
                                                 */
        void stop_scan () { 
                if (scan_flag == SCAN_FLAG_RUN || scan_flag == SCAN_FLAG_PAUSE) 
                        scan_flag = SCAN_FLAG_STOP; 
        }; // interrupt/cancel a scan in progress
        int pause_scan () { 
                if (scan_flag == SCAN_FLAG_RUN)
                        scan_flag = SCAN_FLAG_PAUSE; 
                else
                        if (scan_flag == SCAN_FLAG_PAUSE)
                                scan_flag = SCAN_FLAG_RUN; 

                return scan_flag == SCAN_FLAG_PAUSE;
        }; // pause a scan in progress
        int scan_in_progress() { 
                return scan_flag == SCAN_FLAG_RUN || scan_flag == SCAN_FLAG_PAUSE 
                        ? TRUE : FALSE; 
        }; // check if a scan is in progress
        int finish_scan (); /* finish the scan:
                               return to origin (center of first line (SPM)),
                               add some log info,
                               free scan lists
                             */

        double update_status_info (int reset=FALSE); // compute and show some scan status info
        void autosave_check (double sec, int initvalue=0); // check of autosave if requested

        int set_x_lookup_value (int i, double lv); // not jet used (future plans for remote...)
        int set_y_lookup_value (int i, double lv); // not jet used
        int set_l_lookup_value (int i, double lv); // not jet used

        // some helpers
        static void call_scan_start (Scan* sc, gpointer data){ sc->start (); };
        static void call_scan_draw_line (Scan* sc, gpointer data){
                sc->draw (((SPM_ScanControl*)data)->line2update, ((SPM_ScanControl*)data)->line2update+1);
        };
        static void call_scan_stop (Scan* sc, gpointer data){ 
                sc->stop (((SPM_ScanControl*)data)->scan_flag == SCAN_FLAG_STOP 
                          && ((SPM_ScanControl*)data)->last_scan_dir == SCAN_DIR_TOPDOWN,
                          ((SPM_ScanControl*)data)->line);
        };

        void SetScanDir (GtkWidget *w) { 
                scan_dir = (SCAN_DIR) ((long) gtk_object_get_data ( GTK_OBJECT (w), "SCANDIR")); 
                PI_DEBUG (DBG_L2, "SCM=" << scan_dir ); };
        void ClrScanDir (GtkWidget *w) { };
        int GetScanDir () {return last_scan_dir==SCAN_DIR_TOPDOWN?1:-1;};
private:
        UnitObj *Unity; // Unit "1"

        Scan   *master_scan; // master "topo" scan -- needed as common parameter reference by probe
        Scan   *master_probescan; // master "probe" scan -- needed as common parameter reference by probe

        /* Scan and ProbeScan Lists: xp = X plus (-> dir), xm = X minus (<- dir) */
        GSList *xp_scan_list, *xp_2nd_scan_list, *xp_prbscan_list;
        GSList *xm_scan_list, *xm_2nd_scan_list, *xm_prbscan_list;

        /* xp/xm source mask (bit encoding of channels to aquire) */
        int    xp_srcs, xm_srcs;
        int    xp_2nd_srcs, xm_2nd_srcs;

        int YOriginTop; /* TRUE if the Y origin is the top (first) line (all SPM),
                           else FALSE (SPALEED uses the image center)
                        */
        
        int yline; /* current scanline moveto coordinare */
        
        int line, line2update; // current scan line and line to update in background
        int ix0off; // current X offset (in pixels) -- if in subscan mode
        SCAN_FLAG scan_flag; // scan status flag
        SCAN_DIR  scan_dir, last_scan_dir; // current and last scan direction
        gboolean      do_probe; // set if currently in probe mode
};

#endif

---