IGSTK
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | List of all members
igstk::UltrasoundImageSimulator< TImageGeometricModel > Class Template Reference

This class simulates an ultrasound image by extracting a slice from a 3D MR or CT image. More...

#include <igstkUltrasoundImageSimulator.h>

Inheritance diagram for igstk::UltrasoundImageSimulator< TImageGeometricModel >:
Inheritance graph
[legend]
Collaboration diagram for igstk::UltrasoundImageSimulator< TImageGeometricModel >:
Collaboration graph
[legend]

Public Member Functions

void RequestSetTransform (const TransformType &transform)
 Request to set vector 2 on the plane.
void RequestSetImageGeometricModel (const ImageGeometricModelType *imageGeometricObject)
 Connect this representation class to the spatial object.
void RequestReslice ()
 Request reslice a 3D image.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void RequestGetImage ()
 Declare the UltrasoundImageSimulator class to be a friend in order to give it access to the private method GetVTKImage().
 igstkLoadedObjectEventMacro (ImageModifiedEvent, IGSTKEvent, USImageObject)
 Event type.
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Public Attributes

igstkStandardTemplatedClassTraitsMacro(UltrasoundImageSimulator,
Object) public typedef
Transform 
TransformType
 Macro with standard traits declarations.

Protected Types

typedef
ImageGeometricModelType::ConstPointer 
ImageGeometricModelConstPointer
 Types required for internal implementation.
typedef
ImageGeometricModelType::PointType 
PointType
typedef USImageObject::ImageType USImageType
typedef
ImageGeometricModelType::ImageType 
MRImageType

Protected Member Functions

 UltrasoundImageSimulator ()
 Constructor.
 ~UltrasoundImageSimulator ()
 Destructor.
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () 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

- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs.
typedef ::itk::Object Superclass
typedef ::itk::SmartPointer< SelfPointer
typedef ::itk::SmartPointer
< const Self
ConstPointer
typedef igstk::Logger LoggerType
- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)

Detailed Description

template<class TImageGeometricModel>
class igstk::UltrasoundImageSimulator< TImageGeometricModel >

This class simulates an ultrasound image by extracting a slice from a 3D MR or CT image.

Since most ultrasound systems provide images via a live feed, it is difficult to test Ultrasound applications offline. This class is intended to provide a simulation of Ultrasound images by reading a CT or MR image and extracting an slice from it.

Warning
This class should ONLY be used for testing purposes, and not as part of a final application.

Definition at line 88 of file igstkUltrasoundImageSimulator.h.

Member Typedef Documentation

template<class TImageGeometricModel >
typedef ImageGeometricModelType::ConstPointer igstk::UltrasoundImageSimulator< TImageGeometricModel >::ImageGeometricModelConstPointer
protected

Types required for internal implementation.

Definition at line 137 of file igstkUltrasoundImageSimulator.h.

template<class TImageGeometricModel >
typedef ImageGeometricModelType::PointType igstk::UltrasoundImageSimulator< TImageGeometricModel >::PointType
protected

Definition at line 139 of file igstkUltrasoundImageSimulator.h.

template<class TImageGeometricModel >
typedef USImageObject::ImageType igstk::UltrasoundImageSimulator< TImageGeometricModel >::USImageType
protected

Definition at line 140 of file igstkUltrasoundImageSimulator.h.

template<class TImageGeometricModel >
typedef ImageGeometricModelType::ImageType igstk::UltrasoundImageSimulator< TImageGeometricModel >::MRImageType
protected

Definition at line 141 of file igstkUltrasoundImageSimulator.h.

Constructor & Destructor Documentation

template<class TImageGeometricModel >
igstk::UltrasoundImageSimulator< TImageGeometricModel >::UltrasoundImageSimulator ( )
protected

Constructor.

template<class TImageGeometricModel >
igstk::UltrasoundImageSimulator< TImageGeometricModel >::~UltrasoundImageSimulator ( )
protected

Destructor.

Member Function Documentation

template<class TImageGeometricModel >
void igstk::UltrasoundImageSimulator< TImageGeometricModel >::RequestSetTransform ( const TransformType transform)

Request to set vector 2 on the plane.

template<class TImageGeometricModel >
void igstk::UltrasoundImageSimulator< TImageGeometricModel >::RequestSetImageGeometricModel ( const ImageGeometricModelType *  imageGeometricObject)

Connect this representation class to the spatial object.

template<class TImageGeometricModel >
void igstk::UltrasoundImageSimulator< TImageGeometricModel >::RequestReslice ( )

Request reslice a 3D image.

template<class TImageGeometricModel >
virtual void igstk::UltrasoundImageSimulator< TImageGeometricModel >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
virtual

Print the object information in a stream.

Reimplemented from igstk::Object.

template<class TImageGeometricModel >
void igstk::UltrasoundImageSimulator< TImageGeometricModel >::RequestGetImage ( )

Declare the UltrasoundImageSimulator class to be a friend in order to give it access to the private method GetVTKImage().

Request to get the output image as an event

template<class TImageGeometricModel >
igstk::UltrasoundImageSimulator< TImageGeometricModel >::igstkLoadedObjectEventMacro ( ImageModifiedEvent  ,
IGSTKEvent  ,
USImageObject   
)

Event type.

Member Data Documentation

template<class TImageGeometricModel >
igstkStandardTemplatedClassTraitsMacro ( UltrasoundImageSimulator,Object) public typedef Transform igstk::UltrasoundImageSimulator< TImageGeometricModel >::TransformType

Macro with standard traits declarations.

Definition at line 94 of file igstkUltrasoundImageSimulator.h.


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