vtkPlusSonixPortaVideoSource.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) Elvis Chen, 2008
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Authors include: Elvis Chen (Queen's University)
=========================================================================*/

#ifndef __vtkPlusSONIXPORTAVIDEOSOURCE_H__
#define __vtkPlusSONIXPORTAVIDEOSOURCE_H__

#include "PlusConfigure.h"
#include "vtkPlusDataCollectionExport.h"

#include "vtkPlusUsDevice.h"

class vtkPlusDataCollectionExport vtkPlusSonixPortaVideoSource;
class porta;

#if (PLUS_ULTRASONIX_SDK_MAJOR_VERSION < 6)
  class probeInfo;
#else
  struct probeInfo;
#endif


class vtkPlusDataCollectionExport vtkPlusSonixPortaVideoSourceCleanup
{
public:
  vtkPlusSonixPortaVideoSourceCleanup();
  ~vtkPlusSonixPortaVideoSourceCleanup();

private:
  vtkPlusSonixPortaVideoSourceCleanup(const vtkPlusSonixPortaVideoSourceCleanup& other);
  vtkPlusSonixPortaVideoSourceCleanup& operator=(const vtkPlusSonixPortaVideoSourceCleanup& rhs);
};

class vtkPlusDataCollectionExport vtkPlusSonixPortaVideoSource : public vtkPlusUsDevice
{
  vtkTypeMacro(vtkPlusSonixPortaVideoSource, vtkPlusDevice);
  void PrintSelf(ostream& os, vtkIndent indent);

  static vtkPlusSonixPortaVideoSource* New();

  static vtkPlusSonixPortaVideoSource* GetInstance();

  static void SetInstance(vtkPlusSonixPortaVideoSource* instance);

  //BTX
  static vtkPlusSonixPortaVideoSourceCleanup Cleanup;
  //ETX

  virtual std::string GetSdkVersion();  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* config);
  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* config);

  /* List of parameters which can be set or read in B-mode, other mode parameters not currently implemented*/

  vtkSetStringMacro(PortaProbeName);
  vtkGetStringMacro(PortaProbeName);

  vtkSetStringMacro(PortaSettingPath);
  vtkGetStringMacro(PortaSettingPath);

  vtkSetStringMacro(PortaFirmwarePath);
  vtkGetStringMacro(PortaFirmwarePath);

  vtkSetStringMacro(PortaLUTPath);
  vtkGetStringMacro(PortaLUTPath);

  vtkSetMacro(Usm, int);
  vtkGetMacro(Usm, int);

  vtkSetMacro(Pci, int);
  vtkGetMacro(Pci, int);

  vtkSetStringMacro(PortaLicensePath);
  vtkGetStringMacro(PortaLicensePath);

  PlusStatus SetFrequency(int aFrequency);
  PlusStatus GetFrequency(int& aFrequency);

  PlusStatus SetDepth(int aDepth);
  PlusStatus GetDepth(int& aDepth);

  PlusStatus SetGain(int aGain);
  PlusStatus GetGain(int& aGain);

  PlusStatus SetZoom(int aZoom);
  PlusStatus GetZoom(int& aZoom);

  PlusStatus SetFramePerVolume(int aFramePerVolume);
  PlusStatus GetFramePerVolume(int& aFramePerVolume);

  PlusStatus SetStepPerFrame(int aStepPerFrame);
  PlusStatus GetStepPerFrame(int& aStepPerFrame);

  PlusStatus SetMotorRotationRangeDeg(double fovDeg);
  PlusStatus GetMotorRotationRangeDeg(double& fovDeg);

  vtkSetMacro(ImagingMode, int);
  vtkGetMacro(ImagingMode, int);

  vtkSetMacro(PortaBModeWidth, int);
  vtkGetMacro(PortaBModeWidth, int);

  vtkSetMacro(PortaBModeHeight, int);
  vtkGetMacro(PortaBModeHeight, int);

  void SetPortaCineSize(int size);

  int GetPortaFrameRate();

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

  virtual PlusStatus NotifyConfigured();

protected:
  vtkPlusSonixPortaVideoSource();
  ~vtkPlusSonixPortaVideoSource();

  virtual PlusStatus InternalConnect();

  virtual PlusStatus InternalDisconnect();

  // continues indefinitely until StopRecording() is called.
  virtual PlusStatus InternalStartRecording();

  virtual PlusStatus InternalStopRecording();

  std::string GetLastPortaError();

  porta* Porta;
  bool PortaConnected;

  int Depth;
  int Frequency;
  int Gain;
  int Zoom;

  int ImagingMode;

  int Usm;
  int Pci;

  int DisplayIndex;

  bool ImageGeometryChanged;

  double CurrentDepthMm;
  double CurrentPixelSpacingMm[2];
  int CurrentTransducerOriginPixels[2];

  bool AutoClipEnabled;

  PlusStatus AddFrameToBuffer(void* param, int id, bool motorRotationCcw, int motorStepCount);

  PlusStatus SetParamValue(char* paramId, int paramValue, int& validatedParamValue);
  PlusStatus GetParamValue(char* paramId, int& paramValue, int& validatedParamValue);

  virtual bool IsTracker() const { return false; }

private:
  // data members
  static vtkPlusSonixPortaVideoSource* Instance;

#if (PLUS_ULTRASONIX_SDK_MAJOR_VERSION < 5) || (PLUS_ULTRASONIX_SDK_MAJOR_VERSION == 5 && PLUS_ULTRASONIX_SDK_MINOR_VERSION < 7)
  //  SDK version < 5.7.x
  static bool vtkPlusSonixPortaVideoSourceNewFrameCallback(void* param, int id);
#elif (PLUS_ULTRASONIX_SDK_MAJOR_VERSION < 6)
  //  5.7.x <= SDK version < 6.x
  static bool vtkPlusSonixPortaVideoSourceNewFrameCallback(void* param, int id, int header);
#else
  static int vtkPlusSonixPortaVideoSourceNewFrameCallback(void* param, int id, int header);
#endif

  // vtkPlusSonixPortaVideoSource(const vtkPlusSonixPortaVideoSource&);  // Not implemented.
  // void operator=(const vtkPlusSonixPortaVideoSource&);  // Not implemented.

  PlusStatus vtkPlusSonixPortaVideoSource::UpdateSonixPortaParams();

  std::string GetMotorToMotorRotatedTransform(double MotorAngle);

  // Porta parameters
  int PortaBModeWidth;

  int PortaBModeHeight;

  char* PortaProbeName;

  char* PortaSettingPath;

  char* PortaFirmwarePath;

  char* PortaLUTPath;

  char* PortaLicensePath;

  int PortaCineSize;

  int FramePerVolume;

  double MotorRotationRangeDeg;

  int StepPerFrame;

  probeInfo* ProbeInformation;

  double MotorRotationPerStepDeg;

  double MotorRotationStartAngleDeg;

  bool FirstCallToAddFrameToBuffer;

  int VolumeIndex;

  int FrameIndexInVolume;

  bool LastRotationCcw;

  unsigned char* ImageBuffer;
};

#endif // of __vtkPlusSONIXPORTAVIDEOSOURCE_H__