Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mitk::ToFCameraMITKPlayerController Class Reference

Controller for playing ToF images saved in MITK (.pic) format. More...

#include <mitkToFCameraMITKPlayerController.h>

Inheritance diagram for mitk::ToFCameraMITKPlayerController:
Inheritance graph
[legend]
Collaboration diagram for mitk::ToFCameraMITKPlayerController:
Collaboration graph
[legend]

Public Types

enum  ToFImageType { ToFImageType3D, ToFImageType2DPlusT }
 

Public Member Functions

 mitkClassMacroItkParent (ToFCameraMITKPlayerController, itk::Object)
 
Pointer Clone () const
 
virtual bool OpenCameraConnection ()
 opens a connection to the ToF camera More...
 
virtual bool CloseCameraConnection ()
 closes the connection to the camera More...
 
virtual void GetAmplitudes (float *amplitudeArray)
 gets the current amplitude frame from the input These values can be used to determine the quality of the distance values. The higher the amplitude value, the higher the accuracy of the according distance value More...
 
virtual void GetIntensities (float *intensityArray)
 gets the current intensity frame from the input as a greyscale image More...
 
virtual void GetDistances (float *distanceArray)
 gets the current distance frame from the inpug measuring the distance between the camera and the different object points in millimeters More...
 
virtual void GetRgb (unsigned char *rgbArray)
 gets the current RGB frame from the input if available More...
 
virtual void UpdateCamera ()
 updates the current image frames from input More...
 
virtual void SetInputFileName (std::string inputFileName)
 
virtual int GetPixelNumber ()
 
virtual int GetRGBPixelNumber ()
 
virtual int GetCaptureWidth ()
 
virtual int GetCaptureHeight ()
 
virtual int GetRGBCaptureWidth ()
 
virtual int GetRGBCaptureHeight ()
 
virtual std::string GetDistanceImageFileName ()
 
virtual std::string GetAmplitudeImageFileName ()
 
virtual std::string GetIntensityImageFileName ()
 
virtual std::string GetRGBImageFileName ()
 
virtual void SetDistanceImageFileName (std::string _arg)
 
virtual void SetAmplitudeImageFileName (std::string _arg)
 
virtual void SetIntensityImageFileName (std::string _arg)
 
virtual void SetRGBImageFileName (std::string _arg)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ToFCameraMITKPlayerController ()
 
 ~ToFCameraMITKPlayerController () override
 

Protected Attributes

int m_PixelNumber
 holds the number of pixels contained in the image More...
 
int m_RGBPixelNumber
 same for RGB image More...
 
int m_NumberOfBytes
 holds the number of bytes contained in the image More...
 
int m_NumberOfRGBBytes
 same for RGB image More...
 
int m_CaptureWidth
 holds the width of the image More...
 
int m_CaptureHeight
 holds the height of the image More...
 
int m_RGBCaptureWidth
 same for RGB image which can be different then depth etc. More...
 
int m_RGBCaptureHeight
 same for RGB image which can be different then depth etc. More...
 
bool m_ConnectionCheck
 flag showing whether the camera is connected (true) or not (false) More...
 
std::string m_InputFileName
 
ToFImageType m_ToFImageType
 type of the ToF image to be played: 3D Volume (ToFImageType3D), temporal 2D image stack (ToFImageType2DPlusT) More...
 
Image::Pointer m_DistanceImage
 
Image::Pointer m_AmplitudeImage
 
Image::Pointer m_IntensityImage
 
Image::Pointer m_RGBImage
 
std::vector< bool > m_ImageStatus
 
FILE * m_DistanceInfile
 file holding the distance data More...
 
FILE * m_AmplitudeInfile
 file holding the amplitude data More...
 
FILE * m_IntensityInfile
 file holding the intensity data More...
 
FILE * m_RGBInfile
 file holding the rgb data More...
 
float * m_IntensityArray
 member holding the current intensity frame More...
 
float * m_DistanceArray
 member holding the current distance frame More...
 
float * m_AmplitudeArray
 member holding the current amplitude frame More...
 
unsigned char * m_RGBArray
 member holding the current rgb frame More...
 
std::string m_DistanceImageFileName
 file name of the distance image to be played More...
 
std::string m_AmplitudeImageFileName
 file name of the amplitude image to be played More...
 
std::string m_IntensityImageFileName
 file name of the intensity image to be played More...
 
std::string m_RGBImageFileName
 file name of the rgb image to be played More...
 
long m_PixelStartInFile
 
int m_CurrentFrame
 
int m_NumOfFrames
 

Detailed Description

Controller for playing ToF images saved in MITK (.pic) format.

Definition at line 31 of file mitkToFCameraMITKPlayerController.h.

Member Enumeration Documentation

◆ ToFImageType

enum mitk::ToFCameraMITKPlayerController::ToFImageType
Enumerator
ToFImageType3D 
ToFImageType2DPlusT 

Definition at line 90 of file mitkToFCameraMITKPlayerController.h.

Constructor & Destructor Documentation

◆ ToFCameraMITKPlayerController()

mitk::ToFCameraMITKPlayerController::ToFCameraMITKPlayerController ( )
protected

Definition at line 23 of file mitkToFCameraMITKPlayerController.cpp.

References m_ImageStatus.

◆ ~ToFCameraMITKPlayerController()

mitk::ToFCameraMITKPlayerController::~ToFCameraMITKPlayerController ( )
overrideprotected

Definition at line 58 of file mitkToFCameraMITKPlayerController.cpp.

References m_AmplitudeArray, m_AmplitudeImage, m_AmplitudeImageFileName, m_DistanceArray, m_DistanceImage, m_DistanceImageFileName, m_IntensityArray, m_IntensityImage, m_IntensityImageFileName, m_RGBArray, m_RGBImage, and m_RGBImageFileName.

Member Function Documentation

◆ Clone()

Pointer mitk::ToFCameraMITKPlayerController::Clone ( ) const

◆ CloseCameraConnection()

bool mitk::ToFCameraMITKPlayerController::CloseCameraConnection ( )
virtual

closes the connection to the camera

Returns
Returns 'true' if connection could be closed (i.e. only if a connection was established before) and 'false' otherwise

Definition at line 247 of file mitkToFCameraMITKPlayerController.cpp.

References m_ConnectionCheck.

◆ GetAmplitudeImageFileName()

virtual std::string mitk::ToFCameraMITKPlayerController::GetAmplitudeImageFileName ( )
virtual

◆ GetAmplitudes()

void mitk::ToFCameraMITKPlayerController::GetAmplitudes ( float *  amplitudeArray)
virtual

gets the current amplitude frame from the input These values can be used to determine the quality of the distance values. The higher the amplitude value, the higher the accuracy of the according distance value

Definition at line 308 of file mitkToFCameraMITKPlayerController.cpp.

References m_AmplitudeArray, and m_NumberOfBytes.

◆ GetCaptureHeight()

virtual int mitk::ToFCameraMITKPlayerController::GetCaptureHeight ( )
virtual

◆ GetCaptureWidth()

virtual int mitk::ToFCameraMITKPlayerController::GetCaptureWidth ( )
virtual

◆ GetDistanceImageFileName()

virtual std::string mitk::ToFCameraMITKPlayerController::GetDistanceImageFileName ( )
virtual

◆ GetDistances()

void mitk::ToFCameraMITKPlayerController::GetDistances ( float *  distanceArray)
virtual

gets the current distance frame from the inpug measuring the distance between the camera and the different object points in millimeters

Definition at line 318 of file mitkToFCameraMITKPlayerController.cpp.

References m_DistanceArray, and m_NumberOfBytes.

◆ GetIntensities()

void mitk::ToFCameraMITKPlayerController::GetIntensities ( float *  intensityArray)
virtual

gets the current intensity frame from the input as a greyscale image

Definition at line 313 of file mitkToFCameraMITKPlayerController.cpp.

References m_IntensityArray, and m_NumberOfBytes.

◆ GetIntensityImageFileName()

virtual std::string mitk::ToFCameraMITKPlayerController::GetIntensityImageFileName ( )
virtual

◆ GetPixelNumber()

virtual int mitk::ToFCameraMITKPlayerController::GetPixelNumber ( )
virtual

◆ GetRgb()

void mitk::ToFCameraMITKPlayerController::GetRgb ( unsigned char *  rgbArray)
virtual

gets the current RGB frame from the input if available

Definition at line 323 of file mitkToFCameraMITKPlayerController.cpp.

References m_NumberOfRGBBytes, and m_RGBArray.

◆ GetRGBCaptureHeight()

virtual int mitk::ToFCameraMITKPlayerController::GetRGBCaptureHeight ( )
virtual

◆ GetRGBCaptureWidth()

virtual int mitk::ToFCameraMITKPlayerController::GetRGBCaptureWidth ( )
virtual

◆ GetRGBImageFileName()

virtual std::string mitk::ToFCameraMITKPlayerController::GetRGBImageFileName ( )
virtual

◆ GetRGBPixelNumber()

virtual int mitk::ToFCameraMITKPlayerController::GetRGBPixelNumber ( )
virtual

◆ mitkClassMacroItkParent()

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

◆ New()

static Pointer mitk::ToFCameraMITKPlayerController::New ( )
static

Referenced by mitk::ToFCameraMITKPlayerDevice::ToFCameraMITKPlayerDevice().

◆ OpenCameraConnection()

bool mitk::ToFCameraMITKPlayerController::OpenCameraConnection ( )
virtual

opens a connection to the ToF camera

Returns
Returns 'true' if connection could be established and 'false' otherwise

Definition at line 101 of file mitkToFCameraMITKPlayerController.cpp.

References m_AmplitudeArray, m_AmplitudeImage, m_AmplitudeImageFileName, m_CaptureHeight, m_CaptureWidth, m_ConnectionCheck, m_DistanceArray, m_DistanceImage, m_DistanceImageFileName, m_ImageStatus, m_InputFileName, m_IntensityArray, m_IntensityImage, m_IntensityImageFileName, m_NumberOfBytes, m_NumberOfRGBBytes, m_NumOfFrames, m_PixelNumber, m_RGBArray, m_RGBCaptureHeight, m_RGBCaptureWidth, m_RGBImage, m_RGBImageFileName, m_RGBPixelNumber, m_ToFImageType, MITK_ERROR, MITK_INFO, MITK_WARN, ToFImageType2DPlusT, and ToFImageType3D.

◆ SetAmplitudeImageFileName()

virtual void mitk::ToFCameraMITKPlayerController::SetAmplitudeImageFileName ( std::string  _arg)
virtual

◆ SetDistanceImageFileName()

virtual void mitk::ToFCameraMITKPlayerController::SetDistanceImageFileName ( std::string  _arg)
virtual

◆ SetInputFileName()

void mitk::ToFCameraMITKPlayerController::SetInputFileName ( std::string  inputFileName)
virtual

Definition at line 328 of file mitkToFCameraMITKPlayerController.cpp.

References m_InputFileName.

◆ SetIntensityImageFileName()

virtual void mitk::ToFCameraMITKPlayerController::SetIntensityImageFileName ( std::string  _arg)
virtual

◆ SetRGBImageFileName()

virtual void mitk::ToFCameraMITKPlayerController::SetRGBImageFileName ( std::string  _arg)
virtual

◆ UpdateCamera()

void mitk::ToFCameraMITKPlayerController::UpdateCamera ( )
virtual

updates the current image frames from input

Definition at line 258 of file mitkToFCameraMITKPlayerController.cpp.

References image, m_AmplitudeArray, m_AmplitudeImage, m_CurrentFrame, m_DistanceArray, m_DistanceImage, m_ImageStatus, m_IntensityArray, m_IntensityImage, m_NumberOfBytes, m_NumberOfRGBBytes, m_NumOfFrames, m_RGBArray, m_RGBImage, and m_ToFImageType.

Member Data Documentation

◆ m_AmplitudeArray

float* mitk::ToFCameraMITKPlayerController::m_AmplitudeArray
protected

member holding the current amplitude frame

Definition at line 124 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetAmplitudes(), OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_AmplitudeImage

Image::Pointer mitk::ToFCameraMITKPlayerController::m_AmplitudeImage
protected

Definition at line 112 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_AmplitudeImageFileName

std::string mitk::ToFCameraMITKPlayerController::m_AmplitudeImageFileName
protected

file name of the amplitude image to be played

Definition at line 128 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and ~ToFCameraMITKPlayerController().

◆ m_AmplitudeInfile

FILE* mitk::ToFCameraMITKPlayerController::m_AmplitudeInfile
protected

file holding the amplitude data

Definition at line 118 of file mitkToFCameraMITKPlayerController.h.

◆ m_CaptureHeight

int mitk::ToFCameraMITKPlayerController::m_CaptureHeight
protected

holds the height of the image

Definition at line 103 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_CaptureWidth

int mitk::ToFCameraMITKPlayerController::m_CaptureWidth
protected

holds the width of the image

Definition at line 102 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_ConnectionCheck

bool mitk::ToFCameraMITKPlayerController::m_ConnectionCheck
protected

flag showing whether the camera is connected (true) or not (false)

Definition at line 106 of file mitkToFCameraMITKPlayerController.h.

Referenced by CloseCameraConnection(), and OpenCameraConnection().

◆ m_CurrentFrame

int mitk::ToFCameraMITKPlayerController::m_CurrentFrame
protected

Definition at line 133 of file mitkToFCameraMITKPlayerController.h.

Referenced by UpdateCamera().

◆ m_DistanceArray

float* mitk::ToFCameraMITKPlayerController::m_DistanceArray
protected

member holding the current distance frame

Definition at line 123 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetDistances(), OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_DistanceImage

Image::Pointer mitk::ToFCameraMITKPlayerController::m_DistanceImage
protected

Definition at line 111 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_DistanceImageFileName

std::string mitk::ToFCameraMITKPlayerController::m_DistanceImageFileName
protected

file name of the distance image to be played

Definition at line 127 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and ~ToFCameraMITKPlayerController().

◆ m_DistanceInfile

FILE* mitk::ToFCameraMITKPlayerController::m_DistanceInfile
protected

file holding the distance data

Definition at line 117 of file mitkToFCameraMITKPlayerController.h.

◆ m_ImageStatus

std::vector<bool> mitk::ToFCameraMITKPlayerController::m_ImageStatus
protected

Definition at line 115 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), ToFCameraMITKPlayerController(), and UpdateCamera().

◆ m_InputFileName

std::string mitk::ToFCameraMITKPlayerController::m_InputFileName
protected

Definition at line 108 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and SetInputFileName().

◆ m_IntensityArray

float* mitk::ToFCameraMITKPlayerController::m_IntensityArray
protected

member holding the current intensity frame

Definition at line 122 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetIntensities(), OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_IntensityImage

Image::Pointer mitk::ToFCameraMITKPlayerController::m_IntensityImage
protected

Definition at line 113 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_IntensityImageFileName

std::string mitk::ToFCameraMITKPlayerController::m_IntensityImageFileName
protected

file name of the intensity image to be played

Definition at line 129 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and ~ToFCameraMITKPlayerController().

◆ m_IntensityInfile

FILE* mitk::ToFCameraMITKPlayerController::m_IntensityInfile
protected

file holding the intensity data

Definition at line 119 of file mitkToFCameraMITKPlayerController.h.

◆ m_NumberOfBytes

int mitk::ToFCameraMITKPlayerController::m_NumberOfBytes
protected

holds the number of bytes contained in the image

Definition at line 100 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetAmplitudes(), GetDistances(), GetIntensities(), OpenCameraConnection(), and UpdateCamera().

◆ m_NumberOfRGBBytes

int mitk::ToFCameraMITKPlayerController::m_NumberOfRGBBytes
protected

same for RGB image

Definition at line 101 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetRgb(), OpenCameraConnection(), and UpdateCamera().

◆ m_NumOfFrames

int mitk::ToFCameraMITKPlayerController::m_NumOfFrames
protected

Definition at line 134 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

◆ m_PixelNumber

int mitk::ToFCameraMITKPlayerController::m_PixelNumber
protected

holds the number of pixels contained in the image

Definition at line 98 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_PixelStartInFile

long mitk::ToFCameraMITKPlayerController::m_PixelStartInFile
protected

Definition at line 132 of file mitkToFCameraMITKPlayerController.h.

◆ m_RGBArray

unsigned char* mitk::ToFCameraMITKPlayerController::m_RGBArray
protected

member holding the current rgb frame

Definition at line 125 of file mitkToFCameraMITKPlayerController.h.

Referenced by GetRgb(), OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_RGBCaptureHeight

int mitk::ToFCameraMITKPlayerController::m_RGBCaptureHeight
protected

same for RGB image which can be different then depth etc.

Definition at line 105 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_RGBCaptureWidth

int mitk::ToFCameraMITKPlayerController::m_RGBCaptureWidth
protected

same for RGB image which can be different then depth etc.

Definition at line 104 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_RGBImage

Image::Pointer mitk::ToFCameraMITKPlayerController::m_RGBImage
protected

Definition at line 114 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), UpdateCamera(), and ~ToFCameraMITKPlayerController().

◆ m_RGBImageFileName

std::string mitk::ToFCameraMITKPlayerController::m_RGBImageFileName
protected

file name of the rgb image to be played

Definition at line 130 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and ~ToFCameraMITKPlayerController().

◆ m_RGBInfile

FILE* mitk::ToFCameraMITKPlayerController::m_RGBInfile
protected

file holding the rgb data

Definition at line 120 of file mitkToFCameraMITKPlayerController.h.

◆ m_RGBPixelNumber

int mitk::ToFCameraMITKPlayerController::m_RGBPixelNumber
protected

same for RGB image

Definition at line 99 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

◆ m_ToFImageType

ToFImageType mitk::ToFCameraMITKPlayerController::m_ToFImageType
protected

type of the ToF image to be played: 3D Volume (ToFImageType3D), temporal 2D image stack (ToFImageType2DPlusT)

Definition at line 109 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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