Chaste  Build::
NetworkToImage< DIM > Class Template Reference

#include <NetworkToImage.hpp>

+ Collaboration diagram for NetworkToImage< DIM >:

Public Member Functions

 NetworkToImage ()
 
 ~NetworkToImage ()
 
vtkSmartPointer< vtkImageData > GetOutput ()
 
void SetNetwork (boost::shared_ptr< VesselNetwork< DIM > > pNetwork)
 
void SetGridSpacing (units::quantity< unit::length > spacing)
 
void SetPaddingFactors (double paddingX, double paddingY, double paddingZ)
 
void SetImageDimension (unsigned dimension)
 
void Update ()
 

Static Public Member Functions

static boost::shared_ptr< NetworkToImage< DIM > > Create ()
 

Private Attributes

vtkSmartPointer< vtkImageData > mpImage
 
boost::shared_ptr< VesselNetwork< DIM > > mpNetwork
 
units::quantity< unit::length > mGridSpacing
 
c_vector< double, DIM > mPaddingFactors
 
unsigned mImageDimension
 

Detailed Description

template<unsigned DIM>
class NetworkToImage< DIM >

Convert a vessel network to vtk image data. This can be used for visualization or as input to centreline/mesh tools.

Definition at line 51 of file NetworkToImage.hpp.

Constructor & Destructor Documentation

template<unsigned DIM>
NetworkToImage< DIM >::NetworkToImage ( )

Constructor

Definition at line 46 of file NetworkToImage.cpp.

template<unsigned DIM>
NetworkToImage< DIM >::~NetworkToImage ( )

Destructor

Definition at line 64 of file NetworkToImage.cpp.

Member Function Documentation

template<unsigned DIM>
boost::shared_ptr< NetworkToImage< DIM > > NetworkToImage< DIM >::Create ( )
static

Factory constructor method

Returns
a pointer to the class

Definition at line 57 of file NetworkToImage.cpp.

Referenced by NetworkToSurface< DIM >::Update().

template<unsigned DIM>
vtkSmartPointer< vtkImageData > NetworkToImage< DIM >::GetOutput ( )

Get the image

Returns
a pointer to the image representation of the network

Definition at line 70 of file NetworkToImage.cpp.

References NetworkToImage< DIM >::mpImage.

template<unsigned DIM>
void NetworkToImage< DIM >::SetGridSpacing ( units::quantity< unit::length >  spacing)

Set the pixel spacing for the image

Parameters
spacingthe pixel spacing

Definition at line 89 of file NetworkToImage.cpp.

References NetworkToImage< DIM >::mGridSpacing.

template<unsigned DIM>
void NetworkToImage< DIM >::SetImageDimension ( unsigned  dimension)

Set the image dimension. Although the class is templated over spatial dimension, it is often of interest to make 2D images. The image dimension can be set here.

Parameters
dimensionthe image dimension

Definition at line 106 of file NetworkToImage.cpp.

References NetworkToImage< DIM >::mImageDimension.

template<unsigned DIM>
void NetworkToImage< DIM >::SetNetwork ( boost::shared_ptr< VesselNetwork< DIM > >  pNetwork)

Set the vessel network

Parameters
pNetworkthe network

Definition at line 83 of file NetworkToImage.cpp.

References NetworkToImage< DIM >::mpNetwork.

template<unsigned DIM>
void NetworkToImage< DIM >::SetPaddingFactors ( double  paddingX,
double  paddingY,
double  paddingZ 
)

Set the padding factors for the image. This is multiplied by the network extents to add padding. Eg. final_extent = original_extent * (1+padding factor)

Parameters
paddingXthe X padding factor
paddingYthe Y padding factor
paddingZthe Z padding factor

Definition at line 95 of file NetworkToImage.cpp.

References NetworkToImage< DIM >::mPaddingFactors.

Member Data Documentation

template<unsigned DIM>
units::quantity<unit::length> NetworkToImage< DIM >::mGridSpacing
private

The grid spacing

Definition at line 66 of file NetworkToImage.hpp.

Referenced by NetworkToImage< DIM >::SetGridSpacing(), and NetworkToImage< DIM >::Update().

template<unsigned DIM>
unsigned NetworkToImage< DIM >::mImageDimension
private

The dimension of the output image

Definition at line 76 of file NetworkToImage.hpp.

Referenced by NetworkToImage< DIM >::SetImageDimension(), and NetworkToImage< DIM >::Update().

template<unsigned DIM>
c_vector<double, DIM> NetworkToImage< DIM >::mPaddingFactors
private

The padding factors in each direction

Definition at line 71 of file NetworkToImage.hpp.

Referenced by NetworkToImage< DIM >::SetPaddingFactors(), and NetworkToImage< DIM >::Update().

template<unsigned DIM>
vtkSmartPointer<vtkImageData> NetworkToImage< DIM >::mpImage
private

The image

Definition at line 56 of file NetworkToImage.hpp.

Referenced by NetworkToImage< DIM >::GetOutput(), and NetworkToImage< DIM >::Update().

template<unsigned DIM>
boost::shared_ptr<VesselNetwork<DIM> > NetworkToImage< DIM >::mpNetwork
private

The vessel network

Definition at line 61 of file NetworkToImage.hpp.

Referenced by NetworkToImage< DIM >::SetNetwork(), and NetworkToImage< DIM >::Update().


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