vtkVectorNorm Class Reference

generate scalars from Euclidean norm of vectors More...

#include <vtkVectorNorm.h>

Inheritance diagram for vtkVectorNorm:

Collaboration diagram for vtkVectorNorm:

List of all members.

Public Types
typedef vtkDataSetAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkVectorNorm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetNormalize (int)
virtual int	GetNormalize ()
virtual void	NormalizeOn ()
virtual void	NormalizeOff ()
virtual void	SetAttributeMode (int)
virtual int	GetAttributeMode ()
void	SetAttributeModeToDefault ()
void	SetAttributeModeToUsePointData ()
void	SetAttributeModeToUseCellData ()
const char *	GetAttributeModeAsString ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkVectorNorm *	SafeDownCast (vtkObjectBase *o)
static vtkVectorNorm *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkVectorNorm ()
	~vtkVectorNorm ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Attributes
int	Normalize
int	AttributeMode

---

Detailed Description

generate scalars from Euclidean norm of vectors

vtkVectorNorm is a filter that generates scalar values by computing Euclidean norm of vector triplets. Scalars can be normalized 0<=s<=1 if desired.

Note that this filter operates on point or cell attribute data, or both. By default, the filter operates on both point and cell data if vector point and cell data, respectively, are available from the input. Alternatively, you can choose to generate scalar norm values for just cell or point data.

Tests:

vtkVectorNorm (Tests)

Definition at line 42 of file vtkVectorNorm.h.

---

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkVectorNorm::Superclass

Reimplemented from vtkDataSetAlgorithm.

Definition at line 45 of file vtkVectorNorm.h.

---

Constructor & Destructor Documentation

vtkVectorNorm::vtkVectorNorm

(

)

[protected]

vtkVectorNorm::~vtkVectorNorm

(

)

[inline, protected]

Definition at line 78 of file vtkVectorNorm.h.

---

Member Function Documentation

static int vtkVectorNorm::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

virtual int vtkVectorNorm::IsA

(

const char *

name

)

[virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

static vtkVectorNorm* vtkVectorNorm::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkDataSetAlgorithm.

virtual vtkObjectBase* vtkVectorNorm::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkDataSetAlgorithm.

vtkVectorNorm* vtkVectorNorm::NewInstance

(

)

const

Reimplemented from vtkDataSetAlgorithm.

void vtkVectorNorm::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSetAlgorithm.

static vtkVectorNorm* vtkVectorNorm::New

(

)

[static]

Construct with normalize flag off.

Reimplemented from vtkDataSetAlgorithm.

virtual void vtkVectorNorm::SetNormalize

(

int

)

[virtual]

Specify whether to normalize scalar values.

virtual int vtkVectorNorm::GetNormalize

(

)

[virtual]

Specify whether to normalize scalar values.

virtual void vtkVectorNorm::NormalizeOn

(

)

[virtual]

Specify whether to normalize scalar values.

virtual void vtkVectorNorm::NormalizeOff

(

)

[virtual]

Specify whether to normalize scalar values.

virtual void vtkVectorNorm::SetAttributeMode

(

int

)

[virtual]

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

virtual int vtkVectorNorm::GetAttributeMode

(

)

[virtual]

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

void vtkVectorNorm::SetAttributeModeToDefault

(

)

[inline]

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

Definition at line 67 of file vtkVectorNorm.h.

void vtkVectorNorm::SetAttributeModeToUsePointData

(

)

[inline]

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

Definition at line 69 of file vtkVectorNorm.h.

void vtkVectorNorm::SetAttributeModeToUseCellData

(

)

[inline]

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

Definition at line 71 of file vtkVectorNorm.h.

const char* vtkVectorNorm::GetAttributeModeAsString

(

)

Control how the filter works to generate scalar data from the input vector data. By default, (AttributeModeToDefault) the filter will generate the scalar norm for point and cell data (if vector data present in the input). Alternatively, you can explicitly set the filter to generate point data (AttributeModeToUsePointData) or cell data (AttributeModeToUseCellData).

int vtkVectorNorm::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)		[protected, virtual]

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

---

Member Data Documentation

int vtkVectorNorm::Normalize [protected]

Definition at line 82 of file vtkVectorNorm.h.

int vtkVectorNorm::AttributeMode [protected]

Definition at line 83 of file vtkVectorNorm.h.

---

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

• dox/Filters/Core/vtkVectorNorm.h