Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkParametricPolynomialApproximation Class Reference

parametric function for 1D polynomials More...

#include <Modules/Loadable/Markups/MRML/vtkParametricPolynomialApproximation.h>

Inheritance diagram for vtkParametricPolynomialApproximation:
Inheritance graph
[legend]
Collaboration diagram for vtkParametricPolynomialApproximation:
Collaboration graph
[legend]

Public Types

typedef vtkParametricFunction Superclass
 
enum  { FIT_METHOD_GLOBAL_LEAST_SQUARES = 0, FIT_METHOD_MOVING_LEAST_SQUARES, FIT_METHOD_LAST }
 
enum  {
  WEIGHT_FUNCTION_RECTANGULAR = 0, WEIGHT_FUNCTION_TRIANGULAR, WEIGHT_FUNCTION_COSINE, WEIGHT_FUNCTION_GAUSSIAN,
  WEIGHT_FUNCTION_LAST
}
 

Public Member Functions

void Evaluate (double u[3], double Pt[3], double Du[9]) override
 
double EvaluateScalar (double u[3], double Pt[3], double Du[9]) override
 
virtual const char * GetClassName ()
 
int GetDimension () override
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual int GetPolynomialOrder ()
 
virtual void SetPolynomialOrder (int)
 
void SetPoints (vtkPoints *)
 
void SetParameters (vtkDoubleArray *)
 
virtual int GetFitMethod ()
 
virtual void SetFitMethod (int)
 
void SetFitMethodToGlobalLeastSquares ()
 
void SetFitMethodToMovingLeastSquares ()
 
virtual int GetWeightFunction ()
 
virtual void SetWeightFunction (int)
 
void SetWeightFunctionToRectangular ()
 
void SetWeightFunctionToTriangular ()
 
void SetWeightFunctionToCosine ()
 
void SetWeightFunctionToGaussian ()
 
virtual double GetSampleWidth ()
 
virtual void SetSampleWidth (double)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkParametricPolynomialApproximationNew ()
 
static vtkParametricPolynomialApproximationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkParametricPolynomialApproximation ()
 
 ~vtkParametricPolynomialApproximation () override
 

Detailed Description

parametric function for 1D polynomials

vtkParametricPolynomialApproximation is a parametric function for 1D approximating polynomials. vtkParametricPolynomialApproximation maps the single parameter u to a 3D point (x,y,z). Internally a polynomial is fit to a set of input points using the least squares basis.

Definition at line 42 of file vtkParametricPolynomialApproximation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkParametricFunction vtkParametricPolynomialApproximation::Superclass

Definition at line 45 of file vtkParametricPolynomialApproximation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Fitting options, see FitMethod

Enumerator
FIT_METHOD_GLOBAL_LEAST_SQUARES 
FIT_METHOD_MOVING_LEAST_SQUARES 
FIT_METHOD_LAST 

Definition at line 95 of file vtkParametricPolynomialApproximation.h.

◆ anonymous enum

anonymous enum

Options for weighing points in moving least squares, see WeightFunction

Enumerator
WEIGHT_FUNCTION_RECTANGULAR 
WEIGHT_FUNCTION_TRIANGULAR 
WEIGHT_FUNCTION_COSINE 
WEIGHT_FUNCTION_GAUSSIAN 
WEIGHT_FUNCTION_LAST 

Definition at line 116 of file vtkParametricPolynomialApproximation.h.

Constructor & Destructor Documentation

◆ vtkParametricPolynomialApproximation()

vtkParametricPolynomialApproximation::vtkParametricPolynomialApproximation ( )
protected

◆ ~vtkParametricPolynomialApproximation()

vtkParametricPolynomialApproximation::~vtkParametricPolynomialApproximation ( )
overrideprotected

Member Function Documentation

◆ Evaluate()

void vtkParametricPolynomialApproximation::Evaluate ( double  u[3],
double  Pt[3],
double  Du[9] 
)
override

Evaluate the parametric function at parametric coordinate u[0] returning the point coordinate Pt[3].

◆ EvaluateScalar()

double vtkParametricPolynomialApproximation::EvaluateScalar ( double  u[3],
double  Pt[3],
double  Du[9] 
)
override

Evaluate a scalar value at parametric coordinate u[0] and Pt[3]. Simply returns the parameter u[0].

◆ GetClassName()

virtual const char* vtkParametricPolynomialApproximation::GetClassName ( )
virtual

◆ GetDimension()

int vtkParametricPolynomialApproximation::GetDimension ( )
inlineoverride

Return the parametric dimension of the class.

Definition at line 53 of file vtkParametricPolynomialApproximation.h.

◆ GetFitMethod()

virtual int vtkParametricPolynomialApproximation::GetFitMethod ( )
virtual

What type of fit should be used (e.g. global/local)

◆ GetPolynomialOrder()

virtual int vtkParametricPolynomialApproximation::GetPolynomialOrder ( )
virtual

Specify the order of polynomial (maximum exponent) that should be fit.

◆ GetSampleWidth()

virtual double vtkParametricPolynomialApproximation::GetSampleWidth ( )
virtual

The width of sampling for moving least squares (in parameter space) This is total width, so the space that is sampled is SamplePosition - ( SampleWidth / 2 ) through to SamplePosition + ( SampleWidth / 2 ). Valid range is from 0.0 to 1.0. Default is 0.5.

◆ GetWeightFunction()

virtual int vtkParametricPolynomialApproximation::GetWeightFunction ( )
virtual

Specify the order of polynomial (maximum exponent) that should be fit.

◆ IsA()

virtual int vtkParametricPolynomialApproximation::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkParametricPolynomialApproximation::IsTypeOf ( const char *  type)
static

◆ New()

static vtkParametricPolynomialApproximation* vtkParametricPolynomialApproximation::New ( )
static

◆ PrintSelf()

void vtkParametricPolynomialApproximation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

static vtkParametricPolynomialApproximation* vtkParametricPolynomialApproximation::SafeDownCast ( vtkObject *  o)
static

◆ SetFitMethod()

virtual void vtkParametricPolynomialApproximation::SetFitMethod ( int  )
virtual

◆ SetFitMethodToGlobalLeastSquares()

void vtkParametricPolynomialApproximation::SetFitMethodToGlobalLeastSquares ( )
inline

Definition at line 108 of file vtkParametricPolynomialApproximation.h.

◆ SetFitMethodToMovingLeastSquares()

void vtkParametricPolynomialApproximation::SetFitMethodToMovingLeastSquares ( )
inline

Definition at line 109 of file vtkParametricPolynomialApproximation.h.

◆ SetParameters()

void vtkParametricPolynomialApproximation::SetParameters ( vtkDoubleArray *  )

Specify the parameters for the points. Length of list should be the same, and the points should be in the same order as the parameters.

◆ SetPoints()

void vtkParametricPolynomialApproximation::SetPoints ( vtkPoints *  )

Specify the list of points that the polynomial should approximate. Set the point parameters that should be used during fitting with SetParameters.

◆ SetPolynomialOrder()

virtual void vtkParametricPolynomialApproximation::SetPolynomialOrder ( int  )
virtual

◆ SetSampleWidth()

virtual void vtkParametricPolynomialApproximation::SetSampleWidth ( double  )
virtual

◆ SetWeightFunction()

virtual void vtkParametricPolynomialApproximation::SetWeightFunction ( int  )
virtual

◆ SetWeightFunctionToCosine()

void vtkParametricPolynomialApproximation::SetWeightFunctionToCosine ( )
inline

Definition at line 133 of file vtkParametricPolynomialApproximation.h.

◆ SetWeightFunctionToGaussian()

void vtkParametricPolynomialApproximation::SetWeightFunctionToGaussian ( )
inline

Definition at line 134 of file vtkParametricPolynomialApproximation.h.

◆ SetWeightFunctionToRectangular()

void vtkParametricPolynomialApproximation::SetWeightFunctionToRectangular ( )
inline

Definition at line 131 of file vtkParametricPolynomialApproximation.h.

◆ SetWeightFunctionToTriangular()

void vtkParametricPolynomialApproximation::SetWeightFunctionToTriangular ( )
inline

Definition at line 132 of file vtkParametricPolynomialApproximation.h.


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