Main Page | Files | Data Structures | Functions | Global Variables |
gpiv-cam.h File Reference

module for IEEE1394 camera control More...

Go to the source code of this file.

Data Structures

struct  __GpivCamPar
 Parameters for camera settings. More...
 
struct  __GpivCamVar
 Camera variables. More...
 

Macros

#define GPIV_CAMPAR_DEFAULT__MODE   1
 Default camera mode. More...
 
#define GPIV_CAMPAR_DEFAULT__CYCLES   1
 Default number of cycles. More...
 
#define GPIV_CAMPAR_DEFAULT__FNAME   "gpiv_img"
 Default output image name. More...
 
#define GPIV_CAMPAR_CYCLES_MIN   1
 
#define GPIV_CAMPAR_CYCLES_MAX   1
 
#define GPIV_CAMPAR_KEY   "CAM"
 Key of camera parameters. More...
 
#define GPIV_CAMPAR_KEY__MODE   "Mode"
 Parameter key for camera mode. More...
 
#define GPIV_CAMPAR_KEY__CYCLES   "Cycles"
 Parameter key for number of cycles. More...
 
#define GPIV_CAMPAR_KEY__FNAME   "Fname"
 Parameter key for output image name. More...
 
#define GPIV_CAMPAR_CYCLES_MIN   1
 
#define GPIV_CAMPAR_CYCLES_MAX   1
 

Typedefs

typedef struct __GpivCamPar GpivCamPar
 
typedef struct __GpivCamVar GpivCamVar
 

Enumerations

enum  GpivCamMode {
  GPIV_CAM_MODE__PERIODIC = 1, GPIV_CAM_MODE__DURATION, GPIV_CAM_MODE__ONE_SHOT_IRQ, GPIV_CAM_MODE__TRIGGER_IRQ,
  GPIV_CAM_MODE__INCREMENT, GPIV_CAM_MODE__DOUBLE
}
 Camera modes. More...
 

Functions

GpivCamVargpiv_cam_get_camvar (const gboolean verbose)
 Get varaiables of connected cameras using firewire. More...
 
gchar * gpiv_cam_free_camvar (GpivCamVar *cam_var)
 Free memory variables of connected cameras using firewire. More...
 
void gpiv_cam_default_parameters (GpivCamPar *cam_par_default, const gboolean force)
 Sets default GpivCamPar parameter values. More...
 
void gpiv_cam_read_parameters (FILE *fp_par, GpivCamPar *cam_par, const gboolean verbose)
 Read all GpivCamPar parameters. More...
 
gchar * gpiv_cam_check_parameters_read (GpivCamPar *cam_par, const GpivCamPar *cam_par_default)
 Checks if all GpivCamPar parameters have been read. More...
 
void gpiv_cam_parameters__set (GpivCamPar *cam_par, const gboolean flag)
 Sets flags for __set variables of GpivCamPar. More...
 
gchar * gpiv_cam_test_parameter (const GpivCamPar *cam_par)
 Testing GpivCamPar parameters on valid values and initializing derived variables. More...
 
void gpiv_cam_print_parameters (FILE *fp_par_out, const GpivCamPar *cam_par)
 Prints GpivCamPar parameters to fp_par_out. More...
 

Detailed Description

module for IEEE1394 camera control

SOURCES: lib/cam.c, cam_par.c

LAST MODIFICATION DATE:

Id
gpiv-cam.h,v 1.2 2008-04-09 06:10:27 gerber Exp

Definition in file gpiv-cam.h.

Macro Definition Documentation

◆ GPIV_CAMPAR_CYCLES_MAX [1/2]

#define GPIV_CAMPAR_CYCLES_MAX   1

Definition at line 76 of file gpiv-cam.h.

◆ GPIV_CAMPAR_CYCLES_MAX [2/2]

#define GPIV_CAMPAR_CYCLES_MAX   1

Definition at line 76 of file gpiv-cam.h.

◆ GPIV_CAMPAR_CYCLES_MIN [1/2]

#define GPIV_CAMPAR_CYCLES_MIN   1

Definition at line 75 of file gpiv-cam.h.

◆ GPIV_CAMPAR_CYCLES_MIN [2/2]

#define GPIV_CAMPAR_CYCLES_MIN   1

Definition at line 75 of file gpiv-cam.h.

◆ GPIV_CAMPAR_DEFAULT__CYCLES

#define GPIV_CAMPAR_DEFAULT__CYCLES   1

Default number of cycles.

Definition at line 61 of file gpiv-cam.h.

◆ GPIV_CAMPAR_DEFAULT__FNAME

#define GPIV_CAMPAR_DEFAULT__FNAME   "gpiv_img"

Default output image name.

Definition at line 62 of file gpiv-cam.h.

◆ GPIV_CAMPAR_DEFAULT__MODE

#define GPIV_CAMPAR_DEFAULT__MODE   1

Default camera mode.

Definition at line 60 of file gpiv-cam.h.

◆ GPIV_CAMPAR_KEY

#define GPIV_CAMPAR_KEY   "CAM"

Key of camera parameters.

Definition at line 70 of file gpiv-cam.h.

◆ GPIV_CAMPAR_KEY__CYCLES

#define GPIV_CAMPAR_KEY__CYCLES   "Cycles"

Parameter key for number of cycles.

Definition at line 72 of file gpiv-cam.h.

◆ GPIV_CAMPAR_KEY__FNAME

#define GPIV_CAMPAR_KEY__FNAME   "Fname"

Parameter key for output image name.

Definition at line 73 of file gpiv-cam.h.

◆ GPIV_CAMPAR_KEY__MODE

#define GPIV_CAMPAR_KEY__MODE   "Mode"

Parameter key for camera mode.

Definition at line 71 of file gpiv-cam.h.

Typedef Documentation

◆ GpivCamPar

typedef struct __GpivCamPar GpivCamPar

Definition at line 90 of file gpiv-cam.h.

◆ GpivCamVar

typedef struct __GpivCamVar GpivCamVar

Definition at line 108 of file gpiv-cam.h.

Enumeration Type Documentation

◆ GpivCamMode

Camera modes.

Enumerator
GPIV_CAM_MODE__PERIODIC 

periodic

GPIV_CAM_MODE__DURATION 

continuoulsy

GPIV_CAM_MODE__ONE_SHOT_IRQ 

single image pair

GPIV_CAM_MODE__TRIGGER_IRQ 

on wxternal trigger signals

GPIV_CAM_MODE__INCREMENT 

?

GPIV_CAM_MODE__DOUBLE 

?

Definition at line 81 of file gpiv-cam.h.

Function Documentation

◆ gpiv_cam_check_parameters_read()

gchar* gpiv_cam_check_parameters_read ( GpivCamPar cam_par,
const GpivCamPar cam_par_default 
)

Checks if all GpivCamPar parameters have been read.

If a parameter has not been read, it will be set to *cam_par_default or to its hard-coded default value in case *cam_par_default is NULL.

Parameters
[in]cam_par_defaultdefault parameters. If NULL, library default values are used
[out]cam_parparameters of camera parameters
Returns
NULL on success or error message on failure

◆ gpiv_cam_default_parameters()

void gpiv_cam_default_parameters ( GpivCamPar cam_par_default,
const gboolean  force 
)

Sets default GpivCamPar parameter values.

Parameters
[out]cam_par_defaultstructure of camera parameters
[out]forceforces to set to default, even if already defined
Returns
NULL on success or error message on failure

◆ gpiv_cam_free_camvar()

gchar* gpiv_cam_free_camvar ( GpivCamVar cam_var)

Free memory variables of connected cameras using firewire.

Parameters
[out]cam_varstructure of camera variables
Returns
NULL on success or error message on failure

◆ gpiv_cam_get_camvar()

GpivCamVar* gpiv_cam_get_camvar ( const gboolean  verbose)

Get varaiables of connected cameras using firewire.

Parameters
[in]verboseprints camera info to stdout
Returns
GpivCamVar or NULL on failure

◆ gpiv_cam_parameters__set()

void gpiv_cam_parameters__set ( GpivCamPar cam_par,
const gboolean  flag 
)

Sets flags for __set variables of GpivCamPar.

Parameters
[in]flagflag representing __set value
[out]cam_parparameters for recording images
Returns
void

◆ gpiv_cam_print_parameters()

void gpiv_cam_print_parameters ( FILE *  fp_par_out,
const GpivCamPar cam_par 
)

Prints GpivCamPar parameters to fp_par_out.

Parameters
[in]fp_par_outoutput file
[in]cam_parparameters for camera
Returns
void

◆ gpiv_cam_read_parameters()

void gpiv_cam_read_parameters ( FILE *  fp_par,
GpivCamPar cam_par,
const gboolean  verbose 
)

Read all GpivCamPar parameters.

Parameters
[in]fp_parfile pointer to parameter file
[in]verboseflag to print parametrs to stdout
[out]cam_parparameters of camera parameters
Returns
void

◆ gpiv_cam_test_parameter()

gchar* gpiv_cam_test_parameter ( const GpivCamPar cam_par)

Testing GpivCamPar parameters on valid values and initializing derived variables.

Parameters
[in]cam_parparameters for camera
Returns
NULL on success or error message on failure

Generated for libgpiv-0.6.1 by doxygen 1.8.13