vtkPlusCapistranoVideoSource.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*/

#ifndef __vtkPlusCapistranoVideoSource_h
#define __vtkPlusCapistranoVideoSource_h

#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusUsDevice.h"
#include "vtkPlusUsImagingParameters.h"

class vtkPlusDataCollectionExport vtkPlusCapistranoVideoSource: public vtkPlusUsDevice
{
public:
  static vtkPlusCapistranoVideoSource* New();
  vtkTypeMacro(vtkPlusCapistranoVideoSource, vtkPlusUsDevice);
  void PrintSelf(ostream& os, vtkIndent indent) override;
  static const char* CAPISTRANO_SET_WOBBLE_RATE;
  static const char* CAPISTRANO_GET_WOBBLE_RATE;
  static const char* CAPISTRANO_SET_BIDIRECTIONAL_MODE;
  static const char* CAPISTRANO_GET_BIDIRECTIONAL_MODE;
  static const char* CAPISTRANO_FREEZE_PROBE;
  static const char* CAPISTRANO_IS_PROBE_FROZEN;
  static const char* CAPISTRANO_SET_JITTER_COMPENSATION;
  static const char* CAPISTRANO_GET_JITTER_COMPENSATION;
  static const char* CAPISTRANO_SET_MIS_MODE;
  static const char* CAPISTRANO_GET_MIS_MODE;
  static const char* CAPISTRANO_SET_MIS_PULSE_PERIOD;
  static const char* CAPISTRANO_GET_MIS_PULSE_PERIOD;
  static const char* CAPISTRANO_SET_SWEEP_ANGLE;
  static const char* CAPISTRANO_GET_SWEEP_ANGLE;
  static const char* CAPISTRANO_SET_DERIVATIVE_COMPENSATION;
  static const char* CAPISTRANO_GET_DERIVATIVE_COMPENSATION;
  static const char* CAPISTRANO_SET_SAMPLE_FREQUENCY;
  static const char* CAPISTRANO_GET_SAMPLE_FREQUENCY;
  static const char* CAPISTRANO_SET_SERVO_GAIN;
  static const char* CAPISTRANO_GET_SERVO_GAIN;
  static const char* CAPISTRANO_SET_POSITION_SCALE;
  static const char* CAPISTRANO_GET_POSITION_SCALE;

  bool IsTracker() const override
  {
    return false;
  }

  PlusStatus ReadConfiguration(vtkXMLDataElement* config) override;

  PlusStatus WriteConfiguration(vtkXMLDataElement* config) override;

  PlusStatus NotifyConfigured() override;

  std::string GetSdkVersion() override;

  PlusStatus GetHardwareVersion(int& HardwareVersion);

  PlusStatus GetHighPassFilter(int& HighPassFilter);

  PlusStatus GetLowPassFilter(int& LowPassFilter);

  /* Update Speed of Sound */
  PlusStatus GetProbeVelocityDevice(float& aVel);

  /* Set the speed of sound of US probe */
  PlusStatus SetSoundVelocity(float ss);

  /* Set the scan directional mode of US probe */
  PlusStatus SetBidirectionalMode(bool mode);

  /* Get the scan directional mode of US probe */
  bool GetBidirectionalMode();

  /* Set the size of cinebuffer of US probe */
  PlusStatus SetCineBuffers(int cinebuffer);

  /* Set the sample frequency of US probe */
  PlusStatus SetSampleFrequency(float sf);

  /* Set the pulser frequency of US probe */
  PlusStatus SetPulseFrequency(float pf);

  /* Set the desired probe speed in Hz.
  *  The resulting probe speed will be approximately the value specified. */
  PlusStatus SetWobbleRate(unsigned char wobbleRate);

  /* Probe speed in Hz */
  unsigned char GetWobbleRate();

  /* Set the jitter compensation value for the probe servo */
  PlusStatus SetJitterCompensation(unsigned char jitterComp);

  /* Jitter compensation value for the probe servo */
  unsigned char GetJitterCompensation();

  /* Set the position scale value for the probe servo */
  PlusStatus SetPositionScale(unsigned char scale);

  /* Position scale value for the probe servo */
  unsigned char GetPositionScale();

  /* Set the desired probe scan angle (in radians) */
  PlusStatus SetSweepAngle(float sweepAngle);

  /* Probe scan angle (in radians) */
  float GetSweepAngle();

  /* Set the gain value for the probe servo */
  PlusStatus SetServoGain(unsigned char servoGain);

  /* Gain value for the probe servo */
  unsigned char GetServoGain();

  /* State is the desired overscan multiplier.
  *  Overscan is done in 6.25% steps from 6.25% to 50% (three-bit number).
  *  As such, the valid values are 0…7 which correspond to 6.25%, 12.5%, …, 43.75%, 50%. */
  PlusStatus SetOverscan(int state);

  /* Overscan multiplier. Overscan is done in 6.25% steps from 6.25% to 50% (three-bit number).
  *  As such, the valid values are 0…7 which correspond to 6.25%, 12.5%, …, 43.75%, 50%. */
  int GetOverscan();

  /* Sets the desired probe servo derivative compensation */
  PlusStatus SetDerivativeCompensation(unsigned char derivativeCompensation);

  /* Probe servo derivative compensation */
  unsigned char GetDerivativeCompensation();

  /* Set the pulser voltage of US probe. Valid range is from 0.0 to 100.0. Values outside the range will be clipped to this range. */
  PlusStatus SetPulseVoltage(float pv);

  /* Get the pulser voltage of US probe */
  float GetPulseVoltage();

  /* Set the scan depth of US probe */
  PlusStatus SetScanDepth(float sd);

  /* Set the interpolation of B-Mode image */
  PlusStatus SetInterpolate(bool interpolate);

  /* Set the average mode of US B-Mode image */
  PlusStatus SetAverageMode(bool averagemode);

  /* Set the view option of US B-Mode image */
  PlusStatus SetBModeViewOption(unsigned int bmodeviewoption);

  /* Set the size of US B-mode image */
  PlusStatus SetImageSize(const FrameSizeType& imageSize);

  /* Set the Intensity (Brightness) of US B-mode image */
  PlusStatus SetIntensity(double value);

  /* Set the Contrast of US B-mode image */
  PlusStatus SetContrast(double value);

  /* Set the zoom factor. */
  PlusStatus SetZoomFactor(double zoomfactor);

  /* Set the zoom factor on the US Device. */
  PlusStatus SetDisplayZoomDevice(double zoom);

  /* Set the LUT Center of US B-mode image */
  PlusStatus SetLutCenter(double lutcenter);

  /* Set the LUT Window of US B-mode image */
  PlusStatus SetLutWindow(double lutwindow);

  /* Set the gain in percent */
  PlusStatus SetGainPercent(double gainPercent[3]);

  /* Set the gain in percent in the device */
  PlusStatus SetGainPercentDevice(double gainPercent[3]);

  /* Set the probe depth on US Device in mm */
  PlusStatus SetDepthMmDevice(float depthMm);

  /* Set the probe depth in mm */
  PlusStatus SetDepthMm(float depthMm);

  PlusStatus InternalApplyImagingParameterChange() override;

  vtkSetVector3Macro(CurrentPixelSpacingMm, double);

  vtkGetVector3Macro(CurrentPixelSpacingMm, double);

  PlusStatus FreezeDevice(bool freeze);

  bool IsFrozen();

  PlusStatus SetMISMode(bool mode);

  /* Get the MIS Mode state. Only implemented with Capistrano SDK 2019.2 and newer. */
  PlusStatus GetMISMode(bool& MISMode);

  PlusStatus SetMISPulsePeriod(unsigned int val);

  PlusStatus GetMISPulsePeriod(unsigned int& PulsePeriod);

  bool IsBoardAttached();

protected:
  vtkPlusCapistranoVideoSource();

  ~vtkPlusCapistranoVideoSource();

  PlusStatus InternalConnect() override;

  PlusStatus InternalDisconnect() override;

  PlusStatus InternalStartRecording() override;

  PlusStatus InternalStopRecording() override;

  PlusStatus InitializeCapistranoVideoSource();

  PlusStatus InternalUpdate();

  PlusStatus InitializeCapistranoProbe();

  /* Set up US Probe with ID */
  PlusStatus SetupProbe(int probeID = 0);

  PlusStatus InitializeImageWindow();

  PlusStatus InitializeLUT();

  PlusStatus InitializeTGC();

  PlusStatus WaitForFrame();

  /* Set the boolean value to use US parameters from XML file */
  PlusStatus SetUpdateParameters(bool b);

  /* Update US parameters (US probe/B-Mode parameters) */
  PlusStatus UpdateUSParameters();

  /* Update US probe parameters  */
  PlusStatus UpdateUSProbeParameters();

  /* Update US B-Mode parameters */
  PlusStatus UpdateUSBModeParameters();

  /* Calculate US Image Display */
  PlusStatus CalculateDisplay();

  /* Calculate US Image Display with a given B-Mode view option */
  PlusStatus CalculateDisplay(unsigned int option);

  /* Update US Scan depth */
  PlusStatus UpdateDepthMode();

  /* Update US Scan depth with a given clockdivider */
  PlusStatus UpdateDepthMode(int clockdivider);

  /* Update US Sample frequency */
  PlusStatus GetSampleFrequencyDevice(float& aFreq);

  PlusStatus GetProbeNameDevice(std::string& probeName);

  class        vtkInternal;
  vtkInternal* Internal;

  bool                           Initialized = false;
  bool                           Frozen;
  bool                           UpdateParameters;
  bool                           MISMode;
  unsigned int                   PulsePeriod;
  int                            HardwareVersion;
  int                            HighPassFilter;
  int                            LowPassFilter;
  bool                           BidirectionalMode;
  int                            ProbeID;
  int                            ClockDivider;
  int                            CineBuffers;
  float                          SampleFrequency;
  unsigned char                  PositionScale;
  bool                           Interpolate;
  bool                           AverageMode;
  unsigned int                   CurrentBModeViewOption;
  double                         LutCenter;
  double                         LutWindow;

  igsioFieldMapType CustomFields;

private:
  vtkPlusCapistranoVideoSource(const vtkPlusCapistranoVideoSource&);  // Not implemented
  void operator=(const vtkPlusCapistranoVideoSource&);  // Not implemented
};

#endif