vtkArrayNorm Class Reference
#include <vtkArrayNorm.h>
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 (tshead@sandia.gov) at Sandia National Laboratories.
- Tests:
- vtkArrayNorm (Tests)
Definition at line 45 of file vtkArrayNorm.h.
Public Types | |
| typedef vtkArrayDataAlgorithm | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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 vtkArrayNorm * | New () |
| static int | IsTypeOf (const char *type) |
| static vtkArrayNorm * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkArrayNorm () | |
| ~vtkArrayNorm () | |
| int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkArrayNorm::vtkArrayNorm | ( | ) | [protected] |
| vtkArrayNorm::~vtkArrayNorm | ( | ) | [protected] |
Member Function Documentation
| static vtkArrayNorm* vtkArrayNorm::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkArrayDataAlgorithm.
| virtual const char* vtkArrayNorm::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkArrayDataAlgorithm.
| static int vtkArrayNorm::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 vtkArrayDataAlgorithm.
| virtual int vtkArrayNorm::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 vtkArrayDataAlgorithm.
| static vtkArrayNorm* vtkArrayNorm::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkArrayDataAlgorithm.
| void vtkArrayNorm::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 vtkArrayDataAlgorithm.
| 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 * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkArrayDataAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/vtkArrayNorm.h
