FreeMat: vtkGenericAdaptorCell

FreeMat

- Main Page
- Related Pages

vtkGenericAdaptorCell

Section: Visualization Toolkit Filtering Classes

# Usage

In VTK, spatial-temporal data is defined in terms of a dataset which is composed of cells. The cells are topological entities over which an interpolation field is applied. Cells are defined in terms of a topology (e.g., vertices, lines, triangles, polygons, tetrahedra, etc.), points that instantiate the geometry of the cells, and interpolation fields (in the general case one interpolation field is for geometry, the other is for attribute data associated with the cell).

Currently most algorithms in VTK use vtkCell and vtkDataSet, which make assumptions about the nature of datasets, cells, and attributes. In particular, this abstraction assumes that cell interpolation functions are linear, or products of linear functions. Further, VTK implements most of the interpolation functions. This implementation starts breaking down as the complexity of the interpolation (or basis) functions increases.

vtkGenericAdaptorCell addresses these issues by providing more general abstraction for cells. It also adopts modern C++ practices including using iterators. The vtkGenericAdaptorCell is designed to fit within the adaptor framework; meaning that it is meant to adapt VTK to external simulation systems (see the GenericFiltering/README.html).

Please note that most cells are defined in terms of other cells (the boundary cells). They are also defined in terms of points, which are not the same as vertices (vertices are a 0-D cell; points represent a position in space).

Another important concept is the notion of DOFNodes. These concept supports cell types with complex interpolation functions. For example, higher-order p-method finite elements may have different functions on each of their topological features (edges, faces, region). The coefficients of these polynomial functions are associated with DOFNodes. (There is a single DOFNode for each topological feature.) Note that from this perspective, points are used to establish the topological form of the cell; mid-side nodes and such are considered DOFNodes.

To create an instance of class vtkGenericAdaptorCell, simply invoke its constructor as follows

      obj = vtkGenericAdaptorCell

# Methods

The class vtkGenericAdaptorCell has several methods that can be used. They are listed below. Note that the documentation is translated automatically from the VTK sources, and may not be completely intelligible. When in doubt, consult the VTK website. In the methods listed below, `obj` is an instance of the vtkGenericAdaptorCell class.

- `string = obj.GetClassName ()`
- `int = obj.IsA (string name)`
- `vtkGenericAdaptorCell = obj.NewInstance ()`
- `vtkGenericAdaptorCell = obj.SafeDownCast (vtkObject o)`
- `vtkIdType = obj.GetId ()` - Unique identification number of the cell over the whole data set. This unique key may not be contiguous.
- `int = obj.IsInDataSet ()` - Does `this' a cell of a dataset? (otherwise, it is a boundary cell)
- `int = obj.GetType ()` - Return the type of the current cell.
  Postcondition:
    (result==VTK_HIGHER_ORDER_EDGE)|| (result==VTK_HIGHER_ORDER_TRIANGLE)|| (result==VTK_HIGHER_ORDER_TETRAHEDRON)
- `int = obj.GetDimension ()` - Return the topological dimension of the current cell.
  Postcondition:
    valid_result: result>=0 && result<=3
- `int = obj.GetGeometryOrder ()` - Return the interpolation order of the geometry.
  Postcondition:
    positive_result: result>=0
- `int = obj.IsGeometryLinear ()` - Does the cell have a non-linear interpolation for the geometry?
  Postcondition:
    definition: result==(GetGeometryOrder()==1)
- `int = obj.GetAttributeOrder (vtkGenericAttribute a)` - Return the interpolation order of attribute `a' on the cell (may differ by cell).
  Precondition:
    a_exists: a!=0
  Postcondition:
    positive_result: result>=0
- `int = obj.GetHighestOrderAttribute (vtkGenericAttributeCollection ac)` - Return the index of the first point centered attribute with the highest order in `ac'.
  Precondition:
    ac_exists: ac!=0
  Postcondition:
    valid_result: result>=-1 && result<ac->GetNumberOfAttributes()
- `int = obj.IsAttributeLinear (vtkGenericAttribute a)` - Does the attribute `a' have a non-linear interpolation?
  Precondition:
    a_exists: a!=0
  Postcondition:
    definition: result==(GetAttributeOrder()==1)
- `int = obj.IsPrimary ()` - Is the cell primary (i.e. not composite) ?
- `int = obj.GetNumberOfPoints ()` - Return the number of corner points that compose the cell.
  Postcondition:
    positive_result: result>=0
- `int = obj.GetNumberOfBoundaries (int dim)` - Return the number of boundaries of dimension `dim' (or all dimensions greater than 0 and less than GetDimension() if -1) of the cell. When dim is -1, the number of vertices is not included in the count because vertices are a special case: a vertex will have at most a single field value associated with it; DOF nodes may have an arbitrary number of field values associated with them.
  Precondition:
    valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension()))
  Postcondition:
    positive_result: result>=0

- `int = obj.GetNumberOfDOFNodes ()` - Accumulated number of DOF nodes of the current cell. A DOF node is a component of cell with a given topological dimension. e.g.: a triangle has 4 DOF: 1 face and 3 edges. An hexahedron has 19 DOF: 1 region, 6 faces, and 12 edges.

  The number of vertices is not included in the count because vertices are a special case: a vertex will have at most a single field value associated with it; DOF nodes may have an arbitrary number of field values associated with them.

  Postcondition:
    valid_result: result==GetNumberOfBoundaries(-1)+1
- `obj.GetPointIterator (vtkGenericPointIterator it)` - Return the points of cell into `it'.
  Precondition:
    it_exists: it!=0
- `vtkGenericCellIterator = obj.NewCellIterator ()` - Create an empty cell iterator. The user is responsible for deleting it.
  Postcondition:
    result_exists: result!=0
- `obj.GetBoundaryIterator (vtkGenericCellIterator boundaries, int dim)` - Return the `boundaries' cells of dimension `dim' (or all dimensions less than GetDimension() if -1) that are part of the boundary of the cell.
  Precondition:
    valid_dim_range: (dim==-1) || ((dim>=0)&&(dim<GetDimension()))
    boundaries_exist: boundaries!=0
- `int = obj.CountNeighbors (vtkGenericAdaptorCell boundary)` - Number of cells (dimension>boundary->GetDimension()) of the dataset that share the boundary `boundary' of `this'. `this' IS NOT INCLUDED.
  Precondition:
    boundary_exists: boundary!=0
    real_boundary: !boundary->IsInDataSet()
    cell_of_the_dataset: IsInDataSet()
    boundary: HasBoundary(boundary)
  Postcondition:
    positive_result: result>=0
- `obj.CountEdgeNeighbors (int sharing)` - Number of cells (dimension>boundary->GetDimension()) of the dataset that share the boundary `boundary' of `this'. `this' IS NOT INCLUDED.
  Precondition:
    boundary_exists: boundary!=0
    real_boundary: !boundary->IsInDataSet()
    cell_of_the_dataset: IsInDataSet()
    boundary: HasBoundary(boundary)
  Postcondition:
    positive_result: result>=0
- `obj.GetNeighbors (vtkGenericAdaptorCell boundary, vtkGenericCellIterator neighbors)` - Put into `neighbors' the cells (dimension>boundary->GetDimension()) of the dataset that share the boundary `boundary' with this cell. `this' IS NOT INCLUDED.
  Precondition:
    boundary_exists: boundary!=0
    real_boundary: !boundary->IsInDataSet()
    cell_of_the_dataset: IsInDataSet()
    boundary: HasBoundary(boundary)
    neighbors_exist: neighbors!=0
- `obj.EvaluateLocation (int subId, double pcoords[3], double x[3])` - Determine the global coordinates `x' from sub-cell `subId' and parametric coordinates `pcoords' in the cell.
  Precondition:
    positive_subId: subId>=0
    clamped_pcoords: (0<=pcoords[0])&&(pcoords[0]<=1)&&(0<=pcoords[1]) &&(pcoords[1]<=1)&&(0<=pcoords[2])&&(pcoords[2]<=1)
- `obj.InterpolateTuple (vtkGenericAttribute a, double pcoords[3], double val)` - Interpolate the attribute `a' at local position `pcoords' of the cell into `val'.
  Precondition:
    a_exists: a!=0
    a_is_point_centered: a->GetCentering()==vtkPointCentered
    clamped_point: pcoords[0]>=0 && pcoords[0]<=1 && pcoords[1]>=0 && pcoords[1]<=1 && pcoords[2]>=0 && pcoords[2]<=1
    val_exists: val!=0
    valid_size: sizeof(val)==a->GetNumberOfComponents()
- `obj.InterpolateTuple (vtkGenericAttributeCollection c, double pcoords[3], double val)` - Interpolate the whole collection of attributes `c' at local position `pcoords' of the cell into `val'. Only point centered attributes are taken into account.
  Precondition:
    c_exists: c!=0
    clamped_point: pcoords[0]>=0 && pcoords[0]<=1 && pcoords[1]>=0 && pcoords[1]<=1 && pcoords[2]>=0 && pcoords[2]<=1
    val_exists: val!=0
    valid_size: sizeof(val)==c->GetNumberOfPointCenteredComponents()

- `obj.Contour (vtkContourValues values, vtkImplicitFunction f, vtkGenericAttributeCollection attributes, vtkGenericCellTessellator tess, vtkIncrementalPointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData outPd, vtkCellData outCd, vtkPointData internalPd, vtkPointData secondaryPd, vtkCellData secondaryCd)` - Generate a contour (contouring primitives) for each `values' or with respect to an implicit function `f'. Contouring is performed on the scalar attribute (`attributes->GetActiveAttribute()' `attributes->GetActiveComponent()'). Contouring interpolates the `attributes->GetNumberOfattributesToInterpolate()' attributes `attributes->GetAttributesToInterpolate()'. The `locator', `verts', `lines', `polys', `outPd' and `outCd' are cumulative data arrays over cell iterations: they store the result of each call to Contour():

  - `locator' is a points list that merges points as they are inserted (i.e., prevents duplicates).
  - `verts' is an array of generated vertices
  - `lines' is an array of generated lines
  - `polys' is an array of generated polygons
  - `outPd' is an array of interpolated point data along the edge (if not-NULL)
  - `outCd' is an array of copied cell data of the current cell (if not-NULL) `internalPd', `secondaryPd' and `secondaryCd' are initialized by the filter that call it from `attributes'.
  - `internalPd' stores the result of the tessellation pass: the higher-order cell is tessellated into linear sub-cells.
  - `secondaryPd' and `secondaryCd' are used internally as inputs to the Contour() method on linear sub-cells. Note: the CopyAllocate() method must be invoked on both `outPd' and `outCd', from `secondaryPd' and `secondaryCd'.

  NOTE: `vtkGenericAttributeCollection *attributes' will be replaced by a `vtkInformation'.

  Precondition:
    values_exist: (values!=0 && f==0) || (values==0 && f!=0)
    attributes_exist: attributes!=0
    tessellator_exists: tess!=0
    locator_exists: locator!=0
    verts_exist: verts!=0
    lines_exist: lines!=0
    polys_exist: polys!=0
    internalPd_exists: internalPd!=0
    secondaryPd_exists: secondaryPd!=0
    secondaryCd_exists: secondaryCd!=0

- `obj.Clip (double value, vtkImplicitFunction f, vtkGenericAttributeCollection attributes, vtkGenericCellTessellator tess, int insideOut, vtkIncrementalPointLocator locator, vtkCellArray connectivity, vtkPointData outPd, vtkCellData outCd, vtkPointData internalPd, vtkPointData secondaryPd, vtkCellData secondaryCd)` - Cut (or clip) the current cell with respect to the contour defined by the `value' or the implicit function `f' of the scalar attribute (`attributes->GetActiveAttribute()',`attributes->GetActiveComponent()'). If `f' exists, `value' is not used. The output is the part of the current cell which is inside the contour. The output is a set of zero, one or more cells of the same topological dimension as the current cell. Normally, cell points whose scalar value is greater than "value" are considered inside. If `insideOut' is on, this is reversed. Clipping interpolates the `attributes->GetNumberOfattributesToInterpolate()' attributes `attributes->GetAttributesToInterpolate()'. `locator', `connectivity', `outPd' and `outCd' are cumulative data arrays over cell iterations: they store the result of each call to Clip():

  - `locator' is a points list that merges points as they are inserted (i.e., prevents duplicates).
  - `connectivity' is an array of generated cells
  - `outPd' is an array of interpolated point data along the edge (if not-NULL)
  - `outCd' is an array of copied cell data of the current cell (if not-NULL) `internalPd', `secondaryPd' and `secondaryCd' are initialized by the filter that call it from `attributes'.
  - `internalPd' stores the result of the tessellation pass: the higher-order cell is tessellated into linear sub-cells.
  - `secondaryPd' and `secondaryCd' are used internally as inputs to the Clip() method on linear sub-cells. Note: the CopyAllocate() method must be invoked on both `outPd' and `outCd', from `secondaryPd' and `secondaryCd'.

  NOTE: `vtkGenericAttributeCollection *attributes' will be replaced by a `vtkInformation'.

  Precondition:
    attributes_exist: attributes!=0
    tessellator_exists: tess!=0
    locator_exists: locator!=0
    connectivity_exists: connectivity!=0
    internalPd_exists: internalPd!=0
    secondaryPd_exists: secondaryPd!=0
    secondaryCd_exists: secondaryCd!=0
- `obj.Derivatives (int subId, double pcoords[3], vtkGenericAttribute attribute, double derivs)` - Compute derivatives `derivs' of the attribute `attribute' (from its values at the corner points of the cell) given sub-cell `subId' (0 means primary cell) and parametric coordinates `pcoords'. Derivatives are in the x-y-z coordinate directions for each data value.
  Precondition:
    positive_subId: subId>=0
    clamped_pcoords: (0<=pcoords[0])&&(pcoords[0]<=1)&&(0<=pcoords[1]) &&(pcoords[1]<=1)&&(0<=pcoords[2])%%(pcoords[2]<=1)
    attribute_exists: attribute!=0
    derivs_exists: derivs!=0
    valid_size: sizeof(derivs)>=attribute->GetNumberOfComponents()*3
- `obj.GetBounds (double bounds[6])` - Compute the bounding box of the current cell in `bounds' in global coordinates. THREAD SAFE
- `double = obj.GetLength2 ()` - Return the bounding box diagonal squared of the current cell.
  Postcondition:
    positive_result: result>=0
- `int = obj.GetParametricCenter (double pcoords[3])` - Get the center of the current cell (in parametric coordinates) and place it in `pcoords'. If the current cell is a composite, the return value is the sub-cell id that the center is in.
  Postcondition:
    valid_result: (result>=0) && (IsPrimary() implies result==0)
- `double = obj.GetParametricDistance (double pcoords[3])` - Return the distance of the parametric coordinate `pcoords' to the current cell. If inside the cell, a distance of zero is returned. This is used during picking to get the correct cell picked. (The tolerance will occasionally allow cells to be picked who are not really intersected "inside" the cell.)
  Postcondition:
    positive_result: result>=0
- `obj.Tessellate (vtkGenericAttributeCollection attributes, vtkGenericCellTessellator tess, vtkPoints points, vtkIncrementalPointLocator locator, vtkCellArray cellArray, vtkPointData internalPd, vtkPointData pd, vtkCellData cd, vtkUnsignedCharArray types)` - Tessellate the cell if it is not linear or if at least one attribute of `attributes' is not linear. The output are linear cells of the same dimension than the cell. If the cell is linear and all attributes are linear, the output is just a copy of the current cell. `points', `cellArray', `pd' and `cd' are cumulative output data arrays over cell iterations: they store the result of each call to Tessellate(). `internalPd' is initialized by the calling filter and stores the result of the tessellation. If it is not null, `types' is filled with the types of the linear cells. `types' is null when it is called from vtkGenericGeometryFilter and not null when it is called from vtkGenericDatasetTessellator.
  Precondition:
    attributes_exist: attributes!=0
    tessellator_exists: tess!=0
    points_exist: points!=0
    cellArray_exists: cellArray!=0
    internalPd_exists: internalPd!=0
    pd_exist: pd!=0
    cd_exists: cd!=0
- `int = obj.IsFaceOnBoundary (vtkIdType faceId)` - Is the face `faceId' of the current cell on the exterior boundary of the dataset?
  Precondition:
    3d: GetDimension()==3
- `int = obj.IsOnBoundary ()` - Is the cell on the exterior boundary of the dataset?
  Precondition:
    2d: GetDimension()==2
- `obj.TriangulateFace (vtkGenericAttributeCollection attributes, vtkGenericCellTessellator tess, int index, vtkPoints points, vtkIncrementalPointLocator locator, vtkCellArray cellArray, vtkPointData internalPd, vtkPointData pd, vtkCellData cd)` - Tessellate face `index' of the cell. See Tessellate() for further explanations.
  Precondition:
    cell_is_3d: GetDimension()==3
    attributes_exist: attributes!=0
    tessellator_exists: tess!=0
    valid_face: index>=0
    points_exist: points!=0
    cellArray_exists: cellArray!=0
    internalPd_exists: internalPd!=0
    pd_exist: pd!=0
    cd_exists: cd!=0
- `int = obj.GetNumberOfVerticesOnFace (int faceId)` - Return the number of vertices defining face `faceId'.
  Precondition:
    is_3d: this->GetDimension()==3
    valid_faceId_range: faceId>=0 && faceId<this->GetNumberOfBoundaries(2)
  Postcondition:
    positive_result: && result>0