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

// .NAME vtkPlusDataSource - interfaces VTK to a handheld 3D positioning tool or video source
// .SECTION Description
// The vtkPlusDataSource provides an interface between a tracked object or video stream in
// the real world and a virtual object.
// .SECTION see also
// vtkPlusDevice vtkPlusBuffer vtkPlusChannel

#ifndef __vtkPlusDataSource_h
#define __vtkPlusDataSource_h

// Local includes
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusBuffer.h"
#include "vtkPlusDevice.h"

// VTK includes
#include <vtkObject.h>

class vtkPlusBuffer;

enum DataSourceType
{
  DATA_SOURCE_TYPE_NONE,
  DATA_SOURCE_TYPE_TOOL,
  DATA_SOURCE_TYPE_VIDEO,
  DATA_SOURCE_TYPE_FIELDDATA,
};

class vtkPlusDataCollectionExport vtkPlusDataSource : public vtkObject
{
  typedef std::map< std::string, std::string > CustomPropertyMap;
  typedef CustomPropertyMap::iterator CustomPropertyMapIterator;
  typedef CustomPropertyMap::const_iterator CustomPropertyMapConstIterator;

public:
  static std::string DATA_SOURCE_TYPE_TOOL_TAG;
  static std::string DATA_SOURCE_TYPE_VIDEO_TAG;
  static std::string DATA_SOURCE_TYPE_FIELDDATA_TAG;

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

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* toolElement, bool requirePortNameInSourceConfiguration = false, bool requireImageOrientationInChannelConfiguration = false, const std::string& aDescriptiveNameForBuffer = std::string(""));
  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* toolElement);
  virtual PlusStatus WriteCompactConfiguration(vtkXMLDataElement* toolElement);

  PlusStatus SetId(const char* aSourceId);
  PlusStatus SetId(const std::string& aSourceId);
  PlusStatus SetSourceId(const std::string& aSourceId);
  vtkGetStdStringMacro(Id);
  std::string GetSourceId() const;

  PlusStatus SetReferenceCoordinateFrameName(const char* referenceName);
  PlusStatus SetReferenceCoordinateFrameName(const std::string& referenceName);
  vtkGetStdStringMacro(ReferenceCoordinateFrameName);

  std::string GetTransformName() const;

  PlusStatus SetImageType(US_IMAGE_TYPE imageType);
  US_IMAGE_TYPE GetImageType();

  PlusStatus SetInputFrameSize(unsigned int x, unsigned int y, unsigned int z);
  PlusStatus SetInputFrameSize(const FrameSizeType& frameSize);
  FrameSizeType GetInputFrameSize() const;

  virtual FrameSizeType GetOutputFrameSize() const;
  virtual PlusStatus GetOutputFrameSize(unsigned int& _arg1, unsigned int& _arg2, unsigned int& _arg3) const;

  virtual void SetStartTime(double startTime);
  virtual double GetStartTime();

  virtual int GetNumberOfItems();

  virtual ItemStatus GetIndex(const BufferItemUidType uid, unsigned long& index);

  virtual double GetFrameRate(bool ideal = false, double* framePeriodStdevSecPtr = NULL);

  virtual BufferItemUidType GetOldestItemUidInBuffer();
  virtual BufferItemUidType GetLatestItemUidInBuffer();
  virtual ItemStatus GetItemUidFromTime(double time, BufferItemUidType& uid);

  virtual bool GetLatestItemHasValidVideoData();

  virtual bool GetLatestItemHasValidTransformData();

  virtual bool GetLatestItemHasValidFieldData();

  virtual ItemStatus GetStreamBufferItem(BufferItemUidType uid, StreamBufferItem* bufferItem);
  virtual ItemStatus GetLatestStreamBufferItem(StreamBufferItem* bufferItem);
  virtual ItemStatus GetOldestStreamBufferItem(StreamBufferItem* bufferItem);
  virtual ItemStatus GetStreamBufferItemFromTime(double time, StreamBufferItem* bufferItem, vtkPlusBuffer::DataItemTemporalInterpolationType interpolation);
  virtual PlusStatus ModifyBufferItemFrameField(BufferItemUidType uid, const std::string& key, const std::string& value);

  virtual PlusStatus DeepCopyBufferTo(vtkPlusBuffer& bufferToFill);

  virtual void Clear();

  virtual PlusStatus WriteToSequenceFile(const char* filename, bool useCompression = false);

  virtual PlusStatus GetTimeStampReportTable(vtkTable* timeStampReportTable);

  void SetTimeStampReporting(bool enable);
  bool GetTimeStampReporting();

  virtual PlusStatus SetBufferSize(int n);
  virtual int GetBufferSize();

  virtual ItemStatus GetLatestTimeStamp(double& latestTimestamp);

  virtual ItemStatus GetOldestTimeStamp(double& oldestTimestamp);

  virtual ItemStatus GetTimeStamp(BufferItemUidType uid, double& timestamp);

  virtual void SetLocalTimeOffsetSec(double offsetSec);
  virtual double GetLocalTimeOffsetSec();

  virtual PlusStatus AddItem(vtkImageData* frame,
                             US_IMAGE_ORIENTATION usImageOrientation,
                             US_IMAGE_TYPE imageType,
                             long frameNumber,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL);

  virtual PlusStatus AddItem(const igsioVideoFrame* frame,
                             long frameNumber,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL);

  virtual PlusStatus AddItem(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 AddItem(void* imageDataPtr,
                             const FrameSizeType& frameSize,
                             unsigned int frameSizeInBytes,
                             US_IMAGE_TYPE imageType,
                             long frameNumber,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL);

  virtual PlusStatus AddItem(const igsioFieldMapType& customFields, long frameNumber, double unfilteredTimestamp = UNDEFINED_TIMESTAMP, double filteredTimestamp = UNDEFINED_TIMESTAMP);

  PlusStatus AddTimeStampedItem(vtkMatrix4x4* matrix, ToolStatus status, unsigned long frameNumber, double unfilteredTimestamp, double filteredTimestamp = UNDEFINED_TIMESTAMP, const igsioFieldMapType* customFields = NULL);

  // TODO : consider a re-design of this idea
  void SetDevice(vtkPlusDevice* _arg) { this->Device = _arg; }
  vtkPlusDevice* GetDevice() { return this->Device; }

  vtkGetStdStringMacro(PortName);
  PlusStatus SetPortName(const std::string& portName);
  PlusStatus SetPortName(const char* portName);

  PlusStatus SetPixelType(igsioCommon::VTKScalarPixelType pixelType);
  virtual igsioCommon::VTKScalarPixelType GetPixelType();

  PlusStatus SetNumberOfScalarComponents(unsigned int numberOfScalarComponents);
  virtual unsigned int GetNumberOfScalarComponents();

  int GetNumberOfBytesPerPixel();

  virtual PlusStatus SetInputImageOrientation(US_IMAGE_ORIENTATION imageOrientation);
  virtual US_IMAGE_ORIENTATION GetInputImageOrientation();

  virtual PlusStatus SetOutputImageOrientation(US_IMAGE_ORIENTATION imageOrientation);
  virtual US_IMAGE_ORIENTATION GetOutputImageOrientation();

  vtkGetMacroConst(Type, DataSourceType);
  vtkSetMacro(Type, DataSourceType);

  vtkGetMacroConst(FrameNumber, unsigned long);
  vtkSetMacro(FrameNumber, unsigned long);

  std::string GetCustomProperty(const std::string& propertyName);
  void SetCustomProperty(const std::string& propertyName, const std::string& propertyValue);

  void DeepCopy(const vtkPlusDataSource& source);

  std::array<int, 3> GetClipRectangleSize() const;

  std::array<int, 3> GetClipRectangleOrigin() const;

  void SetClipRectangleSize(const std::array<int, 3> _arg);

  void SetClipRectangleOrigin(const std::array<int, 3> _arg);

protected:
  virtual vtkPlusBuffer* GetBuffer() const;

protected:
  vtkPlusDataSource();
  ~vtkPlusDataSource();

  vtkPlusDevice* Device;

  std::string PortName;
  US_IMAGE_ORIENTATION InputImageOrientation;

  DataSourceType Type;

  unsigned long FrameNumber;

  std::string Id;
  std::string ReferenceCoordinateFrameName;

  vtkPlusBuffer* Buffer;

  CustomPropertyMap CustomProperties;

  std::array<int, 3> ClipRectangleOrigin;
  std::array<int, 3> ClipRectangleSize;

  FrameSizeType InputFrameSize;

private:
  vtkPlusDataSource(const vtkPlusDataSource&);
  void operator=(const vtkPlusDataSource&);

};

#endif