LTI-Lib latest version v1.9 - last update 24 Nov 2005
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

lti::camera::parameters Class Reference

the parameters for the class camera More...

#include <ltiCamera.h>

Inheritance diagram for lti::camera::parameters:

Inheritance graph
[legend]
Collaboration diagram for lti::camera::parameters:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 parameters ()
 parameters (const parameters &other)
 ~parameters ()
const char * getTypeName () const
parameterscopy (const parameters &other)
parametersoperator= (const parameters &other)
virtual functor::parametersclone () const
virtual bool write (ioHandler &handler, const bool complete=true) const
virtual bool read (ioHandler &handler, const bool complete=true)

Public Attributes

bool autoWhiteBalance
bool autoGain
float gain
float redGain
float blueGain
bool autoShutter
float shutterSpeed
bool autoFocus
float focus
float zoom

Static Public Attributes

static const float minGain
static const float maxGain
static const float minRBGain
static const float maxRBGain
static const float minShutterSpeed
static const float maxShutterSpeed
static const float minFocus
static const float maxFocus
static const float maxZoom

Detailed Description

the parameters for the class camera


Constructor & Destructor Documentation

lti::camera::parameters::parameters  ) 
 

default constructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.

lti::camera::parameters::parameters const parameters other  ) 
 

copy constructor

Parameters:
other the parameters object to be copied

lti::camera::parameters::~parameters  )  [virtual]
 

destructor

Reimplemented from lti::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.


Member Function Documentation

virtual functor::parameters* lti::camera::parameters::clone  )  const [virtual]
 

returns a pointer to a clone of the parameters

Implements lti::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.

parameters& lti::camera::parameters::copy const parameters other  ) 
 

copy the contents of a parameters object

Parameters:
other the parameters object to be copied
Returns:
a reference to this parameters object

const char* lti::camera::parameters::getTypeName  )  const [virtual]
 

returns name of this type

Reimplemented from lti::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.

parameters& lti::camera::parameters::operator= const parameters other  ) 
 

copy the contents of a parameters object

Parameters:
other the parameters object to be copied
Returns:
a reference to this parameters object

virtual bool lti::camera::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::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.

virtual bool lti::camera::parameters::write ioHandler handler,
const bool  complete = true
const [virtual]
 

write the parameters in 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::functor::parameters.

Reimplemented in lti::sonyEviD100P::parameters.


Member Data Documentation

bool lti::camera::parameters::autoFocus
 

auto focus (true) or manual focus (false).

Default: true.

bool lti::camera::parameters::autoGain
 

automatic determination of the global gain by the camera (true) or manual setting by the user (false).

Default: true.

bool lti::camera::parameters::autoShutter
 

if true the shutter speed is set automatically, otherwise it is controlled manually.

Default: true.

bool lti::camera::parameters::autoWhiteBalance
 

Mode of determing the whiteBalance.

Default: Auto, i.e. true. Derived classes may distinguish between more than two modes by adding a whiteBalanceMode-parameter. If a class does not distinguish between further modes false refers to manual white balance, i.e. direct control by the red and blue gain values. Default: true.

float lti::camera::parameters::blueGain
 

the green gain in dB.

Default: maxRBGain.

float lti::camera::parameters::focus
 

focus value which the camera shall use in meter.

Default: maxFocus.

float lti::camera::parameters::gain
 

the global gain in dB.

Default: maxGain.

const float lti::camera::parameters::maxFocus [static]
 

the maximum focus in meter

const float lti::camera::parameters::maxGain [static]
 

the max.

possible gain in dB

const float lti::camera::parameters::maxRBGain [static]
 

the max.

possible red or blue gain in dB

const float lti::camera::parameters::maxShutterSpeed [static]
 

the maximum shutter speed

const float lti::camera::parameters::maxZoom [static]
 

The maximum possible zoom value.

The zoom ranges from 0 (no zoom) to max. zoom.

const float lti::camera::parameters::minFocus [static]
 

the minimum focus in meter

const float lti::camera::parameters::minGain [static]
 

the min.

possible gain in dB

const float lti::camera::parameters::minRBGain [static]
 

the min.

possible red or blue gain in dB

const float lti::camera::parameters::minShutterSpeed [static]
 

the minimum shutter speed of the device

float lti::camera::parameters::redGain
 

the red gain in dB.

Default: maxRBGain.

float lti::camera::parameters::shutterSpeed
 

the shutter speed in 1/s.

Default: minShutterSpeed.

float lti::camera::parameters::zoom
 

Zoom value which the camera shall use.

Default: 0.


The documentation for this class was generated from the following file:
Generated on Thu Nov 24 16:52:33 2005 for LTI-Lib by Doxygen 1.4.4