Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::ToFCameraPMDPlayerController Class Reference

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

#include <mitkToFCameraPMDPlayerController.h>

Inheritance diagram for mitk::ToFCameraPMDPlayerController:
Collaboration diagram for mitk::ToFCameraPMDPlayerController:

Public Member Functions

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

Static Public Member Functions

static Pointer New ()
 

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. More...
 

Protected Attributes

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

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

◆ ~ToFCameraPMDPlayerController()

mitk::ToFCameraPMDPlayerController::~ToFCameraPMDPlayerController ( )
protected

Member Function Documentation

◆ Clone()

Pointer mitk::ToFCameraPMDPlayerController::Clone ( ) const

◆ GetPMDFileName()

virtual std::string mitk::ToFCameraPMDPlayerController::GetPMDFileName ( )
virtual

◆ mitkClassMacro()

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

◆ New()

static Pointer mitk::ToFCameraPMDPlayerController::New ( )
static

◆ OpenCameraConnection()

bool mitk::ToFCameraPMDPlayerController::OpenCameraConnection ( )
virtual

opens a connection to the ToF camera

Implements mitk::ToFCameraPMDController.

◆ 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.

◆ 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.

◆ SetPMDFileName()

virtual void mitk::ToFCameraPMDPlayerController::SetPMDFileName ( std::string  _arg)
virtual

◆ 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 file: