Public Member Functions | Protected Member Functions | List of all members
mirtk::BoundarySegmentMapper Class Referenceabstract

#include <BoundarySegmentMapper.h>

Inheritance diagram for mirtk::BoundarySegmentMapper:
Inheritance graph
Collaboration diagram for mirtk::BoundarySegmentMapper:
Collaboration graph

Public Member Functions

virtual void Finalize ()
 Finalize boundary map.
 
virtual void Initialize ()
 Initialize filter after input and parameters are set.
 
void MapLargest ()
 Process boundary segment with the most number of points.
 
void MapLongest ()
 Process longest boundary segment.
 
void MapSegment (int n)
 
virtual ~BoundarySegmentMapper ()
 Destructor.
 
- Public Member Functions inherited from mirtk::BoundaryMapper
double GetBoundaryValue (int i, int j=0) const
 
double GetSurfaceValue (int ptId, int j=0) const
 
bool HasBoundaryValue (int i) const
 
virtual BoundaryMapperNewCopy () 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

 BoundarySegmentMapper ()
 Default constructor.
 
 BoundarySegmentMapper (const BoundarySegmentMapper &)
 Copy constructor.
 
virtual void ComputeMap ()
 
virtual void MapBoundarySegment (int n, const Array< int > &indices, const Array< double > &tvalues, const Array< int > &selection)=0
 
BoundarySegmentMapperoperator= (const BoundarySegmentMapper &)
 Assignment operator.
 
- Protected Member Functions inherited from mirtk::BoundaryMapper
 BoundaryMapper ()
 Default constructor.
 
 BoundaryMapper (const BoundaryMapper &)
 Copy constructor.
 
BoundaryMapperoperator= (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 one surface boundary segment

Definition at line 35 of file BoundarySegmentMapper.h.

Member Function Documentation

§ ComputeMap()

virtual void mirtk::BoundarySegmentMapper::ComputeMap ( )
protectedvirtual

Assign map values to longest boundary of input surface

When the surface has more than one boundary segment and a different boundary segment should be processed or when multiple boundary segments should be processed with different boundary map settings, perform the following steps instead of calling the Run() function.

  1. Initialize() filter
  2. Repeat the following steps for each boundary segment to be mapped: a) Set selected boundary segment points and map parameters. b) MapSegment() to assign map values to current segment.
  3. Finalize() boundary map

Implements mirtk::BoundaryMapper.

§ MapBoundarySegment()

virtual void mirtk::BoundarySegmentMapper::MapBoundarySegment ( int  n,
const Array< int > &  indices,
const Array< double > &  tvalues,
const Array< int > &  selection 
)
protectedpure virtual

Map boundary segment

Parameters
[in]nIndex of boundary segment.
[in]indicesIndices of boundary points forming a closed line strip that discretizes the current surface boundary segment.
[in]tvaluesCurve parameter in [0, 1) for each boundary segment point, where the first point has value t=0 and the parameter value for consecutive points is proportional to the distance of the point from the first point along the boundary curve.
[in]selectionIndices in i and t arrays corresponding to selected boundary points.

Implemented in mirtk::BoundaryToPolygonMapper, mirtk::BoundaryToDiskMapper, and mirtk::BoundaryToSquareMapper.

§ MapSegment()

void mirtk::BoundarySegmentMapper::MapSegment ( int  n)

Process specified boundary segment

Parameters
[in]nIndex of boundary segment.

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