Libpiv API documentation

 Search for 

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...
Defines
#define	GPIV_CAMPAR_DEFAULT__MODE   1
#define	GPIV_CAMPAR_DEFAULT__CYCLES   1
#define	GPIV_CAMPAR_DEFAULT__FNAME   "gpiv_img"
#define	GPIV_CAMPAR_CYCLES_MIN   1
#define	GPIV_CAMPAR_CYCLES_MAX   1
#define	GPIV_CAMPAR_KEY   "CAM"
#define	GPIV_CAMPAR_KEY__MODE   "Mode"
#define	GPIV_CAMPAR_KEY__CYCLES   "Cycles"
#define	GPIV_CAMPAR_KEY__FNAME   "Fname"
#define	GPIV_CAMPAR_CYCLES_MIN   1
#define	GPIV_CAMPAR_CYCLES_MAX   1
Typedefs
typedef __GpivCamPar	GpivCamPar
typedef __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 }
Functions
GpivCamVar *	gpiv_cam_get_camvar (const gboolean verbose)
gchar *	gpiv_cam_free_camvar (GpivCamVar *cam_var)
void	gpiv_cam_default_parameters (GpivCamPar *cam_par_default, const gboolean force)
void	gpiv_cam_read_parameters (FILE *fp_par, GpivCamPar *cam_par, const gboolean verbose)
gchar *	gpiv_cam_check_parameters_read (GpivCamPar *cam_par, const GpivCamPar *cam_par_default)
void	gpiv_cam_parameters__set (GpivCamPar *cam_par, const gboolean flag)
gchar *	gpiv_cam_test_parameter (const GpivCamPar *cam_par)
void	gpiv_cam_print_parameters (FILE *fp_par_out, const 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.3 2007-06-06 16:59:02 gerber Exp

Definition in file gpiv-cam.h.

---

Define Documentation

#define GPIV_CAMPAR_CYCLES_MAX   1

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

#define GPIV_CAMPAR_CYCLES_MAX   1

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

#define GPIV_CAMPAR_CYCLES_MIN   1

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

#define GPIV_CAMPAR_CYCLES_MIN   1

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

#define GPIV_CAMPAR_DEFAULT__CYCLES   1

Default number of cycles

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

#define GPIV_CAMPAR_DEFAULT__FNAME   "gpiv_img"

Default output image name

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

#define GPIV_CAMPAR_DEFAULT__MODE   1

Default camera mode

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

#define GPIV_CAMPAR_KEY   "CAM"

Key of camera parameters

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

#define GPIV_CAMPAR_KEY__CYCLES   "Cycles"

Parameter key for number of cycles

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

#define GPIV_CAMPAR_KEY__FNAME   "Fname"

Parameter key for output image name

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

#define GPIV_CAMPAR_KEY__MODE   "Mode"

Parameter key for camera mode

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

---

Typedef Documentation

typedef struct __GpivCamPar GpivCamPar

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

typedef struct __GpivCamVar GpivCamVar

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

---

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	?

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

---

Function Documentation

gchar* gpiv_cam_check_parameters_read	(	GpivCamPar *	cam_par,
		const GpivCamPar *	cam_par_default
	)

Check out if all GpivCamPar parameters have been read

Parameters:

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

Returns:

NULL on success or error message on failure

void gpiv_cam_default_parameters	(	GpivCamPar *	cam_par_default,
		const 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 error message on failure

gchar* 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 error message on failure

GpivCamVar* gpiv_cam_get_camvar

(

const gboolean

verbose

)

Get varaiables of connected cameras using firewire

Parameters:

[in]

verbose

prints camera info to stdout

Returns:

GpivCamVar or NULL on failure

void gpiv_cam_parameters__set	(	GpivCamPar *	cam_par,
		const gboolean	flag
	)

Sets flags for __set variables of GpivCamPar

Parameters:

[in]	flag	flag representing __set value
[out]	cam_par	parameters for recording images

Returns:

void

void gpiv_cam_print_parameters	(	FILE *	fp_par_out,
		const GpivCamPar *	cam_par
	)

Prints GpivCamPar parameters to fp_par_out

Parameters:

[in]	fp_par_out	output file
[in]	cam_par	parameters for camera

Returns:

void

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

Read all GpivCamPar parameters

Parameters:

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

Returns:

void

gchar* gpiv_cam_test_parameter

(

const 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 error message on failure

---