Medical Imaging Interaction Toolkit  2016.11.0
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 ()
 

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 35 of file mitkToFCameraMITKPlayerController.h.

Member Enumeration Documentation

enum mitk::ToFCameraMITKPlayerController::ToFImageType
Enumerator
ToFImageType3D 
ToFImageType2DPlusT 

Definition at line 93 of file mitkToFCameraMITKPlayerController.h.

Constructor & Destructor Documentation

mitk::ToFCameraMITKPlayerController::ToFCameraMITKPlayerController ( )
protected

Definition at line 27 of file mitkToFCameraMITKPlayerController.cpp.

References m_ImageStatus.

mitk::ToFCameraMITKPlayerController::~ToFCameraMITKPlayerController ( )
protected

Definition at line 62 of file mitkToFCameraMITKPlayerController.cpp.

Member Function Documentation

Pointer mitk::ToFCameraMITKPlayerController::Clone ( ) const
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 251 of file mitkToFCameraMITKPlayerController.cpp.

References m_ConnectionCheck.

virtual std::string mitk::ToFCameraMITKPlayerController::GetAmplitudeImageFileName ( )
virtual
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 312 of file mitkToFCameraMITKPlayerController.cpp.

References m_AmplitudeArray, and m_NumberOfBytes.

virtual int mitk::ToFCameraMITKPlayerController::GetCaptureHeight ( )
virtual
virtual int mitk::ToFCameraMITKPlayerController::GetCaptureWidth ( )
virtual
virtual std::string mitk::ToFCameraMITKPlayerController::GetDistanceImageFileName ( )
virtual
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 322 of file mitkToFCameraMITKPlayerController.cpp.

References m_DistanceArray, and m_NumberOfBytes.

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

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

Definition at line 317 of file mitkToFCameraMITKPlayerController.cpp.

References m_IntensityArray, and m_NumberOfBytes.

virtual std::string mitk::ToFCameraMITKPlayerController::GetIntensityImageFileName ( )
virtual
virtual int mitk::ToFCameraMITKPlayerController::GetPixelNumber ( )
virtual
void mitk::ToFCameraMITKPlayerController::GetRgb ( unsigned char *  rgbArray)
virtual

gets the current RGB frame from the input if available

Definition at line 327 of file mitkToFCameraMITKPlayerController.cpp.

References m_NumberOfRGBBytes, and m_RGBArray.

virtual int mitk::ToFCameraMITKPlayerController::GetRGBCaptureHeight ( )
virtual
virtual int mitk::ToFCameraMITKPlayerController::GetRGBCaptureWidth ( )
virtual
virtual std::string mitk::ToFCameraMITKPlayerController::GetRGBImageFileName ( )
virtual
virtual int mitk::ToFCameraMITKPlayerController::GetRGBPixelNumber ( )
virtual
mitk::ToFCameraMITKPlayerController::mitkClassMacroItkParent ( ToFCameraMITKPlayerController  ,
itk::Object   
)
static Pointer mitk::ToFCameraMITKPlayerController::New ( )
static

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

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 105 of file mitkToFCameraMITKPlayerController.cpp.

References mitk::IOUtil::LoadImage(), 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.

virtual void mitk::ToFCameraMITKPlayerController::SetAmplitudeImageFileName ( std::string  _arg)
virtual
virtual void mitk::ToFCameraMITKPlayerController::SetDistanceImageFileName ( std::string  _arg)
virtual
void mitk::ToFCameraMITKPlayerController::SetInputFileName ( std::string  inputFileName)
virtual

Definition at line 332 of file mitkToFCameraMITKPlayerController.cpp.

References m_InputFileName.

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

updates the current image frames from input

Definition at line 262 of file mitkToFCameraMITKPlayerController.cpp.

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

Member Data Documentation

float* mitk::ToFCameraMITKPlayerController::m_AmplitudeArray
protected

member holding the current amplitude frame

Definition at line 127 of file mitkToFCameraMITKPlayerController.h.

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

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

Definition at line 115 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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

file name of the amplitude image to be played

Definition at line 131 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

FILE* mitk::ToFCameraMITKPlayerController::m_AmplitudeInfile
protected

file holding the amplitude data

Definition at line 121 of file mitkToFCameraMITKPlayerController.h.

int mitk::ToFCameraMITKPlayerController::m_CaptureHeight
protected

holds the height of the image

Definition at line 106 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

int mitk::ToFCameraMITKPlayerController::m_CaptureWidth
protected

holds the width of the image

Definition at line 105 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

bool mitk::ToFCameraMITKPlayerController::m_ConnectionCheck
protected

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

Definition at line 109 of file mitkToFCameraMITKPlayerController.h.

Referenced by CloseCameraConnection(), and OpenCameraConnection().

int mitk::ToFCameraMITKPlayerController::m_CurrentFrame
protected

Definition at line 136 of file mitkToFCameraMITKPlayerController.h.

Referenced by UpdateCamera().

float* mitk::ToFCameraMITKPlayerController::m_DistanceArray
protected

member holding the current distance frame

Definition at line 126 of file mitkToFCameraMITKPlayerController.h.

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

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

Definition at line 114 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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

file name of the distance image to be played

Definition at line 130 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

FILE* mitk::ToFCameraMITKPlayerController::m_DistanceInfile
protected

file holding the distance data

Definition at line 120 of file mitkToFCameraMITKPlayerController.h.

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

Definition at line 118 of file mitkToFCameraMITKPlayerController.h.

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

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

Definition at line 111 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and SetInputFileName().

float* mitk::ToFCameraMITKPlayerController::m_IntensityArray
protected

member holding the current intensity frame

Definition at line 125 of file mitkToFCameraMITKPlayerController.h.

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

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

Definition at line 116 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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

file name of the intensity image to be played

Definition at line 132 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

FILE* mitk::ToFCameraMITKPlayerController::m_IntensityInfile
protected

file holding the intensity data

Definition at line 122 of file mitkToFCameraMITKPlayerController.h.

int mitk::ToFCameraMITKPlayerController::m_NumberOfBytes
protected

holds the number of bytes contained in the image

Definition at line 103 of file mitkToFCameraMITKPlayerController.h.

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

int mitk::ToFCameraMITKPlayerController::m_NumberOfRGBBytes
protected

same for RGB image

Definition at line 104 of file mitkToFCameraMITKPlayerController.h.

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

int mitk::ToFCameraMITKPlayerController::m_NumOfFrames
protected

Definition at line 137 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

int mitk::ToFCameraMITKPlayerController::m_PixelNumber
protected

holds the number of pixels contained in the image

Definition at line 101 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

long mitk::ToFCameraMITKPlayerController::m_PixelStartInFile
protected

Definition at line 135 of file mitkToFCameraMITKPlayerController.h.

unsigned char* mitk::ToFCameraMITKPlayerController::m_RGBArray
protected

member holding the current rgb frame

Definition at line 128 of file mitkToFCameraMITKPlayerController.h.

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

int mitk::ToFCameraMITKPlayerController::m_RGBCaptureHeight
protected

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

Definition at line 108 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

int mitk::ToFCameraMITKPlayerController::m_RGBCaptureWidth
protected

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

Definition at line 107 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

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

Definition at line 117 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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

file name of the rgb image to be played

Definition at line 133 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

FILE* mitk::ToFCameraMITKPlayerController::m_RGBInfile
protected

file holding the rgb data

Definition at line 123 of file mitkToFCameraMITKPlayerController.h.

int mitk::ToFCameraMITKPlayerController::m_RGBPixelNumber
protected

same for RGB image

Definition at line 102 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection().

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 112 of file mitkToFCameraMITKPlayerController.h.

Referenced by OpenCameraConnection(), and UpdateCamera().

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