Medical Imaging Interaction Toolkit  2018.4.99-12ad79a3
Medical Imaging Interaction Toolkit
mitk::USVideoDevice Class Reference

A mitk::USVideoDevice is the common class for video only devices. They capture video input either from a file or from a device and transform the output into an mitk::USImage with attached metadata. This simple implementation does only capture and display 2d images without registration for example. More...

#include <mitkUSVideoDevice.h>

Inheritance diagram for mitk::USVideoDevice:
Collaboration diagram for mitk::USVideoDevice:

Public Member Functions

 mitkClassMacro (USVideoDevice, mitk::USDevice)
 
 mitkNewMacro3Param (Self, int, std::string, std::string)
 
 mitkNewMacro3Param (Self, std::string, std::string, std::string)
 
 mitkNewMacro2Param (Self, int, mitk::USImageMetadata::Pointer)
 
 mitkNewMacro2Param (Self, std::string, mitk::USImageMetadata::Pointer)
 
std::string GetDeviceClass () override
 
itk::SmartPointer< USAbstractControlInterfaceGetControlInterfaceCustom () override
 
void UnregisterOnService ()
 Remove this device from the micro service. This method is public for mitk::USVideoDevice, because this devices can be completly removed. This is not possible for API devices, which should be available while their sub module is loaded. More...
 
USImageSource::Pointer GetUSImageSource () override
 
std::vector< mitk::USProbe::Pointer > GetAllProbes () override
 Return all probes for this USVideoDevice or an empty vector it no probes were set Returns a std::vector of all probes that exist for this USVideoDevice if there were probes set while creating or modifying this USVideoDevice. Otherwise it returns an empty vector. Therefore always check if vector is filled, before using it! More...
 
void DeleteAllProbes () override
 Cleans the std::vector containing all configured probes. More...
 
mitk::USProbe::Pointer GetCurrentProbe () override
 Return current active probe for this USVideoDevice Returns a pointer to the probe that is currently in use. If there were probes set while creating or modifying this USVideoDevice. Returns null otherwise. More...
 
void AddNewProbe (mitk::USProbe::Pointer probe) override
 adds a new probe to the device More...
 
mitk::USProbe::Pointer GetProbeByName (std::string name) override
 get the probe by its name Returns a pointer to the probe identified by the given name. If no probe of given name exists for this Device 0 is returned. More...
 
void RemoveProbeByName (std::string name) override
 Removes the Probe with the given name. More...
 
bool GetIsSourceFile ()
 True, if this Device plays back a file, false if it recieves data from a device. More...
 
void SetDefaultProbeAsCurrentProbe () override
 Sets the first existing probe or the default probe of the video device as the current probe of it. More...
 
void SetCurrentProbe (std::string probename) override
 Sets the probe with the given name as current probe if the named probe exists. More...
 
void SetSpacing (double xSpacing, double ySpacing) override
 Sets the given spacing of the current depth of the current probe. More...
 
virtual std::vector< mitk::Image::PointerGetImageVector ()
 
virtual int GetDeviceID ()
 
virtual std::string GetFilePath ()
 
- Public Member Functions inherited from mitk::USDevice
 mitkClassMacro (USDevice, mitk::ImageSource)
 
virtual void SetSpawnAcquireThread (bool _arg)
 
virtual bool GetSpawnAcquireThread ()
 
virtual itk::SmartPointer< USControlInterfaceBModeGetControlInterfaceBMode ()
 Default getter for the b mode control interface. Has to be implemented in a subclass if a b mode control interface is available. Default implementation returns null. More...
 
virtual itk::SmartPointer< USControlInterfaceProbesGetControlInterfaceProbes ()
 Default getter for the probes control interface. Has to be implemented in a subclass if a probes control interface is available. Default implementation returns null. More...
 
virtual itk::SmartPointer< USControlInterfaceDopplerGetControlInterfaceDoppler ()
 Default getter for the doppler control interface. Has to be implemented in a subclass if a doppler control interface is available. Default implementation returns null. More...
 
bool Initialize ()
 Changes device state to mitk::USDevice::State_Initialized. During initialization the virtual method mitk::USDevice::OnInitialization will be called. If this method returns false the initialization process will be canceled. Otherwise the mitk::USDevice is registered in a micro service. More...
 
bool Connect ()
 Connects this device. A connected device is ready to deliver images (i.e. be Activated). A Connected Device can be active. A disconnected Device cannot be active. Internally calls onConnect and then registers the device with the service. A device usually should override the OnConnection() method, but never the Connect() method, since this will possibly exclude the device from normal service management. The exact flow of events is: 0. Check if the device is already connected. If yes, return true anyway, but don't do anything. More...
 
void ConnectAsynchron ()
 
bool Disconnect ()
 Works analogously to mitk::USDevice::Connect(). Don't override this Method, but onDisconnection instead. More...
 
bool Activate ()
 Activates this device. After the activation process, the device will start to produce images. This Method will fail, if the device is not connected. More...
 
void Deactivate ()
 Deactivates this device. After the deactivation process, the device will no longer produce images, but still be connected. More...
 
virtual void SetIsFreezed (bool freeze)
 Can toggle if ultrasound image is currently updated or freezed. More...
 
virtual bool GetIsFreezed ()
 
void PushFilter (AbstractOpenCVImageFilter::Pointer filter)
 
void PushFilterIfNotPushedBefore (AbstractOpenCVImageFilter::Pointer filter)
 
bool RemoveFilter (AbstractOpenCVImageFilter::Pointer filter)
 
void ProbeChanged (std::string probename)
 To be called when the used probe changed. Will update the service properties. More...
 
void DepthChanged (double depth)
 To be called when the scanning depth of the probe changed. Will update the service properties. More...
 
void UpdateServiceProperty (std::string key, std::string value)
 Given property is updated in the device micro service. This method is mainly for being used by the control interface superclasses. You do not need to call it by yoursefs in your concrete control interface classes. More...
 
void UpdateServiceProperty (std::string key, double value)
 
void UpdateServiceProperty (std::string key, bool value)
 
bool GetIsInitialized ()
 True, if the device object is created and initialized, false otherwise. More...
 
bool GetIsActive ()
 True, if the device is currently generating image data, false otherwise. More...
 
bool GetIsConnected ()
 True, if the device is currently ready to start transmitting image data or is already transmitting image data. A disconnected device cannot be activated. More...
 
mitk::USDevice::USImageCropArea GetCropArea ()
 
unsigned int GetSizeOfImageVector ()
 
std::string GetDeviceManufacturer ()
 Deprecated -> use GetManufacturer() instead. More...
 
std::string GetDeviceModel ()
 Deprecated -> use GetName() instead. More...
 
std::string GetDeviceComment ()
 Deprecated -> use GetCommend() instead. More...
 
virtual std::string GetManufacturer ()
 
virtual std::string GetName ()
 
virtual std::string GetComment ()
 
void SetManufacturer (std::string manufacturer)
 
void SetName (std::string name)
 
void SetComment (std::string comment)
 
virtual DeviceStates GetDeviceState ()
 
virtual us::ServiceProperties GetServiceProperties ()
 
void GrabImage ()
 
- Public Member Functions inherited from mitk::ImageSource
virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
OutputTypeGetOutput ()
 Get the output data of this image source object. More...
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
itk::DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 Make a DataObject of the correct type to used as the specified output. More...
 
itk::DataObject::Pointer MakeOutput (const DataObjectIdentifierType &name) override
 
virtual vtkImageData * GetVtkImageData ()
 
virtual const vtkImageData * GetVtkImageData () const
 
- Public Member Functions inherited from mitk::BaseDataSource
OutputTypeGetOutput ()
 
const OutputTypeGetOutput () const
 
OutputTypeGetOutput (DataObjectPointerArraySizeType idx)
 
const OutputTypeGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void GraftOutput (OutputType *output)
 Graft the specified BaseData onto this BaseDataSource's output. More...
 
virtual void GraftOutput (const DataObjectIdentifierType &key, OutputType *output)
 
virtual void GraftNthOutput (unsigned int idx, OutputType *output)
 Graft the specified base data object onto this BaseDataSource's idx'th output. More...
 
bool Updating () const
 Access itk::ProcessObject::m_Updating. More...
 

Static Public Member Functions

static std::string GetDeviceClassStatic ()
 
- Static Public Member Functions inherited from mitk::ImageSource
static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 Method for creation through the object factory. More...
 
- Static Public Member Functions inherited from mitk::BaseDataSource
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

 USVideoDevice (int videoDeviceNumber, std::string manufacturer, std::string model)
 Creates a new device that will deliver USImages taken from a video device. under windows, try -1 for device number, which will grab the first available one (Open CV functionality) More...
 
 USVideoDevice (std::string videoFilePath, std::string manufacturer, std::string model)
 Creates a new device that will deliver USImages taken from a video file. More...
 
 USVideoDevice (int videoDeviceNumber, mitk::USImageMetadata::Pointer metadata)
 Creates a new device that will deliver USImages taken from a video device. under windows, try -1 for device number, which will grab the first available one (Open CV functionality) More...
 
 USVideoDevice (std::string videoFilePath, mitk::USImageMetadata::Pointer metadata)
 Creates a new device that will deliver USImages taken from a video file. More...
 
 ~USVideoDevice () override
 
void Init ()
 Initializes common properties for all constructors. More...
 
bool OnInitialization () override
 Is called during the initialization process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong. More...
 
bool OnConnection () override
 Is called during the connection process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong. More...
 
bool OnDisconnection () override
 Is called during the disconnection process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong. More...
 
bool OnActivation () override
 Is called during the activation process. After this method is finsihed, the device should be generating images. More...
 
bool OnDeactivation () override
 Is called during the deactivation process. After a call to this method the device should still be connected, but not producing images anymore. More...
 
void GenerateData () override
 Grabs the next frame from the Video input. This method is called internally, whenever Update() is invoked by an Output. More...
 
- Protected Member Functions inherited from mitk::USDevice
virtual void SetImageVector (std::vector< mitk::Image::Pointer > vec)
 
void ProvideViaOIGTL ()
 Registers an OpenIGTLink device as a microservice so that we can send the images of this device via the network. More...
 
void DisableOIGTL ()
 Deregisters the microservices for OpenIGTLink. More...
 
us::ServiceProperties ConstructServiceProperties ()
 This Method constructs the service properties which can later be used to register the object with the Microservices Return service properties. More...
 
void UnregisterOnService ()
 Remove this device from the micro service. More...
 
virtual void OnFreeze (bool)
 Called when mitk::USDevice::SetIsFreezed() is called. Subclasses can overwrite this method to do additional actions. Default implementation does noting. More...
 
 USDevice (std::string manufacturer, std::string model)
 Enforces minimal Metadata to be set. More...
 
 USDevice (mitk::USImageMetadata::Pointer metadata)
 Constructs a device with the given Metadata. Make sure the Metadata contains meaningful content! More...
 
 ~USDevice () override
 
void GenerateData () override
 Grabs the next frame from the Video input. This method is called internally, whenever Update() is invoked by an Output. More...
 
std::string GetServicePropertyLabel ()
 
- Protected Member Functions inherited from mitk::ImageSource
 ImageSource ()
 
 ~ImageSource () override
 
void GenerateData () override
 A version of GenerateData() specific for image processing filters. More...
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, itk::ThreadIdType threadId)
 If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). More...
 
void PrepareOutputs () override
 This method is intentionally left blank. More...
 
virtual void AllocateOutputs ()
 The GenerateData method normally allocates the buffers for all of the outputs of a filter. More...
 
virtual void BeforeThreadedGenerateData ()
 If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). More...
 
virtual void AfterThreadedGenerateData ()
 If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). More...
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
 Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". More...
 
- Protected Member Functions inherited from mitk::BaseDataSource
 BaseDataSource ()
 
 ~BaseDataSource () override
 

Protected Attributes

mitk::USImageVideoSource::Pointer m_Source
 The image source that we use to aquire data. More...
 
bool m_SourceIsFile
 True, if this source plays back a file, false if it recieves data from a device. More...
 
int m_DeviceID
 The device id to connect to. Undefined, if m_SourceIsFile == true;. More...
 
std::string m_FilePath
 The Filepath id to connect to. Undefined, if m_SourceIsFile == false;. More...
 
itk::SmartPointer< USVideoDeviceCustomControlsm_ControlInterfaceCustom
 custom control interface for us video device More...
 
std::vector< mitk::USProbe::Pointer > m_Probes
 probes for this USVideoDevice More...
 
mitk::USProbe::Pointer m_CurrentProbe
 probe that is currently in use More...
 
- Protected Attributes inherited from mitk::USDevice
itk::ConditionVariable::Pointer m_FreezeBarrier
 
itk::SimpleMutexLock m_FreezeMutex
 
itk::MultiThreader::Pointer m_MultiThreader
 itk::MultiThreader used for thread handling More...
 
itk::FastMutexLock::Pointer m_ImageMutex
 mutex for images provided by the image source More...
 
int m_ThreadID
 ID of the started thread. More...
 
std::vector< mitk::Image::Pointerm_ImageVector
 
mitk::Vector3D m_Spacing
 
mitk::IGTLServer::Pointer m_IGTLServer
 
mitk::IGTLMessageProvider::Pointer m_IGTLMessageProvider
 
mitk::ImageToIGTLMessageFilter::Pointer m_ImageToIGTLMsgFilter
 
bool m_IsFreezed
 
DeviceStates m_DeviceState
 
USImageCropArea m_CropArea
 
unsigned int m_NumberOfOutputs
 
us::ServiceProperties m_ServiceProperties
 Properties of the device's Microservice. More...
 
us::ServiceRegistration< Selfm_ServiceRegistration
 The device's ServiceRegistration object that allows to modify it's Microservice registraton details. More...
 

Additional Inherited Members

- Public Types inherited from mitk::USDevice
enum  DeviceStates { State_NoState, State_Initialized, State_Connected, State_Activated }
 
- Public Types inherited from mitk::ImageSource
typedef ImageSource Self
 
typedef BaseDataSource Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef mitk::Image OutputImageType
 Some convenient typedefs. More...
 
typedef OutputImageType OutputType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef SlicedData::RegionType OutputImageRegionType
 
- Public Types inherited from mitk::BaseDataSource
typedef BaseDataSource Self
 
typedef itk::ProcessObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef BaseData OutputType
 
typedef itk::DataObject::DataObjectIdentifierType DataObjectIdentifierType
 
- Public Attributes inherited from mitk::USDevice
virtual mitkNewMessage2Macro(PropertyChanged, const std::string &, const std::string &) static mitk itk::SmartPointer< USAbstractControlInterfaceGetControlInterfaceCustom ()
 Event for being notified about changes of the micro service properties. This event can be used if no micro service context is available. More...
 
- Static Protected Member Functions inherited from mitk::USDevice
static ITK_THREAD_RETURN_TYPE Acquire (void *pInfoStruct)
 
static ITK_THREAD_RETURN_TYPE ConnectThread (void *pInfoStruct)
 
- Static Protected Member Functions inherited from mitk::ImageSource
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 Static function used as a "callback" by the MultiThreader. More...
 
- Static Protected Member Functions inherited from mitk::BaseDataSource
static Pointer New ()
 

Detailed Description

A mitk::USVideoDevice is the common class for video only devices. They capture video input either from a file or from a device and transform the output into an mitk::USImage with attached metadata. This simple implementation does only capture and display 2d images without registration for example.

Definition at line 40 of file mitkUSVideoDevice.h.

Constructor & Destructor Documentation

◆ USVideoDevice() [1/4]

mitk::USVideoDevice::USVideoDevice ( int  videoDeviceNumber,
std::string  manufacturer,
std::string  model 
)
protected

Creates a new device that will deliver USImages taken from a video device. under windows, try -1 for device number, which will grab the first available one (Open CV functionality)

Definition at line 16 of file mitkUSVideoDevice.cpp.

References Init(), m_DeviceID, m_FilePath, and m_SourceIsFile.

◆ USVideoDevice() [2/4]

mitk::USVideoDevice::USVideoDevice ( std::string  videoFilePath,
std::string  manufacturer,
std::string  model 
)
protected

Creates a new device that will deliver USImages taken from a video file.

Definition at line 24 of file mitkUSVideoDevice.cpp.

References Init(), m_FilePath, and m_SourceIsFile.

◆ USVideoDevice() [3/4]

mitk::USVideoDevice::USVideoDevice ( int  videoDeviceNumber,
mitk::USImageMetadata::Pointer  metadata 
)
protected

Creates a new device that will deliver USImages taken from a video device. under windows, try -1 for device number, which will grab the first available one (Open CV functionality)

Definition at line 31 of file mitkUSVideoDevice.cpp.

References Init(), m_DeviceID, m_FilePath, and m_SourceIsFile.

◆ USVideoDevice() [4/4]

mitk::USVideoDevice::USVideoDevice ( std::string  videoFilePath,
mitk::USImageMetadata::Pointer  metadata 
)
protected

Creates a new device that will deliver USImages taken from a video file.

Definition at line 39 of file mitkUSVideoDevice.cpp.

References Init(), m_FilePath, and m_SourceIsFile.

◆ ~USVideoDevice()

mitk::USVideoDevice::~USVideoDevice ( )
overrideprotected

Definition at line 46 of file mitkUSVideoDevice.cpp.

References m_Source.

Member Function Documentation

◆ AddNewProbe()

void mitk::USVideoDevice::AddNewProbe ( mitk::USProbe::Pointer  probe)
overridevirtual

adds a new probe to the device

Reimplemented from mitk::USDevice.

Definition at line 208 of file mitkUSVideoDevice.cpp.

References m_Probes.

◆ DeleteAllProbes()

void mitk::USVideoDevice::DeleteAllProbes ( )
overridevirtual

Cleans the std::vector containing all configured probes.

Reimplemented from mitk::USDevice.

Definition at line 167 of file mitkUSVideoDevice.cpp.

References m_Probes.

◆ GenerateData()

void mitk::USVideoDevice::GenerateData ( )
overrideprotected

Grabs the next frame from the Video input. This method is called internally, whenever Update() is invoked by an Output.

Definition at line 125 of file mitkUSVideoDevice.cpp.

References mitk::ImageSource::GetOutput(), image, m_CurrentProbe, mitk::USDevice::m_ImageMutex, mitk::USDevice::m_ImageVector, and mitk::BaseData::SetGeometry().

◆ GetAllProbes()

std::vector< mitk::USProbe::Pointer > mitk::USVideoDevice::GetAllProbes ( )
overridevirtual

Return all probes for this USVideoDevice or an empty vector it no probes were set Returns a std::vector of all probes that exist for this USVideoDevice if there were probes set while creating or modifying this USVideoDevice. Otherwise it returns an empty vector. Therefore always check if vector is filled, before using it!

Implements mitk::USDevice.

Definition at line 158 of file mitkUSVideoDevice.cpp.

References m_Probes, and MITK_INFO.

◆ GetControlInterfaceCustom()

mitk::USAbstractControlInterface::Pointer mitk::USVideoDevice::GetControlInterfaceCustom ( )
override

Getter for the custom control interface which was created during the construction process of mitk::USVideoDevice.

Returns
custom control interface of the video device

Definition at line 74 of file mitkUSVideoDevice.cpp.

References m_ControlInterfaceCustom.

◆ GetCurrentProbe()

mitk::USProbe::Pointer mitk::USVideoDevice::GetCurrentProbe ( )
overridevirtual

Return current active probe for this USVideoDevice Returns a pointer to the probe that is currently in use. If there were probes set while creating or modifying this USVideoDevice. Returns null otherwise.

Implements mitk::USDevice.

Definition at line 172 of file mitkUSVideoDevice.cpp.

References m_CurrentProbe.

◆ GetDeviceClass()

std::string mitk::USVideoDevice::GetDeviceClass ( )
overridevirtual
Returns
the qualified name of this class (as returned by GetDeviceClassStatic())

Implements mitk::USDevice.

Definition at line 64 of file mitkUSVideoDevice.cpp.

References GetDeviceClassStatic().

◆ GetDeviceClassStatic()

std::string mitk::USVideoDevice::GetDeviceClassStatic ( )
static

This methode is necessary instead of a static member attribute to avoid "static initialization order fiasco" when an instance of this class is used in a module activator.

Returns
the qualified name of this class

Definition at line 69 of file mitkUSVideoDevice.cpp.

Referenced by GetDeviceClass(), and QmitkUSControlsCustomVideoDeviceWidget::GetDeviceClass().

◆ GetDeviceID()

virtual int mitk::USVideoDevice::GetDeviceID ( )
virtual

◆ GetFilePath()

virtual std::string mitk::USVideoDevice::GetFilePath ( )
virtual

◆ GetImageVector()

virtual std::vector<mitk::Image::Pointer> mitk::USVideoDevice::GetImageVector ( )
virtual

◆ GetIsSourceFile()

bool mitk::USVideoDevice::GetIsSourceFile ( )

True, if this Device plays back a file, false if it recieves data from a device.

Definition at line 213 of file mitkUSVideoDevice.cpp.

References m_SourceIsFile.

◆ GetProbeByName()

mitk::USProbe::Pointer mitk::USVideoDevice::GetProbeByName ( std::string  name)
overridevirtual

get the probe by its name Returns a pointer to the probe identified by the given name. If no probe of given name exists for this Device 0 is returned.

Implements mitk::USDevice.

Definition at line 184 of file mitkUSVideoDevice.cpp.

References m_Probes, and MITK_INFO.

Referenced by SetCurrentProbe().

◆ GetUSImageSource()

mitk::USImageSource::Pointer mitk::USVideoDevice::GetUSImageSource ( )
overridevirtual
Returns
mitk::USImageSource connected to this device

Implements mitk::USDevice.

Definition at line 153 of file mitkUSVideoDevice.cpp.

References m_Source.

◆ Init()

void mitk::USVideoDevice::Init ( )
protected

Initializes common properties for all constructors.

Definition at line 52 of file mitkUSVideoDevice.cpp.

References m_ControlInterfaceCustom, m_Source, mitk::ImageSource::MakeOutput(), and mitk::USImageVideoSource::New().

Referenced by USVideoDevice().

◆ mitkClassMacro()

mitk::USVideoDevice::mitkClassMacro ( USVideoDevice  ,
mitk::USDevice   
)

◆ mitkNewMacro2Param() [1/2]

mitk::USVideoDevice::mitkNewMacro2Param ( Self  ,
int  ,
mitk::USImageMetadata::Pointer   
)

◆ mitkNewMacro2Param() [2/2]

mitk::USVideoDevice::mitkNewMacro2Param ( Self  ,
std::string  ,
mitk::USImageMetadata::Pointer   
)

◆ mitkNewMacro3Param() [1/2]

mitk::USVideoDevice::mitkNewMacro3Param ( Self  ,
int  ,
std::string  ,
std::string   
)

◆ mitkNewMacro3Param() [2/2]

mitk::USVideoDevice::mitkNewMacro3Param ( Self  ,
std::string  ,
std::string  ,
std::string   
)

◆ OnActivation()

bool mitk::USVideoDevice::OnActivation ( )
overrideprotectedvirtual

Is called during the activation process. After this method is finsihed, the device should be generating images.

Implements mitk::USDevice.

Definition at line 106 of file mitkUSVideoDevice.cpp.

References m_Source, MITK_INFO, and MITK_WARN.

◆ OnConnection()

bool mitk::USVideoDevice::OnConnection ( )
overrideprotectedvirtual

Is called during the connection process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong.

Implements mitk::USDevice.

Definition at line 85 of file mitkUSVideoDevice.cpp.

References m_DeviceID, m_FilePath, m_Source, and m_SourceIsFile.

◆ OnDeactivation()

bool mitk::USVideoDevice::OnDeactivation ( )
overrideprotectedvirtual

Is called during the deactivation process. After a call to this method the device should still be connected, but not producing images anymore.

Implements mitk::USDevice.

Definition at line 119 of file mitkUSVideoDevice.cpp.

◆ OnDisconnection()

bool mitk::USVideoDevice::OnDisconnection ( )
overrideprotectedvirtual

Is called during the disconnection process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong.

Implements mitk::USDevice.

Definition at line 97 of file mitkUSVideoDevice.cpp.

References mitk::USDevice::Deactivate(), mitk::USDevice::m_DeviceState, m_Source, and mitk::USDevice::State_Activated.

◆ OnInitialization()

bool mitk::USVideoDevice::OnInitialization ( )
overrideprotectedvirtual

Is called during the initialization process. Returns true if successful and false if unsuccessful. Additionally, you may throw an exception to clarify what went wrong.

Implements mitk::USDevice.

Definition at line 79 of file mitkUSVideoDevice.cpp.

◆ RemoveProbeByName()

void mitk::USVideoDevice::RemoveProbeByName ( std::string  name)
overridevirtual

Removes the Probe with the given name.

Reimplemented from mitk::USDevice.

Definition at line 195 of file mitkUSVideoDevice.cpp.

References m_Probes, and MITK_INFO.

◆ SetCurrentProbe()

void mitk::USVideoDevice::SetCurrentProbe ( std::string  probename)
overridevirtual

Sets the probe with the given name as current probe if the named probe exists.

Reimplemented from mitk::USDevice.

Definition at line 232 of file mitkUSVideoDevice.cpp.

References GetProbeByName(), m_CurrentProbe, and MITK_INFO.

◆ SetDefaultProbeAsCurrentProbe()

void mitk::USVideoDevice::SetDefaultProbeAsCurrentProbe ( )
overridevirtual

Sets the first existing probe or the default probe of the video device as the current probe of it.

Reimplemented from mitk::USDevice.

Definition at line 218 of file mitkUSVideoDevice.cpp.

References m_CurrentProbe, m_Probes, MITK_INFO, mitk::USProbe::New(), and mitk::USDevice::ProbeChanged().

◆ SetSpacing()

void mitk::USVideoDevice::SetSpacing ( double  xSpacing,
double  ySpacing 
)
overridevirtual

Sets the given spacing of the current depth of the current probe.

Reimplemented from mitk::USDevice.

Definition at line 238 of file mitkUSVideoDevice.cpp.

References m_CurrentProbe, MITK_INFO, and MITK_WARN.

◆ UnregisterOnService()

void mitk::USVideoDevice::UnregisterOnService ( )

Remove this device from the micro service. This method is public for mitk::USVideoDevice, because this devices can be completly removed. This is not possible for API devices, which should be available while their sub module is loaded.

Definition at line 145 of file mitkUSVideoDevice.cpp.

References mitk::USDevice::Deactivate(), mitk::USDevice::Disconnect(), mitk::USDevice::m_DeviceState, mitk::USDevice::State_Activated, mitk::USDevice::State_Connected, and mitk::USDevice::UnregisterOnService().

Member Data Documentation

◆ m_ControlInterfaceCustom

itk::SmartPointer<USVideoDeviceCustomControls> mitk::USVideoDevice::m_ControlInterfaceCustom
protected

custom control interface for us video device

Definition at line 234 of file mitkUSVideoDevice.h.

Referenced by GetControlInterfaceCustom(), and Init().

◆ m_CurrentProbe

mitk::USProbe::Pointer mitk::USVideoDevice::m_CurrentProbe
protected

probe that is currently in use

Definition at line 244 of file mitkUSVideoDevice.h.

Referenced by GenerateData(), GetCurrentProbe(), SetCurrentProbe(), SetDefaultProbeAsCurrentProbe(), and SetSpacing().

◆ m_DeviceID

int mitk::USVideoDevice::m_DeviceID
protected

The device id to connect to. Undefined, if m_SourceIsFile == true;.

Definition at line 224 of file mitkUSVideoDevice.h.

Referenced by OnConnection(), and USVideoDevice().

◆ m_FilePath

std::string mitk::USVideoDevice::m_FilePath
protected

The Filepath id to connect to. Undefined, if m_SourceIsFile == false;.

Definition at line 229 of file mitkUSVideoDevice.h.

Referenced by OnConnection(), and USVideoDevice().

◆ m_Probes

std::vector< mitk::USProbe::Pointer > mitk::USVideoDevice::m_Probes
protected

◆ m_Source

mitk::USImageVideoSource::Pointer mitk::USVideoDevice::m_Source
protected

The image source that we use to aquire data.

Definition at line 214 of file mitkUSVideoDevice.h.

Referenced by GetUSImageSource(), Init(), OnActivation(), OnConnection(), OnDisconnection(), and ~USVideoDevice().

◆ m_SourceIsFile

bool mitk::USVideoDevice::m_SourceIsFile
protected

True, if this source plays back a file, false if it recieves data from a device.

Definition at line 219 of file mitkUSVideoDevice.h.

Referenced by GetIsSourceFile(), OnConnection(), and USVideoDevice().


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