vtkPlusSpinnakerVideoSource.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Progra  : Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

#ifndef __vtkPlusSpinnakerVideoSource_h
#define __vtkPlusSpinnakerVideoSource_h

#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusDevice.h"
#include <string>

class vtkPlusDataCollectionExport vtkPlusSpinnakerVideoSource : public vtkPlusDevice
{
public:

  static vtkPlusSpinnakerVideoSource *New();
  
  vtkTypeMacro(vtkPlusSpinnakerVideoSource, vtkPlusDevice);
  void PrintConfiguration(ostream& os, vtkIndent indent);
  virtual void PrintSelf(ostream& os, vtkIndent indent);

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* config);
  PlusStatus WriteConfiguration(vtkXMLDataElement* config);

  bool IsTracker() const { return false; }
  bool IsVirtual() const { return false; }
  
  virtual PlusStatus NotifyConfigured();

  // available pixel encodings
  enum PIXEL_ENCODING
  {
    RGB24 = 0,
    MONO8
  };

  // enums for camera controls
  enum EXPOSURE_MODE
  {
    EXPOSURE_TIMED = 0,
    EXPOSURE_AUTO_ONCE,
    EXPOSURE_AUTO_CONTINUOUS
  };

  enum GAIN_MODE
  {
    GAIN_MANUAL = 0,
    GAIN_AUTO_ONCE,
    GAIN_AUTO_CONTINUOUS
  };

  enum WHITE_BALANCE_MODE
  {
    WB_MANUAL = 0,
    WB_AUTO_ONCE,
    WB_AUTO_CONTINUOUS
  };

protected:
  PlusStatus InternalStartRecording();

  PlusStatus InternalStopRecording();

  virtual PlusStatus InternalUpdate();

  virtual PlusStatus InternalConnect();
  virtual PlusStatus InternalDisconnect();

  // methods to set & get camera parameters
  vtkGetMacro(CameraNumber, unsigned int);
  vtkSetMacro(CameraNumber, unsigned int);
  vtkGetMacro(PixelEncoding, PIXEL_ENCODING);
  vtkSetMacro(PixelEncoding, PIXEL_ENCODING);
  PlusStatus SetFrameRate(int FrameRate);
  EXPOSURE_MODE GetExposureMode() { return this->ExposureMode; }
  PlusStatus SetExposureMode(EXPOSURE_MODE expMode);
  vtkGetMacro(ExposureMicroSec, float);
  PlusStatus SetExposureMicroSec(int exposureMicroSec);
  GAIN_MODE GetGainMode() { return this->GainMode; }
  PlusStatus SetGainMode(GAIN_MODE gainMode);
  vtkGetMacro(GainDB, float);
  PlusStatus SetGainDB(int gainDb);
  WHITE_BALANCE_MODE GetWhiteBalanceMode() { return this->WhiteBalanceMode; }
  PlusStatus SetWhiteBalanceMode(WHITE_BALANCE_MODE wbMode);
  vtkGetMacro(WhiteBalanceRed, float);
  vtkSetMacro(WhiteBalanceRed, float);
  vtkGetMacro(WhiteBalanceBlue, float);
  vtkSetMacro(WhiteBalanceBlue, float);

  // check camera parameters as set are valid
  PlusStatus CheckCameraParameterValidity();

protected:
  vtkPlusSpinnakerVideoSource();
  ~vtkPlusSpinnakerVideoSource();
  
  // frame configuration
  int CameraNumber;
  PIXEL_ENCODING PixelEncoding;
  FrameSizeType FrameSize;
  int FrameRate;

  // camera configuration
  EXPOSURE_MODE ExposureMode;
  float ExposureMicroSec;
  GAIN_MODE GainMode;
  float GainDB;
  WHITE_BALANCE_MODE WhiteBalanceMode;
  float WhiteBalanceRed;
  float WhiteBalanceBlue;

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

  class vtkInternal;
  vtkInternal* Internal;

  unsigned long FrameNumber;
};

#endif