PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
vtkPlusCameraControlParameters Class Reference

This class is used to store a configuration of the imaging parameters of an Microsoft Media Foundation camera device. This class exists mainly for two reasons: Provide a standard interface for accessing camera parameters Enable standardized API for operating on camera parametersCurrently contains the following items CameraControlParameters PanDegrees TiltDegrees RollDegrees ZoomMm IrisFStop ExposureLog2Seconds AutoExposure FocusMm AutoFocus. More...

#include <src/PlusDataCollection/vtkPlusCameraControlParameters.h>

Inheritance diagram for vtkPlusCameraControlParameters:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusCameraControlParameters:
Collaboration graph
[legend]

Public Types

typedef vtkPlusParameters Superclass
 
- Public Types inherited from vtkPlusParameters
typedef vtkObject Superclass
 

Public Member Functions

PlusStatus GetAutoExposure (bool &aAutoExposure) const
 
PlusStatus GetAutoFocus (bool &aAutoFocus) const
 
virtual const char * GetClassName ()
 
PlusStatus GetExposureLog2Seconds (int &aExposureLog2Seconds) const
 
PlusStatus GetFocusMm (double &aFocusMm) const
 
PlusStatus GetIrisFStop (int &aIrisFStop) const
 
PlusStatus GetPanDegrees (double &aPanDegrees) const
 
PlusStatus GetRollDegrees (double &aRollDegrees) const
 
PlusStatus GetTiltDegrees (double &aTiltDegrees) const
 
PlusStatus GetZoomMm (double &aZoomMm) const
 
virtual int IsA (const char *type)
 
PlusStatus SetAutoExposure (bool aAutoExposure)
 
PlusStatus SetAutoFocus (bool aAutoFocus)
 
PlusStatus SetExposureLog2Seconds (int aExposureLog2Seconds)
 
PlusStatus SetFocusMm (double aFocusMm)
 
PlusStatus SetIrisFStop (int aIrisFStop)
 
PlusStatus SetPanDegrees (double aPanDegrees)
 
PlusStatus SetRollDegrees (double aRollDegrees)
 
PlusStatus SetTiltDegrees (double aTiltDegrees)
 
PlusStatus SetZoomMm (double aZoomMm)
 
- Public Member Functions inherited from vtkPlusParameters
virtual PlusStatus DeepCopy (const vtkPlusParameters &otherParameters)
 
template<typename T >
PlusStatus GetValue (const std::string &paramName, T &outputValue) const
 
bool IsPending (const std::string &paramName) const
 
bool IsSet (const std::string &paramName) const
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual PlusStatus ReadConfiguration (vtkXMLDataElement *deviceConfig)
 
PlusStatus SetPending (const std::string &paramName, bool pending)
 
template<typename T >
PlusStatus SetValue (const std::string &paramName, T aValue)
 
virtual PlusStatus WriteConfiguration (vtkXMLDataElement *deviceConfig)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPlusCameraControlParametersNew ()
 
static vtkPlusCameraControlParametersSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPlusParameters
static int IsTypeOf (const char *type)
 
static vtkPlusParametersNew ()
 
static vtkPlusParametersSafeDownCast (vtkObject *o)
 

Static Public Attributes

static const char * CAMERA_CONTROL_XML_ELEMENT_TAG = "CameraControlParameters"
 
static const char * KEY_AUTO_EXPOSURE = "AutoExposure"
 
static const char * KEY_AUTO_FOCUS = "AutoFocus"
 
static const char * KEY_EXPOSURE_LOG2SECONDS = "ExposureLog2Seconds"
 
static const char * KEY_FOCUS_MM = "FocusMm"
 
static const char * KEY_IRIS_FSTOP = "IrisFStop"
 
static const char * KEY_PAN_DEGREES = "PanDegrees"
 
static const char * KEY_ROLL_DEGREES = "RollDegrees"
 
static const char * KEY_TILT_DEGREES = "TiltDegrees"
 
static const char * KEY_ZOOM_MM = "ZoomMm"
 
- Static Public Attributes inherited from vtkPlusParameters
static const char * NAME_TAG = "Name"
 
static const char * PARAMETER_TAG = "Parameter"
 
static const char * VALUE_TAG = "Value"
 
static const char * XML_ELEMENT_TAG = "Parameters"
 

Protected Member Functions

const char * GetXMLElementName () override
 
 vtkPlusCameraControlParameters ()
 
virtual ~vtkPlusCameraControlParameters ()
 
- Protected Member Functions inherited from vtkPlusParameters
ParameterMapConstIterator begin () const
 
ParameterMapConstIterator end () const
 
 vtkPlusParameters ()
 
virtual ~vtkPlusParameters ()
 

Additional Inherited Members

- Protected Types inherited from vtkPlusParameters
typedef std::map< std::string, ParameterInfoParameterMap
 
typedef ParameterMap::const_iterator ParameterMapConstIterator
 
typedef ParameterMap::iterator ParameterMapIterator
 
- Protected Attributes inherited from vtkPlusParameters
ParameterMap Parameters
 

Detailed Description

This class is used to store a configuration of the imaging parameters of an Microsoft Media Foundation camera device. This class exists mainly for two reasons: Provide a standard interface for accessing camera parameters Enable standardized API for operating on camera parameters

Currently contains the following items CameraControlParameters PanDegrees TiltDegrees RollDegrees ZoomMm IrisFStop ExposureLog2Seconds AutoExposure FocusMm AutoFocus.

Definition at line 38 of file vtkPlusCameraControlParameters.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkPlusCameraControlParameters.h.

Constructor & Destructor Documentation

◆ vtkPlusCameraControlParameters()

vtkPlusCameraControlParameters::vtkPlusCameraControlParameters ( )
protected

Definition at line 30 of file vtkPlusCameraControlParameters.cxx.

◆ ~vtkPlusCameraControlParameters()

vtkPlusCameraControlParameters::~vtkPlusCameraControlParameters ( )
protectedvirtual

Definition at line 45 of file vtkPlusCameraControlParameters.cxx.

Member Function Documentation

◆ GetAutoExposure()

PlusStatus vtkPlusCameraControlParameters::GetAutoExposure ( bool &  aAutoExposure) const

Get camera auto exposure enabled.

Definition at line 129 of file vtkPlusCameraControlParameters.cxx.

◆ GetAutoFocus()

PlusStatus vtkPlusCameraControlParameters::GetAutoFocus ( bool &  aAutoFocus) const

Get camera auto focus enabled.

Definition at line 160 of file vtkPlusCameraControlParameters.cxx.

◆ GetClassName()

virtual const char* vtkPlusCameraControlParameters::GetClassName ( )
virtual

Reimplemented from vtkPlusParameters.

◆ GetExposureLog2Seconds()

PlusStatus vtkPlusCameraControlParameters::GetExposureLog2Seconds ( int aExposureLog2Seconds) const

Get camera exposure in log2 seconds. Value Seconds -3 1/8 -2 1/4 -1 1/2 0 1 1 2 2 4

Definition at line 117 of file vtkPlusCameraControlParameters.cxx.

◆ GetFocusMm()

PlusStatus vtkPlusCameraControlParameters::GetFocusMm ( double &  aFocusMm) const

Get camera focus in mm.

Definition at line 148 of file vtkPlusCameraControlParameters.cxx.

◆ GetIrisFStop()

PlusStatus vtkPlusCameraControlParameters::GetIrisFStop ( int aIrisFStop) const

Get camera iris in f-stops. Values in units of fstop * 10.

Definition at line 105 of file vtkPlusCameraControlParameters.cxx.

◆ GetPanDegrees()

PlusStatus vtkPlusCameraControlParameters::GetPanDegrees ( double &  aPanDegrees) const

Get camera pan in degrees from -180 to +180.

Definition at line 57 of file vtkPlusCameraControlParameters.cxx.

◆ GetRollDegrees()

PlusStatus vtkPlusCameraControlParameters::GetRollDegrees ( double &  aRollDegrees) const

Get camera roll in degrees from -180 to +180.

Definition at line 81 of file vtkPlusCameraControlParameters.cxx.

◆ GetTiltDegrees()

PlusStatus vtkPlusCameraControlParameters::GetTiltDegrees ( double &  aTiltDegrees) const

Get camera tilt in degrees from -180 to +180.

Definition at line 69 of file vtkPlusCameraControlParameters.cxx.

◆ GetXMLElementName()

const char* vtkPlusCameraControlParameters::GetXMLElementName ( )
inlineoverrideprotectedvirtual

Reimplemented from vtkPlusParameters.

Definition at line 111 of file vtkPlusCameraControlParameters.h.

◆ GetZoomMm()

PlusStatus vtkPlusCameraControlParameters::GetZoomMm ( double &  aZoomMm) const

Get camera zoom in mm. Values from 10 to 600.

Definition at line 93 of file vtkPlusCameraControlParameters.cxx.

◆ IsA()

virtual int vtkPlusCameraControlParameters::IsA ( const char *  type)
virtual

Reimplemented from vtkPlusParameters.

◆ IsTypeOf()

static int vtkPlusCameraControlParameters::IsTypeOf ( const char *  type)
static

◆ New()

static vtkPlusCameraControlParameters* vtkPlusCameraControlParameters::New ( )
static

◆ SafeDownCast()

static vtkPlusCameraControlParameters* vtkPlusCameraControlParameters::SafeDownCast ( vtkObject *  o)
static

◆ SetAutoExposure()

PlusStatus vtkPlusCameraControlParameters::SetAutoExposure ( bool  aAutoExposure)

Set camera auto exposure enabled.

Definition at line 123 of file vtkPlusCameraControlParameters.cxx.

◆ SetAutoFocus()

PlusStatus vtkPlusCameraControlParameters::SetAutoFocus ( bool  aAutoFocus)

Set camera auto focus enabled.

Definition at line 154 of file vtkPlusCameraControlParameters.cxx.

◆ SetExposureLog2Seconds()

PlusStatus vtkPlusCameraControlParameters::SetExposureLog2Seconds ( int  aExposureLog2Seconds)

Set camera exposure in log2 seconds. Value Seconds -3 1/8 -2 1/4 -1 1/2 0 1 1 2 2 4

Definition at line 111 of file vtkPlusCameraControlParameters.cxx.

◆ SetFocusMm()

PlusStatus vtkPlusCameraControlParameters::SetFocusMm ( double  aFocusMm)

Set camera focus in mm.

Definition at line 142 of file vtkPlusCameraControlParameters.cxx.

◆ SetIrisFStop()

PlusStatus vtkPlusCameraControlParameters::SetIrisFStop ( int  aIrisFStop)

Set camera iris in f-stops. Values in units of fstop * 10.

Definition at line 99 of file vtkPlusCameraControlParameters.cxx.

◆ SetPanDegrees()

PlusStatus vtkPlusCameraControlParameters::SetPanDegrees ( double  aPanDegrees)

Set camera pan in degrees from -180 to +180.

Definition at line 51 of file vtkPlusCameraControlParameters.cxx.

◆ SetRollDegrees()

PlusStatus vtkPlusCameraControlParameters::SetRollDegrees ( double  aRollDegrees)

Set camera roll in degrees from -180 to +180.

Definition at line 75 of file vtkPlusCameraControlParameters.cxx.

◆ SetTiltDegrees()

PlusStatus vtkPlusCameraControlParameters::SetTiltDegrees ( double  aTiltDegrees)

Set camera tilt in degrees from -180 to +180.

Definition at line 63 of file vtkPlusCameraControlParameters.cxx.

◆ SetZoomMm()

PlusStatus vtkPlusCameraControlParameters::SetZoomMm ( double  aZoomMm)

Set camera zoom in mm. Values from 10 to 600.

Definition at line 87 of file vtkPlusCameraControlParameters.cxx.

Member Data Documentation

◆ CAMERA_CONTROL_XML_ELEMENT_TAG

const char * vtkPlusCameraControlParameters::CAMERA_CONTROL_XML_ELEMENT_TAG = "CameraControlParameters"
static

Definition at line 41 of file vtkPlusCameraControlParameters.h.

◆ KEY_AUTO_EXPOSURE

const char * vtkPlusCameraControlParameters::KEY_AUTO_EXPOSURE = "AutoExposure"
static

Definition at line 48 of file vtkPlusCameraControlParameters.h.

◆ KEY_AUTO_FOCUS

const char * vtkPlusCameraControlParameters::KEY_AUTO_FOCUS = "AutoFocus"
static

Definition at line 50 of file vtkPlusCameraControlParameters.h.

◆ KEY_EXPOSURE_LOG2SECONDS

const char * vtkPlusCameraControlParameters::KEY_EXPOSURE_LOG2SECONDS = "ExposureLog2Seconds"
static

Definition at line 47 of file vtkPlusCameraControlParameters.h.

◆ KEY_FOCUS_MM

const char * vtkPlusCameraControlParameters::KEY_FOCUS_MM = "FocusMm"
static

Definition at line 49 of file vtkPlusCameraControlParameters.h.

◆ KEY_IRIS_FSTOP

const char * vtkPlusCameraControlParameters::KEY_IRIS_FSTOP = "IrisFStop"
static

Definition at line 46 of file vtkPlusCameraControlParameters.h.

◆ KEY_PAN_DEGREES

const char * vtkPlusCameraControlParameters::KEY_PAN_DEGREES = "PanDegrees"
static

Definition at line 42 of file vtkPlusCameraControlParameters.h.

◆ KEY_ROLL_DEGREES

const char * vtkPlusCameraControlParameters::KEY_ROLL_DEGREES = "RollDegrees"
static

Definition at line 44 of file vtkPlusCameraControlParameters.h.

◆ KEY_TILT_DEGREES

const char * vtkPlusCameraControlParameters::KEY_TILT_DEGREES = "TiltDegrees"
static

Definition at line 43 of file vtkPlusCameraControlParameters.h.

◆ KEY_ZOOM_MM

const char * vtkPlusCameraControlParameters::KEY_ZOOM_MM = "ZoomMm"
static

Definition at line 45 of file vtkPlusCameraControlParameters.h.


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