vtkPlusClariusOEM.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
    Program: Plus
    Copyright (c) Verdure Imaging Inc, Stockton, California. All rights reserved.
    See License.txt for details.

    We would like to acknowledge Verdure Imaging Inc for generously open-sourcing
    this support for the Clarius OEM interface to the PLUS & Slicer communities.
=========================================================Plus=header=end*/

#ifndef _VTKPLUSCLARIUSOEM_H
#define _VTKPLUSCLARIUSOEM_H

// Local includes
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusUsDevice.h"

// STL includes
#include <vector>

class vtkPlusDataCollectionExport vtkPlusClariusOEM : public vtkPlusUsDevice
{
public:
  vtkTypeMacro(vtkPlusClariusOEM, vtkPlusUsDevice);
  static vtkPlusClariusOEM* New();
  void PrintSelf(ostream& os, vtkIndent indent) override;

  PlusStatus Probe() override;

  std::string GetSdkVersion() override;
  bool IsTracker() const override { return true; };
  bool IsVirtual() const override { return false; };

  static const std::string OVERLAY_PORT_NAME;

public:

  PlusStatus ReadConfiguration(vtkXMLDataElement* config) override;

  PlusStatus WriteConfiguration(vtkXMLDataElement* config) override;

  PlusStatus NotifyConfigured() override;

  static vtkPlusClariusOEM* GetInstance();

  PlusStatus InternalUpdate() override;

  PlusStatus UpdateProbeStatus();

protected:
  vtkPlusClariusOEM();
  ~vtkPlusClariusOEM();

protected:

  PlusStatus InitializeBLE();

  PlusStatus InitializeProbe();

  PlusStatus InitializeWifi();

  PlusStatus InitializeOEM();

  PlusStatus SetClariusCert();

  PlusStatus ConfigureProbeApplication();

  PlusStatus SetInitialUsParams();

  PlusStatus InternalConnect() override;

  void DeInitializeOEM();

  void DeInitializeWifi();

  void DeInitializeProbe();

  void DeInitializeBLE();

  PlusStatus InternalDisconnect() override;

  PlusStatus InternalStartRecording() override;

  PlusStatus InternalStopRecording() override;

  PlusStatus InternalApplyImagingParameterChange() override;

public:

  // US parameters API

  PlusStatus GetDepthMm(double& aDepthMm);
  PlusStatus SetDepthMm(double aDepthMm);

  PlusStatus GetGainPercent(double& aGainPercent);
  PlusStatus SetGainPercent(double aGainPercent);

  PlusStatus GetDynRangePercent(double& aDynamicRangePercent);
  PlusStatus SetDynRangePercent(double aDynamicRangePercent);

  PlusStatus GetTimeGainCompensationDb(std::vector<double>& aTGC);
  PlusStatus SetTimeGainCompensationDb(const std::vector<double>& aTGC);

  PlusStatus SetEnableAutoFocus(bool aEnableAutoFocus);
  PlusStatus GetEnableAutoFocus(bool& aEnableAutoFocus);

  PlusStatus SetEnableAutoGain(bool aEnableAutoGain);
  PlusStatus GetEnableAutoGain(bool& aEnableAutoGain);

  PlusStatus SetEnablePenetrationMode(bool aEnablePenetrationMode);
  PlusStatus GetEnablePenetrationMode(bool& aEnablePenetrationMode);

  PlusStatus GetFocusDepthPercent(double& aFocusDepthPercent);
  PlusStatus SetFocusDepthPercent(double aFocusDepthPercent);

  double ConvertDepthCmToPercent(double aFocusDepthMm);
  double ConvertDepthPercentToCm(double aFocusDepthPercent);

  PlusStatus UpdateFrameSize();

private:

  static vtkPlusClariusOEM* instance;

  class vtkInternal;
  vtkInternal* Internal;
};

#endif