ipa_CameraSensors Namespace Reference

Classes
class	CameraSensorToolbox
struct	t_cameraProperty
	Struct to represent a general camera property. More...
struct	t_cameraResolution
	Struct to represent a camera resolution. More...
Typedefs
typedef boost::shared_ptr < CameraSensorToolbox >	CameraSensorToolboxPtr
Enumerations
enum	{   RET_OK = 0x00000001UL, RET_FAILED = 0x00000002UL, RET_FAILED_OPEN_FILE = 0x00000004UL, RET_FAILED_CV_CREATE_CAMERA = 0x00000008UL,   RET_MISSING_INTRINSIC_DISTORTION_PARAMS = 0x00000010UL, RET_FUNCTION_NOT_IMPLEMENTED = 0x00000020UL, RET_XML_ATTR_NOT_FOUND = 0x00000040UL, RET_XML_TAG_NOT_FOUND = 0x00000080UL,   RET_CAMERA_ALREADY_OPEN = 0x00000100UL, RET_CAMERA_ALREADY_INITIALIZED = 0x00000200UL, RET_CAMERA_NOT_OPEN = 0x00000400UL, RET_CAMERA_NOT_INITIALIZED = 0x00000600UL,   RET_INIT_CAMERA_FAILED = 0x00000800UL, RET_OPEN_CAMERA_FAILED = 0x00001000UL, RET_OPEN_CHECK_FAILED = 0x00002000UL, RET_INIT_CHECK_FAILED = 0x00004000UL,   RET_CLOSE_CAMERA_FAILED = 0x00008000UL, RET_GET_COLOR_IMAGE_FAILED = 0x00010000UL, RET_GET_INTRINSIC_PARAMS_FAILED = 0x00020000UL, RET_SET_INTRINSIC_PARAMS_FAILED = 0x00040000UL,   RET_GET_DISTORTION_COEFFS_FAILED = 0x00060000UL, RET_SET_DISTORTION_COEFFS_FAILED = 0x00080000UL, RET_REMOVE_DISTORTION_FAILED = 0x00100000UL, RET_SET_PROPERTY_DEFAULTS_FAILED = 0x00200000UL,   RET_SAVE_PARAMS_FAILED = 0x00400000UL, RET_SET_PROPERTY_FAILED = 0x00800000UL, RET_GET_PROPERTY_FAILED = 0x01000000UL }
	Enum to encode return codes or return values. More...
enum	t_CalibrationMethod { NATIVE = 0, MATLAB_NO_Z, MATLAB }
enum	t_cameraPropertyID {   PROP_BRIGHTNESS = 0, PROP_SHARPNESS, PROP_WHITE_BALANCE_U, PROP_WHITE_BALANCE_V,   PROP_HUE, PROP_SATURATION, PROP_GAMMA, PROP_EXPOSURE_TIME,   PROP_GAIN, PROP_OPTICAL_FILTER, PROP_FRAME_RATE, PROP_REGISTER,   PROP_TIMEOUT, PROP_CAMERA_RESOLUTION, PROP_VIDEO_ALL, PROP_VIDEO_FORMAT,   PROP_VIDEO_MODE, PROP_COLOR_MODE, PROP_ISO_SPEED, PROP_FW_OPERATION_MODE,   PROP_SHUTTER, PROP_AMPLITUDE_THRESHOLD, PROP_INTEGRATION_TIME, PROP_RESOLUTION,   PROP_MODULATION_FREQUENCY, PROP_ACQUIRE_MODE, PROP_DISTANCE_OFFSET, PROP_ROI,   PROP_LENS_CALIBRATION, PROP_DMA_BUFFER_SIZE, PROP_PMD_TYPE }
	Enum to identify camera device properties. More...
enum	t_cameraPropertyType {   TYPE_CAMERA_RESOLUTION = 0x00000001L, TYPE_VIDEO_FORMAT = 0x00000002L, TYPE_VIDEO_MODE = 0x00000004L, TYPE_COLOR_MODE = 0x00000008L,   TYPE_CHARACTER = 0x00000010L, TYPE_SHORT = 0x00000020L, TYPE_INTEGER = 0x00000040L, TYPE_LONG = 0x00000080L,   TYPE_FLOAT = 0x00000100L, TYPE_DOUBLE = 0x00000200L, TYPE_UNSIGNED = 0x00000400L, TYPE_STRING = 0x00000800L,   TYPE_DATA = 0x00001000L, TYPE_SPECIAL = 0x00002000L }
	Enum that specifies the return type of a parameter request. More...
enum	t_cameraRole { MASTER = 0, SLAVE }
	Enum to encode the different camera roles. More...
enum	t_cameraType {   CAM_VIRTUALCOLOR = 0, CAM_VIRTUALRANGE, CAM_IC, CAM_AVTPIKE,   CAM_AXIS, CAM_PROSILICA, CAM_SWISSRANGER, CAM_PMDCAM,   CAM_KINECT, CAM_OPENCVCAMERA, ROBOT }
	Enum to encode the different camera types. More...
enum	t_colorMode {   COLOR_YUV444 = 0, COLOR_YUV422, COLOR_YUV411, COLOR_RGB8,   COLOR_RGB16S, COLOR_RGB16, COLOR_MONO8, COLOR_MONO16S,   COLOR_MONO16, COLOR_RAW8, COLOR_RAW16, COLOR_DEFAULT }
	Enum represents color modes. More...
enum	t_specialValues { VALUE_AUTO = 0, VALUE_ONESHOT, VALUE_OFF, VALUE_DEFAULT }
	Special values for camera properties. More...
enum	t_ToFGrayImageType { INTENSITY_32F1 = 0, AMPLITUDE, INTENSITY_8U3 }
enum	t_videoFormat {   FORMAT_0 = 0, FORMAT_1, FORMAT_2, FORMAT_7,   FORMAT_DEFAULT }
	Enum represents video formats. More...
enum	t_videoMode {   MODE_0 = 0, MODE_1, MODE_2, MODE_3,   MODE_4, MODE_5, MODE_6, MODE_7,   MODE_DEFAULT }
	Enum represents video modes. More...
Functions
__DLL_LIBCAMERASENSORS__ CameraSensorToolboxPtr	CreateCameraSensorToolbox ()

---

Typedef Documentation

typedef boost::shared_ptr<CameraSensorToolbox> ipa_CameraSensors::CameraSensorToolboxPtr

Definition at line 80 of file CameraSensorToolbox.h.

---

Enumeration Type Documentation

anonymous enum

Enum to encode return codes or return values.

Enumerator:

RET_OK	Everythings OK. BEGIN Do not change to keep consistency with RET_OK and RET_FAILED definition in ipa_Utils (GlobalDefines.h)
RET_FAILED	Something went wrong.
RET_FAILED_OPEN_FILE	END. Could not open file error.
RET_FAILED_CV_CREATE_CAMERA	Camera object could not be created.
RET_MISSING_INTRINSIC_DISTORTION_PARAMS	Intrinsic or distortion parameters have not been set.
RET_FUNCTION_NOT_IMPLEMENTED	The function of the interface is not implemented within the child instance.
RET_XML_ATTR_NOT_FOUND	An xml attribute has not been found while parsing the xml ini file.
RET_XML_TAG_NOT_FOUND	An xml tag has not been found while parsing the xml ini file.
RET_CAMERA_ALREADY_OPEN	Camera has already been opened.
RET_CAMERA_ALREADY_INITIALIZED	Camera has already been initialized.
RET_CAMERA_NOT_OPEN	Camera has not been opened.
RET_CAMERA_NOT_INITIALIZED	Camera has not been initialized.
RET_INIT_CAMERA_FAILED	Initialization of camera device failed.
RET_OPEN_CAMERA_FAILED	Opening camera device failed.
RET_OPEN_CHECK_FAILED	isOpen() check failed.
RET_INIT_CHECK_FAILED	isInitialized() check failed.
RET_CLOSE_CAMERA_FAILED	Closing camera device failed.
RET_GET_COLOR_IMAGE_FAILED	Acquiring a color image failed.
RET_GET_INTRINSIC_PARAMS_FAILED	Acquiring intrinsic parameters failed.
RET_SET_INTRINSIC_PARAMS_FAILED	Setting intrinsic parameters failed.
RET_GET_DISTORTION_COEFFS_FAILED	Acquiring distortion coeffs failed.
RET_SET_DISTORTION_COEFFS_FAILED	Setting distortion coeffs failed.
RET_REMOVE_DISTORTION_FAILED	Removeing distortion failed.
RET_SET_PROPERTY_DEFAULTS_FAILED	Setting property defaults failed.
RET_SAVE_PARAMS_FAILED	Setting property defaults failed.
RET_SET_PROPERTY_FAILED	Setting property failed.
RET_GET_PROPERTY_FAILED	Getting property failed.

Definition at line 69 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_CalibrationMethod

Enumerator:

NATIVE
MATLAB_NO_Z
MATLAB

Definition at line 280 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_cameraPropertyID

Enum to identify camera device properties.

Enumerator:

PROP_BRIGHTNESS	An offset is added to the CCD output signal.
PROP_SHARPNESS	Enhance blurred images.
PROP_WHITE_BALANCE_U	Varies the degree of red and blue to achieve equal values for R G and B in case of gray values. Auto: Balance algorithm affects the video stream continuously. One push: Triggers only one pass of the adaption procedure.
PROP_WHITE_BALANCE_V	See also: PROP_WHITE_BALANCE_U
PROP_HUE	Shifts the color values. Relation between colors remains.
PROP_SATURATION	Adjusts the color's saturation from monochrome to high color values.
PROP_GAMMA	Increases/Decreases the middle gray level of an image.
PROP_EXPOSURE_TIME	Specifies the exposure time.
PROP_GAIN	Specifies the amplification of the CCD output signal.
PROP_OPTICAL_FILTER
PROP_FRAME_RATE	Specifies the framerate (frames per second)
PROP_REGISTER
PROP_TIMEOUT
PROP_CAMERA_RESOLUTION	Specifies the camera resolution.
PROP_VIDEO_ALL	Specifies the video format, video mode and color mode (. See also: t_videoFormat).
PROP_VIDEO_FORMAT	DCAM specification (FORMAT 0 - FORMAT 7)
PROP_VIDEO_MODE	DCAM specification (MODE 0 - MODE 7)
PROP_COLOR_MODE	COLOR_RGB8/16/16S, COLOR_MONO8/16/16S, COLOR_YUV411/422/444, RAW8/16.
PROP_ISO_SPEED	Specifies the designated isochronous speed (100, 200, 400, or 800)
PROP_FW_OPERATION_MODE	Firewire operation mode (A/B)
PROP_SHUTTER	Specifies the exposure time.
PROP_AMPLITUDE_THRESHOLD	Specifies the amplitude threshold of the range imaging camera Enables filtering of noisy pixels. Pixels that do not have an intensity value (reflected light) higher than the threshold are set to 0.
PROP_INTEGRATION_TIME	Specifies the exposure time for each of the four internally acquired images to determine the actual range data. Values may vary from 0 (0.2 ms) to 255 (51.2 ms) The higher the integration time, the more accurate the measurement, but also the lower the framrate.
PROP_RESOLUTION	Camera resolution.
PROP_MODULATION_FREQUENCY	Due to phase shift calculations from the reflected and original wave, the distiance is induced. For range cameras only: Defines the modulation frequency of the simus wave.
PROP_ACQUIRE_MODE	Acquire modes for swissranger camera.
PROP_DISTANCE_OFFSET	Offset that is added to the distance values of the range imaging sensor.
PROP_ROI	Region of interest.
PROP_LENS_CALIBRATION	Specifies if to use native lens calibration of manufactorer.
PROP_DMA_BUFFER_SIZE	Buffer size of camera module.
PROP_PMD_TYPE	select PMDCam type (PMDCamCube or PMDCamBoard)

Definition at line 122 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_cameraPropertyType

Enum that specifies the return type of a parameter request.

Enumerator:

TYPE_CAMERA_RESOLUTION	Type camera resolution.
TYPE_VIDEO_FORMAT	Type video format.
TYPE_VIDEO_MODE	Type video mode.
TYPE_COLOR_MODE	Type color mode.
TYPE_CHARACTER	Type character.
TYPE_SHORT	Type short.
TYPE_INTEGER	Type integer.
TYPE_LONG	Type long.
TYPE_FLOAT	Type float.
TYPE_DOUBLE	Type double.
TYPE_UNSIGNED	Type unsigned (only in combination with others valid)
TYPE_STRING	Type string.
TYPE_DATA	Type data.
TYPE_SPECIAL	Type special. See also: t_specialValue

Definition at line 218 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_cameraRole

Enum to encode the different camera roles.

Enumerator:

MASTER	Initializes and releases the library, emits the trigger signal if possible.
SLAVE	Takes pictures based on the received trigger signal.

Definition at line 295 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_cameraType

Enum to encode the different camera types.

Enumerator:

CAM_VIRTUALCOLOR	Virtual color camera.
CAM_VIRTUALRANGE	Virtual range camera.
CAM_IC	Imaging source camera (blue camera)
CAM_AVTPIKE	AVT Pike camera (red camera)
CAM_AXIS	Axis 2100 IP camera.
CAM_PROSILICA	Prosilica GigE camera.
CAM_SWISSRANGER	Swissranger 3000/3100/4000 camera.
CAM_PMDCAM	PMD camera.
CAM_KINECT	Microsoft Kinect camera.
CAM_OPENCVCAMERA	OpenCV supported generic video camera.
ROBOT	Robot.

Definition at line 106 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_colorMode

Enum represents color modes.

Enumerator:

COLOR_YUV444
COLOR_YUV422
COLOR_YUV411
COLOR_RGB8
COLOR_RGB16S
COLOR_RGB16
COLOR_MONO8
COLOR_MONO16S
COLOR_MONO16
COLOR_RAW8
COLOR_RAW16
COLOR_DEFAULT	Set default value.

Definition at line 168 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_specialValues

Special values for camera properties.

Enumerator:

VALUE_AUTO	No control of this parameter allowed. Parameter is switched back to manufacturers default value.
VALUE_ONESHOT	Parameter is continuously controlled automatically by the image device itself. A normal value write switches the automatic mode off.
VALUE_OFF	Parameter is adjusted automatically one time and can then be controlled manually again by writing new values.
VALUE_DEFAULT	Set default values. This usual means, that nothing is set at all.

Definition at line 209 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_ToFGrayImageType

Enumerator:

INTENSITY_32F1
AMPLITUDE
INTENSITY_8U3

Definition at line 287 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_videoFormat

Enum represents video formats.

Enumerator:

FORMAT_0
FORMAT_1
FORMAT_2
FORMAT_7
FORMAT_DEFAULT	Set default value.

Definition at line 185 of file CameraSensorTypes.h.

enum ipa_CameraSensors::t_videoMode

Enum represents video modes.

Enumerator:

MODE_0
MODE_1
MODE_2
MODE_3
MODE_4
MODE_5
MODE_6
MODE_7
MODE_DEFAULT	Set default value.

Definition at line 195 of file CameraSensorTypes.h.

---

Function Documentation

__DLL_LIBCAMERASENSORS__ CameraSensorToolboxPtr ipa_CameraSensors::CreateCameraSensorToolbox

(

)

Creates, intializes and returns a smart pointer object for the toolbox.

Returns:

Smart pointer, refering to the generated object

Definition at line 68 of file CameraSensorToolbox.cpp.