Libpiv API documentation

 Search for 

/home/gerber/gpiv_all/libgpiv-0.4.0/include/gpiv/cam.h File Reference

module for IEEE1394 camera control More...

Data Structures
struct	__GpivCamPar
struct	__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 }
Functions
char *	gpiv_cam_get_camvar (GpivCamVar *cam_var, gboolean verbose)
char *	gpiv_cam_free_camvar (GpivCamVar *cam_var)
void	gpiv_cam_default_parameters (GpivCamPar *cam_par_default, gboolean force)
void	gpiv_cam_read_parameters (FILE *fp_par, GpivCamPar *cam_par, int print_par)
char *	gpiv_cam_check_parameters_read (GpivCamPar *cam_par, GpivCamPar cam_par_default)
void	gpiv_cam_parameters_logic (GpivCamPar *cam_par, gboolean flag)
char *	gpiv_cam_test_parameter (GpivCamPar *cam_par)
void	gpiv_cam_fprint_parameters (FILE *fp_par_out, GpivCamPar cam_par)

---

Detailed Description

module for IEEE1394 camera control

SOURCES: lib/cam.c, cam_par.c

LAST MODIFICATION DATE:

Id

cam.h,v 1.2 2007-01-29 11:53:54 gerber Exp

---

Enumeration Type Documentation

enum 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	?

---

Function Documentation

char* gpiv_cam_check_parameters_read	(	GpivCamPar *	cam_par,
		GpivCamPar	cam_par_default
	)

Check out if all GpivCamPar parameters have been read

Parameters:

[in]	cam_par_default
[out]	cam_par	parameters of camera parameters

Returns:

NULL on success or *err_msg on failure

void gpiv_cam_default_parameters	(	GpivCamPar *	cam_par_default,
		gboolean	force
	)

Sets default GpivCamPar parameter values

Parameters:

[out]	cam_par_default	structure of camera parameters
[out]	force	forces to set to default, even if already defined

Returns:

NULL on success or *err_msg on failure

void gpiv_cam_fprint_parameters	(	FILE *	fp_par_out,
		GpivCamPar	cam_par
	)

Prints GpivCamPar parameters to fp_par_out

Parameters:

[in]	fp_par_out
[in]	cam_par	parameters for camera

Returns:

void

char* gpiv_cam_free_camvar

(

GpivCamVar *

cam_var

)

Free memory variables of connected cameras using firewire

Parameters:

[out]

cam_var

structure of camera variables

Returns:

NULL on success or *err_msg on failure

char* gpiv_cam_get_camvar	(	GpivCamVar *	cam_var,
		gboolean	verbose
	)

Get varaiables of connected cameras using firewire

Parameters:

[in]	verbose	prints camera info to stdout
[out]	cam_var	structure of camera variables

Returns:

NULL on success or *err_msg on failure

void gpiv_cam_parameters_logic	(	GpivCamPar *	cam_par,
		gboolean	flag
	)

Sets flags for _logic variables of GpivCamPar

Parameters:

[in]	flag	TRUE or FALSE
[out]	cam_par	parameters for recording images

Returns:

void

void gpiv_cam_read_parameters	(	FILE *	fp_par,
		GpivCamPar *	cam_par,
		int	print_par
	)

Read all GpivCamPar parameters

Parameters:

[in]	fp_par	file pointer to parameter file
[in]	print_par	flag to print parametrs to stdout
[out]	cam_par	parameters of camera parameters

Returns:

void

char* gpiv_cam_test_parameter

(

GpivCamPar *

cam_par

)

Testing GpivCamPar parameters on valid values and initializing derived variables

Parameters:

[in]

cam_par

parameters for camera

Returns:

NULL on success or *err_msg on failure

---