NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Classes | Public Types | Public Member Functions | Public Attributes | Protected Slots | Protected Member Functions | List of all members
niftk::NVidiaSDIDataSourceService Class Reference

Provides an NVidia SDI video feed, as an IGIDataSourceServiceI. More...

Inheritance diagram for niftk::NVidiaSDIDataSourceService:
Inheritance graph
[legend]
Collaboration diagram for niftk::NVidiaSDIDataSourceService:
Collaboration graph
[legend]

Public Types

enum  InterlacedBehaviour { DO_NOTHING_SPECIAL = 0, DROP_ONE_FIELD = 1, STACK_FIELDS = 2, SPLIT_LINE_INTERLEAVED_STEREO = 3 }
 

Public Member Functions

 mitkClassMacroItkParent (NVidiaSDIDataSourceService, IGIDataSource) mitkNewMacro3Param(NVidiaSDIDataSourceService
 
virtual void GrabData () override
 
virtual void CleanBuffer () override
 
virtual void StartPlayback (niftk::IGIDataType::IGITimeType firstTimeStamp, niftk::IGIDataType::IGITimeType lastTimeStamp) override
 
void PlaybackData (niftk::IGIDataType::IGITimeType requestedTimeStamp) override
 
virtual void StopPlayback () override
 
virtual std::vector
< IGIDataItemInfo
Update (const niftk::IGIDataType::IGITimeType &time) override
 
bool ProbeRecordedData (niftk::IGIDataType::IGITimeType *firstTimeStampInStore, niftk::IGIDataType::IGITimeType *lastTimeStampInStore) override
 
virtual void SetProperties (const IGIDataSourceProperties &properties) override
 IGIDataSourceI::SetProperties() More...
 
virtual IGIDataSourceProperties GetProperties () const override
 IGIDataSourceI::GetProperties() More...
 
void SetMipmapLevel (unsigned int l)
 
void SetFieldMode (InterlacedBehaviour b)
 
InterlacedBehaviour GetFieldMode () const
 
int GetNumberOfStreams ()
 
int GetCaptureWidth ()
 
int GetCaptureHeight ()
 
int GetRefreshRate ()
 
int GetTextureId (int stream)
 
const char * GetWireFormatString ()
 
- Public Member Functions inherited from niftk::IGIDataSource
 mitkClassMacroItkParent (IGIDataSource, niftk::IGIDataSourceI) virtual QString GetName() const override
 
virtual QString GetFactoryName () const override
 
virtual QString GetStatus () const override
 
QString GetDescription () const override
 
virtual bool GetShouldUpdate () const override
 
virtual void SetShouldUpdate (bool shouldUpdate) override
 
virtual void StartRecording () override
 
virtual void StopRecording () override
 
virtual void SetRecordingLocation (const QString &pathName) override
 
virtual QString GetRecordingLocation () const override
 
virtual void SetPlaybackSourceName (const QString &sourceName) override
 
virtual QString GetPlaybackSourceName () const override
 
QString GetPlaybackDirectory () const
 Returns this->GetRecordingLocation() slash this->GetPlaybackSourceName(). More...
 
QString GetRecordingDirectory () const
 Returns this->GetRecordingLocation() slash this->GetName(). More...
 
virtual bool GetIsRecording () const
 
virtual bool GetIsPlayingBack () const
 
virtual void SetTimeStampTolerance (niftk::IGIDataType::IGITimeType _arg)
 
virtual
niftk::IGIDataType::IGITimeType 
GetTimeStampTolerance () const
 
- Public Member Functions inherited from niftk::IGIDataSourceI
 mitkClassMacroItkParent (IGIDataSourceI, itk::Object) virtual QString GetName() const =0
 Returns the unique name of the data source, e.g. OpenCV-0. More...
 

Public Attributes

 QString
 

Protected Slots

void ShowFatalErrorMessage (QString msg)
 

Protected Member Functions

 NVidiaSDIDataSourceService (QString factoryName, const IGIDataSourceProperties &properties, mitk::DataStorage::Pointer dataStorage)
 
virtual ~NVidiaSDIDataSourceService ()
 
- Protected Member Functions inherited from niftk::IGIDataSource
 IGIDataSource (const std::string &name, const std::string &factoryName, mitk::DataStorage::Pointer dataStorage)
 
virtual ~IGIDataSource ()
 
 IGIDataSource (const IGIDataSource &)
 
IGIDataSourceoperator= (const IGIDataSource &)
 
mitk::DataNode::Pointer GetDataNode (const QString &name=QString(), const bool &addToDataStorage=true)
 Derived classes request a node for a given name. If the node does not exist, it will be created with some default properties. More...
 
bool IsLate (const niftk::IGIDataType::IGITimeType &requested, const niftk::IGIDataType::IGITimeType &actual) const
 Returns true if the delay between requested and actual is greater than the TimeStampTolerance, and false otherwise. More...
 
unsigned int GetLagInMilliseconds (const niftk::IGIDataType::IGITimeType &requested, const niftk::IGIDataType::IGITimeType &actual) const
 Simply checks the difference in time, and converts to milliseconds. More...
 
mitk::DataStorage::Pointer GetDataStorage () const
 Returns the pointer to the internal data storage. More...
 
niftk::IGIDataType::IGITimeType GetTimeStampInNanoseconds ()
 Queries the internal igtl::TimeStamp to get an up-to-date timestamp. More...
 
virtual void SetIsRecording (bool _arg)
 
virtual void SetIsPlayingBack (bool _arg)
 
void SetStatus (const QString &status)
 
void SetDescription (const QString &description)
 
- Protected Member Functions inherited from niftk::IGIDataSourceI
 IGIDataSourceI ()
 
virtual ~IGIDataSourceI ()
 
- Protected Member Functions inherited from niftk::IGILocalDataSourceI
 IGILocalDataSourceI ()
 
virtual ~IGILocalDataSourceI ()
 
 IGILocalDataSourceI (const IGILocalDataSourceI &)
 
IGILocalDataSourceIoperator= (const IGILocalDataSourceI &)
 
- Protected Member Functions inherited from niftk::IGICleanableDataSourceI
 IGICleanableDataSourceI ()
 
virtual ~IGICleanableDataSourceI ()
 
 IGICleanableDataSourceI (const IGICleanableDataSourceI &)
 
IGICleanableDataSourceIoperator= (const IGICleanableDataSourceI &)
 

Detailed Description

Provides an NVidia SDI video feed, as an IGIDataSourceServiceI.

Note: All errors should thrown as mitk::Exception or sub-classes thereof.

Member Enumeration Documentation

Enumerator
DO_NOTHING_SPECIAL 
DROP_ONE_FIELD 
STACK_FIELDS 
SPLIT_LINE_INTERLEAVED_STEREO 

No longer supported!

Constructor & Destructor Documentation

niftk::NVidiaSDIDataSourceService::NVidiaSDIDataSourceService ( QString  factoryName,
const IGIDataSourceProperties properties,
mitk::DataStorage::Pointer  dataStorage 
)
protected
niftk::NVidiaSDIDataSourceService::~NVidiaSDIDataSourceService ( )
protectedvirtual

Member Function Documentation

void niftk::NVidiaSDIDataSourceService::CleanBuffer ( )
overridevirtual
See also
niftk::IGIDataSource::CleanBuffer()

Implements niftk::IGICleanableDataSourceI.

int niftk::NVidiaSDIDataSourceService::GetCaptureHeight ( )
int niftk::NVidiaSDIDataSourceService::GetCaptureWidth ( )
NVidiaSDIDataSourceService::InterlacedBehaviour niftk::NVidiaSDIDataSourceService::GetFieldMode ( ) const
int niftk::NVidiaSDIDataSourceService::GetNumberOfStreams ( )
IGIDataSourceProperties niftk::NVidiaSDIDataSourceService::GetProperties ( ) const
overridevirtual
int niftk::NVidiaSDIDataSourceService::GetRefreshRate ( )
int niftk::NVidiaSDIDataSourceService::GetTextureId ( int  stream)
const char * niftk::NVidiaSDIDataSourceService::GetWireFormatString ( )
void niftk::NVidiaSDIDataSourceService::GrabData ( )
overridevirtual
niftk::NVidiaSDIDataSourceService::mitkClassMacroItkParent ( NVidiaSDIDataSourceService  ,
IGIDataSource   
)
void niftk::NVidiaSDIDataSourceService::PlaybackData ( niftk::IGIDataType::IGITimeType  requestedTimeStamp)
overridevirtual
bool niftk::NVidiaSDIDataSourceService::ProbeRecordedData ( niftk::IGIDataType::IGITimeType firstTimeStampInStore,
niftk::IGIDataType::IGITimeType lastTimeStampInStore 
)
overridevirtual
void niftk::NVidiaSDIDataSourceService::SetFieldMode ( InterlacedBehaviour  b)
void niftk::NVidiaSDIDataSourceService::SetMipmapLevel ( unsigned int  l)

From here down until 'protected:', importing Johannes's QmitkIGINVidiaDataSource API.

void niftk::NVidiaSDIDataSourceService::SetProperties ( const IGIDataSourceProperties properties)
overridevirtual
void niftk::NVidiaSDIDataSourceService::ShowFatalErrorMessage ( QString  msg)
protectedslot
void niftk::NVidiaSDIDataSourceService::StartPlayback ( niftk::IGIDataType::IGITimeType  firstTimeStamp,
niftk::IGIDataType::IGITimeType  lastTimeStamp 
)
overridevirtual
void niftk::NVidiaSDIDataSourceService::StopPlayback ( )
overridevirtual
std::vector< IGIDataItemInfo > niftk::NVidiaSDIDataSourceService::Update ( const niftk::IGIDataType::IGITimeType time)
overridevirtual

Member Data Documentation

niftk::NVidiaSDIDataSourceService::QString

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