Medical Imaging Interaction Toolkit  2023.04.00
Medical Imaging Interaction Toolkit
mitk::KinectController Class Reference

Interface to the Kinect camera. More...

#include <mitkKinectController.h>

Inheritance diagram for mitk::KinectController:
Collaboration diagram for mitk::KinectController:

Public Member Functions

 mitkClassMacroItkParent (KinectController, itk::Object)
 
Pointer Clone () const
 
unsigned int GetCaptureWidth () const
 
unsigned int GetCaptureHeight () const
 
bool GetUseIR () const
 
void SetUseIR (bool useIR)
 
virtual bool OpenCameraConnection ()
 opens a connection to the Kinect camera. More...
 
virtual bool CloseCameraConnection ()
 closes the connection to the camera More...
 
virtual bool UpdateCamera ()
 updates the camera. The update function of the hardware interface is called only when new data is available More...
 
void GetDistances (float *distances)
 acquire new distance data from the Kinect camera More...
 
void GetAmplitudes (float *amplitudes)
 
void GetIntensities (float *intensities)
 
void GetRgb (unsigned char *rgb)
 acquire new rgb data from the Kinect camera More...
 
void GetAllData (float *distances, float *amplitudes, unsigned char *rgb)
 convenience method for faster access to distance and rgb data More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 KinectController ()
 
 ~KinectController ()
 

Detailed Description

Interface to the Kinect camera.

Definition at line 30 of file mitkKinectController.h.

Constructor & Destructor Documentation

◆ KinectController()

mitk::KinectController::KinectController ( )
protected

◆ ~KinectController()

mitk::KinectController::~KinectController ( )
protected

Member Function Documentation

◆ Clone()

Pointer mitk::KinectController::Clone ( ) const

◆ CloseCameraConnection()

virtual bool mitk::KinectController::CloseCameraConnection ( )
virtual

closes the connection to the camera

◆ GetAllData()

void mitk::KinectController::GetAllData ( float *  distances,
float *  amplitudes,
unsigned char *  rgb 
)

convenience method for faster access to distance and rgb data

Parameters
distancespointer to memory location where distances should be stored
amplitudes
rgbpointer to memory location where rgb information should be stored

◆ GetAmplitudes()

void mitk::KinectController::GetAmplitudes ( float *  amplitudes)

◆ GetCaptureHeight()

unsigned int mitk::KinectController::GetCaptureHeight ( ) const

◆ GetCaptureWidth()

unsigned int mitk::KinectController::GetCaptureWidth ( ) const

◆ GetDistances()

void mitk::KinectController::GetDistances ( float *  distances)

acquire new distance data from the Kinect camera

Parameters
distancespointer to memory location where distances should be stored

◆ GetIntensities()

void mitk::KinectController::GetIntensities ( float *  intensities)

◆ GetRgb()

void mitk::KinectController::GetRgb ( unsigned char *  rgb)

acquire new rgb data from the Kinect camera

Parameters
rgbpointer to memory location where rgb information should be stored

◆ GetUseIR()

bool mitk::KinectController::GetUseIR ( ) const

◆ mitkClassMacroItkParent()

mitk::KinectController::mitkClassMacroItkParent ( KinectController  ,
itk::Object   
)

◆ New()

static Pointer mitk::KinectController::New ( )
static

◆ OpenCameraConnection()

virtual bool mitk::KinectController::OpenCameraConnection ( )
virtual

opens a connection to the Kinect camera.

Exceptions
mitkExceptionIn case of no connection, an exception is thrown!

◆ SetUseIR()

void mitk::KinectController::SetUseIR ( bool  useIR)

◆ UpdateCamera()

virtual bool mitk::KinectController::UpdateCamera ( )
virtual

updates the camera. The update function of the hardware interface is called only when new data is available

Exceptions
mitkExceptionIn case of no connection, an exception is thrown!

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