vidl2_iidc1394_params Struct Reference

#include <vidl2_iidc1394_params.h>

Detailed Description

A parameters struct for IIDC 1394 camera streams.

The setter functions are provided for convenience, so that the parameters can be set through an anonynous object.

   ostream.open( filename,
                 vidl2_iidc1394_params()
                 .frame_rate( vidl2_iidc1394_params::FRAMERATE_7_5 )
                 .video_mode( vidl2_iidc1394_params::MODE_1024x768_YUV422 ) );

Definition at line 33 of file vidl2_iidc1394_params.h.


Public Types
enum	speed_t { ISO_SPEED_100 = 0, ISO_SPEED_200, ISO_SPEED_400, ISO_SPEED_800, ISO_SPEED_1600, ISO_SPEED_3200 }
	Available data transfer speeds. More...
enum	frame_rate_t { FRAMERATE_1_875 = 32, FRAMERATE_3_75, FRAMERATE_7_5, FRAMERATE_15, FRAMERATE_30, FRAMERATE_60, FRAMERATE_120, FRAMERATE_240 }
	Available frame rates. More...
enum	video_mode_t { MODE_160x120_YUV444 = 64, MODE_320x240_YUV422, MODE_640x480_YUV411, MODE_640x480_YUV422, MODE_640x480_RGB8, MODE_640x480_MONO8, MODE_640x480_MONO16, MODE_800x600_YUV422, MODE_800x600_RGB8, MODE_800x600_MONO8, MODE_1024x768_YUV422, MODE_1024x768_RGB8, MODE_1024x768_MONO8, MODE_800x600_MONO16, MODE_1024x768_MONO16, MODE_1280x960_YUV422, MODE_1280x960_RGB8, MODE_1280x960_MONO8, MODE_1600x1200_YUV422, MODE_1600x1200_RGB8, MODE_1600x1200_MONO8, MODE_1280x960_MONO16, MODE_1600x1200_MONO16, MODE_EXIF, MODE_FORMAT7_0, MODE_FORMAT7_1, MODE_FORMAT7_2, MODE_FORMAT7_3, MODE_FORMAT7_4, MODE_FORMAT7_5, MODE_FORMAT7_6, MODE_FORMAT7_7 }
	Available video modes (format and mode combined). More...
enum	feature_t { FEATURE_BRIGHTNESS, FEATURE_EXPOSURE, FEATURE_SHARPNESS, FEATURE_WHITE_BALANCE, FEATURE_HUE, FEATURE_SATURATION, FEATURE_GAMMA, FEATURE_SHUTTER, FEATURE_GAIN, FEATURE_IRIS, FEATURE_FOCUS, FEATURE_TEMPERATURE, FEATURE_TRIGGER, FEATURE_TRIGGER_DELAY, FEATURE_WHITE_SHADING, FEATURE_FRAME_RATE, FEATURE_ZOOM, FEATURE_PAN, FEATURE_TILT, FEATURE_OPTICAL_FILTER, FEATURE_CAPTURE_SIZE, FEATURE_CAPTURE_QUALITY }
	Available camera features. More...
enum	feature_mode_t { FEATURE_MODE_MANUAL, FEATURE_MODE_AUTO, FEATURE_MODE_ONE_PUSH_AUTO }
	Available feature control modes. More...
Public Member Functions
	vidl2_iidc1394_params ()
	Construct to default values.
vidl2_iidc1394_params &	guid (vxl_uint_64 guid)
	Set the guid.
vidl2_iidc1394_params &	speed (speed_t s)
	Set the speed.
vidl2_iidc1394_params &	b_mode (bool b)
	Set b mode.
vidl2_iidc1394_params &	frame_rate (frame_rate_t r)
	Set the frame rate.
vidl2_iidc1394_params &	video_mode (video_mode_t m)
	Set the video mode.
Static Public Member Functions
static unsigned int	speed_val (speed_t s)
	Return the speed value for a speed setting.
static float	frame_rate_val (frame_rate_t r)
	Return the frame rate as a floating point value.
static vcl_string	video_mode_string (video_mode_t m)
	Return string describing the mode.
static vcl_string	feature_string (feature_t f)
	Return string describing the feature.
static vcl_string	feature_mode_string (feature_mode_t fm)
	Return string describing the feature mode.
static unsigned int	video_format_val (video_mode_t m)
	Return the format number from the video mode enumeration.
static unsigned int	video_mode_val (video_mode_t m)
	Return the mode number from the video mode enumeration.
static vidl2_pixel_format	pixel_format (video_mode_t m)
	Return the pixel format of the video mode.
static bool	resolution (video_mode_t m, unsigned &ni, unsigned &nj)
	Return the image resolution of the video mode.
static video_mode_t	video_mode (unsigned int format, unsigned int mode)
	Return the video mode enumeration for a format and mode.
Public Attributes
vxl_uint_64	guid_
	The global unique identifier of the camera (default 0).
speed_t	speed_
	The data transfer speed (default ISO_SPEED_400).
bool	b_mode_
	Operate the camera in 1394b mode.
frame_rate_t	frame_rate_
	The frame rate (default FRAMERATE_15).
video_mode_t	video_mode_
	The video format and mode (default MODE_640x480_RGB8).
vcl_vector< feature_options >	features_
	The settings of camera features.
Classes
struct	feature_options
	Describes a feature and it's set of options. More...
struct	valid_options
	This structure holds the set of valid options for parameters. More...

Member Enumeration Documentation

enum vidl2_iidc1394_params::speed_t

Available data transfer speeds.

Enumerator:

ISO_SPEED_100
ISO_SPEED_200
ISO_SPEED_400
ISO_SPEED_800
ISO_SPEED_1600
ISO_SPEED_3200

Definition at line 36 of file vidl2_iidc1394_params.h.

enum vidl2_iidc1394_params::frame_rate_t

Available frame rates.

Enumerator:

FRAMERATE_1_875
FRAMERATE_3_75
FRAMERATE_7_5
FRAMERATE_15
FRAMERATE_30
FRAMERATE_60
FRAMERATE_120
FRAMERATE_240

Definition at line 47 of file vidl2_iidc1394_params.h.

enum vidl2_iidc1394_params::video_mode_t

Available video modes (format and mode combined).

Enumerator:

MODE_160x120_YUV444
MODE_320x240_YUV422
MODE_640x480_YUV411
MODE_640x480_YUV422
MODE_640x480_RGB8
MODE_640x480_MONO8
MODE_640x480_MONO16
MODE_800x600_YUV422
MODE_800x600_RGB8
MODE_800x600_MONO8
MODE_1024x768_YUV422
MODE_1024x768_RGB8
MODE_1024x768_MONO8
MODE_800x600_MONO16
MODE_1024x768_MONO16
MODE_1280x960_YUV422
MODE_1280x960_RGB8
MODE_1280x960_MONO8
MODE_1600x1200_YUV422
MODE_1600x1200_RGB8
MODE_1600x1200_MONO8
MODE_1280x960_MONO16
MODE_1600x1200_MONO16
MODE_EXIF
MODE_FORMAT7_0
MODE_FORMAT7_1
MODE_FORMAT7_2
MODE_FORMAT7_3
MODE_FORMAT7_4
MODE_FORMAT7_5
MODE_FORMAT7_6
MODE_FORMAT7_7

Definition at line 60 of file vidl2_iidc1394_params.h.

enum vidl2_iidc1394_params::feature_t

Available camera features.

Enumerator:

FEATURE_BRIGHTNESS
FEATURE_EXPOSURE
FEATURE_SHARPNESS
FEATURE_WHITE_BALANCE
FEATURE_HUE
FEATURE_SATURATION
FEATURE_GAMMA
FEATURE_SHUTTER
FEATURE_GAIN
FEATURE_IRIS
FEATURE_FOCUS
FEATURE_TEMPERATURE
FEATURE_TRIGGER
FEATURE_TRIGGER_DELAY
FEATURE_WHITE_SHADING
FEATURE_FRAME_RATE
FEATURE_ZOOM
FEATURE_PAN
FEATURE_TILT
FEATURE_OPTICAL_FILTER
FEATURE_CAPTURE_SIZE
FEATURE_CAPTURE_QUALITY

Definition at line 94 of file vidl2_iidc1394_params.h.

enum vidl2_iidc1394_params::feature_mode_t

Available feature control modes.

Enumerator:

FEATURE_MODE_MANUAL
FEATURE_MODE_AUTO
FEATURE_MODE_ONE_PUSH_AUTO

Definition at line 118 of file vidl2_iidc1394_params.h.

Constructor & Destructor Documentation

vidl2_iidc1394_params::vidl2_iidc1394_params ( )

Construct to default values.

Definition at line 17 of file vidl2_iidc1394_params.cxx.

Member Function Documentation

unsigned int vidl2_iidc1394_params::speed_val ( speed_t s ) [static]

Return the speed value for a speed setting.

Definition at line 30 of file vidl2_iidc1394_params.cxx.

float vidl2_iidc1394_params::frame_rate_val ( frame_rate_t r ) [static]

Return the frame rate as a floating point value.

Definition at line 48 of file vidl2_iidc1394_params.cxx.

vcl_string vidl2_iidc1394_params::video_mode_string ( video_mode_t m ) [static]

Return string describing the mode.

Definition at line 68 of file vidl2_iidc1394_params.cxx.

vcl_string vidl2_iidc1394_params::feature_string ( feature_t f ) [static]

Return string describing the feature.

Definition at line 112 of file vidl2_iidc1394_params.cxx.

vcl_string vidl2_iidc1394_params::feature_mode_string ( feature_mode_t fm ) [static]

Return string describing the feature mode.

Definition at line 146 of file vidl2_iidc1394_params.cxx.

unsigned int vidl2_iidc1394_params::video_format_val ( video_mode_t m ) [static]

Return the format number from the video mode enumeration.

Definition at line 161 of file vidl2_iidc1394_params.cxx.

unsigned int vidl2_iidc1394_params::video_mode_val ( video_mode_t m ) [static]

Return the mode number from the video mode enumeration.

Definition at line 186 of file vidl2_iidc1394_params.cxx.

vidl2_pixel_format vidl2_iidc1394_params::pixel_format ( video_mode_t m ) [static]

Return the pixel format of the video mode.

Note:: Only works for predefined modes (not Format 7 or Exif)

Definition at line 236 of file vidl2_iidc1394_params.cxx.

bool vidl2_iidc1394_params::resolution	(	video_mode_t	m,
		unsigned &	ni,
		unsigned &	nj
	)			`[static]`

Return the image resolution of the video mode.

Note:: Only works for predefined modes (not Format 7 or Exif)

Definition at line 284 of file vidl2_iidc1394_params.cxx.

vidl2_iidc1394_params::video_mode_t vidl2_iidc1394_params::video_mode	(	unsigned int	format,
		unsigned int	mode
	)			`[static]`

Return the video mode enumeration for a format and mode.

Definition at line 211 of file vidl2_iidc1394_params.cxx.

vidl2_iidc1394_params& vidl2_iidc1394_params::guid ( vxl_uint_64 guid ) [inline]

Set the guid.

Definition at line 179 of file vidl2_iidc1394_params.h.

vidl2_iidc1394_params& vidl2_iidc1394_params::speed ( speed_t s ) [inline]

Set the speed.

Definition at line 183 of file vidl2_iidc1394_params.h.

vidl2_iidc1394_params& vidl2_iidc1394_params::b_mode ( bool b ) [inline]

Set b mode.

Definition at line 187 of file vidl2_iidc1394_params.h.

vidl2_iidc1394_params& vidl2_iidc1394_params::frame_rate ( frame_rate_t r ) [inline]

Set the frame rate.

Definition at line 191 of file vidl2_iidc1394_params.h.

vidl2_iidc1394_params& vidl2_iidc1394_params::video_mode ( video_mode_t m ) [inline]

Set the video mode.

Definition at line 195 of file vidl2_iidc1394_params.h.

Member Data Documentation

vxl_uint_64 vidl2_iidc1394_params::guid_

The global unique identifier of the camera (default 0).

Definition at line 151 of file vidl2_iidc1394_params.h.

speed_t vidl2_iidc1394_params::speed_

The data transfer speed (default ISO_SPEED_400).

Definition at line 159 of file vidl2_iidc1394_params.h.

bool vidl2_iidc1394_params::b_mode_

Operate the camera in 1394b mode.

Definition at line 162 of file vidl2_iidc1394_params.h.

frame_rate_t vidl2_iidc1394_params::frame_rate_

The frame rate (default FRAMERATE_15).

Definition at line 165 of file vidl2_iidc1394_params.h.

video_mode_t vidl2_iidc1394_params::video_mode_

The video format and mode (default MODE_640x480_RGB8).

Definition at line 168 of file vidl2_iidc1394_params.h.

vcl_vector<feature_options> vidl2_iidc1394_params::features_

The settings of camera features.

Definition at line 171 of file vidl2_iidc1394_params.h.

The documentation for this struct was generated from the following files:

contrib/brl/bbas/vidl2/vidl2_iidc1394_params.h
contrib/brl/bbas/vidl2/vidl2_iidc1394_params.cxx

Generated on Wed Dec 3 05:21:04 2008 for contrib/brl/bbas/vidl2 by

1.5.1

vidl2_iidc1394_params Struct Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Classes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation