mitkVirtualTrackingDevice.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MITKVIRTUALTRACKINGDEVICE_H_HEADER_INCLUDED_
#define MITKVIRTUALTRACKINGDEVICE_H_HEADER_INCLUDED_

#include <MitkIGTExports.h>
#include <mitkTrackingDevice.h>
#include <mitkVirtualTrackingTool.h>
#include <itkMultiThreader.h>

#include "itkFastMutexLock.h"
#include <vector>

namespace mitk
{
  class MITKIGT_EXPORT VirtualTrackingDevice : public TrackingDevice
  {
  public:

    mitkClassMacro(VirtualTrackingDevice, TrackingDevice);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);

    itkSetMacro(RefreshRate, unsigned int);

    itkGetConstMacro(RefreshRate, unsigned int);

    bool StartTracking() override;

    bool StopTracking() override;

    bool OpenConnection() override;

    bool CloseConnection() override;

    unsigned int GetToolCount() const override;

    TrackingTool* GetTool(unsigned int toolNumber) const override;

    TrackingTool* AddTool(const char* toolName);


    itkSetVectorMacro(Bounds, mitk::ScalarType, 6);

    const mitk::ScalarType* GetBounds() const
    {
      return m_Bounds;
    };

    mitk::ScalarType GetSplineChordLength(unsigned int idx);

    void SetToolSpeed(unsigned int idx, mitk::ScalarType roundsPerSecond);

  void EnableGaussianNoise();

  void DisableGaussianNoise();

  void SetParamsForGaussianNoise(double meanDistribution, double deviationDistribution);

  double GetMeanDistribution();

  double GetDeviationDistribution();

  protected:
    VirtualTrackingDevice();
    ~VirtualTrackingDevice() override;
    void TrackTools();

    void InitializeSpline(mitk::VirtualTrackingTool* t);  

    static ITK_THREAD_RETURN_TYPE ThreadStartTracking(void* data); 

    typedef mitk::VirtualTrackingTool::SplineType::ControlPointType ControlPointType;

    ControlPointType GetRandomPoint(); 
    mitk::VirtualTrackingTool* GetInternalTool(unsigned int idx);

    typedef std::vector<VirtualTrackingTool::Pointer> ToolContainer; 
    ToolContainer m_AllTools;                       
    itk::FastMutexLock::Pointer m_ToolsMutex; 

    itk::MultiThreader::Pointer m_MultiThreader;    
    int m_ThreadID;

    unsigned int m_RefreshRate;                     
    unsigned int m_NumberOfControlPoints;           

    mitk::ScalarType m_Bounds[6];                   
  bool m_GaussianNoiseEnabled;    
  double m_MeanDistributionParam;    
  double m_DeviationDistributionParam;  
  };
}//mitk
#endif /* MITKVIRTUALTRACKINGDEVICE_H_HEADER_INCLUDED_ */