CustusX  2021.04.21-dev+develop.337f9
An IGT application
cx::BasicVideoSource Class Reference

VideoSource controlled by a vtkImageData. More...

#include <cxBasicVideoSource.h>

Inheritance diagram for cx::BasicVideoSource:
cx::VideoSource

Public Member Functions

 BasicVideoSource (QString uid="<none>")
 
virtual ~BasicVideoSource ()
 
virtual QString getUid ()
 
virtual QString getName ()
 
virtual vtkImageDataPtr getVtkImageData ()
 
virtual double getTimestamp ()
 
virtual TimeInfo getAdvancedTimeInfo ()
 
virtual QString getInfoString () const
 an information text intended to be visible along with the data stream at all times More...
 
virtual QString getStatusString () const
 status text describing the stream state, display instead of stream when the stream is invalid. More...
 
virtual void start ()
 start streaming More...
 
virtual void stop ()
 stop streaming More...
 
virtual bool validData () const
 return true is data stream is ok to display. This is a heuristic based on the data rate. More...
 
virtual bool isConnected () const
 return true when a connection to the data source is established. More...
 
virtual bool isStreaming () const
 return true when the source is streaming data. More...
 
virtual void setResolution (double resolution)
 
void setInput (ImagePtr input)
 
void setInfoString (QString text)
 
void setStatusString (QString text)
 
void deconfigure ()
 
void overrideTimeout (bool timeout)
 
- Public Member Functions inherited from cx::VideoSource
virtual ~VideoSource ()
 

Additional Inherited Members

- Signals inherited from cx::VideoSource
void streaming (bool on)
 emitted when streaming started/stopped More...
 
void connected (bool on)
 emitted when source is connected/disconnected More...
 
void newFrame ()
 emitted when a new frame has arrived (getVtkImageData() returns something new). info/status/name/valid might also have changed More...
 

Detailed Description

VideoSource controlled by a vtkImageData.

Primitive implementation of the VideoSource interface. Use the interface extensions to control the input: Set a vtkImageData and

Date
April 26, 2013
Author
Christian Askeland, SINTEF

Definition at line 44 of file cxBasicVideoSource.h.

Constructor & Destructor Documentation

cx::BasicVideoSource::BasicVideoSource ( QString  uid = "<none>")
explicit

Definition at line 28 of file cxBasicVideoSource.cpp.

cx::BasicVideoSource::~BasicVideoSource ( )
virtual

Definition at line 48 of file cxBasicVideoSource.cpp.

Member Function Documentation

void cx::BasicVideoSource::deconfigure ( )
inline

Definition at line 85 of file cxBasicVideoSource.h.

TimeInfo cx::BasicVideoSource::getAdvancedTimeInfo ( )
virtual

Implements cx::VideoSource.

Definition at line 94 of file cxBasicVideoSource.cpp.

virtual QString cx::BasicVideoSource::getInfoString ( ) const
inlinevirtual

an information text intended to be visible along with the data stream at all times

Implements cx::VideoSource.

Definition at line 58 of file cxBasicVideoSource.h.

QString cx::BasicVideoSource::getName ( )
virtual

Implements cx::VideoSource.

Definition at line 69 of file cxBasicVideoSource.cpp.

QString cx::BasicVideoSource::getStatusString ( ) const
virtual

status text describing the stream state, display instead of stream when the stream is invalid.

Implements cx::VideoSource.

Definition at line 154 of file cxBasicVideoSource.cpp.

double cx::BasicVideoSource::getTimestamp ( )
virtual

Implements cx::VideoSource.

Definition at line 89 of file cxBasicVideoSource.cpp.

QString cx::BasicVideoSource::getUid ( )
virtual

Implements cx::VideoSource.

Definition at line 65 of file cxBasicVideoSource.cpp.

vtkImageDataPtr cx::BasicVideoSource::getVtkImageData ( )
virtual

Implements cx::VideoSource.

Definition at line 114 of file cxBasicVideoSource.cpp.

bool cx::BasicVideoSource::isConnected ( ) const
virtual

return true when a connection to the data source is established.

Implements cx::VideoSource.

Definition at line 99 of file cxBasicVideoSource.cpp.

bool cx::BasicVideoSource::isStreaming ( ) const
virtual

return true when the source is streaming data.

Implements cx::VideoSource.

Definition at line 104 of file cxBasicVideoSource.cpp.

void cx::BasicVideoSource::overrideTimeout ( bool  timeout)

Disable internal timeout checking, instead set timeout directly.

Definition at line 53 of file cxBasicVideoSource.cpp.

void cx::BasicVideoSource::setInfoString ( QString  text)
inline

Definition at line 83 of file cxBasicVideoSource.h.

void cx::BasicVideoSource::setInput ( ImagePtr  input)

Set an image that is used for output.

Set a new image for each new frame. Only the vtkImageData, uid and timestamp are used, also make sure the uid is unchanged for each setInput().

Setting an input indicates connect(), settings an empty input indicates disconnect()

Definition at line 171 of file cxBasicVideoSource.cpp.

void cx::BasicVideoSource::setResolution ( double  mmPerPixel)
virtual

Set the resolution of the incoming video in mm/pixel

Reimplemented from cx::VideoSource.

Definition at line 109 of file cxBasicVideoSource.cpp.

void cx::BasicVideoSource::setStatusString ( QString  text)
inline

Definition at line 84 of file cxBasicVideoSource.h.

void cx::BasicVideoSource::start ( )
virtual

start streaming

Implements cx::VideoSource.

Definition at line 120 of file cxBasicVideoSource.cpp.

void cx::BasicVideoSource::stop ( )
virtual

stop streaming

Implements cx::VideoSource.

Definition at line 139 of file cxBasicVideoSource.cpp.

bool cx::BasicVideoSource::validData ( ) const
virtual

return true is data stream is ok to display. This is a heuristic based on the data rate.

Implements cx::VideoSource.

Definition at line 84 of file cxBasicVideoSource.cpp.


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