vtkPlusSonixVideoSource.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

/*=========================================================================
The following copyright notice is applicable to parts of this file:
Copyright (c) 2008, Queen's University, Kingston, Ontario, Canada
All rights reserved.
Authors include: Danielle Pace
(Robarts Research Institute and The University of Western Ontario)
Siddharth Vikal (Queen's University, Kingston, Ontario, Canada)
=========================================================================*/

#ifndef __vtkPlusSonixVideoSource_h
#define __vtkPlusSonixVideoSource_h

#include "PlusConfigure.h"
#include "ulterius.h"
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusUsDevice.h"

class uDataDesc;
enum uData;

class vtkPlusDataCollectionExport vtkPlusSonixVideoSource : public vtkPlusUsDevice
{
private:
  class Plus_uTGC : public uTGC
  {
  public:
    std::vector<int> toVector();
    void fromVector(const std::vector<int> input);
    std::string toString(char separator = ' ');
    void fromString(const std::string& input, char separator = ' ');
  };

public:
  static vtkPlusSonixVideoSource* New();
  vtkTypeMacro(vtkPlusSonixVideoSource, vtkPlusUsDevice);
  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual std::string GetSdkVersion();

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* config);

  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* config);

  vtkSetStringMacro(SonixIP);
  vtkGetStringMacro(SonixIP);

  PlusStatus SetFrequencyDevice(double aFrequency);
  PlusStatus GetFrequencyDevice(double& aFrequency);

  PlusStatus SetDepthDevice(int aDepth);
  PlusStatus GetDepthDevice(int& aDepth);

  PlusStatus SetGainDevice(int aGain);
  PlusStatus GetGainDevice(int& aGain);

  PlusStatus SetDynRangeDevice(int aDynRange);
  PlusStatus GetDynRangeDevice(int& aDynRange);

  PlusStatus SetZoomDevice(int aZoom);
  PlusStatus GetZoomDevice(int& aZoom);

  PlusStatus SetSectorDevice(int aSector);
  PlusStatus GetSectorDevice(int& aSector);

  PlusStatus SetTimeGainCompensationDevice(int tgc[8]);
  PlusStatus SetTimeGainCompensationDevice(const Plus_uTGC& tgc);
  PlusStatus GetTimeGainCompensationDevice(int tgc[8]);
  PlusStatus GetTimeGainCompensationDevice(Plus_uTGC& tgc);

  PlusStatus GetSoundVelocityDevice(float& soundVelocity);
  PlusStatus SetSoundVelocityDevice(float _arg);

  PlusStatus SetCompressionStatus(int aCompressionStatus);
  PlusStatus GetCompressionStatus(int& aCompressionStatus);

  PlusStatus SetTimeout(int aTimeout);

  PlusStatus SetAcquisitionDataTypeDevice(int aAcquisitionDataType);
  PlusStatus GetAcquisitionDataTypeDevice(int& acquisitionDataType);

  PlusStatus SetImagingModeDevice(int mode);
  PlusStatus GetImagingModeDevice(int& mode);

  vtkSetMacro(ConnectionSetupDelayMs, int);
  vtkGetMacro(ConnectionSetupDelayMs, int);

  vtkSetMacro(SharedMemoryStatus, int);
  vtkGetMacro(SharedMemoryStatus, int);

  PlusStatus GetDisplayedFrameRateDevice(int& aFrameRate);

  PlusStatus SetRFDecimationDevice(int decimation);

  PlusStatus SetPPFilterDevice(int filterIndex);

  PlusStatus SetFrameRateLimitDevice(int frLimit);

  PlusStatus PrintListOfImagingParametersFromDevice();

  virtual PlusStatus NotifyConfigured();

  virtual bool IsTracker() const { return false; }

  vtkSetMacro(AutoClipEnabled, bool);
  vtkGetMacro(AutoClipEnabled, bool);

  vtkSetMacro(ImageGeometryOutputEnabled, bool);
  vtkGetMacro(ImageGeometryOutputEnabled, bool);

protected:
  virtual PlusStatus InternalConnect();

  virtual PlusStatus InternalDisconnect();

  virtual PlusStatus InternalStartRecording();

  virtual PlusStatus InternalStopRecording();

  std::string GetLastUlteriusError();


  enum RfAcquisitionModeType
  {
    RF_UNKNOWN = -1,
    RF_ACQ_B_ONLY = 0,
    RF_ACQ_RF_ONLY = 1,
    RF_ACQ_B_AND_RF = 2,
    RF_ACQ_CHRF_ONLY = 3,
    RF_ACQ_B_AND_CHRF = 4
  };
  PlusStatus SetRfAcquisitionModeDevice(RfAcquisitionModeType mode);
  PlusStatus GetRfAcquisitionModeDevice(RfAcquisitionModeType& mode);

  PlusStatus AddFrameToBuffer(void* data, int type, int sz, bool cine, int frmnum);

  PlusStatus SetParamValueDevice(char* paramId, int paramValue, int& validatedParamValue);
  PlusStatus SetParamValueDevice(char* paramId, Plus_uTGC& paramValue, Plus_uTGC& validatedParamValue);
  PlusStatus GetParamValueDevice(char* paramId, int& paramValue, int& validatedParamValue);
  PlusStatus GetParamValueDevice(char* paramId, Plus_uTGC& paramValue, Plus_uTGC& validatedParamValue);

  bool HasDataType( uData aValue );
  bool WantDataType( uData aValue );
  PlusStatus ConfigureVideoSource( uData aValue );

  virtual PlusStatus GetRequestedImagingDataTypeFromSources(int& requestedImagingDataType);

  void UpdateImagingParametersFromDevice();

  virtual PlusStatus InternalApplyImagingParameterChange();

protected:
  vtkPlusSonixVideoSource();
  virtual ~vtkPlusSonixVideoSource();

  ulterius* Ult;
  int AcquisitionDataType;
  int ImagingMode;
  int OutputFormat;
  int CompressionStatus;
  int Timeout;
  int ConnectionSetupDelayMs;
  int SharedMemoryStatus;
  RfAcquisitionModeType RfAcquisitionMode;

  bool ImageGeometryChanged;
  bool ImagingParameterChanged;
  std::map<std::string, bool> ChangedImagingParameters;

  char* SonixIP;
  bool UlteriusConnected;
  bool AutoClipEnabled;
  bool ImageGeometryOutputEnabled;

private:
  static bool vtkPlusSonixVideoSourceNewFrameCallback(void* data, int type, int sz, bool cine, int frmnum);
  static bool vtkPlusSonixVideoSourceParamCallback(void* paramId, int ptX, int ptY);
  static vtkPlusSonixVideoSource* ActiveSonixDevice;
  vtkPlusSonixVideoSource(const vtkPlusSonixVideoSource&);  // Not implemented.
  void operator=(const vtkPlusSonixVideoSource&);  // Not implemented.
};

#endif