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

#include <VesselNetworkGeometryCalculator.hpp>

+ Collaboration diagram for VesselNetworkGeometryCalculator< DIM >:

Public Member Functions

 VesselNetworkGeometryCalculator ()
 
 ~VesselNetworkGeometryCalculator ()
 
void SetVesselNetwork (boost::shared_ptr< VesselNetwork< DIM > > pVesselNetwork)
 
std::vector< units::quantity< unit::length > > GetInterCapillaryDistances ()
 
units::quantity< unit::length > GetTotalLength ()
 
units::quantity< unit::volume > GetTotalVolume ()
 
units::quantity< unit::area > GetTotalSurfaceArea ()
 
units::quantity< unit::length > GetAverageInterSegmentDistance ()
 
units::quantity< unit::length > GetAverageVesselLength ()
 
std::vector< unsigned > GetVesselLengthDistribution (double binSpacing=10.0, unsigned numberOfBins=10)
 

Static Public Member Functions

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

Private Attributes

boost::shared_ptr< VesselNetwork< DIM > > mpVesselNetwork
 

Detailed Description

template<unsigned DIM>
class VesselNetworkGeometryCalculator< DIM >

Calculate geometric properties of vessel networks

Definition at line 49 of file VesselNetworkGeometryCalculator.hpp.

Constructor & Destructor Documentation

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

Constructor

Definition at line 41 of file VesselNetworkGeometryCalculator.cpp.

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

Destructor

Definition at line 48 of file VesselNetworkGeometryCalculator.cpp.

Member Function Documentation

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

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

Returns
a pointer to a class instance

Definition at line 54 of file VesselNetworkGeometryCalculator.cpp.

template<unsigned DIM>
units::quantity< unit::length > VesselNetworkGeometryCalculator< DIM >::GetAverageInterSegmentDistance ( )

Return the average distance between segments

Returns
the average distance between segments

Definition at line 141 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
units::quantity< unit::length > VesselNetworkGeometryCalculator< DIM >::GetAverageVesselLength ( )

Return the average vessel length

Returns
the average vessel length

Definition at line 179 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::GetTotalLength(), and VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
std::vector< units::quantity< unit::length > > VesselNetworkGeometryCalculator< DIM >::GetInterCapillaryDistances ( )

Get the intercapillary distance using a 2d measure

Returns

Definition at line 61 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
units::quantity< unit::length > VesselNetworkGeometryCalculator< DIM >::GetTotalLength ( )

Return the total length of the network

Returns
the total length of the network

Definition at line 90 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

Referenced by VesselNetworkGeometryCalculator< DIM >::GetAverageVesselLength().

template<unsigned DIM>
units::quantity< unit::area > VesselNetworkGeometryCalculator< DIM >::GetTotalSurfaceArea ( )

Return the total surface area of the network

Returns
the total surface area of the network

Definition at line 124 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
units::quantity< unit::volume > VesselNetworkGeometryCalculator< DIM >::GetTotalVolume ( )

Return the total volume of the network

Returns
the total volume of the network

Definition at line 107 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
std::vector< unsigned > VesselNetworkGeometryCalculator< DIM >::GetVesselLengthDistribution ( double  binSpacing = 10.0,
unsigned  numberOfBins = 10 
)

Return a histogram of vessel length distributions

Parameters
binSpacingthe bin spacing
numberOfBinsthe number of bins
Returns
a histogram of vessel length distributions

Definition at line 190 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

template<unsigned DIM>
void VesselNetworkGeometryCalculator< DIM >::SetVesselNetwork ( boost::shared_ptr< VesselNetwork< DIM > >  pVesselNetwork)

Set the vessel network

Parameters
pVesselNetworkthe vessel network

Definition at line 214 of file VesselNetworkGeometryCalculator.cpp.

References VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork.

Member Data Documentation

template<unsigned DIM>
boost::shared_ptr<VesselNetwork<DIM> > VesselNetworkGeometryCalculator< DIM >::mpVesselNetwork
private

Container for the VesselNetwork.

Definition at line 57 of file VesselNetworkGeometryCalculator.hpp.

Referenced by VesselNetworkGeometryCalculator< DIM >::GetAverageInterSegmentDistance(), VesselNetworkGeometryCalculator< DIM >::GetAverageVesselLength(), VesselNetworkGeometryCalculator< DIM >::GetInterCapillaryDistances(), VesselNetworkGeometryCalculator< DIM >::GetTotalLength(), VesselNetworkGeometryCalculator< DIM >::GetTotalSurfaceArea(), VesselNetworkGeometryCalculator< DIM >::GetTotalVolume(), VesselNetworkGeometryCalculator< DIM >::GetVesselLengthDistribution(), and VesselNetworkGeometryCalculator< DIM >::SetVesselNetwork().

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