vtkPlusUsDevice.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 __vtkPlusUsDevice_h
#define __vtkPlusUsDevice_h

#include "igsioCommon.h"
#include "PlusConfigure.h"
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusDevice.h"
#include <igtlioUsSectorDefinitions.h>

class vtkPlusUsImagingParameters;
class vtkPlusChannel;

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

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement*);

  virtual PlusStatus WriteConfiguration(vtkXMLDataElement*);

  virtual PlusStatus SetNewImagingParameters(const vtkPlusUsImagingParameters& newImagingParameters);

  virtual PlusStatus AddVideoItemToVideoSource(vtkPlusDataSource& videoSource, const igsioVideoFrame& frame, long frameNumber, double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
      double filteredTimestamp = UNDEFINED_TIMESTAMP, const igsioFieldMapType* customFields = NULL);
  virtual PlusStatus AddVideoItemToVideoSource(vtkPlusDataSource& videoSource, void* imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType& frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType,
      unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
      double filteredTimestamp = UNDEFINED_TIMESTAMP, const igsioFieldMapType* customFields = NULL);

  virtual PlusStatus AddVideoItemToVideoSources(const std::vector<vtkPlusDataSource*>& videoSources, const igsioVideoFrame& frame, long frameNumber, double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
      double filteredTimestamp = UNDEFINED_TIMESTAMP, const igsioFieldMapType* customFields = NULL) override;

  virtual PlusStatus AddVideoItemToVideoSources(const std::vector<vtkPlusDataSource*>& videoSources, void* imageDataPtr, US_IMAGE_ORIENTATION usImageOrientation, const FrameSizeType& frameSizeInPx,
      igsioCommon::VTKScalarPixelType pixelType, unsigned int numberOfScalarComponents, US_IMAGE_TYPE imageType, int numberOfBytesToSkip, long frameNumber, double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
      double filteredTimestamp = UNDEFINED_TIMESTAMP, const igsioFieldMapType* customFields = NULL) override;

  vtkGetStdStringMacro(ImageToTransducerTransformName);
  vtkSetStdStringMacro(ImageToTransducerTransformName);

  vtkGetObjectMacro(ImagingParameters, vtkPlusUsImagingParameters);

  virtual PlusStatus SetParameter(const std::string& key, const std::string& value);
  virtual std::string GetParameter(const std::string& key) const;
  virtual PlusStatus GetParameter(const std::string& key, std::string& outValue) const;

  bool IsKnownKey(const std::string& queryKey) const;

  // Virtual functions for creating the OpenIGTLinkIO ultrasound parameters.
  // Implement these in all US devices that should support ultrasound sector information

  virtual IGTLIO_PROBE_TYPE GetProbeType();

  virtual std::vector<double> CalculateOrigin();

  virtual std::vector<double> CalculateAngles();

  virtual std::vector<double> CalculateBoundingBox();

  virtual std::vector<double> CalculateDepths();

  virtual double CalculateLinearWidth();

protected:
  virtual PlusStatus InternalApplyImagingParameterChange();

  void CalculateImageToTransducer(igsioFieldMapType& customFields);

  vtkPlusUsDevice();
  virtual ~vtkPlusUsDevice();

protected:
  vtkPlusUsImagingParameters* ImagingParameters;

  double CurrentPixelSpacingMm[3];
  int CurrentTransducerOriginPixels[3];

  igsioTransformName ImageToTransducerTransform;
  std::string ImageToTransducerTransformName;

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

#endif