vtkArrayWeights Class Reference

#include <vtkArrayWeights.h>

List of all members.


Detailed Description

Stores a collection of weighting factors.

vtkArrayWeights provides storage for a collection of weights to be used when merging / interpolating N-way arrays. Convenience constructors are provided for working with one, two, three, and four weighting factors. For arbitrary collections of weights, use SetCount() and operator[] to assign values.

vtkArrayWeights is most commonly used with the vtkInterpolate() function to compute weighted sums of vtkArray objects.

See also:
vtkArray, vtkArraySlices
Thanks:
Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National Laboratories.
Tests:
vtkArrayWeights (Tests)

Definition at line 53 of file vtkArrayWeights.h.


Public Member Functions

 vtkArrayWeights ()
 vtkArrayWeights (double i)
 vtkArrayWeights (double i, double j)
 vtkArrayWeights (double i, double j, double k)
 vtkArrayWeights (double i, double j, double k, double l)
 ~vtkArrayWeights ()
vtkIdType GetCount () const
void SetCount (vtkIdType count)
double & operator[] (vtkIdType)
const double & operator[] (vtkIdType) const

Protected Attributes

vtkArrayWeightsStorage * Storage

Constructor & Destructor Documentation

vtkArrayWeights::vtkArrayWeights (  ) 

Create an empty collection of weights

vtkArrayWeights::vtkArrayWeights ( double  i  ) 

Create a collection containing one weight.

vtkArrayWeights::vtkArrayWeights ( double  i,
double  j 
)

Create a collection containing two weights.

vtkArrayWeights::vtkArrayWeights ( double  i,
double  j,
double  k 
)

Create a collection containing three weights.

vtkArrayWeights::vtkArrayWeights ( double  i,
double  j,
double  k,
double  l 
)

Create a collection containing four weights.

vtkArrayWeights::~vtkArrayWeights (  ) 

Destructor.


Member Function Documentation

vtkIdType vtkArrayWeights::GetCount (  )  const

Returns the number of weights stored in this container.

void vtkArrayWeights::SetCount ( vtkIdType  count  ) 

Sets the number of weights stored in this container. Note that each weight will be reset to 0.0 after calling SetCount(), use operator[] to assign the desired value for each weight.

double& vtkArrayWeights::operator[] ( vtkIdType   ) 

Accesses the i-th weight in the collection.

const double& vtkArrayWeights::operator[] ( vtkIdType   )  const

Accesses the i-th weight in the collection.


Member Data Documentation

vtkArrayWeightsStorage* vtkArrayWeights::Storage [protected]

Definition at line 89 of file vtkArrayWeights.h.


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

Generated on Wed Aug 24 11:28:54 2011 for VTK by  doxygen 1.5.6