Chaste  Build::
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
VesselNetworkReader< DIM > Class Template Reference

#include <VesselNetworkReader.hpp>

+ Collaboration diagram for VesselNetworkReader< DIM >:

Public Member Functions

 VesselNetworkReader ()
 
 ~VesselNetworkReader ()
 
boost::shared_ptr< VesselNetwork< DIM > > Read ()
 
void SetRadiusArrayName (const std::string &rRadius)
 
void SetMergeCoincidentPoints (bool mergePoints)
 
void SetTargetSegmentLength (units::quantity< unit::length > targetSegmentLength)
 
void SetFileName (const std::string &rFileName)
 
void SetReferenceLengthScale (units::quantity< unit::length > rReferenceLength)
 

Static Public Member Functions

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

Private Attributes

std::string mFileName
 
std::string mRadiusLabel
 
double mRadiusConversionFactor
 
bool mMergeCoincidentPoints
 
units::quantity< unit::length > mTargetSegmentLength
 
units::quantity< unit::length > mReferenceLength
 

Detailed Description

template<unsigned DIM>
class VesselNetworkReader< DIM >

Read vessel networks from file

Definition at line 48 of file VesselNetworkReader.hpp.

Constructor & Destructor Documentation

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

Constructor

Definition at line 52 of file VesselNetworkReader.cpp.

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

Destructor

Definition at line 64 of file VesselNetworkReader.cpp.

Member Function Documentation

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

Construct a new instance of the class and return a shared pointer to it.

Returns
a shared pointer to the class instance

Definition at line 69 of file VesselNetworkReader.cpp.

template<unsigned DIM>
boost::shared_ptr< VesselNetwork< DIM > > VesselNetworkReader< DIM >::Read ( )

Do the read and return the vessel network

Returns
the vessel network

Definition at line 100 of file VesselNetworkReader.cpp.

References VesselNetwork< DIM >::Create(), VesselSegment< DIM >::Create(), VesselNetworkReader< DIM >::mFileName, VesselNetworkReader< DIM >::mMergeCoincidentPoints, VesselNetworkReader< DIM >::mRadiusLabel, VesselNetworkReader< DIM >::mReferenceLength, and VesselNetworkReader< DIM >::mTargetSegmentLength.

template<unsigned DIM>
void VesselNetworkReader< DIM >::SetFileName ( const std::string &  rFileName)

Set the full path the file

Parameters
rFileNamethe full path to the file

Definition at line 204 of file VesselNetworkReader.cpp.

References VesselNetworkReader< DIM >::mFileName.

template<unsigned DIM>
void VesselNetworkReader< DIM >::SetMergeCoincidentPoints ( bool  mergePoints)

If true merge coincident input points

Parameters
mergePointsmerge coincident input points

Definition at line 82 of file VesselNetworkReader.cpp.

References VesselNetworkReader< DIM >::mMergeCoincidentPoints.

template<unsigned DIM>
void VesselNetworkReader< DIM >::SetRadiusArrayName ( const std::string &  rRadius)

Set the name of the radius array

Parameters
rRadiusthe radius array name

Definition at line 76 of file VesselNetworkReader.cpp.

References VesselNetworkReader< DIM >::mRadiusLabel.

template<unsigned DIM>
void VesselNetworkReader< DIM >::SetReferenceLengthScale ( units::quantity< unit::length >  rReferenceLength)

Set the reference length scale

Parameters
rReferenceLengththe reference length scale

Definition at line 94 of file VesselNetworkReader.cpp.

References VesselNetworkReader< DIM >::mReferenceLength.

template<unsigned DIM>
void VesselNetworkReader< DIM >::SetTargetSegmentLength ( units::quantity< unit::length >  targetSegmentLength)

If nonzero resample the network to a target segment length

Parameters
targetSegmentLengththe target segment length

Definition at line 88 of file VesselNetworkReader.cpp.

References VesselNetworkReader< DIM >::mTargetSegmentLength.

Member Data Documentation

template<unsigned DIM>
std::string VesselNetworkReader< DIM >::mFileName
private

The full path to the file

Definition at line 53 of file VesselNetworkReader.hpp.

Referenced by VesselNetworkReader< DIM >::Read(), and VesselNetworkReader< DIM >::SetFileName().

template<unsigned DIM>
bool VesselNetworkReader< DIM >::mMergeCoincidentPoints
private

Merge any coincident points in the input data

Definition at line 69 of file VesselNetworkReader.hpp.

Referenced by VesselNetworkReader< DIM >::Read(), and VesselNetworkReader< DIM >::SetMergeCoincidentPoints().

template<unsigned DIM>
double VesselNetworkReader< DIM >::mRadiusConversionFactor
private

Radius conversion factor. Multiply radii by this factor, useful if the contents of the 'Radius' array in the vtk file is not in the form we want

Definition at line 64 of file VesselNetworkReader.hpp.

template<unsigned DIM>
std::string VesselNetworkReader< DIM >::mRadiusLabel
private

The name of the array containing radius info

Definition at line 58 of file VesselNetworkReader.hpp.

Referenced by VesselNetworkReader< DIM >::Read(), and VesselNetworkReader< DIM >::SetRadiusArrayName().

template<unsigned DIM>
units::quantity<unit::length> VesselNetworkReader< DIM >::mReferenceLength
private

The reference length scale for the vessel network, default in microns.

Definition at line 80 of file VesselNetworkReader.hpp.

Referenced by VesselNetworkReader< DIM >::Read(), and VesselNetworkReader< DIM >::SetReferenceLengthScale().

template<unsigned DIM>
units::quantity<unit::length> VesselNetworkReader< DIM >::mTargetSegmentLength
private

If this is non-zero the network will be re-sampled to a target segment length using a vtk spline filter.

Definition at line 75 of file VesselNetworkReader.hpp.

Referenced by VesselNetworkReader< DIM >::Read(), and VesselNetworkReader< DIM >::SetTargetSegmentLength().

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