IGSTK
|
This imager provides support for socket communication (using the Open IGTLink protocol) to the OpenIGTLink system. More...
#include <igstkOpenIGTLinkVideoImager.h>
Protected Types | |
typedef VideoImager::ResultType | ResultType |
Typedef for internal boolean return type. | |
![]() | |
enum | ResultType { FAILURE = 0, SUCCESS } |
typedef Transform::TimePeriodType | TimePeriodType |
typedef for times used by the VideoImager | |
typedef Transform | TransformType |
typedefs from Transform class | |
typedef Frame | FrameType |
typedefs from Frame class | |
typedef std::map< std::string, VideoImagerToolType * > | VideoImagerToolsContainerType |
typedefs from VideoImagerTool class |
Protected Member Functions | |
OpenIGTLinkVideoImager (void) | |
virtual | ~OpenIGTLinkVideoImager (void) |
virtual ResultType | InternalOpen (void) |
Open communication with the tracking device. | |
virtual ResultType | InternalClose (void) |
Close communication with the tracking device. | |
virtual ResultType | InternalStartImaging (void) |
Put the tracking device into tracking mode. | |
virtual ResultType | InternalStopImaging (void) |
Take the tracking device out of tracking mode. | |
virtual ResultType | InternalUpdateStatus (void) |
Update the status and the transforms for all VideoImagerTools. | |
virtual ResultType | InternalThreadedUpdateStatus (void) |
Update the status and the transforms. | |
virtual ResultType | InternalReset (void) |
Reset the tracking 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 tracking 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 from internal containers. | |
![]() | |
VideoImager (void) | |
virtual | ~VideoImager (void) |
virtual void | SetThreadingEnabled (bool _arg) |
SetThreadingEnabled(bool) : set m_ThreadingEnabled value. | |
virtual bool | GetThreadingEnabled () |
GetThreadingEnabled(bool) : get m_ThreadingEnabled value. | |
virtual TimePeriodType | GetValidityTime () |
Get the validity time. | |
const VideoImagerToolsContainerType & | GetVideoImagerToolContainer () const |
Access method for the VideoImager tool container. | |
void | ReportImagingToolNotAvailable (VideoImagerToolType *VideoImagerTool) const |
Report to VideoImager tool that it is not available for imaging. | |
void | ReportImagingToolStreaming (VideoImagerToolType *videoImagerTool) const |
Report to VideoImager tool that it is streaming. | |
void | SetVideoImagerToolFrame (VideoImagerToolType *videoImagerTool, FrameType *frame) |
FrameType * | GetVideoImagerToolFrame (VideoImagerToolType *videoImagerTool) |
void | SetVideoImagerToolUpdate (VideoImagerToolType *videoImagerTool, bool flag) const |
Turn on/off update flag of the VideoImager tool. | |
void | ExitImagingStateProcessing (void) |
Always called when exiting imaging state. | |
void | ExitImagingWithoutTerminatingImagingThread () |
Exit imaging without terminating imaging thread. | |
void | ExitImagingTerminatingImagingThread () |
Exit imaging after terminating imaging thread. | |
![]() | |
LoggerType * | GetLogger () const |
Object (void) | |
Constructor is protected in order to enforce the use of the New() operator. | |
virtual | ~Object (void) |
void | RegisterObservedObject (const ::igstk::Object *object, unsigned long tag) |
Register observed objects in an internal array so that they can be disconnected upon destruction. | |
void | RemoveFromObservedObjects () |
Remove observers that this object may have connected to other objects. |
Additional Inherited Members | |
![]() | |
typedef Object | Self |
General Typedefs. | |
typedef ::itk::Object | Superclass |
typedef ::itk::SmartPointer< Self > | Pointer |
typedef ::itk::SmartPointer < const Self > | ConstPointer |
typedef igstk::Logger | LoggerType |
![]() | |
void | RequestOpen (void) |
The "RequestOpen" method attempts to open communication with the imaging device. | |
void | RequestClose (void) |
The "RequestClose" method closes communication with the device. | |
void | RequestReset (void) |
The "RequestReset" method should be used to bring the VideoImager | |
void | RequestStartImaging (void) |
The "RequestStartImaging" method readies the VideoImager for imaging the tools connected to the VideoImager. | |
void | RequestStopImaging (void) |
The "RequestStopImaging" stops VideoImager from imaging the tools. | |
void | RequestSetFrequency (double frequencyInHz) |
The "RequestSetFrequency" method defines the frequency at which a frame will be queried from the VideoImager device. | |
![]() | |
static Pointer | New (void) |
![]() | |
igstkStandardAbstractClassTraitsMacro(VideoImager, Object) public typedef VideoImagerTool | VideoImagerToolType |
Macro with standard traits declarations. |
This imager provides support for socket communication (using the Open IGTLink protocol) to the OpenIGTLink system.
Definition at line 46 of file igstkOpenIGTLinkVideoImager.h.
|
protected |
Typedef for internal boolean return type.
Definition at line 66 of file igstkOpenIGTLinkVideoImager.h.
|
protected |
|
protectedvirtual |
|
protectedvirtual |
Open communication with the tracking device.
Implements igstk::VideoImager.
|
protectedvirtual |
Close communication with the tracking device.
Implements igstk::VideoImager.
|
protectedvirtual |
Put the tracking device into tracking mode.
Implements igstk::VideoImager.
|
protectedvirtual |
Take the tracking device out of tracking mode.
Implements igstk::VideoImager.
|
protectedvirtual |
Update the status and the transforms for all VideoImagerTools.
Implements igstk::VideoImager.
|
protectedvirtual |
Update the status and the transforms.
This function is called by a separate thread.
Implements igstk::VideoImager.
|
protectedvirtual |
Reset the tracking device to put it back to its original state.
Implements igstk::VideoImager.
|
protectedvirtual |
Verify imager tool information.
Implements igstk::VideoImager.
|
protectedvirtual |
The "ValidateSpecifiedFrequency" method checks if the specified frequency is valid for the tracking device that is being used.
Reimplemented from igstk::VideoImager.
|
protectedvirtual |
Print object information.
Reimplemented from igstk::VideoImager.
|
protectedvirtual |
Remove imager tool entry from internal containers.
Implements igstk::VideoImager.
|
protectedvirtual |
Add imager tool entry from internal containers.
Implements igstk::VideoImager.