igstkVideoImagerTool.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Image Guided Surgery Software Toolkit
  Module:    $RCSfile: igstkVideoImagerTool.h,v $
  Language:  C++
  Date:      $Date: 2009-06-18 18:40:55 $
  Version:   $Revision: 1.1 $

  Copyright (c) ISC  Insight Software Consortium.  All rights reserved.
  See IGSTKCopyright.txt or http://www.igstk.org/copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef __igstkVideoImagerTool_h
#define __igstkVideoImagerTool_h

#include "igstkObject.h"
#include "igstkTransform.h"
#include "igstkFrame.h"
#include "igstkMacros.h"
#include "igstkStateMachine.h"
#include "igstkCoordinateSystemInterfaceMacros.h"

class vtkImagedata;

namespace igstk
{

igstkEventMacro( VideoImagerToolEvent, StringEvent);
igstkEventMacro( VideoImagerToolErrorEvent, IGSTKErrorWithStringEvent);
igstkEventMacro( VideoImagerToolConfigurationEvent,VideoImagerToolEvent);
igstkEventMacro( VideoImagerToolConfigurationErrorEvent,
                                                     VideoImagerToolErrorEvent);
igstkEventMacro( InvalidRequestToAttachVideoImagerToolErrorEvent,
                                                     VideoImagerToolErrorEvent);
igstkEventMacro( InvalidRequestToDetachVideoImagerToolErrorEvent,
                                                     VideoImagerToolErrorEvent);
igstkEventMacro( VideoImagerToolAttachmentToVideoImagerEvent,
                                                          VideoImagerToolEvent);
igstkEventMacro( VideoImagerToolAttachmentToVideoImagerErrorEvent,
                                                     VideoImagerToolErrorEvent);
igstkEventMacro( VideoImagerToolDetachmentFromVideoImagerEvent,
                                                          VideoImagerToolEvent);
igstkEventMacro( VideoImagerToolDetachmentFromVideoImagerErrorEvent,
                                                     VideoImagerToolErrorEvent);
igstkEventMacro( VideoImagerToolMadeTransitionToStreamingStateEvent,
                                                          VideoImagerToolEvent);
igstkEventMacro( VideoImagerToolNotAvailableEvent,VideoImagerToolEvent);
igstkEventMacro( ToolImagingStartedEvent,VideoImagerToolEvent);
igstkEventMacro( ToolImagingStoppedEvent,VideoImagerToolEvent);
igstkLoadedEventMacro( FrameModifiedEvent, IGSTKEvent, igstk::Frame);

class VideoImager;

class VideoImagerTool : public Object
{
public:

  igstkStandardAbstractClassTraitsMacro( VideoImagerTool, Object )

public:

  igstkFriendClassMacro( VideoImager );

  typedef VideoImager       VideoImagerType;
  typedef Transform         TransformType;
  typedef Frame             FrameType;

  igstkGetMacro( Updated, bool );

  virtual void RequestConfigure( void );

  virtual void RequestDetachFromVideoImager( );

  virtual void RequestGetFrame();

  const std::string GetVideoImagerToolIdentifier( ) const;

  virtual void RequestAttachToVideoImager( VideoImagerType * );

  FrameType* GetInternalFrame( void );

  void SetInternalFrame( FrameType* );

  void SetFrameDimensions( unsigned int * );
  void GetFrameDimensions( unsigned int * );

  igstkSetMacro( PixelDepth, unsigned int );
  igstkGetMacro( PixelDepth, unsigned int );

  igstkSetMacro( Delay, unsigned int );
  igstkGetMacro( Delay, unsigned int );

  igstk::Frame* GetFrameFromBuffer(const unsigned int index);
  igstk::Frame* GetTemporalCalibratedFrame();

protected:

  VideoImagerTool(void);
  virtual ~VideoImagerTool(void);

  virtual void PrintSelf( std::ostream& os, itk::Indent indent ) const;

  void SetVideoImagerToolIdentifier( const std::string identifier );

private:

  VideoImagerTool(const Self&);       //purposely not implemented
  void operator=(const Self&);    //purposely not implemented

  virtual void RequestReportImagingStarted( );

  virtual void RequestReportImagingStopped( );

  virtual void RequestReportImagingToolNotAvailable( );

  virtual void RequestReportImagingToolStreaming( );

  void RequestReportSuccessfulVideoImagerToolAttachment();

  void RequestReportFailedVideoImagerToolAttachment();

  igstkSetMacro( Updated, bool );

  virtual bool CheckIfVideoImagerToolIsConfigured( ) const = 0;

  igstkDeclareInputMacro( ConfigureTool );
  igstkDeclareInputMacro( ToolConfigurationSuccess );
  igstkDeclareInputMacro( ToolConfigurationFailure );
  igstkDeclareInputMacro( AttachToolToVideoImager );
  igstkDeclareInputMacro( ImagingStarted );
  igstkDeclareInputMacro( ImagingStopped );
  igstkDeclareInputMacro( VideoImagerToolNotAvailable );
  igstkDeclareInputMacro( VideoImagerToolStreaming );
  igstkDeclareInputMacro( DetachVideoImagerToolFromVideoImager );
  igstkDeclareInputMacro( AttachmentToVideoImagerSuccess );
  igstkDeclareInputMacro( AttachmentToVideoImagerFailure );
  igstkDeclareInputMacro( DetachmentFromVideoImagerSuccess );
  igstkDeclareInputMacro( DetachmentFromVideoImagerFailure );
  igstkDeclareInputMacro( GetFrame );

  igstkDeclareStateMacro( Idle );
  igstkDeclareStateMacro( AttemptingToConfigureVideoImagerTool );
  igstkDeclareStateMacro( Configured );
  igstkDeclareStateMacro( AttemptingToAttachVideoImagerToolToVideoImager );
  igstkDeclareStateMacro( Attached );
  igstkDeclareStateMacro( AttemptingToDetachVideoImagerToolFromVideoImager );
  igstkDeclareStateMacro( NotAvailable );
  igstkDeclareStateMacro( Streaming );

  void AttemptToConfigureProcessing( void );

  void AttemptToAttachVideoImagerToolToVideoImagerProcessing( void );

  void VideoImagerToolConfigurationSuccessProcessing( void );

  void VideoImagerToolConfigurationFailureProcessing( void );

  void VideoImagerToolAttachmentToVideoImagerSuccessProcessing( void );

  void VideoImagerToolAttachmentToVideoImagerFailureProcessing( void );

  void AttemptToDetachVideoImagerToolFromVideoImagerProcessing( void );

  void VideoImagerToolDetachmentFromVideoImagerSuccessProcessing( void );

  void VideoImagerToolDetachmentFromVideoImagerFailureProcessing( void );

  void GetFrameProcessing( void );

  void ReportVideoImagerToolStreamingStateProcessing( void );

  void ReportVideoImagerToolNotAvailableProcessing( void );

  void ReportImagingStartedProcessing( void );

  void ReportImagingStoppedProcessing( void );

  void ReportInvalidRequestProcessing( void );

  void ReportInvalidRequestToAttachVideoImagerToolProcessing( void );

  void ReportInvalidRequestToDetachVideoImagerToolProcessing( void );

  void NoProcessing( void );

  void AddFrameToBuffer( igstk::Frame* frame);

  std::vector< igstk::Frame* > *m_FrameRingBuffer;

  int                           m_Index;
  unsigned int                  m_NumberOfFramesInBuffer;
  unsigned int                  m_MaxBufferSize;
  unsigned int                  m_Delay;
  unsigned int                  m_FrameDimensions[3];
  unsigned int                  m_PixelDepth;

  bool                          m_Updated;

  std::string        m_VideoImagerToolIdentifier;

  VideoImager        * m_VideoImagerToAttachTo;

  igstkCoordinateSystemClassInterfaceMacro();

  CoordinateSystem::Pointer   m_CalibrationCoordinateSystem;
};

std::ostream& operator<<(std::ostream& os, const VideoImagerTool& o);

}

#endif //__igstk_VideoImagerTool_h_