VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkArrayNorm Class Reference

Computes L-norms along one dimension of an array. More...

#include <vtkArrayNorm.h>

Inherits vtkArrayDataAlgorithm.

Public Types

typedef vtkArrayDataAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkArrayNormNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int GetDimension ()
 
virtual void SetDimension (int)
 
virtual int GetL ()
 
void SetL (int value)
 
virtual void SetInvert (int)
 
virtual int GetInvert ()
 
void SetWindow (const vtkArrayRange &window)
 
vtkArrayRange GetWindow ()
 

Static Public Member Functions

static vtkArrayNormNew ()
 
static int IsTypeOf (const char *type)
 
static vtkArrayNormSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkArrayNorm ()
 
 ~vtkArrayNorm ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Detailed Description

Computes L-norms along one dimension of an array.

Given an input matrix (vtkTypedArray<double>), computes the L-norm for each vector along either dimension, storing the results in a dense output vector (1D vtkDenseArray<double>). The caller may optionally request the inverse norm as output (useful for subsequent normalization), and may limit the computation to a "window" of vector elements, to avoid data copying.

Thanks:
Developed by Timothy M. Shead (tshea.nosp@m.d@sa.nosp@m.ndia..nosp@m.gov) at Sandia National Laboratories.
Tests:
vtkArrayNorm (Tests)

Definition at line 46 of file vtkArrayNorm.h.

Member Typedef Documentation

typedef vtkArrayDataAlgorithm vtkArrayNorm::Superclass

Definition at line 50 of file vtkArrayNorm.h.

Constructor & Destructor Documentation

vtkArrayNorm::vtkArrayNorm ( )
protected
vtkArrayNorm::~vtkArrayNorm ( )
protected

Member Function Documentation

static vtkArrayNorm* vtkArrayNorm::New ( )
static
static int vtkArrayNorm::IsTypeOf ( const char *  type)
static
virtual int vtkArrayNorm::IsA ( const char *  type)
virtual
static vtkArrayNorm* vtkArrayNorm::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkArrayNorm::NewInstanceInternal ( ) const
protectedvirtual
vtkArrayNorm* vtkArrayNorm::NewInstance ( ) const
void vtkArrayNorm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkArrayNorm::GetDimension ( )
virtual

Controls the dimension along which norms will be computed. For input matrices, For input matrices, use "0" (rows) or "1" (columns). Default: 0

virtual void vtkArrayNorm::SetDimension ( int  )
virtual

Controls the dimension along which norms will be computed. For input matrices, For input matrices, use "0" (rows) or "1" (columns). Default: 0

virtual int vtkArrayNorm::GetL ( )
virtual

Controls the L-value. Default: 2

void vtkArrayNorm::SetL ( int  value)

Controls the L-value. Default: 2

virtual void vtkArrayNorm::SetInvert ( int  )
virtual

Controls whether to invert output values. Default: false

virtual int vtkArrayNorm::GetInvert ( )
virtual

Controls whether to invert output values. Default: false

void vtkArrayNorm::SetWindow ( const vtkArrayRange &  window)

Defines an optional "window" used to compute the norm on a subset of the elements in a vector.

vtkArrayRange vtkArrayNorm::GetWindow ( )

Defines an optional "window" used to compute the norm on a subset of the elements in a vector.

int vtkArrayNorm::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

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