vtkPlusBuffer.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) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
=========================================================================*/

#ifndef __vtkPlusDataBuffer_h
#define __vtkPlusDataBuffer_h

// Local includes
#include "igsioCommon.h"
#include "PlusConfigure.h"
#include "vtkPlusDataCollectionExport.h"
#include "PlusStreamBufferItem.h"
#include "vtkPlusTimestampedCircularBuffer.h"

//#include "igsioTrackedFrame.h"

// VTK includes
#include <vtkObject.h>

class vtkPlusDevice;
enum ToolStatus;

//class vtkIGSIOTrackedFrameList;

class vtkPlusDataCollectionExport vtkPlusBuffer : public vtkObject
{
public:
  enum TIMESTAMP_FILTERING_OPTION
  {
    READ_FILTERED_AND_UNFILTERED_TIMESTAMPS = 0,
    READ_UNFILTERED_COMPUTE_FILTERED_TIMESTAMPS,
    READ_FILTERED_IGNORE_UNFILTERED_TIMESTAMPS
  };

  enum DataItemTemporalInterpolationType
  {
    EXACT_TIME, 
    INTERPOLATED, 
    CLOSEST_TIME 
  };

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

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

  virtual PlusStatus AddItem(vtkImageData* frame,
                             US_IMAGE_ORIENTATION usImageOrientation,
                             US_IMAGE_TYPE imageType,
                             long frameNumber,
                             const std::array<int, 3>& clipRectangleOrigin,
                             const std::array<int, 3>& clipRectangleSize,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL);
  virtual PlusStatus AddItem(const igsioVideoFrame* frame,
                             long frameNumber,
                             const std::array<int, 3>& clipRectangleOrigin,
                             const std::array<int, 3>& clipRectangleSize,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL);
  virtual PlusStatus AddItem(void* imageDataPtr,
                             US_IMAGE_ORIENTATION usImageOrientation,
                             const FrameSizeType& inputFrameSizeInPx,
                             igsioCommon::VTKScalarPixelType pixelType,
                             unsigned int numberOfScalarComponents,
                             US_IMAGE_TYPE imageType,
                             int numberOfBytesToSkip,
                             long frameNumber,
                             const std::array<int, 3>& clipRectangleOrigin,
                             const std::array<int, 3>& clipRectangleSize,
                             double unfilteredTimestamp = UNDEFINED_TIMESTAMP,
                             double filteredTimestamp = UNDEFINED_TIMESTAMP,
                             const igsioFieldMapType* customFields = NULL,
                             vtkStreamingVolumeFrame* encodedFrame = 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& fields,
                             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);

  virtual ItemStatus GetStreamBufferItem(BufferItemUidType uid, StreamBufferItem* bufferItem);
  virtual ItemStatus GetLatestStreamBufferItem(StreamBufferItem* bufferItem)
  {
    return this->GetStreamBufferItem(this->GetLatestItemUidInBuffer(), bufferItem);
  };
  virtual ItemStatus GetOldestStreamBufferItem(StreamBufferItem* bufferItem)
  {
    return this->GetStreamBufferItem(this->GetOldestItemUidInBuffer(), bufferItem);
  };
  virtual ItemStatus GetStreamBufferItemFromTime(double time, StreamBufferItem* bufferItem, DataItemTemporalInterpolationType interpolation);
  virtual PlusStatus ModifyBufferItemFrameField(BufferItemUidType uid, const std::string& key, const std::string& value);

  virtual ItemStatus GetLatestTimeStamp(double& latestTimestamp);

  virtual ItemStatus GetOldestTimeStamp(double& oldestTimestamp);

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

  virtual bool GetLatestItemHasValidVideoData();

  virtual bool GetLatestItemHasValidTransformData();

  virtual bool GetLatestItemHasValidFieldData();

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

  ItemStatus GetBufferIndexFromTime(const double time, int& bufferIndex);

  virtual BufferItemUidType GetOldestItemUidInBuffer()
  {
    return this->StreamBuffer->GetOldestItemUidInBuffer();
  }
  virtual BufferItemUidType GetLatestItemUidInBuffer()
  {
    return this->StreamBuffer->GetLatestItemUidInBuffer();
  }
  virtual ItemStatus GetItemUidFromTime(double time, BufferItemUidType& uid)
  {
    return this->StreamBuffer->GetItemUidFromTime(time, uid);
  }

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

  virtual int GetNumberOfItems()
  {
    return this->StreamBuffer->GetNumberOfItems();
  }

  virtual double GetFrameRate(bool ideal = false, double* framePeriodStdevSecPtr = NULL)
  {
    return this->StreamBuffer->GetFrameRate(ideal, framePeriodStdevSecPtr);
  }

  vtkSetMacro(MaxAllowedTimeDifference, double);
  vtkGetMacro(MaxAllowedTimeDifference, double);

  PlusStatus CopyTransformFromTrackedFrameList(vtkIGSIOTrackedFrameList* sourceTrackedFrameList, TIMESTAMP_FILTERING_OPTION timestampFiltering, igsioTransformName& transformName);


  virtual void DeepCopy(vtkPlusBuffer* buffer);

  virtual void Clear();

  virtual void SetAveragedItemsForFiltering(int averagedItemsForFiltering);

  virtual int GetAveragedItemsForFiltering();

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

  virtual PlusStatus GetTimeStampReportTable(vtkTable* timeStampReportTable);

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

  PlusStatus SetFrameSize(unsigned int x, unsigned int y, unsigned int z, bool allocateFrames = true);
  PlusStatus SetFrameSize(const FrameSizeType& frameSize, bool allocateFrames = true);
  virtual FrameSizeType GetFrameSize() const;
  virtual PlusStatus GetFrameSize(unsigned int& _arg1, unsigned int& _arg2, unsigned int& _arg3) const;

  PlusStatus SetPixelType(igsioCommon::VTKScalarPixelType pixelType);
  vtkGetMacro(PixelType, igsioCommon::VTKScalarPixelType);

  PlusStatus SetNumberOfScalarComponents(unsigned int numberOfScalarComponents);
  vtkGetMacro(NumberOfScalarComponents, unsigned int);

  PlusStatus SetImageType(US_IMAGE_TYPE imageType);
  vtkGetMacro(ImageType, US_IMAGE_TYPE);

  PlusStatus SetImageOrientation(US_IMAGE_ORIENTATION imageOrientation);
  vtkGetMacro(ImageOrientation, US_IMAGE_ORIENTATION);

  int GetNumberOfBytesPerScalar();

  int GetNumberOfBytesPerPixel();

  PlusStatus CopyImagesFromTrackedFrameList(vtkIGSIOTrackedFrameList* sourceTrackedFrameList, TIMESTAMP_FILTERING_OPTION timestampFiltering, bool copyFrameFields);

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

  vtkGetStringMacro(DescriptiveName);
  vtkSetStringMacro(DescriptiveName);

protected:
  vtkPlusBuffer();
  ~vtkPlusBuffer();

  virtual PlusStatus AllocateMemoryForFrames();

  virtual bool CheckFrameFormat(const FrameSizeType& frameSizeInPx, igsioCommon::VTKScalarPixelType pixelType, US_IMAGE_TYPE imgType, int numberOfScalarComponents);

  PlusStatus GetPrevNextBufferItemFromTime(double time, StreamBufferItem& itemA, StreamBufferItem& itemB);

  virtual ItemStatus GetInterpolatedStreamBufferItemFromTime(double time, StreamBufferItem* bufferItem);

  virtual ItemStatus GetStreamBufferItemFromExactTime(double time, StreamBufferItem* bufferItem);

  virtual ItemStatus GetStreamBufferItemFromClosestTime(double time, StreamBufferItem* bufferItem);

protected:
  FrameSizeType FrameSize;

  igsioCommon::VTKScalarPixelType PixelType;

  unsigned int NumberOfScalarComponents;

  US_IMAGE_TYPE ImageType;

  US_IMAGE_ORIENTATION ImageOrientation;

  typedef vtkPlusTimestampedCircularBuffer StreamItemCircularBuffer;
  StreamItemCircularBuffer* StreamBuffer;

  double MaxAllowedTimeDifference;

  char* DescriptiveName;

private:
  vtkPlusBuffer(const vtkPlusBuffer&);
  void operator=(const vtkPlusBuffer&);
};

#endif