Libpiv API documentation

 Search for 

gpiv-trig.h

Go to the documentation of this file.

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

/*-----------------------------------------------------------------------------
   libgpiv - library for Particle Image Velocimetry

   Copyright (C) 2002, 2003, 2004, 2005
   Gerber van der Graaf <gerber_graaf@users.sourceforge.net>

   This file is part of libgpiv.

   Libgpiv 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, 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.  




-------------------------------------------------------------------------------
LIBRARY:                libgpiv
EXTERNAL FUNCTIONS:
                        gpiv_trig_openrtfs
                        gpiv_trig_default_parameters
                        gpiv_trig_read_parameters
                        gpiv_trig_check_parameters_read
                        gpiv_trig_parameters_set
                        gpiv_trig_test_parameter
                        gpiv_trig_fprint_parameters

LAST MODIFICATION DATE:  $Id: trig.h,v 1.3 2007-06-06 16:59:02 gerber Exp $
---------------------------------------------------------------------------- */

#ifndef __LIBGPIV_TRIG_H__
#define __LIBGPIV_TRIG_H__



/* #include <rtai.h> */
/* #include <fcntl.h> */

/*
 * Default values and keys of GpivTrigPar
 */
#define GPIV_TRIGPAR_DEFAULT__CAP 250    
#define GPIV_TRIGPAR_DEFAULT__LPW 0.02   
#define GPIV_TRIGPAR_DEFAULT__T2L 0.19   
#define GPIV_TRIGPAR_DEFAULT__DT 10      
#define GPIV_TRIGPAR_DEFAULT__MODE 2     
#define GPIV_TRIGPAR_DEFAULT__CYCLES 1   
#define GPIV_TRIGPAR_DEFAULT__INCR_DT 1  
#define GPIV_TRIGPAR_KEY "TRIG" 
#define GPIV_TRIGPAR_KEY__CAP "Ttime_cap"    
#define GPIV_TRIGPAR_KEY__LPW "Ttime_lpw"   
#define GPIV_TRIGPAR_KEY__T2L "Ttime_t2l"  
#define GPIV_TRIGPAR_KEY__DT "Ttime_dt"    
#define GPIV_TRIGPAR_KEY__MODE "Ttime_mode"     
#define GPIV_TRIGPAR_KEY__CYCLES "Ttime_cycles"   
#define GPIV_TRIGPAR_KEY__INCR_DT "Ttime_incr_dt"  
#define GPIV_TRIGPAR_CAP_MIN 100         
#define GPIV_TRIGPAR_LPW_MIN 0.02        
#define GPIV_TRIGPAR_T2L_MIN 0.19        
#define GPIV_TRIGPAR_DT_MIN 0.10         
#define GPIV_TRIGPAR_MODE_MIN 1          
#define GPIV_TRIGPAR_CYCLES_MIN 1        
#define GPIV_TRIGPAR_INCR_DT_MIN 0.01    
#define GPIV_TRIGPAR_CAP_MAX 1000         
#define GPIV_TRIGPAR_LPW_MAX 0.02         
#define GPIV_TRIGPAR_T2L_MAX 0.19         
#define GPIV_TRIGPAR_DT_MAX 100           
#define GPIV_TRIGPAR_MODE_MAX 6           
#define GPIV_TRIGPAR_CYCLES_MAX 1         
#define GPIV_TRIGPAR_INCR_DT_MAX 20       
#define GPIV_NANO2MILI 0.001 * 0.001            
#define GPIV_MILI2NANO 1000 * 1000              
enum GpivFifo {
    GPIV_FIFO_TIMING_PARAMETER = 1,
    GPIV_FIFO_START_COMMAND,
    GPIV_FIFO_STOP_COMMAND,
    GPIV_FIFO_ERROR,
    GPIV_FIFO_JITTER,
};

enum GpivTimingMode {
    GPIV_TIMER_MODE__PERIODIC = 1, 
    GPIV_TIMER_MODE__DURATION,     
    GPIV_TIMER_MODE__ONE_SHOT_IRQ, 
    GPIV_TIMER_MODE__TRIGGER_IRQ,  
    GPIV_TIMER_MODE__INCREMENT,    
    GPIV_TIMER_MODE__DOUBLE,       
};
/*     GPIV_TIMER_MODE__SNAPSHOT, */
/*     GPIV_TIMER_MODE__EXIT, */



typedef struct __GpivTrigTime GpivTrigTime;

struct __GpivTrigTime {
    RTIME cam_acq_period;       
    RTIME laser_trig_pw;        
    RTIME time2laser;           
    RTIME dt;                   
    enum GpivTimingMode mode;   
    gint cycles;                
    RTIME increment;            
};
  

  
typedef struct __GpivTrigPar GpivTrigPar;

struct __GpivTrigPar {
    GpivTrigTime ttime; 

    gboolean ttime__cam_acq_period__set; 
    gboolean ttime__laser_trig_pw__set;  
    gboolean ttime__time2laser__set;     
    gboolean ttime__dt__set;             
    gboolean ttime__mode__set;           
    gboolean ttime__cycles__set;         
    gboolean ttime__increment__set;      
};



gint 
gpiv_trig_openrtfs                      (gint                   *init, 
                                        gint                    *trig, 
                                        gint                    *stop, 
                                        gint                    *error
                                        );



void
gpiv_trig_default_parameters            (GpivTrigPar            *trig_par_default,
                                        const gboolean          force
                                        );



void 
gpiv_trig_read_parameters               (FILE                   *fp_par, 
                                        GpivTrigPar             *trig_par, 
                                        const gboolean          verbose
                                        );



gchar *
gpiv_trig_check_parameters_read         (GpivTrigPar            *trig_par,
                                        const GpivTrigPar       *trig_par_default
                                        );



void
gpiv_trig_parameters_set                (GpivTrigPar            *trig_par,
                                        const gboolean          flag
                                        );



gchar *
gpiv_trig_test_parameter                (const GpivTrigPar      *trig_par
                                        );



void 
gpiv_trig_print_parameters              (FILE                   *fp_par_out, 
                                        const GpivTrigPar *trig_par
                                        );

#endif /*__LIBGPIV_TRIG_H__ */

---