Widget allowing to play / record ToF data. More...

#include <QmitkToFRecorderWidget.h>

Inheritance diagram for QmitkToFRecorderWidget:

Collaboration diagram for QmitkToFRecorderWidget:

Public Slots
void	OnPlay ()
	slot invoking to start the camera. Calls StartCamera() and emits ToFCameraStarted signal More...

void	OnStop ()
	slot invoking to stop the camera and the recorder. Calls StopCamera() and StopRecorder and emits ToFCameraStarted signal. Resets GUI to initial state. More...

void	OnStartRecorder ()
	slot invoking to start the recording After letting the user chose a file location for the record, m_ImageRecorder->StartRecording() is inoved. More...

void	OnRecordingStopped ()
	slot resetting the GUI elements of the recording box More...

void	OnChangeRecordModeComboBox (int index)
	slot activating/deactivating "number of frames" spin box dependent on recording mode (PerFrame / Infinite) More...

Signals
void	ToFCameraStarted ()
	signal emitted when "Play" button is pressed More...

void	ToFCameraStopped ()
	signal emitted when "Stop" button is pressed More...

void	RecordingStarted ()
	signal emitted when recording is started More...

void	RecordingStopped ()
	signal emitted AbortEvent() in ToFImageRecorder is observed More...

Public Member Functions
	QmitkToFRecorderWidget (QWidget *p=nullptr, Qt::WindowFlags f1=nullptr)

	~QmitkToFRecorderWidget () override

virtual void	CreateQtPartControl (QWidget *parent)

virtual void	CreateConnections ()

void	SetParameter (mitk::ToFImageGrabber ToFImageGrabber, mitk::ToFImageRecorder toFImageRecorder)
	Set the parameters used for this widget. More...

void	ResetGUIToInitial ()
	resets the GUI elements to the initial state. Play button: enabled, Stop button: disabled, Recording box: disabled More...

Static Public Attributes
static const std::string	VIEW_ID

Protected Types
typedef itk::SimpleMemberCommand< QmitkToFRecorderWidget >	CommandType

Protected Member Functions
void	StartCamera ()
	starts the camera by calling ToFImageGrabber::StartCamera() More...

void	StopCamera ()
	stops the camera by calling ToFImageGrabber::StopCamera() More...

void	StopRecorder ()
	stops the recording by calling ToFImageRecorder::StopRecording() More...

void	StopRecordingCallback ()
	emits RecordingStopped signal. More...

std::string	prepareFilename (std::string dir, std::string baseFilename, std::string modulationFreq, std::string integrationTime, std::string numOfFrames, std::string extension, std::string imageType)
	method creating a filename from the given information More...

Static Protected Member Functions
static QString	getSaveFileName (mitk::ToFImageWriter::ToFImageType &tofImageType, bool &distanceImageSelected, bool &amplitudeImageSelected, bool &intensityImageSelected, bool &rgbImageSelected, bool &rawDataSelected, QWidget parent=nullptr, const QString &caption=QString(), const QString &dir=QString(), const QString &filter=QString(), QString selectedFilter=nullptr, QFileDialog::Options options=nullptr)
	adapted version of QFileDialog::getSaveFileName() The user is now asked to choose which images he wants to save (Distance and/or Intensity and/or Amplitude image) and which type the saved image should have (3D, 2D+t). More...

Protected Attributes
Ui::QmitkToFRecorderWidgetControls *	m_Controls
	member holding the UI elements of this widget More...

mitk::ToFImageGrabber::Pointer	m_ToFImageGrabber
	member holding the ToFImageGrabber for acquiring ToF images More...

mitk::ToFImageRecorder::Pointer	m_ToFImageRecorder
	member holding the recorder for ToF images More...

mitk::ToFImageRecorder::RecordMode	m_RecordMode
	member holding the RecordMode of the recorder (PerFrame / Infinite) More...

CommandType::Pointer	m_StopRecordingCommand
	itkCommand for abort of recording More...

Detailed Description

Widget allowing to play / record ToF data.

Definition at line 43 of file QmitkToFRecorderWidget.h.

Member Typedef Documentation

◆ CommandType

typedef itk::SimpleMemberCommand<QmitkToFRecorderWidget> QmitkToFRecorderWidget::CommandType

protected

Definition at line 178 of file QmitkToFRecorderWidget.h.

Constructor & Destructor Documentation

◆ QmitkToFRecorderWidget()

QmitkToFRecorderWidget::QmitkToFRecorderWidget	(	QWidget *	p = `nullptr`,
		Qt::WindowFlags	f1 = `nullptr`
	)

Definition at line 39 of file QmitkToFRecorderWidget.cpp.

References CreateQtPartControl(), m_Controls, m_RecordMode, m_ToFImageGrabber, m_ToFImageRecorder, and mitk::ToFImageRecorder::PerFrames.

◆ ~QmitkToFRecorderWidget()

QmitkToFRecorderWidget::~QmitkToFRecorderWidget ( )

override

Definition at line 49 of file QmitkToFRecorderWidget.cpp.

Member Function Documentation

◆ CreateConnections()

void QmitkToFRecorderWidget::CreateConnections ( )

virtual

Definition at line 64 of file QmitkToFRecorderWidget.cpp.

References m_Controls, OnChangeRecordModeComboBox(), OnPlay(), OnRecordingStopped(), OnStartRecorder(), OnStop(), and RecordingStopped().

Referenced by CreateQtPartControl().

◆ CreateQtPartControl()

void QmitkToFRecorderWidget::CreateQtPartControl ( QWidget * parent )

virtual

Definition at line 53 of file QmitkToFRecorderWidget.cpp.

References CreateConnections(), and m_Controls.

Referenced by QmitkToFRecorderWidget().

◆ getSaveFileName()

QString QmitkToFRecorderWidget::getSaveFileName	(	mitk::ToFImageWriter::ToFImageType &	tofImageType,
		bool &	distanceImageSelected,
		bool &	amplitudeImageSelected,
		bool &	intensityImageSelected,
		bool &	rgbImageSelected,
		bool &	rawDataSelected,
		QWidget *	parent = `nullptr`,
		const QString &	caption = `QString()`,
		const QString &	dir = `QString()`,
		const QString &	filter = `QString()`,
		QString *	selectedFilter = `nullptr`,
		QFileDialog::Options	options = `nullptr`
	)

staticprotected

adapted version of QFileDialog::getSaveFileName() The user is now asked to choose which images he wants to save (Distance and/or Intensity and/or Amplitude image) and which type the saved image should have (3D, 2D+t).

Definition at line 279 of file QmitkToFRecorderWidget.cpp.

References mitk::ToFImageWriter::ToFImageType2DPlusT, and mitk::ToFImageWriter::ToFImageType3D.

Referenced by OnStartRecorder().

◆ OnChangeRecordModeComboBox

void QmitkToFRecorderWidget::OnChangeRecordModeComboBox ( int index )

slot

slot activating/deactivating "number of frames" spin box dependent on recording mode (PerFrame / Infinite)

Definition at line 411 of file QmitkToFRecorderWidget.cpp.

References mitk::ToFImageRecorder::Infinite, m_Controls, m_RecordMode, and mitk::ToFImageRecorder::PerFrames.

Referenced by CreateConnections().

◆ OnPlay

void QmitkToFRecorderWidget::OnPlay ( )

slot

slot invoking to start the camera. Calls StartCamera() and emits ToFCameraStarted signal

Definition at line 122 of file QmitkToFRecorderWidget.cpp.

References m_Controls, StartCamera(), and ToFCameraStarted().

Referenced by CreateConnections().

◆ OnRecordingStopped

void QmitkToFRecorderWidget::OnRecordingStopped ( )

slot

slot resetting the GUI elements of the recording box

Definition at line 106 of file QmitkToFRecorderWidget.cpp.

References m_Controls.

Referenced by CreateConnections(), and OnStartRecorder().

◆ OnStartRecorder

void QmitkToFRecorderWidget::OnStartRecorder ( )

slot

slot invoking to start the recording After letting the user chose a file location for the record, m_ImageRecorder->StartRecording() is inoved.

Definition at line 156 of file QmitkToFRecorderWidget.cpp.

References getSaveFileName(), m_Controls, m_RecordMode, m_ToFImageGrabber, m_ToFImageRecorder, MITK_INFO, OnRecordingStopped(), mitk::ToFImageRecorder::PerFrames, prepareFilename(), and RecordingStarted().

Referenced by CreateConnections().

◆ OnStop

void QmitkToFRecorderWidget::OnStop ( )

slot

slot invoking to stop the camera and the recorder. Calls StopCamera() and StopRecorder and emits ToFCameraStarted signal. Resets GUI to initial state.

Definition at line 112 of file QmitkToFRecorderWidget.cpp.

References ResetGUIToInitial(), StopCamera(), StopRecorder(), and ToFCameraStopped().

Referenced by CreateConnections().

◆ prepareFilename()

std::string QmitkToFRecorderWidget::prepareFilename	(	std::string	dir,
		std::string	baseFilename,
		std::string	modulationFreq,
		std::string	integrationTime,
		std::string	numOfFrames,
		std::string	extension,
		std::string	imageType
	)

protected

method creating a filename from the given information

Parameters

dir	directory to save the file
baseFilename	base file name entered by the user
modulationFreq	modulation frequency of the camera
integrationTime	integration time of the camera
numOfFrames	number of frames recorded
extension	file extension
imageType	type of image (DistanceImage, IntensityImage, AmplitudeImage)

Returns: dir+"/"+baseFilename+"_MF"+modulationFreq+"_IT"+integrationTime+"_"+numOfFrames+"Images"+imageType+extension

Definition at line 387 of file QmitkToFRecorderWidget.cpp.

Referenced by OnStartRecorder().

◆ RecordingStarted

void QmitkToFRecorderWidget::RecordingStarted ( )

signal

signal emitted when recording is started

Referenced by OnStartRecorder().

◆ RecordingStopped

void QmitkToFRecorderWidget::RecordingStopped ( )

signal

signal emitted AbortEvent() in ToFImageRecorder is observed

Referenced by CreateConnections(), and StopRecordingCallback().

◆ ResetGUIToInitial()

void QmitkToFRecorderWidget::ResetGUIToInitial ( )

resets the GUI elements to the initial state. Play button: enabled, Stop button: disabled, Recording box: disabled

Definition at line 99 of file QmitkToFRecorderWidget.cpp.

References m_Controls.

Referenced by OnStop().

◆ SetParameter()

void QmitkToFRecorderWidget::SetParameter	(	mitk::ToFImageGrabber *	ToFImageGrabber,
		mitk::ToFImageRecorder *	toFImageRecorder
	)

Set the parameters used for this widget.

Parameters

ToFImageGrabber	image grabber providing images from a ToF device
tofImageRecorder	image recorder allowing to record ToF images

Definition at line 77 of file QmitkToFRecorderWidget.cpp.

References m_Controls, m_StopRecordingCommand, m_ToFImageGrabber, m_ToFImageRecorder, and StopRecordingCallback().

◆ StartCamera()

void QmitkToFRecorderWidget::StartCamera ( )

protected

starts the camera by calling ToFImageGrabber::StartCamera()

Definition at line 134 of file QmitkToFRecorderWidget.cpp.

References m_ToFImageGrabber.

Referenced by OnPlay().

◆ StopCamera()

void QmitkToFRecorderWidget::StopCamera ( )

protected

stops the camera by calling ToFImageGrabber::StopCamera()

Definition at line 142 of file QmitkToFRecorderWidget.cpp.

References m_ToFImageGrabber.

Referenced by OnStop().

◆ StopRecorder()

void QmitkToFRecorderWidget::StopRecorder ( )

protected

stops the recording by calling ToFImageRecorder::StopRecording()

Definition at line 148 of file QmitkToFRecorderWidget.cpp.

References m_ToFImageRecorder.

Referenced by OnStop().

◆ StopRecordingCallback()

void QmitkToFRecorderWidget::StopRecordingCallback ( )

protected

emits RecordingStopped signal.

Definition at line 94 of file QmitkToFRecorderWidget.cpp.

References RecordingStopped().

Referenced by SetParameter().

◆ ToFCameraStarted

void QmitkToFRecorderWidget::ToFCameraStarted ( )

signal

signal emitted when "Play" button is pressed

Referenced by OnPlay().

◆ ToFCameraStopped

void QmitkToFRecorderWidget::ToFCameraStopped ( )

signal

signal emitted when "Stop" button is pressed

Referenced by OnStop().

Member Data Documentation

◆ m_Controls

Ui::QmitkToFRecorderWidgetControls* QmitkToFRecorderWidget::m_Controls

protected

member holding the UI elements of this widget

Definition at line 171 of file QmitkToFRecorderWidget.h.

Referenced by CreateConnections(), CreateQtPartControl(), OnChangeRecordModeComboBox(), OnPlay(), OnRecordingStopped(), OnStartRecorder(), QmitkToFRecorderWidget(), ResetGUIToInitial(), and SetParameter().

◆ m_RecordMode

mitk::ToFImageRecorder::RecordMode QmitkToFRecorderWidget::m_RecordMode

protected

member holding the RecordMode of the recorder (PerFrame / Infinite)

Definition at line 176 of file QmitkToFRecorderWidget.h.

Referenced by OnChangeRecordModeComboBox(), OnStartRecorder(), and QmitkToFRecorderWidget().

◆ m_StopRecordingCommand

CommandType::Pointer QmitkToFRecorderWidget::m_StopRecordingCommand

protected

itkCommand for abort of recording

Definition at line 179 of file QmitkToFRecorderWidget.h.

Referenced by SetParameter().

◆ m_ToFImageGrabber

mitk::ToFImageGrabber::Pointer QmitkToFRecorderWidget::m_ToFImageGrabber

protected

member holding the ToFImageGrabber for acquiring ToF images

Definition at line 173 of file QmitkToFRecorderWidget.h.

Referenced by OnStartRecorder(), QmitkToFRecorderWidget(), SetParameter(), StartCamera(), and StopCamera().

◆ m_ToFImageRecorder

mitk::ToFImageRecorder::Pointer QmitkToFRecorderWidget::m_ToFImageRecorder

protected

member holding the recorder for ToF images

Definition at line 174 of file QmitkToFRecorderWidget.h.

Referenced by OnStartRecorder(), QmitkToFRecorderWidget(), SetParameter(), and StopRecorder().

◆ VIEW_ID

const std::string QmitkToFRecorderWidget::VIEW_ID

static

Definition at line 51 of file QmitkToFRecorderWidget.h.

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

Public Slots

Signals

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CommandType

Constructor & Destructor Documentation

◆ QmitkToFRecorderWidget()

◆ ~QmitkToFRecorderWidget()

Member Function Documentation

◆ CreateConnections()

◆ CreateQtPartControl()

◆ getSaveFileName()

◆ OnChangeRecordModeComboBox

◆ OnPlay

◆ OnRecordingStopped

◆ OnStartRecorder

◆ OnStop

◆ prepareFilename()

◆ RecordingStarted

◆ RecordingStopped

◆ ResetGUIToInitial()

◆ SetParameter()

◆ StartCamera()

◆ StopCamera()

◆ StopRecorder()

◆ StopRecordingCallback()

◆ ToFCameraStarted

◆ ToFCameraStopped

Member Data Documentation

◆ m_Controls

◆ m_RecordMode

◆ m_StopRecordingCommand

◆ m_ToFImageGrabber

◆ m_ToFImageRecorder

◆ VIEW_ID