lti::microEnablePulnix::parameters Class Reference

frameGrabber parameters class More...

#include <ltiMicroEnablePulnix.h>

Inheritance diagram for lti::microEnablePulnix::parameters:

[legend]

Collaboration diagram for lti::microEnablePulnix::parameters:

[legend]

List of all members.

Public Types
enum	eShutterMode {   SMUninitialized = -1, DirectM, DirectA, Manual,   Async }
enum	eEdgeEnhancement {   EEUninitialized = -1, Off = 0x00, Horizontal = 0x04, Vertical = 0x08,   Both = 0x0C }
enum	eWhiteBalanceType { WBUninitialized = -1, WBManual, WBAuto }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
virtual const char *	getTypeName () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
virtual bool	download (const serial::parameters::ePortType &serialPort, const bool &allBanks=true)
Public Attributes
serial::parameters::ePortType	serialPort
bankType *	bank
int	currentBank
int	bufferSize
point	windowSize
point	windowOffset
Protected Member Functions
virtual bool	upload (const serial::parameters::ePortType &serialPort, const bool allBanks=false, const bool force=false) const
Static Protected Attributes
static point	camWindowSize
static point	camWindowOffset
static int	camCurrentBank

---

Detailed Description

frameGrabber parameters class

---

Member Enumeration Documentation

enum lti::microEnablePulnix::parameters::eEdgeEnhancement

modes for edge enhancement

Enumerator:

EEUninitialized	uninitialized
Off	No edge enhancement.
Horizontal	Horizontal edge enhancement.
Vertical	Vertical edge enhancement.
Both	Horizontal and vertical edge enhancement.

enum lti::microEnablePulnix::parameters::eShutterMode

Possible shutter modes.

Enumerator:

SMUninitialized	uninitialized shutter mode
DirectM	Direct shutter specification for the manual mode. The shutter value to be used is specified in the parameter shutterSpeed
DirectA	Direct shutter specification for the asynchronous mode. The shutter value to be used is specified in the parameter shutterSpeed
Manual	Use one of the shutter values specified in the manual shutter table. The entry in that table is given in the parameter shutterEntry.
Async	Use one of the shutter values specified in the async shutter table. The entry in that table is given in the parameter shutterEntry.

enum lti::microEnablePulnix::parameters::eWhiteBalanceType

white balance mode

Enumerator:

WBUninitialized	uninitialized
WBManual	Manual mode. You need this mode to adjust the blue and red gains. In the Pulnix documentation, this mode is refered as "External" mode
WBAuto	Automatic White Balance. In the Pulnix documentation, this mode is refered as "Internal" mode

---

Constructor & Destructor Documentation

lti::microEnablePulnix::parameters::parameters

(

)

default constructor

Reimplemented from lti::frameGrabber::parameters.

lti::microEnablePulnix::parameters::parameters

(

const parameters &

other

)

copy constructor

Reimplemented from lti::frameGrabber::parameters.

lti::microEnablePulnix::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from lti::functor::parameters.

---

Member Function Documentation

virtual functor::parameters* lti::microEnablePulnix::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from lti::frameGrabber::parameters.

parameters& lti::microEnablePulnix::parameters::copy

(

const parameters &

other

)

copy member

Reimplemented from lti::frameGrabber::parameters.

virtual bool lti::microEnablePulnix::parameters::download	(	const serial::parameters::ePortType &	serialPort,
		const bool &	allBanks = true
	)			[virtual]

read the parameters from the camera, assuming that the serial port of the pulnix camera is connected at the given serial port.

This will take a while! You can choose if you want to read all parameter sets or the current bank only.

To send the parameters to the camera use the method setParameters() of the microEnablePulnix functor.

Parameters:

	serialPort	the serial port used to communicate with the camera. (Com1, Com2, ...)
	allBanks	if true, all parameter banks will be read. Otherwise only the current bank will be read.

Returns:

true if successful, false otherwise

virtual const char* lti::microEnablePulnix::parameters::getTypeName

(

)

const [virtual]

returns the type name

Reimplemented from lti::frameGrabber::parameters.

virtual bool lti::microEnablePulnix::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::frameGrabber::parameters.

virtual bool lti::microEnablePulnix::parameters::upload	(	const serial::parameters::ePortType &	serialPort,
		const bool	allBanks = false,
		const bool	force = false
	)			const [protected, virtual]

send the parameters to the camera, assuming that the serial port of the pulnix camera is connected to the given serial port.

This will upload only those parameter that have changed! You can choose if you want to send only the current bank (default) or if you want to send all parameters banks.

Parameters:

	serialPort	the serial port used to communicate with the camera. (Com1, Com2, ...)
	allBanks	if true, all parameters sets will be send to the camera. If false, only the current bank will be send.
	force	if true, everything will be senden, ignoring the content of the "camera shadow"

Returns:

true if successful, false otherwise

virtual bool lti::microEnablePulnix::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::frameGrabber::parameters.

---

Member Data Documentation

bankType* lti::microEnablePulnix::parameters::bank

The four parameter banks.

int lti::microEnablePulnix::parameters::bufferSize

Amount of memory in bytes to be allocated on the host to communicate with the grabber (Default 8MB=8*1024*1024).

This parameter is consider just once, at the initialization. After that, it is not possible to change the buffer size.

int lti::microEnablePulnix::parameters::camCurrentBank [static, protected]

current bank in the camera

point lti::microEnablePulnix::parameters::camWindowOffset [static, protected]

offset of the grabbed window

These are the real values in the camera/frame grabber, used to detect if the table needs to be resend.

point lti::microEnablePulnix::parameters::camWindowSize [static, protected]

dimensions of the grabbed window

These are the real values in the camera/frame grabber, used to detect if the table needs to be resend.

int lti::microEnablePulnix::parameters::currentBank

The parameter-bank number to be used.

This must be a value between 0 and 3. Only the last two bits of the given value will be considered. Default value: 3

serial::parameters::ePortType lti::microEnablePulnix::parameters::serialPort

Which serial port should be used to communicate with the camera?

point lti::microEnablePulnix::parameters::windowOffset

offset of the grabbed window (default 104x40)

point lti::microEnablePulnix::parameters::windowSize

dimensions of the grabbed window (default 640x480)

---

The documentation for this class was generated from the following file:

• ltiMicroEnablePulnix.h