MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
mitk::ToFCameraPMDPlayerController Class Reference

Interface to read ToF data from a PMD file. More...

#include <mitkToFCameraPMDPlayerController.h>

Inheritance diagram for mitk::ToFCameraPMDPlayerController:
mitk::ToFCameraPMDController

Public Member Functions

 mitkClassMacro (ToFCameraPMDPlayerController, ToFCameraPMDController)
 
 itkFactorylessNewMacro (Self)
 
 itkCloneMacro (Self)
 
 itkSetMacro (PMDFileName, std::string)
 
 itkGetMacro (PMDFileName, std::string)
 
bool OpenCameraConnection ()
 opens a connection to the ToF camera
 
int SetModulationFrequency (unsigned int modulationFrequency)
 convenience method setting the modulation frequency in the PMDDataDescription
 
int SetIntegrationTime (unsigned int integrationTime)
 convenience method setting the integration time in the PMDDataDescription
 
- Public Member Functions inherited from mitk::ToFCameraPMDController
 mitkClassMacroItkParent (ToFCameraPMDController, itk::Object)
 
virtual bool CloseCameraConnection ()
 closes the connection to the camera
 
virtual bool GetAmplitudes (float *amplitudeArray)
 Gets the current amplitude array from the device.
 
virtual bool GetAmplitudes (char *sourceData, float *amplitudeArray)
 Calculates the current amplitude data from the raw source data using the processing plugin of the PMDSDK.
 
virtual bool GetIntensities (float *intensityArray)
 Gets the current intensity array from the device.
 
virtual bool GetIntensities (char *sourceData, float *intensityArray)
 Calculates the current intensity data from the raw source data using the processing plugin of the PMDSDK.
 
virtual bool GetDistances (float *distanceArray)
 Gets the current distance array from the device.
 
virtual bool GetDistances (char *sourceData, float *distanceArray)
 Calculates the current distance data from the raw source data using the processing plugin of the PMDSDK.
 
virtual bool GetSourceData (char *sourceDataArray)
 Gets the PMD raw data from the ToF device.
 
bool GetShortSourceData (short *sourceData)
 Convenience method to get the PMD raw data from the ToF device as short array.
 
virtual bool UpdateCamera ()
 calls update on the camera -> a new ToF-image is aquired
 
virtual int GetModulationFrequency ()
 Returns the currently set modulation frequency.
 
virtual int GetIntegrationTime ()
 Returns the currently set integration time.
 
virtual void SetInputFileName (std::string inputFileName)
 set input file name used by PMD player classes
 
 itkGetMacro (CaptureWidth, unsigned int)
 Access the resolution of the image in x direction.
 
 itkGetMacro (CaptureHeight, unsigned int)
 Access the resolution of the image in y direction.
 
 itkGetMacro (InternalCaptureWidth, unsigned int)
 Access the chosen width of the resulting image in x direction.
 
 itkGetMacro (InternalCaptureHeight, unsigned int)
 Access the chosen width of the resulting image in y direction.
 
 itkGetMacro (SourceDataStructSize, int)
 

Protected Member Functions

virtual void TransformCameraOutput (float *in, float *out, bool isDist)
 
 ToFCameraPMDPlayerController ()
 
 ~ToFCameraPMDPlayerController ()
 
- Protected Member Functions inherited from mitk::ToFCameraPMDController
 ToFCameraPMDController ()
 
 ~ToFCameraPMDController ()
 
bool ErrorText (int error)
 Method printing the current error message to the console and returning whether the previous command was successful.
 

Protected Attributes

std::string m_PMDFileName
 File name of the pmd data stream.
 
- Protected Attributes inherited from mitk::ToFCameraPMDController
char m_PMDError [128]
 member holding the current error text
 
int m_PMDRes
 holds the current result message provided by PMD
 
int m_PixelNumber
 holds the number of pixels contained in the image
 
int m_NumberOfBytes
 holds the number of bytes contained in the image
 
unsigned int m_CaptureWidth
 holds the width of the image in pixel as it is originally acquired by the camera
 
unsigned int m_CaptureHeight
 holds the height of the image in pixel as it is originally acquired by the camera
 
unsigned int m_InternalCaptureWidth
 holds the width of the image in pixel as it is requested by the user (cf. TransformCameraOutput()) Default: m_CaptureWidth
 
unsigned int m_InternalCaptureHeight
 holds the height of the image in pixel as is it requested by the user (cf. TransformCameraOutput()) Default: m_CaptureHeight
 
int m_SourceDataSize
 size of the original PMD source data
 
int m_SourceDataStructSize
 size of the PMD source data struct and the PMD source data
 
bool m_ConnectionCheck
 flag showing whether the camera is connected (true) or not (false)
 
std::string m_InputFileName
 input file name used by PMD player classes
 
char * m_SourcePlugin
 holds name of source plugin to be loaded (e.g. camcube3.W64.pap for CamCube 3.0 on Win64 platform)
 
char * m_SourceParam
 holds source parameter(s)
 
char * m_ProcPlugin
 holds name of processing plugin to be loaded (e.g. camcubeproc.W64.pap for CamCube 3.0 on Win64 platform)
 
char * m_ProcParam
 holds processing parameter(s)
 

Detailed Description

Interface to read ToF data from a PMD file.

Definition at line 29 of file mitkToFCameraPMDPlayerController.h.

Constructor & Destructor Documentation

◆ ToFCameraPMDPlayerController()

mitk::ToFCameraPMDPlayerController::ToFCameraPMDPlayerController ( )
protected

Definition at line 26 of file mitkToFCameraPMDPlayerController.cpp.

◆ ~ToFCameraPMDPlayerController()

mitk::ToFCameraPMDPlayerController::~ToFCameraPMDPlayerController ( )
protected

Definition at line 35 of file mitkToFCameraPMDPlayerController.cpp.

Member Function Documentation

◆ itkCloneMacro()

mitk::ToFCameraPMDPlayerController::itkCloneMacro ( Self )

◆ itkFactorylessNewMacro()

mitk::ToFCameraPMDPlayerController::itkFactorylessNewMacro ( Self )

◆ itkGetMacro()

mitk::ToFCameraPMDPlayerController::itkGetMacro ( PMDFileName ,
std::string  )

◆ itkSetMacro()

mitk::ToFCameraPMDPlayerController::itkSetMacro ( PMDFileName ,
std::string  )

◆ mitkClassMacro()

mitk::ToFCameraPMDPlayerController::mitkClassMacro ( ToFCameraPMDPlayerController ,
ToFCameraPMDController  )

◆ OpenCameraConnection()

bool mitk::ToFCameraPMDPlayerController::OpenCameraConnection ( )
virtual

opens a connection to the ToF camera

Implements mitk::ToFCameraPMDController.

Definition at line 39 of file mitkToFCameraPMDPlayerController.cpp.

◆ SetIntegrationTime()

int mitk::ToFCameraPMDPlayerController::SetIntegrationTime ( unsigned int integrationTime)
virtual

convenience method setting the integration time in the PMDDataDescription

Parameters
integrationTimeintegration time
Returns
currently set integration time in PMDDataDescription

Reimplemented from mitk::ToFCameraPMDController.

Definition at line 79 of file mitkToFCameraPMDPlayerController.cpp.

◆ SetModulationFrequency()

int mitk::ToFCameraPMDPlayerController::SetModulationFrequency ( unsigned int modulationFrequency)
virtual

convenience method setting the modulation frequency in the PMDDataDescription

Parameters
modulationFrequencymodulation frequency
Returns
currently set modulation frequency in PMDDataDescription

Reimplemented from mitk::ToFCameraPMDController.

Definition at line 84 of file mitkToFCameraPMDPlayerController.cpp.

◆ TransformCameraOutput()

virtual void mitk::ToFCameraPMDPlayerController::TransformCameraOutput ( float * in,
float * out,
bool isDist )
inlineprotectedvirtual

Implements mitk::ToFCameraPMDController.

Definition at line 65 of file mitkToFCameraPMDPlayerController.h.

Member Data Documentation

◆ m_PMDFileName

std::string mitk::ToFCameraPMDPlayerController::m_PMDFileName
protected

File name of the pmd data stream.

Definition at line 71 of file mitkToFCameraPMDPlayerController.h.


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