mirtk::BoundaryMapper Class Reference

#include <BoundaryMapper.h>

Inheritance diagram for mirtk::BoundaryMapper:

Collaboration diagram for mirtk::BoundaryMapper:

Public Member Functions
double	GetBoundaryValue (int i, int j=0) const
double	GetSurfaceValue (int ptId, int j=0) const
bool	HasBoundaryValue (int i) const
virtual BoundaryMapper *	NewCopy () const =0
	Create new copy of this instance.
virtual int	NumberOfComponents () const
	Number of map value components.
virtual void	Run ()
	Compute boundary map values.
virtual	~BoundaryMapper ()
	Destructor.
Public Member Functions inherited from mirtk::Object
virtual const char *	NameOfClass () const =0
	Get name of class, which this object is an instance of.
virtual ParameterList	Parameter () const
	Get parameter name/value pairs.
bool	Parameter (const ParameterList &)
	Set parameters from name/value pairs.
virtual bool	Set (const char *name, const char *value)
virtual	~Object ()
	Destructor.

Protected Member Functions
	BoundaryMapper ()
	Default constructor.
	BoundaryMapper (const BoundaryMapper &)
	Copy constructor.
virtual void	ComputeMap ()=0
	Assign map values to boundary points of surface mesh.
virtual void	Finalize ()
	Finalize boundary map.
virtual void	Initialize ()
	Initialize filter after input and parameters are set.
BoundaryMapper &	operator= (const BoundaryMapper &)
	Assignment operator.
void	SetBoundaryValue (int i, double v)
void	SetBoundaryValue (int i, int j, double v)
Protected Member Functions inherited from mirtk::Object
template<typename... Args>
void	Throw (ErrorType err, const char *func, Args... args) const

Additional Inherited Members
Static Public Member Functions inherited from mirtk::Object
static const char *	NameOfType ()
	Get name of this class type.
Static Protected Member Functions inherited from mirtk::Object
template<typename... Args>
static void	ThrowStatic (ErrorType err, const char *cls, const char *func, Args... args)

Detailed Description

Base class of filters which assign map values to surface boundary points

Filters of this type take a piecewice linear surface boundary segments extracted from a surface mesh as input and compute a map value for each point on the surface boundary. Such piecewise linear boundary map can be used as fixed boundary condition for a surface map.

See also

SurfaceMapper

Definition at line 44 of file BoundaryMapper.h.

Member Function Documentation

GetBoundaryValue()

double mirtk::BoundaryMapper::GetBoundaryValue ( int  i, int  j = 0  ) const

inline

Get map value at boundary point

Parameters

[in]	i	Boundary point index.
[in]	j	Index of map value component.

Returns

Map value component at surface boundary point.

Definition at line 182 of file BoundaryMapper.h.

GetSurfaceValue()

double mirtk::BoundaryMapper::GetSurfaceValue ( int  ptId, int  j = 0  ) const

inline

Get map value at surface point

Parameters

[in]	ptId	Surface point index.
[in]	j	Index of map value component.

Returns

Map value component at surface point.

Definition at line 188 of file BoundaryMapper.h.

HasBoundaryValue()

bool mirtk::BoundaryMapper::HasBoundaryValue ( int  i ) const

inline

Whether a given boundary point has a mapped value

Parameters

[in]

i

Boundary point index.

Returns

Whether this mapper assigned a map value to the specified boundary point.

Definition at line 159 of file BoundaryMapper.h.

SetBoundaryValue() [1/2]

void mirtk::BoundaryMapper::SetBoundaryValue ( int  i, double  v  )

inlineprotected

Set map value at boundary point

Parameters

[in]	i	Boundary point index.
[in]	v	Value of j-th map component.

Returns

Map value component at surface point.

Definition at line 176 of file BoundaryMapper.h.

SetBoundaryValue() [2/2]

void mirtk::BoundaryMapper::SetBoundaryValue ( int  i, int  j, double  v  )

inlineprotected

Set map value at boundary point

Parameters

[in]	i	Boundary point index.
[in]	j	Index of map value component.
[in]	v	Value of j-th map component.

Returns

Map value component at surface point.

Definition at line 170 of file BoundaryMapper.h.

---

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

• BoundaryMapper.h