Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::ToFCameraMESASR4000Controller Class Reference

Interface to the Time-of-Flight (ToF) camera MESA Swissranger 4000. More...

#include <mitkToFCameraMESASR4000Controller.h>

Inheritance diagram for mitk::ToFCameraMESASR4000Controller:
Collaboration diagram for mitk::ToFCameraMESASR4000Controller:

Public Member Functions

 mitkClassMacro (ToFCameraMESASR4000Controller, mitk::ToFCameraMESAController)
 
Pointer Clone () const
 
virtual bool OpenCameraConnection ()
 opens a connection to the ToF camera and initializes the hardware specific members More...
 
virtual int GetModulationFrequency ()
 Returns the currently set modulation frequency. More...
 
virtual int SetModulationFrequency (unsigned int modulationFrequency)
 Sets the modulation frequency of the ToF device. The method automatically calculates a valid value from the given frequency to make sure that only valid frequencies are used. More...
 
virtual int GetIntegrationTime ()
 Returns the currently set integration time. More...
 
virtual int SetIntegrationTime (unsigned int integrationTime)
 Sets the integration time of the ToF device. The method automatically calculates a valid value from the given integration time to make sure that only valid times are used. More...
 
virtual void SetFPN (bool fpn)
 Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details. More...
 
virtual void SetConvGray (bool convGray)
 Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details. More...
 
virtual void SetMedian (bool median)
 Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details. More...
 
virtual void SetANF (bool anf)
 Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details. More...
 
- Public Member Functions inherited from mitk::ToFCameraMESAController
 mitkClassMacroItkParent (ToFCameraMESAController, 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 GetIntensities (float *intensityArray)
 Gets the current intensity array from the device. More...
 
virtual bool GetDistances (float *distanceArray)
 Gets the current distance array from the device. More...
 
virtual bool UpdateCamera ()
 calls update on the camera -> a new ToF-image is aquired More...
 
virtual void SetInputFileName (std::string inputFileName)
 set input file name used by MESA 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...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ToFCameraMESASR4000Controller ()
 
 ~ToFCameraMESASR4000Controller ()
 
- Protected Member Functions inherited from mitk::ToFCameraMESAController
 ToFCameraMESAController ()
 
 ~ToFCameraMESAController ()
 
bool ErrorText (int error)
 Method printing the current error message to the console and returning whether the previous command was successful. More...
 

Additional Inherited Members

- Protected Attributes inherited from mitk::ToFCameraMESAController
char m_MESAError [128]
 member holding the current error text More...
 
int m_MESARes
 holds the current result message provided by MESA 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 More...
 
unsigned int m_CaptureHeight
 holds the height of the image in pixel More...
 
int m_NumImg
 holds the number of images the camera provided (distance, intensity, etc) More...
 
float m_MaxRangeFactor
 holds the factor to calculate the real distance depends on the modulation frequency 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 MESA player classes More...
 

Detailed Description

Interface to the Time-of-Flight (ToF) camera MESA Swissranger 4000.

Definition at line 30 of file mitkToFCameraMESASR4000Controller.h.

Constructor & Destructor Documentation

◆ ToFCameraMESASR4000Controller()

mitk::ToFCameraMESASR4000Controller::ToFCameraMESASR4000Controller ( )
protected

◆ ~ToFCameraMESASR4000Controller()

mitk::ToFCameraMESASR4000Controller::~ToFCameraMESASR4000Controller ( )
protected

Member Function Documentation

◆ Clone()

Pointer mitk::ToFCameraMESASR4000Controller::Clone ( ) const

◆ GetIntegrationTime()

virtual int mitk::ToFCameraMESASR4000Controller::GetIntegrationTime ( )
virtual

Returns the currently set integration time.

Returns
integration time

Implements mitk::ToFCameraMESAController.

◆ GetModulationFrequency()

virtual int mitk::ToFCameraMESASR4000Controller::GetModulationFrequency ( )
virtual

Returns the currently set modulation frequency.

Returns
modulation frequency

Implements mitk::ToFCameraMESAController.

◆ mitkClassMacro()

mitk::ToFCameraMESASR4000Controller::mitkClassMacro ( ToFCameraMESASR4000Controller  ,
mitk::ToFCameraMESAController   
)

◆ New()

static Pointer mitk::ToFCameraMESASR4000Controller::New ( )
static

◆ OpenCameraConnection()

virtual bool mitk::ToFCameraMESASR4000Controller::OpenCameraConnection ( )
virtual

opens a connection to the ToF camera and initializes the hardware specific members

Returns
returns whether the connection was successful (true) or not (false)

Implements mitk::ToFCameraMESAController.

◆ SetANF()

virtual void mitk::ToFCameraMESASR4000Controller::SetANF ( bool  anf)
virtual

Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details.

Parameters
anfTurns on the 5x5 hardware adaptive neighborhood filter

◆ SetConvGray()

virtual void mitk::ToFCameraMESASR4000Controller::SetConvGray ( bool  convGray)
virtual

Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details.

Parameters
convGrayConverts the amplitude image by multiplying by the square of the distance, resulting in image more like a conventional camera

◆ SetFPN()

virtual void mitk::ToFCameraMESASR4000Controller::SetFPN ( bool  fpn)
virtual

Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details.

Parameters
fpnturns on fix pattern noise correction this should always be enabled for good distance measurement

◆ SetIntegrationTime()

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

Sets the integration time of the ToF device. The method automatically calculates a valid value from the given integration time to make sure that only valid times are used.

Parameters
integrationTimeintegration time
Returns
integration time set after validation step

Implements mitk::ToFCameraMESAController.

◆ SetMedian()

virtual void mitk::ToFCameraMESASR4000Controller::SetMedian ( bool  median)
virtual

Sets the acquire mode of the MESA SR4000 camera. The method sets some parameter supported by the MESA SR4000, see MESA API for more details.

Parameters
medianturns on a 3x3 median filter

◆ SetModulationFrequency()

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

Sets the modulation frequency of the ToF device. The method automatically calculates a valid value from the given frequency to make sure that only valid frequencies are used.

Parameters
modulationFrequencymodulation frequency
Returns
frequency set after validation step

Implements mitk::ToFCameraMESAController.


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