IGSTK
Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions
igstk::WebcamWinVideoImager Class Reference

This derivation of the VideoImager class provides communication to a Webcam in Windows. More...

#include <igstkWebcamWinVideoImager.h>

Inheritance diagram for igstk::WebcamWinVideoImager:
Inheritance graph
[legend]
Collaboration diagram for igstk::WebcamWinVideoImager:
Collaboration graph
[legend]

List of all members.

Public Attributes

 igstkStandardClassTraitsMacro (WebcamWinVideoImager, VideoImager) public
 Macro with standard traits declarations.

Static Public Attributes

static itk::MutexLock::Pointer m_FrameBufferLock
 Members and functions for communication with the webcam.

Protected Types

typedef VideoImager::ResultType ResultType
 Typedef for internal boolean return type.

Protected Member Functions

 WebcamWinVideoImager (void)
virtual ~WebcamWinVideoImager (void)
virtual ResultType InternalOpen (void)
 Open communication with the imaging device.
virtual ResultType InternalClose (void)
 Close communication with the imaging device.
virtual ResultType InternalStartImaging (void)
 Put the imaging device into imaging mode.
virtual ResultType InternalStopImaging (void)
 Take the imaging device out of imaging mode.
virtual ResultType InternalUpdateStatus (void)
 Update the status and the transforms for all VideoImagerTools.
virtual ResultType InternalThreadedUpdateStatus (void)
 Update the status and the frames.
virtual ResultType InternalReset (void)
 Reset the imaging device to put it back to its original state.
virtual ResultType VerifyVideoImagerToolInformation (const VideoImagerToolType *)
 Verify imager tool information.
virtual ResultType ValidateSpecifiedFrequency (double frequencyInHz)
 The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the imaging device that is being used.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.
virtual ResultType RemoveVideoImagerToolFromInternalDataContainers (const VideoImagerToolType *imagerTool)
 Remove imager tool entry from internal containers.
virtual ResultType AddVideoImagerToolToInternalDataContainers (const VideoImagerToolType *imagerTool)
 Add imager tool entry to internal containers.

Detailed Description

This derivation of the VideoImager class provides communication to a Webcam in Windows.

Definition at line 49 of file igstkWebcamWinVideoImager.h.


Member Typedef Documentation

Typedef for internal boolean return type.

Reimplemented from igstk::VideoImager.

Definition at line 67 of file igstkWebcamWinVideoImager.h.


Constructor & Destructor Documentation

igstk::WebcamWinVideoImager::WebcamWinVideoImager ( void  ) [protected]
virtual igstk::WebcamWinVideoImager::~WebcamWinVideoImager ( void  ) [protected, virtual]

Member Function Documentation

virtual ResultType igstk::WebcamWinVideoImager::InternalOpen ( void  ) [protected, virtual]

Open communication with the imaging device.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalClose ( void  ) [protected, virtual]

Close communication with the imaging device.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalStartImaging ( void  ) [protected, virtual]

Put the imaging device into imaging mode.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalStopImaging ( void  ) [protected, virtual]

Take the imaging device out of imaging mode.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalUpdateStatus ( void  ) [protected, virtual]

Update the status and the transforms for all VideoImagerTools.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalThreadedUpdateStatus ( void  ) [protected, virtual]

Update the status and the frames.

This function is called by a separate thread.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::InternalReset ( void  ) [protected, virtual]

Reset the imaging device to put it back to its original state.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::VerifyVideoImagerToolInformation ( const VideoImagerToolType ) [protected, virtual]

Verify imager tool information.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::ValidateSpecifiedFrequency ( double  frequencyInHz) [protected, virtual]

The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the imaging device that is being used.

Reimplemented from igstk::VideoImager.

virtual void igstk::WebcamWinVideoImager::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [protected, virtual]

Print object information.

Reimplemented from igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::RemoveVideoImagerToolFromInternalDataContainers ( const VideoImagerToolType imagerTool) [protected, virtual]

Remove imager tool entry from internal containers.

Implements igstk::VideoImager.

virtual ResultType igstk::WebcamWinVideoImager::AddVideoImagerToolToInternalDataContainers ( const VideoImagerToolType imagerTool) [protected, virtual]

Add imager tool entry to internal containers.

Implements igstk::VideoImager.


Member Data Documentation

Macro with standard traits declarations.

Get the number of tools that have been detected.

Definition at line 53 of file igstkWebcamWinVideoImager.h.

itk::MutexLock::Pointer igstk::WebcamWinVideoImager::m_FrameBufferLock [static]

Members and functions for communication with the webcam.

A mutex for multithreaded access to frameBuffer

Definition at line 138 of file igstkWebcamWinVideoImager.h.


The documentation for this class was generated from the following file: