Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
mitk::ToFCameraPMDCamBoardDevice Class Reference
Device class representing a PMD CamBoard camera. More...
#include <mitkToFCameraPMDCamBoardDevice.h>
Inheritance diagram for mitk::ToFCameraPMDCamBoardDevice:
Collaboration diagram for mitk::ToFCameraPMDCamBoardDevice:
Public Member Functions | |
| mitkClassMacro (ToFCameraPMDCamBoardDevice, ToFCameraPMDDevice) | |
| Pointer | Clone () const |
| virtual void | SetProperty (const char *propertyKey, BaseProperty *propertyValue) |
| set a BaseProperty More... | |
| void | SetRegionOfInterest (unsigned int leftUpperCornerX, unsigned int leftUpperCornerY, unsigned int width, unsigned int height) |
| Setting the region of interest, the camera is configured to only output a certain area of the image. More... | |
 Public Member Functions inherited from mitk::ToFCameraPMDDevice | |
| mitkClassMacro (ToFCameraPMDDevice, ToFCameraDevice) | |
| Pointer | Clone () const |
| virtual bool | OnConnectCamera () |
| opens a connection to the ToF camera More... | |
| virtual bool | DisconnectCamera () |
| closes the connection to the camera More... | |
| virtual void | StartCamera () |
| starts the continuous updating of the camera. A separate thread updates the source data, the main thread processes the source data and creates images and coordinates More... | |
| virtual void | UpdateCamera () |
| updated the controller hold by this device More... | |
| virtual void | GetAmplitudes (float *amplitudeArray, int &imageSequence) |
| gets the amplitude data from the ToF camera as the strength of the active illumination of every pixel. Caution! The user is responsible for allocating and deleting the images. 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, int &imageSequence) |
| gets the intensity data from the ToF camera as a greyscale image. Caution! The user is responsible for allocating and deleting the images. More... | |
| virtual void | GetDistances (float *distanceArray, int &imageSequence) |
| gets the distance data from the ToF camera measuring the distance between the camera and the different object points in millimeters. Caution! The user is responsible for allocating and deleting the images. More... | |
| virtual void | GetAllImages (float *distanceArray, float *amplitudeArray, float *intensityArray, char *sourceDataArray, int requiredImageSequence, int &capturedImageSequence, unsigned char *rgbDataArray=nullptr) |
| gets the 3 images (distance, amplitude, intensity) from the ToF camera. Caution! The user is responsible for allocating and deleting the images. More... | |
| ToFCameraPMDController::Pointer | GetController () |
| returns the corresponding camera controller More... | |
| Public Member Functions inherited from mitk::ToFCameraDevice | |
| mitkClassMacroItkParent (ToFCameraDevice, itk::Object) | |
| virtual bool | ConnectCamera () |
| ConnectCamera Internally calls OnConnectCamera() of the respective device implementation. More... | |
| virtual void | StopCamera () |
| stops the continuous updating of the camera More... | |
| virtual bool | IsCameraActive () |
| returns true if the camera is connected and started More... | |
| virtual bool | IsCameraConnected () |
| returns true if the camera is connected More... | |
| virtual int | GetCaptureWidth () |
| get the currently set capture width More... | |
| virtual int | GetCaptureHeight () |
| get the currently set capture height More... | |
| virtual int | GetSourceDataSize () |
| get the currently set source data size More... | |
| virtual int | GetBufferSize () |
| get the currently set buffer size More... | |
| virtual int | GetMaxBufferSize () |
| get the currently set max buffer size More... | |
| void | SetBoolProperty (const char *propertyKey, bool boolValue) |
| set a bool property in the property list More... | |
| void | SetIntProperty (const char *propertyKey, int intValue) |
| set an int property in the property list More... | |
| void | SetFloatProperty (const char *propertyKey, float floatValue) |
| set a float property in the property list More... | |
| void | SetStringProperty (const char *propertyKey, const char *stringValue) |
| set a string property in the property list More... | |
| virtual BaseProperty * | GetProperty (const char *propertyKey) |
| get a BaseProperty from the property list More... | |
| bool | GetBoolProperty (const char *propertyKey, bool &boolValue) |
| get a bool from the property list More... | |
| bool | GetStringProperty (const char *propertyKey, std::string &string) |
| get a string from the property list More... | |
| bool | GetIntProperty (const char *propertyKey, int &integer) |
| get an int from the property list More... | |
| virtual int | GetRGBCaptureWidth () |
| virtual int | GetRGBCaptureHeight () |
Static Public Member Functions | |
| static Pointer | New () |
| Static Public Member Functions inherited from mitk::ToFCameraPMDDevice | |
| static Pointer | New () |
Protected Member Functions | |
| ToFCameraPMDCamBoardDevice () | |
| ~ToFCameraPMDCamBoardDevice () | |
| Protected Member Functions inherited from mitk::ToFCameraPMDDevice | |
| ToFCameraPMDDevice () | |
| ~ToFCameraPMDDevice () | |
| virtual void | AllocateSourceData () |
| method for allocating m_SourceDataArray and m_SourceDataBuffer More... | |
| virtual void | CleanUpSourceData () |
| method for cleaning up memory allocated for m_SourceDataArray and m_SourceDataBuffer More... | |
| void | GetNextPos () |
| moves the position pointer m_CurrentPos to the next position in the buffer if that's not the next free position to prevent reading from an empty buffer More... | |
| Protected Member Functions inherited from mitk::ToFCameraDevice | |
| ToFCameraDevice () | |
| ~ToFCameraDevice () override | |
| virtual void | AllocatePixelArrays () |
| method for allocating memory for pixel arrays m_IntensityArray, m_DistanceArray and m_AmplitudeArray More... | |
| virtual void | CleanupPixelArrays () |
| method for cleanup memory allocated for pixel arrays m_IntensityArray, m_DistanceArray and m_AmplitudeArray More... | |
Additional Inherited Members | |
| Static Protected Member Functions inherited from mitk::ToFCameraPMDDevice | |
| static ITK_THREAD_RETURN_TYPE | Acquire (void *pInfoStruct) |
| Thread method continuously acquiring images from the ToF hardware. More... | |
| Protected Attributes inherited from mitk::ToFCameraPMDDevice | |
| ToFCameraPMDController::Pointer | m_Controller |
| corresponding CameraController More... | |
| char ** | m_SourceDataBuffer |
| buffer holding the last acquired images More... | |
| char * | m_SourceDataArray |
| array holding the current PMD source data More... | |
| Protected Attributes inherited from mitk::ToFCameraDevice | |
| float * | m_IntensityArray |
| float array holding the intensity image More... | |
| float * | m_DistanceArray |
| float array holding the distance image More... | |
| float * | m_AmplitudeArray |
| float array holding the amplitude image More... | |
| int | m_BufferSize |
| buffer size of the image buffer needed for loss-less acquisition of range data More... | |
| int | m_MaxBufferSize |
| maximal buffer size needed for initialization of data arrays. Default value is 100. More... | |
| int | m_CurrentPos |
| current position in the buffer which will be retrieved by the Get methods More... | |
| int | m_FreePos |
| current position in the buffer which will be filled with data acquired from the hardware More... | |
| int | m_CaptureWidth |
| width of the range image (x dimension) More... | |
| int | m_CaptureHeight |
| height of the range image (y dimension) More... | |
| int | m_PixelNumber |
| number of pixels in the range image (m_CaptureWidth*m_CaptureHeight) More... | |
| int | m_RGBImageWidth |
| width of the RGB image (x dimension) More... | |
| int | m_RGBImageHeight |
| height of the RGB image (y dimension) More... | |
| int | m_RGBPixelNumber |
| number of pixels in the range image (m_RGBImageWidth*m_RGBImageHeight) More... | |
| int | m_SourceDataSize |
| size of the PMD source data More... | |
| std::mutex | m_ImageMutex |
| mutex for images provided by the range camera More... | |
| std::mutex | m_CameraActiveMutex |
| mutex for the cameraActive flag More... | |
| std::thread | m_Thread |
| bool | m_CameraActive |
| flag indicating if the camera is currently active or not. Caution: thread safe access only! More... | |
| bool | m_CameraConnected |
| flag indicating if the camera is successfully connected or not. Caution: thread safe access only! More... | |
| int | m_ImageSequence |
| counter for acquired images More... | |
| PropertyList::Pointer | m_PropertyList |
| a list of the corresponding properties More... | |
Detailed Description
Device class representing a PMD CamBoard camera.
Definition at line 34 of file mitkToFCameraPMDCamBoardDevice.h.
Constructor & Destructor Documentation
◆ ToFCameraPMDCamBoardDevice()
|
protected |
◆ ~ToFCameraPMDCamBoardDevice()
|
protected |
Member Function Documentation
◆ Clone()
| Pointer mitk::ToFCameraPMDCamBoardDevice::Clone | ( | ) | const |
◆ mitkClassMacro()
| mitk::ToFCameraPMDCamBoardDevice::mitkClassMacro | ( | ToFCameraPMDCamBoardDevice | , |
| ToFCameraPMDDevice | |||
| ) |
◆ New()
|
static |
◆ SetProperty()
|
virtual |
set a BaseProperty
Reimplemented from mitk::ToFCameraPMDDevice.
◆ SetRegionOfInterest()
| void mitk::ToFCameraPMDCamBoardDevice::SetRegionOfInterest | ( | unsigned int | leftUpperCornerX, |
| unsigned int | leftUpperCornerY, | ||
| unsigned int | width, | ||
| unsigned int | height | ||
| ) |
Setting the region of interest, the camera is configured to only output a certain area of the image.
- Parameters
-
leftUpperCornerX x value of left upper corner of region leftUpperCornerY y value of left upper corner of region width width of region height height of region
The documentation for this class was generated from the following file:
