vtkPlusChannel.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 __vtkPlusStream_h
#define __vtkPlusStream_h

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

#include "PlusStreamBufferItem.h"
#include "vtkDataObject.h"
#include "vtkPlusRfProcessor.h"

//class igsioTrackedFrame; 
class vtkPlusHTMLGenerator;
class vtkPlusDataSource;
class vtkPlusDevice;
//class vtkIGSIOTrackedFrameList;

typedef std::map<std::string, vtkPlusDataSource*> DataSourceContainer;
typedef DataSourceContainer::iterator DataSourceContainerIterator;
typedef DataSourceContainer::const_iterator DataSourceContainerConstIterator;

class vtkPlusDataCollectionExport vtkPlusChannel : public vtkDataObject
{
public:
  typedef std::map< std::string, std::string > CustomAttributeMap;
  typedef CustomAttributeMap::iterator CustomAttributeMapIterator;
  typedef CustomAttributeMap::const_iterator CustomAttributeMapConstIterator;

public:
  static vtkPlusChannel* New();
  vtkTypeMacro(vtkPlusChannel, vtkObject);

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* aChannelElement, bool RequireImageOrientationInChannelConfiguration);
  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* aChannelElement);

  inline PlusStatus GetVideoSource(vtkPlusDataSource*& aVideoSource) const
  {
    aVideoSource = this->VideoSource;
    return aVideoSource != NULL ? PLUS_SUCCESS : PLUS_FAIL;
  }

  void SetVideoSource(vtkPlusDataSource* aSource);
  inline bool HasVideoSource() const { return this->VideoSource != NULL; };
  bool IsVideoSource3D() const;

  int ToolCount() const { return this->Tools.size(); }
  PlusStatus AddTool(vtkPlusDataSource* aTool);
  PlusStatus RemoveTool(const std::string& toolSourceId);
  PlusStatus GetTool(vtkPlusDataSource*& aTool, const std::string& toolSourceId);
  PlusStatus GetToolByPortName(vtkPlusDataSource*& aTool, const std::string& portName);
  PlusStatus RemoveTools();
  inline DataSourceContainerIterator GetToolsStartIterator() { return this->Tools.begin(); };
  inline DataSourceContainerIterator GetToolsEndIterator() { return this->Tools.end(); };
  inline DataSourceContainerConstIterator GetToolsStartConstIterator() const { return this->Tools.begin(); };
  inline DataSourceContainerConstIterator GetToolsEndConstIterator() const { return this->Tools.end(); };

  int FieldCount() const { return this->FieldDataSources.size(); }
  PlusStatus AddFieldDataSource(vtkPlusDataSource* aSource);
  PlusStatus RemoveFieldDataSource(const std::string& sourceId);
  PlusStatus GetFieldDataSource(vtkPlusDataSource*& aSource, const std::string& sourceId);
  PlusStatus RemoveFieldDataSources();
  inline DataSourceContainerIterator GetFieldDataSourcesStartIterator() { return this->FieldDataSources.begin(); };
  inline DataSourceContainerIterator GetFieldDataSourcesEndIterator() { return this->FieldDataSources.end(); };
  inline DataSourceContainerConstIterator GetFieldDataSourcesStartConstIterator() const { return this->FieldDataSources.begin(); };
  inline DataSourceContainerConstIterator GetFieldDataSourcesEndConstIterator() const { return this->FieldDataSources.end(); };

  bool GetTrackingDataAvailable();
  bool GetVideoDataAvailable();
  bool GetFieldDataAvailable();
  bool GetTrackingEnabled() const;
  bool GetVideoEnabled() const;
  bool GetFieldDataEnabled() const;

  vtkImageData* GetBrightnessOutput();

  PlusStatus GetBrightnessFrameSize(FrameSizeType& aDim);

  PlusStatus GetTimestampMasterTool(vtkPlusDataSource*& aTool);

  virtual PlusStatus GetTrackedFrame(double timestamp, igsioTrackedFrame& trackedFrame, bool enableImageData = true);
  virtual PlusStatus GetTrackedFrame(igsioTrackedFrame& trackedFrame);

  virtual PlusStatus GetTrackedFrameListSampled(double& aTimestampOfLastFrameAlreadyGot, double& aTimestampOfNextFrameToBeAdded, vtkIGSIOTrackedFrameList* aTrackedFrameList, double aSamplingPeriodSec, double maxTimeLimitSec = -1);

  PlusStatus GetTrackedFrameList(double& aTimestampOfLastFrameAlreadyGot, vtkIGSIOTrackedFrameList* aTrackedFrameList, int aMaxNumberOfFramesToAdd);

  virtual double GetClosestTrackedFrameTimestampByTime(double time);

  virtual PlusStatus GetMostRecentTimestamp(double& ts);

  virtual PlusStatus GetOldestTimestamp(double& ts);

  virtual PlusStatus Clear();

  virtual void ShallowCopy(vtkDataObject*);
  virtual void ShallowCopy(const vtkPlusChannel& aChannel);

  virtual PlusStatus GetLatestTimestamp(double& aTimestamp) const;

  void SetOwnerDevice(vtkPlusDevice* _arg) { this->OwnerDevice = _arg; }
  vtkPlusDevice* GetOwnerDevice() const { return this->OwnerDevice; }

  PlusStatus SetCustomAttribute(const std::string& attributeId, const std::string& value);
  PlusStatus GetCustomAttribute(const std::string& attributeId, std::string& output) const;
  PlusStatus GetCustomAttributeMap(CustomAttributeMap& output) const;

  vtkSetStringMacro(ChannelId);
  vtkGetStringMacro(ChannelId);

  vtkGetObjectMacro(RfProcessor, vtkPlusRfProcessor);
  vtkSetObjectMacro(RfProcessor, vtkPlusRfProcessor);

  vtkSetMacro(SaveRfProcessingParameters, bool);

  virtual PlusStatus GenerateDataAcquisitionReport(vtkPlusHTMLGenerator* htmlReport);

protected:
  virtual int GetNumberOfFramesBetweenTimestamps(double aTimestampFrom, double aTimestampTo);

protected:
  DataSourceContainer       FieldDataSources;
  DataSourceContainer       Tools;
  vtkPlusDataSource*        VideoSource;
  vtkPlusDevice*            OwnerDevice;
  char*                     ChannelId;

  vtkPlusRfProcessor* RfProcessor;
  vtkImageData* BlankImage;
  StreamBufferItem BrightnessOutputTrackedFrame;
  FrameSizeType BrightnessFrameSize;

  bool SaveRfProcessingParameters;

  vtkPlusDataSource* TimestampMasterTool;

  CustomAttributeMap CustomAttributes;

  vtkPlusChannel(void);
  virtual ~vtkPlusChannel(void);

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

#endif